refactor: rename and reorganize modules

Author: btford

hint.js

@@ -1,20 +1,20 @@
 'use strict';
 
 // Create pipe for all hint messages from different modules
-require('./lib/modules/log');
+require('./src/modules/log');
 
 // Load angular hint modules
-require('./lib/modules/controllers');
-// require('./lib/modules/directives');
-// require('./lib/modules/dom');
-// require('./lib/modules/events');
-// require('./lib/modules/interpolation');
-// require('./lib/modules/modules');
-require('./lib/modules/scopes');
+require('./src/modules/controllers');
+// require('./src/modules/directives');
+// require('./src/modules/dom');
+// require('./src/modules/events');
+// require('./src/modules/interpolation');
+require('./src/modules/modules');
+require('./src/modules/scopes');
 
 // List of all possible modules
 // The default ng-hint behavior loads all modules
-var allModules = [
+var AVAILABLE_MODULES = [
   'ngHintControllers',
 // 'ngHintDirectives',
 //  'ngHintDom',
@@ -71,7 +71,7 @@ function loadModules() {
   } else if (elt = document.querySelector('[ng-hint-exclude]')) {
     modules = excludeModules(hintModulesFromElement(elt));
   } else if (document.querySelector('[ng-hint]')) {
-    modules = allModules;
+    modules = AVAILABLE_MODULES;
   } else {
     angular.hint.log('General', 'ngHint is included on the page, but is not active because ' +
       'there is no `ng-hint` attribute present', SEVERITY_WARNING);
@@ -80,7 +80,7 @@ function loadModules() {
 }
 
 function excludeModules(modulesToExclude) {
-  return allModules.filter(function(module) {
+  return AVAILABLE_MODULES.filter(function(module) {
     return modulesToExclude.indexOf(module) === -1;
   });
 }
@@ -90,7 +90,7 @@ function hintModulesFromElement (elt) {
     elt.attributes['ng-hint-exclude']).value.split(' ');
 
   return selectedModules.map(hintModuleName).filter(function (name) {
-    return (allModules.indexOf(name) > -1) ||
+    return (AVAILABLE_MODULES.indexOf(name) > -1) ||
       angular.hint.log('General', 'Module ' + name + ' could not be found', SEVERITY_WARNING);
   });
 }

karma.conf.js

@@ -4,16 +4,16 @@ var sauceConfig = require('./config/karma.sauce.conf');
 var travisConfig = require('./config/karma.travis.conf');
 //var fs = require('fs');
 
-//fs.readdirSync(__dirname + '/lib/modules').filter
+//fs.readdirSync(__dirname + '/src/modules').filter
 
 module.exports = function(config) {
   var options = {
     frameworks: ['browserify', 'jasmine'],
     files: [
       'node_modules/angular/angular.js',
       'node_modules/angular-mocks/angular-mocks.js',
-      'lib/modules/log.js',
-      'lib/modules/*.js'
+      'src/modules/log.js',
+      'src/modules/*.js'
     ],
     preprocessors: {
       'lib/modules/controllers.js': ['browserify'],

lib/addSuggestions.js renamed to src/lib/addSuggestions.js

@@ -1,11 +1,11 @@
 'use strict';
 
 /**
-* Load necessary functions from /lib into variables.
+* Load necessary functions from /src into variables.
 */
-var EVENT_NAMES = require('../event-directives');
+var EVENT_NAMES = require('../lib/event-directives');
 
-var provider = require('../debug-parse');
+var provider = require('../lib/debug-parse');
 var err = null;
 provider.onUndefined(function (text) {
   if (!err) {

lib/consts.js renamed to src/lib/consts.js

@@ -0,0 +1,39 @@
+'use strict';
+
+var getModule = require('./src/getModule'),
+    start = require('./src/start'),
+    storeNgAppAndView = require('./src/storeNgAppAndView'),
+    storeUsedModules = require('./src/storeUsedModules'),
+    hasNameSpace = require('./src/hasNameSpace'),
+    modData = require('./src/moduleData');
+
+var doc = Array.prototype.slice.call(document.getElementsByTagName('*')),
+    originalAngularModule = angular.module,
+    modules = {};
+
+storeNgAppAndView(doc);
+
+angular.module = function(name, requiresOriginal) {
+  var module = originalAngularModule.apply(this, arguments),
+      name = module.name;
+
+  module.requiresOriginal = requiresOriginal;
+  modules[name] = module;
+  hasNameSpace(module);
+  var modToCheck = getModule(name, true);
+
+  if(modToCheck && modToCheck.requiresOriginal !== module.requiresOriginal) {
+    if(!modData.createdMulti[name]) {
+      modData.createdMulti[name] = [getModule(name,true)];
+    }
+    modData.createdMulti[name].push(module);
+  }
+  modData.createdModules[name] = module;
+  return module;
+};
+
+angular.module('ngHintModules', []).config(function() {
+  var ngAppMod = modules[modData.ngAppMod];
+  storeUsedModules(ngAppMod, modules);
+  start();
+});

lib/debug-parse.js renamed to src/lib/debug-parse.js

@@ -0,0 +1,102 @@
+var hintLog = angular.hint;
+var start = require('./src/start');
+var modData = require('./src/moduleData');
+
+describe('hintModules', function() {
+  beforeEach(function() {
+    modData.createdModules = {
+      'createdAndNotLoaded': {name:'createdAndNotLoaded', requires: []},
+      'testModule': {name:'testModule', requires: []}
+    };
+    modData.loadedModules = {
+      'doesntExist': 'doesntExist',
+      'testModule': 'testModule'
+    };
+    modData.createdMulti = {
+      'testModule': ['testModule']
+    };
+  });
+
+  afterEach(function() {
+    hintLog.flush();
+  });
+
+  it('should identify modules created and not loaded', function() {
+    angular.module('createdAndNotLoaded', []);
+    start();
+    expect(hintLog.flush().Modules.warning[0]).toBe('Module "createdAndNotLoaded" was' +
+      ' created but never loaded.');
+  });
+
+
+  it('should identify modules loaded that do not exist', function() {
+    angular.module('testModule', ['doesntExist']);
+    start();
+    var log = hintLog.flush();
+    expect(log.Modules.error[0]).toBe('Module "doesntExist" was loaded but' +
+      ' does not exist.');
+  });
+
+
+  it('should identify modules that have been loaded multiple times', function() {
+    angular.module('testModule', []);
+    start();
+    expect(hintLog.flush().Modules.warning[1]).toBe('Multiple modules with name ' +
+      '"testModule" are being created and they will overwrite each other.');
+  });
+
+
+  it('should identify modules that have been loaded twice', function() {
+    angular.module('moduleDuplicate', []);
+    angular.module('moduleDuplicate', []);
+    start();
+    expect(hintLog.flush().Modules.warning[3]).toBe('Multiple modules with name ' +
+      '"moduleDuplicate" are being created and they will overwrite each other.');
+  });
+
+
+  it('should ignore modules loaded twice if one is just being called', function() {
+    angular.module('testModule2', []);
+    angular.module('testModule2').controller('controller', [function(){}]);
+    start();
+    var log = hintLog.flush().Modules;
+    var duplicateMessages = log.warning;
+    expect(duplicateMessages).not.toContain('Multiple modules with name "testModule2" are being ' +
+      'created and they will overwrite each other.');
+  });
+
+
+  it('should warn if modules are not named with lowerCamelCase or dotted.segments', function() {
+    angular.module('testmodule', []);
+    start();
+    var log = hintLog.flush();
+    expect(log.Modules.suggestion[0]).toBe('The best practice for' +
+      ' module names is to use lowerCamelCase or dotted.segments. Check the name of "testmodule".');
+
+    angular.module('Testmodule', []);
+    expect(hintLog.flush().Modules.suggestion[0]).toBe('The best practice for' +
+      ' module names is to use lowerCamelCase or dotted.segments. Check the name of "Testmodule".');
+  });
+});
+
+describe('hintModules integration', function() {
+  it('should not warn about itself or other ngHintModules', function() {
+
+    // what is this i dont even
+    modData.createdModules = {};
+    modData.loadedModules = {};
+    modData.createdMulti = {};
+
+    angular.module('ngHintControllers', []);
+    angular.module('ngHintDirectives', []);
+    angular.module('ngHintDom', []);
+    angular.module('ngHintEvents', []);
+    angular.module('ngHintInterpolation', []);
+    angular.module('ngHintScopes', []);
+    angular.module('ng', []);
+    angular.module('ngLocale', []);
+
+    start();
+    expect(hintLog.flush()['Modules']).not.toBeDefined();
+  });
+});

lib/event-directives.js renamed to src/lib/event-directives.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var summarize = require('../summarize-model');
+var summarize = require('../lib/summarize-model');
 var debounceOn = require('debounce-on');
 
 var hint = angular.hint;