Return $delegate on decoration and add readme examples

Author: DAB0mB

README.md

@@ -92,13 +92,14 @@ Used to define a new [service](https://docs.angularjs.org/guide/services).
 import { Service } from 'angular-ecmascript/module-helpers';
 
 class DateService extends Service {
-  $name = '$date'
+  static $name = '$date'
 
   now() {
     return new Date().getTime();
   }
 }
 ```
+
 ### Factory
 
 Used to define a new `factory`.
@@ -109,7 +110,7 @@ Used to define a new `factory`.
 import { Factory } from 'angular-ecmascript/module-helpers';
 
 class MomentFactory extends Factory {
-  $name = 'now'
+  static $name = 'now'
 
   create() {
     return new Date().getTime();
@@ -166,6 +167,7 @@ Used to define a new [decorator](https://docs.angularjs.org/guide/decorators).
 
 - `$delegate` will be injected automatically so no need to specify it.
 - Note that the `decorate` method must be implemented, otherwise an error will be thrown during load time.
+- No need to return the `$delegate` object, it should be handled automatically.
 
 ```js
 import { Decorator } from 'angular-ecmascript/module-helpers';
@@ -179,7 +181,6 @@ class MyDecorator extends Decorator {
 
   decorate() {
     this.$delegate.aHelpfulAddition = this.helperFn;
-    return this.$delegate;
   }
 }
 ```
@@ -217,12 +218,58 @@ Used to define a new `config`.
 
 - Note that the `configure` method must be implemented, otherwise an error will be thrown during load time.
 
+```js
+import { Config } from 'angular-ecmascript/module-helpers';
+
+class RoutesCfg extends Config {
+  static $inject = ['$routeProvider']
+
+  constructor(...args) {
+    super(...args);
+
+    this.fetchUser = ['http', this::this.fetchUser];
+  }
+
+  configure() {
+    this.$routeProvider
+      .when('/', {
+        template: '<home user="$resolve.user"></home>',
+        resolve: {
+          user: this.fetchUser
+        }
+      });
+  }
+
+  fetchUser($http) {
+    return $http.get('...');
+  }
+}
+```
+
 ### Runner
 
 Used to define a new `run block`.
 
 - Note that the `run` method must be implemented, otherwise an error will be thrown during load time.
 
+```js
+import { Runner } from 'angular-meteor/module-helpers';
+
+class RoutesRunner extends Runner {
+  static $inject = ['$rootScope', '$state']
+
+  run() {
+    this.$rootScope.$on('$stateChangeError', (...args) => {
+      const [,,, err] = args;
+
+      if (err === 'AUTH_REQUIRED') {
+        this.$state.go('login');
+      }
+    });
+  }
+}
+```
+
 ## Download
 
 The source is available for download from [GitHub](http://github.com/DAB0mB/angular-ecmascript). Alternatively, you can install using Node Package Manager (`npm`):

src/module-loader.js

@@ -67,7 +67,7 @@ export default class Loader {
   }
 
   loadDirective(Directive) {
-    function helper(...args) {
+    const helper = (...args) => {
       return new Directive(...args);
     }
 
@@ -76,12 +76,18 @@ export default class Loader {
   }
 
   loadDecorator(Decorator) {
-    function helper(...args) {
-      const decorator = new Decorator(...args);
-      return decorator::decorator.decorate;
+    let decorator;
+    const $inject = Decorator.$inject;
+
+    const helper = (...args) => {
+      decorator = new Decorator(...args);
+      return decorate;
     }
 
-    const $inject = Decorator.$inject;
+    const decorate = (...args) => {
+      decorator.decorate(...args);
+      return decorator.$delegate;
+    }
 
     if (!Utils.hasValue($inject, '$delegate')) {
       $inject.unshift('$delegate');
@@ -91,7 +97,7 @@ export default class Loader {
   }
 
   loadFactory(Factory) {
-    function helper(...args) {
+    const helper = (...args) => {
       const factory = new Factory(...args);
       return factory::factory.create;
     }
@@ -101,7 +107,7 @@ export default class Loader {
   }
 
   loadFilter(Filter) {
-    function helper(...args) {
+    const helper = (...args) => {
       const filter = new Filter(...args);
       return filter::filter.filter;
     }
@@ -111,7 +117,7 @@ export default class Loader {
   }
 
   loadConfig(Config) {
-    function helper(...args) {
+    const helper = (...args) => {
       const config = new Config(...args);
       return config.configure();
     }
@@ -121,7 +127,7 @@ export default class Loader {
   }
 
   loadRunner(Runner) {
-    function helper(...args) {
+    const helper = (...args) => {
       const runner = new Runner(...args);
       return runner.run();
     }

test/src/specs/module-helpers/decorator.spec.js

@@ -7,7 +7,6 @@ describe('Decorator', function() {
 
   it('should load a decorator helper', function() {
     const $delegate = {};
-    const expectedResult = {};
     const ctorSpy = jasmine.createSpy('ctor');
     const methodSpy = jasmine.createSpy('method');
 
@@ -21,7 +20,6 @@ describe('Decorator', function() {
 
       decorate(...args) {
         this::methodSpy(...args);
-        return expectedResult;
       }
     }
 
@@ -40,12 +38,11 @@ describe('Decorator', function() {
     expect(expectedDecorator).toEqual(jasmine.any(Decorator));
     expect(decorator).toEqual(expectedDecorator);
     expect(decorator.$delegate).toEqual($delegate);
-    expect(result).toEqual(expectedResult);
+    expect(result).toEqual($delegate);
   });
 
   it('should load a decorator with a custom name', function() {
     const $delegate = {};
-    const expectedResult = {};
     const ctorSpy = jasmine.createSpy('ctor');
     const methodSpy = jasmine.createSpy('method');
 
@@ -60,7 +57,6 @@ describe('Decorator', function() {
 
       decorate(...args) {
         this::methodSpy(...args);
-        return expectedResult;
       }
     }
 
@@ -78,14 +74,12 @@ describe('Decorator', function() {
 
     expect(expectedDecorator).toEqual(jasmine.any(TestDecorator));
     expect(decorator).toEqual(expectedDecorator);
-    expect(decorator.$delegate).toEqual($delegate);
-    expect(result).toEqual(expectedResult);
+    expect(result).toEqual($delegate);
   });
 
   it('should inject a `$delegate` dependency by default', function() {
     const $delegate = {};
     const $dep = {};
-    const expectedResult = {};
     const ctorSpy = jasmine.createSpy('ctor');
     const methodSpy = jasmine.createSpy('method');
 
@@ -99,7 +93,6 @@ describe('Decorator', function() {
 
       decorate(...args) {
         this::methodSpy(...args);
-        return expectedResult;
       }
     }
 
@@ -119,6 +112,6 @@ describe('Decorator', function() {
     expect(expectedDecorator).toEqual(jasmine.any(TestDecorator));
     expect(decorator).toEqual(expectedDecorator);
     expect(decorator.$dep).toEqual($dep);
-    expect(result).toEqual(expectedResult);
+    expect(result).toEqual($delegate);
   });
 });