Added tests.

neogeek · neogeek · commit 9cd9b118cbc1 · 2016-12-19T10:00:00.000-05:00
diff --git a/.eslintrc b/.eslintrc
@@ -3,6 +3,7 @@
     "@neogeek/eslint-config-standards"
   ],
   "rules": {
-    "no-invalid-this": 0
+    "no-invalid-this": 0,
+    "sort-keys": 0
   }
 }
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 node_modules/
+
+temp/
diff --git a/.npmignore b/.npmignore
@@ -1,3 +1,11 @@
+test/
+
+temp/
+
 .eslintrc
 
+.travis.yml
+
+Gruntfile.js
+
 Makefile
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,9 @@
+language: node_js
+node_js:
+  - "4"
+  - "5"
+  - "6"
+  - "7"
+before_install:
+  - if [[ `npm -v` != 3* ]]; then npm i -g npm@3; fi
+sudo: false
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -0,0 +1,37 @@
+module.exports = grunt => {
+
+    grunt.loadNpmTasks('grunt-mkdir');
+    grunt.loadNpmTasks('grunt-mocha-test');
+
+    grunt.loadTasks('tasks');
+
+    grunt.initConfig({
+        'doxdox': {
+            'custom template': {
+                'inputs': ['test/fixtures/plugin.js'],
+                'output': 'temp/plugin.md',
+                'config': {
+                    'title': 'Sample Title',
+                    'description': 'Lorem ipsum dolor sit amet, consectetur adipisicing elit',
+                    'layout': 'test/fixtures/template.hbs',
+                    'packageFile': 'test/fixtures/package.json'
+                }
+            }
+        },
+        'mkdir': {
+            'all': {
+                'options': {
+                    'create': ['temp']
+                }
+            }
+        },
+        'mochaTest': {
+            'doxdox': {
+                'src': ['test/specs/**/*.js']
+            }
+        }
+    });
+
+    grunt.registerTask('test', ['mkdir', 'doxdox', 'mochaTest']);
+
+};
diff --git a/Makefile b/Makefile
@@ -2,6 +2,14 @@ BIN=node_modules/.bin
 
 test:
 	make lint
+	$(BIN)/grunt test
+	@make clean
 
 lint:
 	$(BIN)/eslint tasks/doxdox.js
+	$(BIN)/eslint test/specs/
+
+clean:
+	@rm -rf temp/ || exit 0;
+
+.PHONY: test
diff --git a/README.md b/README.md
@@ -48,7 +48,8 @@ module.exports = function (grunt) {
                 'config': {
                     'title': 'Sample Title',
                     'description': 'Lorem ipsum dolor sit amet, consectetur adipisicing elit',
-                    'layout': 'docs/template.hbs'
+                    'layout': 'docs/template.hbs',
+                    'packageFile': 'package.json'
                 }
             }
         }
diff --git a/package.json b/package.json
@@ -11,10 +11,14 @@
   },
   "devDependencies": {
     "@neogeek/eslint-config-standards": "1.10.0",
-    "eslint": "3.12.2"
+    "eslint": "3.12.2",
+    "grunt": "1.0.1",
+    "grunt-mkdir": "1.0.0",
+    "grunt-mocha-test": "0.13.2",
+    "mocha": "3.2.0"
   },
   "scripts": {
-    "test": "make lint"
+    "test": "make test"
   },
   "keywords": [
     "gruntplugin",
diff --git a/tasks/doxdox.js b/tasks/doxdox.js
@@ -1,16 +1,17 @@
 const doxdox = require('doxdox');
+const utils = require('doxdox/lib/utils');
 
 module.exports = grunt => {
 
     grunt.registerMultiTask('doxdox', 'Generate documentation with doxdox.', function plugin () {
 
         const done = this.async();
 
-        const pkg = grunt.file.readJSON('package.json');
-
         const {inputs, output} = this.data;
 
-        const {description, ignore, layout, parser, title} = this.data.config || {};
+        const {description, ignore, layout, packageFile, parser, title} = this.data.config || {};
+
+        const pkg = grunt.file.readJSON(utils.findPackageFileInPath(packageFile || 'package.json'));
 
         doxdox.parseInputs(inputs, {
             'description': description || pkg.description || '',
diff --git a/test/.eslintrc b/test/.eslintrc
@@ -0,0 +1,8 @@
+{
+  "extends": [
+    "@neogeek/eslint-config-standards/.eslintrc-tests"
+  ],
+  "rules": {
+    "no-sync": 0
+  }
+}
diff --git a/test/fixtures/package.json b/test/fixtures/package.json
@@ -0,0 +1 @@
+{}
diff --git a/test/fixtures/plugin.js b/test/fixtures/plugin.js
@@ -0,0 +1,33 @@
+const fs = require('fs');
+const path = require('path');
+
+const Handlebars = require('handlebars');
+
+/**
+ * Custom Handlebars template plugin for doxdox.
+ *
+ * @example parseInputs(inputs, {'parser': 'dox', 'layout': 'template.hbs'}).then(content => console.log(content));
+ * @param {Array} data Methods parsed using a doxdox parser.
+ * @return {Promise} Promise with generated content.
+ * @public
+ */
+
+const plugin = data => new Promise((resolve, reject) => {
+
+    fs.readFile(path.join(process.cwd(), data.layout), 'utf8', (err, contents) => {
+
+        if (err) {
+
+            return reject(err);
+
+        }
+
+        const template = Handlebars.compile(contents);
+
+        return resolve(template(data));
+
+    });
+
+});
+
+module.exports = plugin;
diff --git a/test/fixtures/plugin.md b/test/fixtures/plugin.md
@@ -0,0 +1,40 @@
+# Sample Title 
+
+> Lorem ipsum dolor sit amet, consectetur adipisicing elit
+
+
+### test/fixtures/plugin.js
+
+
+#### plugin(data) 
+
+Custom Handlebars template plugin for doxdox.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| data | `Array`  | Methods parsed using a doxdox parser. | &nbsp; |
+
+
+
+
+##### Examples
+
+```javascript
+parseInputs(inputs, {'parser': 'dox', 'layout': 'template.hbs'}).then(content => console.log(content));
+```
+
+
+##### Returns
+
+
+- `Promise`  Promise with generated content.
+
+
+
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox) and [grunt-doxdox](https://github.com/neogeek/grunt-doxdox).*
diff --git a/test/fixtures/template.hbs b/test/fixtures/template.hbs
@@ -0,0 +1,77 @@
+{{#if pkg.homepage}}
+# [{{title}}]({{pkg.homepage}}) {{#if pkg.version}}*{{pkg.version}}*{{/if}}
+{{else}}
+# {{title}} {{#if pkg.version}}*{{pkg.version}}*{{/if}}
+{{/if}}
+
+{{#if description}}
+> {{description}}
+{{/if}}
+
+{{#each files}}
+
+### {{name}}
+
+{{#each methods}}
+
+#### {{name}}({{params}}) {{#if isPrivate}} *private method*{{/if}}
+
+{{{description}}}
+
+{{{body}}}
+
+{{#if tags.param}}
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+{{#each tags.param}}
+| {{name}} | {{#each types}}`{{.}}` {{/each}} | {{{description}}} | {{#if isOptional}}*Optional*{{else}}&nbsp;{{/if}} |
+{{/each}}
+
+{{/if}}
+
+{{#if tags.property}}
+
+##### Properties
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+{{#each tags.param}}
+| {{name}} | {{#each types}}`{{.}}` {{/each}} | {{{description}}} | {{#if isOptional}}*Optional*{{else}}&nbsp;{{/if}} |
+{{/each}}
+
+{{/if}}
+
+{{#if tags.example}}
+
+##### Examples
+
+{{#each tags.example}}
+```javascript
+{{{.}}}
+```
+{{/each}}
+
+{{/if}}
+
+##### Returns
+
+{{#if tags.return}}
+
+{{#each tags.return}}
+- {{#each types}}`{{.}}` {{/each}} {{{description}}}
+{{/each}}
+
+{{else}}
+
+- `Void`
+
+{{/if}}
+
+{{/each}}
+
+{{/each}}
+
+*Documentation generated with [doxdox](https://github.com/neogeek/doxdox) and [grunt-doxdox](https://github.com/neogeek/grunt-doxdox).*
diff --git a/test/specs/doxdox.js b/test/specs/doxdox.js
@@ -0,0 +1,19 @@
+const assert = require('assert');
+const fs = require('fs');
+
+describe('grunt task', () => {
+
+    describe('doxdox', () => {
+
+        it('task called with all configuration properties set', () => {
+
+            assert.equal(
+                fs.readFileSync('temp/plugin.md', 'utf8'),
+                fs.readFileSync('./test/fixtures/plugin.md', 'utf8')
+            );
+
+        });
+
+    });
+
+});

Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`"@neogeek/eslint-config-standards"`
`4`	`4`	`],`
`5`	`5`	`"rules": {`
`6`		`- "no-invalid-this": 0`
	`6`	`+ "no-invalid-this": 0,`
	`7`	`+ "sort-keys": 0`
`7`	`8`	`}`
`8`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,8 @@ module.exports = function (grunt) {`
`48`	`48`	`'config': {`
`49`	`49`	`'title': 'Sample Title',`
`50`	`50`	`'description': 'Lorem ipsum dolor sit amet, consectetur adipisicing elit',`
`51`		`- 'layout': 'docs/template.hbs'`
	`51`	`+ 'layout': 'docs/template.hbs',`
	`52`	`+ 'packageFile': 'package.json'`
`52`	`53`	`}`
`53`	`54`	`}`
`54`	`55`	`}`