From a33cd4337b096d2ccb61387afee958bcf1f279d1 Mon Sep 17 00:00:00 2001
From: Matthew Beale <matt.beale@madhatted.com>
Date: Sat, 8 Aug 2015 16:00:40 -0400
Subject: [PATCH] Do not descend ignored directories

Paths may be ignored because they contain a large number of files. The
getDirs method should not actually descend into those ignored
directories.

Additionally this commit flattens the recursion in getDirs.
---
 lib/utils.js                            | 69 +++++++++++++------------
 tests/builder.js                        |  7 ++-
 tests/input/with-symlink/a/.gitignore   |  0
 tests/input/with-symlink/a/b            |  1 +
 tests/input/with-symlink/a/d/.gitignore |  0
 tests/input/with-symlink/a/some-file    |  0
 tests/input/with-symlink/c/.gitignore   |  0
 tests/input/with-symlink/some-file      |  0
 tests/parser.js                         |  9 +++-
 tests/utils.js                          | 55 +++++++++++++++++++-
 10 files changed, 105 insertions(+), 36 deletions(-)
 create mode 100644 tests/input/with-symlink/a/.gitignore
 create mode 120000 tests/input/with-symlink/a/b
 create mode 100644 tests/input/with-symlink/a/d/.gitignore
 create mode 100644 tests/input/with-symlink/a/some-file
 create mode 100644 tests/input/with-symlink/c/.gitignore
 create mode 100644 tests/input/with-symlink/some-file

diff --git a/lib/utils.js b/lib/utils.js
index 328a409e..a45264f9 100644
--- a/lib/utils.js
+++ b/lib/utils.js
@@ -336,27 +336,45 @@ YUI.add('utils', function (Y) {
 
     Y.getProjectData = getProjectData;
 
-
     /**
      * Walks the tree from this dir and returns all the subdirs
      * @method getDirs
-     * @param {String} dir The dir to begin at
+     * @param {String} baseDir The dir to begin at
+     * @param {Array} ignore An array of paths to ignore
      * @return {Array} The array of directories..
      */
-    var getDirs = function (dir) {
-        var dirs = fs.readdirSync(dir),
-            paths = [];
+    var getDirs = function (baseDir, ignore) {
+        var inputPaths = [],
+            paths = [],
+            i, d, isIgnored, subpath,
+            stat, possibleDirs, fullPath;
 
-        dirs.forEach(function (d) {
-            var _dir = path.join(dir, d),
-                stat = fs.lstatSync(_dir);
+        var inputPath = '';
+        while (inputPath !== undefined) {
+            fullPath = path.join(baseDir, inputPath);
+            stat = fs.lstatSync(fullPath);
 
             if (stat.isDirectory()) {
-                if (_dir.indexOf('.') !== 0) {
-                    paths = [].concat(paths, _dir, getDirs(_dir));
+                if (fullPath !== baseDir) {
+                    paths.push(fullPath);
+                }
+                possibleDirs = fs.readdirSync(fullPath);
+                for (d=0;d<possibleDirs.length;d++) {
+                    subpath = path.join(inputPath, possibleDirs[d]);
+                    isIgnored = false;
+                    for (i=0;i<ignore.length;i++) {
+                        if (subpath.indexOf(ignore[i]) === 0) {
+                          isIgnored = true;
+                          break;
+                        }
+                    }
+                    if (!isIgnored) {
+                      inputPaths.push(subpath);
+                    }
                 }
             }
-        });
+            inputPath = inputPaths.pop();
+        }
 
         return paths;
     };
@@ -370,6 +388,12 @@ YUI.add('utils', function (Y) {
      * @param {String} [ignore=false] A string to call `.indexOf` on a path to determine if it should be ignored
      */
     var validatePaths = function (paths, ignore) {
+        if (!ignore) {
+            ignore = [];
+        } else if (!(ignore instanceof Array)) {
+            ignore = [ignore];
+        }
+
         var newpaths = [];
         //Shortcut the *, . & ./ shortcuts that shall globbing fixes for us
         if (paths === '*' || paths === '.' || paths === './') {
@@ -388,7 +412,7 @@ YUI.add('utils', function (Y) {
                 glob = validatePath.replace(/\//g, '\\\\');
             }
 
-            var glob_paths = getDirs('.'),
+            var glob_paths = getDirs('.', ignore),
                 is_globbed = false;
 
             glob_paths.forEach(function (dir) {
@@ -426,27 +450,6 @@ YUI.add('utils', function (Y) {
             throw ('Paths should be an array of paths');
         }
 
-        if (ignore) {
-            if (!(ignore instanceof Array)) {
-                ignore = [ignore];
-            }
-            var p = [],
-                shouldIgnore = false;
-
-            paths.forEach(function (v) {
-                shouldIgnore = false;
-                ignore.forEach(function (i) {
-                    if (!shouldIgnore && v.indexOf(i) !== -1) {
-                        shouldIgnore = true;
-                    }
-                });
-                if (!shouldIgnore) {
-                    p.push(v);
-                }
-            });
-            paths = p;
-        }
-
         paths = paths.sort();
         return paths;
     };
diff --git a/tests/builder.js b/tests/builder.js
index fa1427ff..3133aebe 100644
--- a/tests/builder.js
+++ b/tests/builder.js
@@ -28,7 +28,11 @@ var suite = new YUITest.TestSuite({
 
         options = {
             quiet: true,
-            paths: ['input/'],
+            paths: [
+                'input/inherit',
+                'input/json',
+                'input/test'
+            ],
             outdir: './out',
             helpers: [
                 path.join(__dirname, 'lib/davglass.js')
@@ -37,6 +41,7 @@ var suite = new YUITest.TestSuite({
                 langPrefix: 'language-'
             }
         };
+        process.chdir(__dirname);
         json = (new Y.YUIDoc(options)).run();
 
         this.project = json.project;
diff --git a/tests/input/with-symlink/a/.gitignore b/tests/input/with-symlink/a/.gitignore
new file mode 100644
index 00000000..e69de29b
diff --git a/tests/input/with-symlink/a/b b/tests/input/with-symlink/a/b
new file mode 120000
index 00000000..82f488f2
--- /dev/null
+++ b/tests/input/with-symlink/a/b
@@ -0,0 +1 @@
+../a
\ No newline at end of file
diff --git a/tests/input/with-symlink/a/d/.gitignore b/tests/input/with-symlink/a/d/.gitignore
new file mode 100644
index 00000000..e69de29b
diff --git a/tests/input/with-symlink/a/some-file b/tests/input/with-symlink/a/some-file
new file mode 100644
index 00000000..e69de29b
diff --git a/tests/input/with-symlink/c/.gitignore b/tests/input/with-symlink/c/.gitignore
new file mode 100644
index 00000000..e69de29b
diff --git a/tests/input/with-symlink/some-file b/tests/input/with-symlink/some-file
new file mode 100644
index 00000000..e69de29b
diff --git a/tests/parser.js b/tests/parser.js
index ad60de03..ce46601f 100644
--- a/tests/parser.js
+++ b/tests/parser.js
@@ -15,9 +15,16 @@ var existsSync = fs.existsSync || path.existsSync;
 var suite = new YUITest.TestSuite({
     name: 'Parser Test Suite',
     setUp: function () {
+        process.chdir(__dirname);
         var json = (new Y.YUIDoc({
             quiet: true,
-            paths: ['input/'],
+            paths: [
+                'input/charts',
+                'input/inherit',
+                'input/namespace',
+                'input/test',
+                'input/test2'
+            ],
             outdir: './out'
         })).run();
 
diff --git a/tests/utils.js b/tests/utils.js
index 2b915a57..c2026177 100644
--- a/tests/utils.js
+++ b/tests/utils.js
@@ -6,7 +6,13 @@ var path = require('path');
 var Y = require(path.join(__dirname, '../', 'lib', 'index'));
 
 var suite = new YUITest.TestSuite({
-    name: 'Utils Test Suite'
+    name: 'Utils Test Suite',
+    setUp: function () {
+        process.chdir(__dirname);
+    },
+    tearDown: function () {
+        process.chdir(__dirname);
+    }
 });
 
 suite.add(new YUITest.TestCase({
@@ -74,6 +80,25 @@ suite.add(new YUITest.TestCase({
 
         Assert.isArray(options.paths, 'Failed to set path');
         Assert.areSame(3, options.paths.length, 'Failed to retrieve all path options');
+    },
+    'test: ignore paths': function () {
+        var options;
+
+        process.chdir(path.join(__dirname, 'input/with-symlink'));
+
+        // Simulate a path provided by a configuration
+        options = {
+            paths: 'a',
+            ignorePaths: [
+              'a/d',
+              'c'
+            ]
+        };
+        options = Y.Project.init(options);
+
+        Assert.isArray(options.paths, 'paths are present');
+        Assert.areSame(1, options.paths.length, 'one path present');
+        Assert.areSame('a', options.paths[0], 'path a is in paths');
     }
 }));
 
@@ -93,4 +118,32 @@ suite.add(new YUITest.TestCase({
     }
 }));
 
+suite.add(new YUITest.TestCase({
+    name: 'getDirs',
+    setUp: function () {
+        process.chdir(__dirname);
+    },
+    'test: gets paths as array': function() {
+        process.chdir(__dirname);
+        var pathPrefix = __dirname + '/input/folders1';
+        var dirs = Y.getDirs(pathPrefix, []);
+        Assert.isArray(dirs);
+        Assert.areSame(2, dirs.length);
+        Assert.areNotSame(-1, dirs.indexOf(pathPrefix + '/one'), 'contains path /one');
+        Assert.areNotSame(-1, dirs.indexOf(pathPrefix + '/one/two'), 'contains path /one/two');
+    },
+    'test: ignores paths': function() {
+        process.chdir(__dirname);
+        var pathPrefix = __dirname + '/input/with-symlink';
+        var dirs = Y.getDirs(pathPrefix, ['c']);
+        Assert.isArray(dirs);
+        Assert.areSame(2, dirs.length);
+        Assert.areSame(-1, dirs.indexOf(pathPrefix + '.gitignore'), 'does not contain file some-file');
+        Assert.areSame(-1, dirs.indexOf(pathPrefix + '/a/b'), 'does not contain symlink /a/b');
+        Assert.areSame(-1, dirs.indexOf(pathPrefix + '/c'), 'does not contain path /c');
+        Assert.areNotSame(-1, dirs.indexOf(pathPrefix + '/a'), 'contains path /a');
+        Assert.areNotSame(-1, dirs.indexOf(pathPrefix + '/a/d'), 'contains path /a/d');
+    }
+}));
+
 YUITest.TestRunner.add(suite);