Merge pull request #2 from kenjones-cisco/task/basic-project

chore(project): Project files and testing

.editorconfig

@@ -0,0 +1,19 @@
+# .editorconfig
+# More info: editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[package.json]
+# package.json adhere to --save-dev manipulation styles
+indent_style = space
+indent_size = 2

.jshintrc

@@ -1,5 +1,9 @@
 {
   "node": true,
-  "jasmine": true
+  "jasmine": true,
+  "eqeqeq":    true,
+  "strict":    true,
+  "undef":     true,
+  "unused":    true
 }
 

.travis.yml

@@ -3,17 +3,16 @@ language: node_js
 node_js:
   - 0.10
   - 0.12
+  - 4.1
 
 sudo: false
 
 env:
   global:
     - NODE_ENV=test
 
-before_script:
-  - export PATH=$PATH:$PWD/node_modules/.bin
-
-script: npm run cover
-
-after_success: ./tasks/travis_after_success.sh
+script:
+  - npm run cover
 
+after_script:
+  - npm run coveralls

gulpfile.js

@@ -0,0 +1,46 @@
+'use strict';
+
+var gulp = require('gulp');
+var coveralls = require('gulp-coveralls');
+var istanbul = require('gulp-istanbul');
+var jasmine = require('gulp-jasmine');
+var jshint = require('gulp-jshint');
+var docs = require('./tasks');
+
+var SOURCE_CODE = ['index.js', 'lib/*.js'];
+var TEST_CODE = ['test/*.js'];
+
+gulp.task('lint', function() {
+  return gulp.src(SOURCE_CODE.concat(TEST_CODE))
+    .pipe(jshint())
+    .pipe(jshint.reporter('default'));
+});
+
+gulp.task('pre-test', function () {
+    return gulp.src(SOURCE_CODE)
+        // Covering files
+        .pipe(istanbul())
+        // Force `require` to return covered files
+        .pipe(istanbul.hookRequire());
+});
+
+gulp.task('test', ['lint'], function () {
+    return gulp.src(TEST_CODE)
+        .pipe(jasmine());
+});
+
+gulp.task('cover', ['lint', 'pre-test'], function () {
+    return gulp.src(TEST_CODE)
+        .pipe(jasmine())
+        // Creating the reports after tests ran
+        .pipe(istanbul.writeReports());
+});
+
+gulp.task('coveralls', function () {
+    return gulp.src('coverage/lcov.info')
+        .pipe(coveralls());
+});
+
+gulp.task('docs', function () {
+    docs(SOURCE_CODE);
+});

index.js

@@ -1,8 +1,5 @@
 'use strict';
 
-var fs = require('fs'),
-    path = require('path');
-
 var transforms = require('./lib/transforms');
 
 /**

lib/transforms.js

@@ -1,9 +1,8 @@
 'use strict';
 
 var fs = require('fs'),
-    path = require('path'),
-    assign = require('object-assign'),
-    deprecate = require('util').deprecate;
+  assign = require('object-assign'),
+  deprecate = require('util').deprecate;
 
 var transforms = module.exports;
 
@@ -43,8 +42,7 @@ transforms.loadJSON = function (files) {
 
     try {
       return assign(config, JSON.parse(fs.readFileSync(result)));
-    }
-    catch (e) {
+    } catch (e) {
       throw e;
     }
   };
@@ -72,11 +70,10 @@ transforms.loadEnvironment = function (map, opts) {
 
   function translate(val) {
     if (opts && opts.resolveBooleans) {
-      if (val === 'true') {
-        return true;
-      }
-      else if (val === 'false') {
-        return false;
+      try {
+        return JSON.parse(val);
+      } catch (e) {
+        return val;
       }
     }
     return val;
@@ -93,10 +90,9 @@ transforms.loadEnvironment = function (map, opts) {
   };
 };
 
-transforms.mapEnvironment = function (map) {
-  deprecate('mapEnvironment is deprecated; please use loadEnvironment instead');
+transforms.mapEnvironment = deprecate(function (map) { // jshint ignore:line
   return transforms.loadEnvironment.apply(this, arguments);
-};
+}, 'mapEnvironment is deprecated; please use loadEnvironment instead');
 
 /**
  * Merge an object with the existing config, replacing any existing keys with
@@ -113,7 +109,7 @@ transforms.mapEnvironment = function (map) {
  * @param {Object} obj2... - additional objects to merge into the config
  * @return Function
  */
-transforms.assign = function (obj) {
+transforms.assign = function (obj) { // jshint ignore:line
 
   var objects = [].concat([].slice.call(arguments));
 
@@ -192,4 +188,3 @@ transforms.freeze = function () {
     return config;
   };
 };
-

package.json

@@ -3,11 +3,16 @@
   "version": "0.0.9",
   "description": "fabulous configuration!",
   "main": "index.js",
+  "files": [
+    "index.js",
+    "lib"
+  ],
   "scripts": {
-    "pretest": "jshint .",
-    "test": "NODE_ENV=test jasmine-node test/",
-    "cover": "./tasks/coverage.sh",
-    "docs": "node -e 'require(\"./tasks\").docs([\"index.js\",\"lib/*.js\"])'"
+    "lint": "gulp lint",
+    "test": "gulp test",
+    "cover": "gulp cover",
+    "coveralls": "gulp coveralls",
+    "docs": "gulp docs"
   },
   "repository": {
     "type": "git",
@@ -30,10 +35,14 @@
   "devDependencies": {
     "coveralls": "~2.11.1",
     "glob": "~4.0.0",
+    "gulp": "^3.9.0",
+    "gulp-coveralls": "^0.1.4",
+    "gulp-istanbul": "^0.10.3",
+    "gulp-jasmine": "^2.1.0",
+    "gulp-jshint": "^2.0.0",
     "hogan.js": "~2.0.0",
-    "istanbul": "~0.3.0",
-    "jasmine-node": "^1.14.5",
-    "jshint": "~2.5.2",
+    "jshint": "~2.8.0",
+    "lodash": "^3.10.0",
     "scrawl": "~0.0.5"
   }
 }

tasks/index.js

@@ -1,19 +1,18 @@
 var path = require('path'),
-    fs = require('fs');
+  fs = require('fs');
 
-function fatalOr (orElse) {
+function fatalOr(orElse) {
   return function (err, result) {
     if (err) {
       process.stderr.write(err.toString() + '\n');
       process.exit(1);
-    }
-    else {
+    } else {
       orElse.apply(this, [].slice.call(arguments, 1));
     }
   };
 }
 
-function indexBy (arr, key) {
+function indexBy(arr, key) {
   var indexed = {};
 
   arr.forEach(function (item) {
@@ -29,15 +28,15 @@ function indexBy (arr, key) {
 //
 //    $ npm run-script docs
 //
-module.exports.docs = function (patterns) {
+module.exports = function (patterns) {
 
-  function transformComment (file, comment) {
+  function transformComment(file, comment) {
     if (!comment.group) comment.group = packageJson.name;
     comment.file = path.relative(path.resolve(__dirname, '..'), file);
     return comment;
   }
 
-  function transformFiles (files) {
+  function transformFiles(files) {
     var indexedMethods = indexBy(files, 'group');
     return Object.keys(indexedMethods).map(function (group) {
       return {
@@ -48,11 +47,11 @@ module.exports.docs = function (patterns) {
   }
 
   var glob = require('glob'),
-      hogan = require('hogan.js'),
-      scrawl = require('scrawl');
+    hogan = require('hogan.js'),
+    scrawl = require('scrawl');
 
   var packageJson = require(path.resolve(__dirname, '../package.json')),
-      templateFiles = glob.sync(path.resolve(__dirname, './*.hogan'));
+    templateFiles = glob.sync(path.resolve(__dirname, './*.hogan'));
 
   var files = patterns.reduce(function (memo, pattern) {
     var srcFiles = glob.sync(path.resolve(__dirname, '..', pattern));
@@ -70,11 +69,11 @@ module.exports.docs = function (patterns) {
   }, {});
 
   var tmpl = templates.template.render({
-    groups      : transformFiles(files),
-    repository  : packageJson.repository.url,
-    name        : packageJson.name,
-    license     : packageJson.license,
-    description : packageJson.description
+    groups: transformFiles(files),
+    repository: packageJson.repository.url,
+    name: packageJson.name,
+    license: packageJson.license,
+    description: packageJson.description
   }, templates);
 
   if (!fs.existsSync('./docs')) {
@@ -86,4 +85,3 @@ module.exports.docs = function (patterns) {
 
   fs.writeFileSync('./docs/index.html', tmpl);
 };
-