all files / lib/ multi-require.js

70.91% Statements 39/55
37.5% Branches 9/24
57.14% Functions 8/14
70.91% Lines 39/55
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185                                                                                                                                                                                                                                                                                                    
var _ = require('lodash')
  , fs = require('fs')
  , path = require('path')
  , glob = require('glob');
 
/**
 * Requires multiple modules from the given path pattern.
 *
 * The path pattern can be anything the node-glob library supports.
 *
 * ```js
 * var modules = multiRequire('some/path/**.js')
 *   .filterModule(_.isFunction)
 *   .require();
 * ```
 *
 * @param {String} pathPattern
 * @returns {MultiRequire}
 */
module.exports.multiRequire = function(pathPattern) {
  return new MultiRequire(pathPattern);
};
 
/**
 * @param {*} module
 * @param {String} filePath
 * @param {String} fileName
 * @param {String} fileExt
 * @constructor
 */
function RequireResult(module, filePath, fileName, fileExt) {
  this.module = module;
  this.filePath = filePath;
  this.fileName = fileName;
  this.fileExt = fileExt;
}
 
/**
 * @param {String} pathPattern
 * @constructor
 */
function MultiRequire(pathPattern) {
  this.pathPattern_ = pathPattern;
  this.folderModules_ = true;
  this.filters_ = [];
  this.moduleFilters_ = [];
}
 
/**
 * Are folders that contain an `index.js` file considered as single modules.
 *
 * Default is true.
 *
 * @param {Boolean} folderModules
 * @returns {MultiRequire}
 */
MultiRequire.prototype.folderModules = function(folderModules) {
  this.folderModules_ = folderModules;
  return this;
};
 
/**
 * Filters the result by requiring the modules to have a certain property.
 *
 * Example:
 *
 * ```js
 * multiRequire(path)
 *   .hasProperty('prop1')
 *   .hasProperty(['prop2', 'prop3'])
 *   .hasProperty('prop4', 'prop5', 'prop6')
 *   .require();
 * ```
 *
 * @param {String|Array.<String>} property
 * @returns {MultiRequire}
 */
MultiRequire.prototype.hasProperty = function(property) {
  if (arguments.length > 1 || _.isArray(property)) {
    var array = arguments.length > 1 ? arguments : property;
    for (var i = 0; i < array.length; ++i) {
      this.hasProperty(array[i]);
    }
  } else {
    this.filterModule(function(module) {
      return _.has(module, property);
    });
  }
  return this;
};
 
/**
 * Adds a filter function.
 *
 * @param {function(RequireResult):Boolean} filter
 * @param {*=} context
 * @returns {MultiRequire}
 */
MultiRequire.prototype.filter = function(filter, context) {
  this.filters_.push({func:filter, context: context});
  return this;
};
 
/**
 * Adds a filter function that is passed the module instead of a `RequireResult`.
 *
 * @param {function(*):Boolean} filter
 * @param {*=} context
 * @returns {MultiRequire}
 */
MultiRequire.prototype.filterModule = function(filter, context) {
  this.moduleFilters_.push({func:filter, context: context});
  return this;
};
 
/**
 * Synchronously requires all modules that pass the filters.
 *
 * @param {function(RequireResult)=} callback
 * @returns {Array.<RequireResult>}
 */
MultiRequire.prototype.require = function(callback) {
  return this.doRequire_(callback);
};
 
/**
 * @param {function(RequireResult)=} callback
 * @returns {Array.<RequireResult>}
 * @private
 */
MultiRequire.prototype.doRequire_ = function(callback) {
  var files
    , modules = []
    , folderModules = []
    , includeFolderModules = this.folderModules_
    , filters = this.filters_
    , moduleFilters = this.moduleFilters_;
 
  files = glob.sync(this.pathPattern_);
 
  _.each(files, function(filePath) {
 
    var fileExt = path.extname(filePath)
      , fileName = path.basename(filePath, fileExt)
      , isDir = fs.statSync(filePath).isDirectory()
      , hasIndex = isDir && fs.existsSync(path.join(filePath, 'index.js'))
      , insideFolderModule;
 
    insideFolderModule = _.some(folderModules, function(folderModule) {
      return filePath.indexOf(folderModule.filePath) == 0;
    });
 
    // filePath is inside a folder module that was already required. Skip it.
    Iif (insideFolderModule) {
      return;
    }
 
    Eif (!isDir || (isDir && includeFolderModules && hasIndex)) {
      var module = require(filePath);
      var result = new RequireResult(module, filePath, fileName, fileExt);
 
      var filtersPass = _.every(filters, function(filter) {
        return filter.func.call(filter.context, result);
      });
 
      var moduleFiltersPass = _.every(moduleFilters, function(filter) {
        return filter.func.call(filter.context, result.module);
      });
 
      Eif (filtersPass && moduleFiltersPass) {
        modules.push(result);
 
        Iif (isDir) {
          folderModules.push(result);
        }
 
        Iif (callback) {
          callback(result);
        }
      }
    }
  });
 
  return modules;
};