Merge branch 'develop'

atticoos · Apr 23, 2015 · 6edbc09 · 6edbc09
2 parents d042250 + b9b15d7
commit 6edbc09
Show file tree

Hide file tree

Showing 7 changed files with 127 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -58,6 +58,7 @@ Currently there are a few configurable options to control the output of your con
 - [options.constants](#options.constants)
 - [options.createModule](#options.createModule)
 - [options.wrap](#options.wrap)
+- [options.parser](#options.parser)
 
 ### <a id="options.environment"></a>options.environment
 Type: `String` Optional
@@ -165,5 +166,35 @@ define(["angular"], function () {
 .constant('..', '..');
 });
 ```
+
+### <a id="options.parser"></a>options.parser
+Type: `String` Default value: 'json' Optional
+
+By default, json file is used to generate the module. You can provide yml file to generate the module. Just set `parser` to `'yml'` or `'yaml'`. If your file type is yml and you have not defined `parser`, your file will still be parsed and js be generated correctly.
+For example, you have a `config.yml` file,
+```yml
+string: my string
+integer: 12345
+object:
+  one: 2
+  three:
+    - four
+```
+
+```javascript
+gulp.src("config.yml")
+gulpNgConfig('myApp.config', {
+  parser: 'yml'
+});
+```
+
+Generating,
+```js
+angular.module('myApp.config', [])
+.constant('string', "my string")
+.constant('integer', 12345)
+.constant('object', {"one":2,"three":["four"]});
+```
+
 ## Contributing
 Contributions, issues, suggestions, and all other remarks are welcomed. To run locally just fork &amp; clone the project and run `npm install`. Before submitting a Pull Request, make sure that your changes pass `gulp test`, and if you are introducing or changing a feature, that you add/update any tests involved.
diff --git a/gulp-ng-config.js b/gulp-ng-config.js
@@ -2,6 +2,7 @@ var through = require('through2'),
     gutil = require('gulp-util'),
     _ = require('lodash'),
     fs = require('fs'),
+    jsYaml = require('js-yaml'),
     templateFilePath = __dirname + '/template.html',
     PluginError = gutil.PluginError;
 
@@ -13,7 +14,8 @@ function gulpNgConfig (moduleName, configuration) {
   defaults = {
     createModule: true,
     wrap: false,
-    environment: null
+    environment: null,
+    parser: null
   };
 
   if (!moduleName) {
@@ -30,10 +32,28 @@ function gulpNgConfig (moduleName, configuration) {
         jsonObj,
         wrapTemplate;
 
-    try {
-      jsonObj = JSON.parse(file.contents.toString('utf8'));
-    } catch (e) {
-      this.emit('error', new PluginError(PLUGIN_NAME, 'invaild JSON file provided'));
+    if (!configuration.parser && (_.endsWith(file.path, 'yml') || _.endsWith(file.path, 'yaml'))) {
+      configuration.parser = 'yml';
+    }
+
+    if (!configuration.parser) {
+      configuration.parser = 'json';
+    }
+
+    if (configuration.parser === 'json') {
+      try {
+        jsonObj = file.isNull() ? {} : JSON.parse(file.contents.toString('utf8'));
+      } catch (e) {
+        this.emit('error', new PluginError(PLUGIN_NAME, 'invaild JSON file provided'));
+      }
+    } else if (configuration.parser === 'yml' || configuration.parser === 'yaml') {
+      try {
+        jsonObj = jsYaml.safeLoad(file.contents);
+      } catch (e) {
+        this.emit('error', new PluginError(PLUGIN_NAME, 'invaild YML file provided'));
+      }
+    } else {
+      this.emit('error', new PluginError(PLUGIN_NAME, configuration.parser + ' is not supported as a valid parser'));
     }
 
     if (!_.isPlainObject(jsonObj)) {

diff --git a/package.json b/package.json
@@ -30,7 +30,8 @@
   "dependencies": {
     "gulp-util": "^3.0.0",
     "lodash": "^3.0.1",
-    "through2": "^1.1.1"
+    "through2": "^1.1.1",
+    "js-yaml": "3.2.7"
   },
   "devDependencies": {
     "chai": "^1.9.1",

diff --git a/test/mocks/input_1.yml b/test/mocks/input_1.yml
@@ -0,0 +1 @@
+one: two
diff --git a/test/mocks/input_2.yaml b/test/mocks/input_2.yaml
@@ -0,0 +1,2 @@
+one:
+  two: three
diff --git a/test/mocks/input_2.yml b/test/mocks/input_2.yml
@@ -0,0 +1,2 @@
+one:
+  two: three
diff --git a/test/stream.js b/test/stream.js
@@ -82,23 +82,71 @@ describe('gulp-ng-config', function () {
   });
 
   describe('config generation', function () {
-    it ('should generate the angular template with scalar properties', function (done) {
-      var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_1.js'));
-      gulp.src(path.normalize(__dirname + '/mocks/input_1.json'))
-      .pipe(plugin('gulp-ng-config'))
-      .pipe(through.obj(function (file) {
-        expect(file.contents.toString()).to.equal(expectedOutput.toString());
-        done();
-      }));
+    describe('json', function () {
+      it ('should generate the angular template with scalar properties', function (done) {
+        var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_1.js'));
+        gulp.src(path.normalize(__dirname + '/mocks/input_1.json'))
+        .pipe(plugin('gulp-ng-config'))
+        .pipe(through.obj(function (file) {
+          expect(file.contents.toString()).to.equal(expectedOutput.toString());
+          done();
+        }));
+      });
+      it ('should generate the angular template with object properties', function (done) {
+        var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_2.js'));
+        gulp.src(path.normalize(__dirname + '/mocks/input_2.json'))
+        .pipe(plugin('gulp-ng-config'))
+        .pipe(through.obj(function (file) {
+          expect(file.contents.toString()).to.equal(expectedOutput.toString());
+          done();
+        }));
+      });
     });
-    it ('should generate the angular template with object properties', function (done) {
-      var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_2.js'));
-      gulp.src(path.normalize(__dirname + '/mocks/input_2.json'))
-      .pipe(plugin('gulp-ng-config'))
-      .pipe(through.obj(function (file) {
-        expect(file.contents.toString()).to.equal(expectedOutput.toString());
-        done();
-      }));
+    describe('yml', function () {
+      it ('should generate the angular template with scalar properties', function (done) {
+        var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_1.js'));
+        gulp.src(path.normalize(__dirname + '/mocks/input_1.yml'))
+        .pipe(plugin('gulp-ng-config', {
+          parser: 'yml'
+        }))
+        .pipe(through.obj(function (file) {
+          expect(file.contents.toString()).to.equal(expectedOutput.toString());
+          done();
+        }));
+      });
+      it ('should generate the angular template with object properties', function (done) {
+        var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_2.js'));
+        gulp.src(path.normalize(__dirname + '/mocks/input_2.yml'))
+        .pipe(plugin('gulp-ng-config', {
+          parser: 'yml'
+        }))
+        .pipe(through.obj(function (file) {
+          expect(file.contents.toString()).to.equal(expectedOutput.toString());
+          done();
+        }));
+      });
+      it ('should generate the angular template with object properties with no parser', function (done) {
+        var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_2.js'));
+        gulp.src(path.normalize(__dirname + '/mocks/input_2.yml'))
+        .pipe(plugin('gulp-ng-config'))
+        .pipe(through.obj(function (file) {
+          expect(file.contents.toString()).to.equal(expectedOutput.toString());
+          done();
+        }));
+      });
+    });
+    describe('yaml', function () {
+      it ('should generate the angular template with object properties', function (done) {
+        var expectedOutput = fs.readFileSync(path.normalize(__dirname + '/mocks/output_2.js'));
+        gulp.src(path.normalize(__dirname + '/mocks/input_2.yaml'))
+        .pipe(plugin('gulp-ng-config', {
+          parser: 'yaml'
+        }))
+        .pipe(through.obj(function (file) {
+          expect(file.contents.toString()).to.equal(expectedOutput.toString());
+          done();
+        }));
+      });
     });
   });
   describe('plugin options', function () {