revised webstorm file templates

Author: benholloway

tasks/webstorm.js

@@ -212,15 +212,31 @@ gulp.task('webstorm:project', function () {
 gulp.task('webstorm:templates', function () {
   var srcDirectory  = path.join(TEMPLATE_PATH, 'fileTemplates');
   var destDirectory = path.join(userPreferencesDirectory(), 'fileTemplates');
+  var removed       = [ ];
+  var added         = [ ];
+  fs.readdirSync(destDirectory)
+    .forEach(function eachTemplate(filename) {
+      if (/^angularity/.test(path.basename(filename))) {
+        removed.push(filename);
+        fs.unlinkSync(path.join(destDirectory, filename));
+      }
+    });
   fs.readdirSync(srcDirectory)
     .forEach(function eachTemplate(filename) {
       var srcPath  = path.join(srcDirectory, filename);
       var destPath = path.join(destDirectory, filename);
-      if (!fs.existsSync(destPath)) {
-        gutil.log('wrote template ' + filename);
-        fs.writeFileSync(destPath, fs.readFileSync(srcPath))
+      added.push(filename);
+      fs.writeFileSync(destPath, fs.readFileSync(srcPath))
+    });
+  removed.forEach(function (filename) {
+      var isRemove = (added.indexOf(filename) < 0);
+      if (isRemove) {
+        gutil.log('removed template ' + filename);
       }
     });
+  added.forEach(function (filename) {
+      gutil.log('wrote template ' + filename);
+    });
 // TODO review with @impaler
 //  ideTemplate.webStorm.copyFileTemplates(fileTemplatePath);
 });

templates/webstorm/fileTemplates/angularity-controller-spec.js

@@ -0,0 +1,34 @@
+/* globals module, describe, beforeEach, inject, it, expect, spyOn */
+
+var $declaration_to_test = require('./$file_that_exports_declaration');
+
+describe('@', function() {
+
+  // variables
+  var scope;
+  /* TODO additional variables for each mock */
+
+  // definition
+  angular.module('@', [ ])
+    .controller('$declaration_to_test', $declaration_to_test);
+
+  // our temporary module
+  beforeEach(angular.mock.module('@'));
+
+  // mocks
+  beforeEach(function() {
+    /* TODO create mocks and assign them to variables */
+  });
+
+  // create the scope
+  beforeEach(inject(function (${DS}rootScope, ${DS}controller /* TODO injectables.. */) {
+    scope = ${DS}rootScope.${DS}new();
+    ${DS}controller('$declaration_to_test', {
+      '${DS}scope': scope
+      /* TODO map mock objects here */
+    });
+  }));
+
+  /* TODO jasmine description */
+
+});

templates/webstorm/fileTemplates/angularity-controller.js

@@ -0,0 +1,21 @@
+/**
+ * TODO description of this controller
+ * @ngInject
+ */
+function $declaration(${DS}scope /*, TODO injectables.. */) {
+
+  // initialisation
+  var somePrivateVar = 'delete-me';
+
+  // composition
+  ${DS}scope.somePublicVar = 'delete-me';
+  ${DS}scope.someMethod    = someHoistedMethod;
+
+  /**
+   * TODO description of this method per JSDoc
+   */
+  function someHoistedMethod() {
+  }
+}
+
+module.exports = $declaration;

templates/webstorm/fileTemplates/angularity-directive-spec.js

@@ -0,0 +1,35 @@
+/* globals module, describe, beforeEach, inject, it, expect, spyOn */
+
+var $declaration_to_test = require('./$file_that_exports_declaration');
+
+describe('@', function() {
+
+  // variables
+  var scope;
+  /* TODO additional variables for each mock */
+
+  // definition
+  angular.module('@', [ ])
+    .directive('$declaration_to_test', $declaration_to_test);
+
+  // our temporary module
+  beforeEach(angular.mock.module('@'));
+
+  // mocks
+  beforeEach(function() {
+    /* TODO create mocks and assign them to variables */
+  });
+
+  // create the scope
+  beforeEach(inject(function (${DS}rootScope/*, TODO injectables.. */) {
+    scope = ${DS}rootScope.${DS}new();
+    /* TODO mock (contoller) methods on the scope using spies */
+  }));
+
+  beforeEach(inject(function(${DS}compile) {
+    ${DS}compile(/* TODO html string goes here */)(scope);
+  }));
+
+  /* TODO jasmine description */
+
+});

templates/webstorm/fileTemplates/angularity-directive.js

@@ -0,0 +1,42 @@
+/**
+ * TODO description of this Directive
+ * @ngInject
+ */
+function $declaration(/* TODO injectables.. */) {
+  return {
+    scope      : {
+      /* TODO define isolated scope */
+      foo: '@foo',  /* initialise from attribute    */
+      bar: '&bar',  /* 1 way binding with attribute */
+      baz: '=baz'   /* 2 way binding with attribute */
+    },
+    restrict   : 'ACE',
+    replace    : true,
+    transclude : false,
+    template   : require('./${NAME}.html'),
+    templateUrl: undefined,
+    require    : undefined,
+    link       : link,
+    controller : controller /* TODO set undefined if API is not required */
+  };
+}
+
+/**
+ * The link function for the directive
+ * @param {object} ${DS}element the DOM element
+ * @param {object} ${DS}attributes attributes from the element
+ * @param {object} ${DS}scope the directive scope
+ */
+function link(${DS}element, ${DS}attributes, ${DS}scope /*, TODO required controllers.. */) {
+  /* TODO implement directive here, controller is only for API (where needed) */
+}
+
+/**
+ * The external API of the directive
+ * @ngInject
+ */
+function controller(/* TODO injectables.. */) {
+  /* TODO implement API only, delete if unused */
+}
+
+module.exports = $declaration;