Merge pull request #44 from zxqfox/hotfix/invalid-configuration-should-throws

fixup rule configuration asserts and add tests

Author: qfox

lib/rules/validate-jsdoc/index.js

@@ -19,12 +19,12 @@ var validatorsByName = module.exports = {
 
 Object.defineProperty(validatorsByName, 'load', {
     value: function loadValidators(passedOptions) {
-        var validators = [];
-
         if (!passedOptions) {
-            return validators;
+            return [];
         }
 
+        var validators = [];
+
         Object.keys(validatorsByName).forEach(function(name) {
             var v = validatorsByName[name];
 
@@ -50,22 +50,22 @@ Object.defineProperty(validatorsByName, 'load', {
 
 Object.defineProperty(validatorsByName, 'checkOptions', {
     value: function checkOptions(validator, options) {
-        Object.keys(validator.options).forEach(function(data, option) {
+        Object.keys(validator.options).forEach(function(option) {
+            var data = validator.options[option];
             if (!data.allowedValues) {
                 return;
             }
 
-            var values;
-            if (typeof data.allowedValues === 'function') {
-                values = data.allowedValues();
+            var values = data.allowedValues;
+            if (typeof values === 'function') {
+                values = values();
             }
 
-            if (!Array.isArray(values)) {
-                throw new Error('Internal error in jsDoc validator ' + validator._name);
+            assert(Array.isArray(values), 'Internal error in jsDoc validator ' + validator._name);
 
-            } else if (values.length > 1) {
+            if (values.length > 1) {
                 assert(values.indexOf(options[option]) !== -1,
-                    'Available values for option jsDoc.' + option + ' are ' + values.map(JSON.stringify).join(', '));
+                    'Accepted values for option jsDoc.' + option + ' are ' + values.map(JSON.stringify).join(', '));
 
             } else if (values.length) {
                 assert(values[0] === options[option],

test/init.js

@@ -6,6 +6,7 @@ var expect = chai.expect;
 global.parse = parse;
 global.fnBody = fnBody;
 global.checker = rulesChecker;
+global.expect = expect;
 
 function fnBody(func) {
     var str = func.toString();

test/lib/rules/validate-jsdoc/check-param-names.js

@@ -1,9 +1,25 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/check-param-names', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('check-param-names', function () {
+    describe('configured', function() {
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkParamNames: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkParamNames: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
         checker.rules({checkParamNames: true});
 
         checker.cases([

test/lib/rules/validate-jsdoc/check-redundant-access.js

@@ -1,11 +1,27 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/check-redundant-access', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('check-redundant-access', function () {
+    describe('configured', function() {
 
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkRedundantAccess: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkRedundantAccess: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
         checker.rules({checkRedundantAccess: true});
+
         checker.cases([
             /* jshint ignore:start */
             {

test/lib/rules/validate-jsdoc/check-redundant-params.js

@@ -1,9 +1,25 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/check-redundant-params', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('check-redundant-params', function () {
+    describe('configured', function() {
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkRedundantParams: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkRedundantParams: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with this', function() {
         checker.rules({checkRedundantParams: true});
 
         checker.cases([

test/lib/rules/validate-jsdoc/check-redundant-returns.js

@@ -1,9 +1,25 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/check-redundant-returns', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('check-redundant-returns', function() {
+    describe('configured', function() {
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkRedundantReturns: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkRedundantReturns: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
         checker.rules({checkRedundantReturns: true});
 
         checker.cases([

test/lib/rules/validate-jsdoc/check-return-types.js

@@ -1,11 +1,27 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/check-return-types', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('check-return-types', function () {
+    describe('configured', function() {
 
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkReturnTypes: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkReturnTypes: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
         checker.rules({checkReturnTypes: true});
+
         checker.cases([
             /* jshint ignore:start */
             {

test/lib/rules/validate-jsdoc/check-types.js

@@ -1,11 +1,27 @@
-describe('rules/validate-jsdoc', function() {
+describe('lib/rules/validate-jsdoc/check-types', function() {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('check-types', function() {
+    describe('configured', function() {
 
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkTypes: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({checkTypes: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
         checker.rules({checkTypes: true});
+
         checker.cases([
             /* jshint ignore:start */
             {

test/lib/rules/validate-jsdoc/enforce-existence.js

@@ -1,11 +1,27 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/enforce-existence', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('enforce-existence', function () {
+    describe('configured', function() {
 
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({enforceExistence: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({enforceExistence: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('with true', function() {
         checker.rules({enforceExistence: true});
+
         checker.cases([
             /* jshint ignore:start */
             {

test/lib/rules/validate-jsdoc/leading-underscore-access.js

@@ -1,14 +1,31 @@
-describe('rules/validate-jsdoc', function () {
+describe('lib/rules/validate-jsdoc/leading-underscore-access', function () {
     var checker = global.checker({
         additionalRules: ['lib/rules/validate-jsdoc.js']
     });
 
-    describe('leading-underscore-access', function () {
+    describe('configured', function() {
+
+        it('with undefined should throws', function() {
+            global.expect(function() {
+                checker.configure({leadingUnderscoreAccess: undefined});
+            }).to.throws(/accepted value/i);
+        });
+
+        it('with object should throws', function() {
+            global.expect(function() {
+                checker.configure({leadingUnderscoreAccess: {}});
+            }).to.throws(/accepted value/i);
+        });
+
+    });
+
+    describe('common', function() {
 
         checker.cases([
             /* jshint ignore:start */
             {
                 it: 'should not throw',
+                rules: {leadingUnderscoreAccess: true},
                 code: function() {
                     function yay(yey) {
                     }