refactor($compile): detect and log bad directive 'restrict' values on directive factory init

Author: jbedard

docs/content/error/$compile/badrestrict.ngdoc

@@ -0,0 +1,12 @@
+@ngdoc error
+@name $compile:badrestrict
+@fullName Invalid Directive Restrict
+@description
+
+This error occurs when the restrict property of a directive is not valid.
+
+The directive restrict property must be a string with possible character values being:
+* E (element)
+* A (attribute)
+* C (class)
+* M (comment)

src/ng/compile.js

@@ -969,6 +969,17 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
     return require;
   }
 
+  function getDirectiveRestrict(directive, name) {
+    if (directive.restrict != null && !(isString(directive.restrict) && /[EACM]/.test(directive.restrict))) {
+      throw $compileMinErr('badrestrict',
+          "Restrict property '{0}' of directive '{1}' is invalid",
+          directive.restrict,
+          name);
+    }
+
+    return directive.restrict || 'EA';
+  }
+
   /**
    * @ngdoc method
    * @name $compileProvider#directive
@@ -989,6 +1000,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
     if (isString(name)) {
       assertValidDirectiveName(name);
       assertArg(directiveFactory, 'directiveFactory');
+
       if (!hasDirectives.hasOwnProperty(name)) {
         hasDirectives[name] = [];
         $provide.factory(name + Suffix, ['$injector', '$exceptionHandler',
@@ -1006,7 +1018,7 @@ function $CompileProvider($provide, $$sanitizeUriProvider) {
                 directive.index = index;
                 directive.name = directive.name || name;
                 directive.require = getDirectiveRequire(directive);
-                directive.restrict = directive.restrict || 'EA';
+                directive.restrict = getDirectiveRestrict(directive, name);
                 directive.$$moduleName = directiveFactory.$$moduleName;
                 directives.push(directive);
               } catch (e) {

test/ng/compileSpec.js

@@ -5558,6 +5558,42 @@ describe('$compile', function() {
     });
 
 
+    it('should throw badrestrict on first compilation when restrict is invalid', function() {
+      module(function($compileProvider, $exceptionHandlerProvider) {
+        $compileProvider.directive('invalidRestrictBadString', valueFn({restrict: '"'}));
+        $compileProvider.directive('invalidRestrictFalse', valueFn({restrict: false}));
+        $compileProvider.directive('invalidRestrictTrue', valueFn({restrict: true}));
+        $compileProvider.directive('invalidRestrictObject', valueFn({restrict: {}}));
+        $compileProvider.directive('invalidRestrictZero', valueFn({restrict: 0}));
+
+        // We need to test with the exceptionHandler not rethrowing...
+        $exceptionHandlerProvider.mode('log');
+      });
+
+      inject(function($exceptionHandler, $compile, $rootScope) {
+        $compile('<div invalid-restrict-false>')($rootScope);
+        expect($exceptionHandler.errors.length).toBe(1);
+        expect($exceptionHandler.errors[0]).toMatch(/\$compile.*badrestrict.*'false'/);
+
+        $compile('<div invalid-restrict-true>')($rootScope);
+        expect($exceptionHandler.errors.length).toBe(2);
+        expect($exceptionHandler.errors[1]).toMatch(/\$compile.*badrestrict.*'true'/);
+
+        $compile('<div invalid-restrict-bad-string>')($rootScope);
+        expect($exceptionHandler.errors.length).toBe(3);
+        expect($exceptionHandler.errors[2]).toMatch(/\$compile.*badrestrict.*'\"'/);
+
+        $compile('<div invalid-restrict-object invalid-restrict-zero>')($rootScope);
+        expect($exceptionHandler.errors.length).toBe(5);
+        expect($exceptionHandler.errors[3]).toMatch(/\$compile.*badrestrict.*'{}'/);
+        expect($exceptionHandler.errors[4]).toMatch(/\$compile.*badrestrict.*'0'/);
+
+        $compile('<div invalid-restrict-true invalid-restrict-zero>')($rootScope);
+        expect($exceptionHandler.errors.length).toBe(5);
+      });
+    });
+
+
     it('should throw noident when missing controllerAs directive property', function() {
       module(function($compileProvider) {
         $compileProvider.directive('noIdent', valueFn({