Merge pull request #157 from Gillespie59/development

0.5.0

Author: EmmanuelDemey

README.md

@@ -100,7 +100,8 @@ We provide also three samples :
 | 'ng_no_services': [2, ['$http', '$resource', 'Restangular']] | Some services should be used only in a specific AngularJS service (Ajax-based service for example), in order to follow the separation of concerns paradigm. The second parameter specifies the services. The third parameter can be a list of angular objects (controller, factory, etc.). Or second parameter can be an object, where keys are angular object names and value is a list of services (like {controller: ['$http'], factory: ['$q']}) |
 | 'ng_no_service_method': 2                                    | You should prefer the factory() method instead of service() [Y040](https://github.com/johnpapa/angular-styleguide#style-y040)|
 | 'ng_on_watch': 2                                             | Watch and On methods on the scope object should be assigned to a variable, in order to be deleted in a $destroy event handler |
-| 'ng_service_name': 2                                             | All your services should have a name starting with the parameter you can define in your config object. The second parameter can be a Regexp wrapped in quotes. You can not prefix your services by "$" (reserved keyword for AngularJS services) ("ng_service_name":  [2, "ng"]) [Y125](https://github.com/johnpapa/angular-styleguide#style-y125) |
+| 'ng_rest_service': 0                                         | Check the service used to send request to your REST API. This rule can have one parameter, with tone he following value : $http, $resource or Restangular ('ng_rest_service': [0, '$http']).
+| 'ng_service_name': 2                                         | All your services should have a name starting with the parameter you can define in your config object. The second parameter can be a Regexp wrapped in quotes. You can not prefix your services by "$" (reserved keyword for AngularJS services) ("ng_service_name":  [2, "ng"]) [Y125](https://github.com/johnpapa/angular-styleguide#style-y125) |
 | 'ng_timeout_service': 2                                      | Instead of the default setTimeout function, you should use the AngularJS wrapper service $timeout [Y181](https://github.com/johnpapa/angular-styleguide#style-y181) |
 | 'ng_typecheck_array': 2                                      | You should use the angular.isArray method instead of the default JavaScript implementation (typeof [] === "[object Array]"). |
 | 'ng_typecheck_date': 2                                       | You should use the angular.isDate method instead of the default JavaScript implementation (typeof new Date() === "[object Date]"). |

index.js

@@ -30,6 +30,7 @@
                   'ng_no_services': require('./rules/ng_no_services'),
                   'ng_no_service_method': require('./rules/ng_no_service_method'),
                   'ng_on_watch': require('./rules/ng_on_watch'),
+                  'ng_rest_service': require('./rules/ng_rest_service'),
                   'ng_service_name': require('./rules/ng_service_name'),
                   'ng_timeout_service': require('./rules/ng_timeout_service'),
                   'ng_typecheck_array': require('./rules/ng_typecheck_array'),
@@ -70,6 +71,7 @@
                   'ng_no_services': [2, ['$http', '$resource', 'Restangular', '$q']],
                   'ng_no_service_method': 2,
                   'ng_on_watch': 2,
+                  'ng_rest_service': 0,
                   'ng_service_name': 0,
                   'ng_timeout_service': 2,
                   'ng_typecheck_array': 2,

rules/ng_rest_service.js

@@ -0,0 +1,47 @@
+module.exports = function(context) {
+
+    'use strict';
+
+    var utils = require('./utils/utils');
+
+    var angularObjectList = ['controller', 'filter', 'directive', 'service', 'factory', 'provider'];
+    var services = ['$http', '$resource', 'Restangular'];
+    var message = 'You should use the same service ({{method}}) for REST API calls';
+
+
+    return {
+
+        'CallExpression': function(node) {
+
+            function checkElement(element){
+                if(element.type === 'Identifier' && services.indexOf(element.name) >= 0 && context.options[0] !== element.name){
+                    context.report(node, message, {
+                        method: context.options[0]
+                    });
+                } else if(element.type === 'Literal' && services.indexOf(element.value) >= 0 && context.options[0] !== element.value){
+                    context.report(node, message, {
+                        method: context.options[0]
+                    });
+                }
+            }
+
+            function checkAllElements(elements){
+                elements.forEach(checkElement);
+            }
+
+            var callee = node.callee;
+
+            if (utils.isAngularComponent(node) && callee.type === 'MemberExpression' && angularObjectList.indexOf(callee.property.name) >= 0) {
+                if(utils.isFunctionType(node.arguments[1])){
+                    checkAllElements(node.arguments[1].params);
+                }
+
+                if(utils.isArrayType(node.arguments[1])){
+                    checkAllElements(node.arguments[1].elements);
+
+                }
+            }
+        }
+    };
+
+};

test/ng_rest_service.js

@@ -0,0 +1,54 @@
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+var eslint = require('../node_modules/eslint/lib/eslint'),
+    ESLintTester = require('eslint-tester');
+
+var angularObjectList = ['controller', 'filter', 'directive', 'service', 'factory', 'provider'];
+var possibleValues = ['$http', '$resource', 'Restangular'];
+var valid = [], invalid = [];
+
+
+angularObjectList.forEach(function(object){
+    possibleValues.forEach(function(value) {
+        valid.push({
+            code: 'app.' + object + '("name", function(Service1){});',
+            args: [1, value]
+        },{
+            code: 'app.' + object + '("name", function(Service1){});',
+            args: [1]
+        }, {
+            code: 'app.' + object + '("name", ["Service1", function(Service1){}]);',
+            args: [1, value]
+        }, {
+            code: '"use strict";app.' + object + '("name", ["Service1", function(Service1){}]);',
+            args: [1, value]
+        });
+    });
+
+    possibleValues.forEach(function(value){
+        possibleValues.filter(function(v){ return v !== value}).forEach(function(badValue){
+            invalid.push({
+                code: 'app.' + object + '("name", function(' + badValue + '){});',
+                args: [1, value],
+                errors: [{ message: 'You should use the same service (' + value + ') for REST API calls'}]
+            }, {
+                code: 'app.' + object + '("name", ["' + badValue + '", function(' + badValue + '){}]);',
+                args: [1, value],
+                errors: [{ message: 'You should use the same service (' + value + ') for REST API calls'}]
+            });
+        });
+    });
+
+});
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+var eslintTester = new ESLintTester(eslint);
+eslintTester.addRuleTest('rules/ng_rest_service', {
+    valid: valid,
+    invalid: invalid
+});