Merge pull request #2 from mizunashi-mana/add-examples

Add some examples

.gitignore

@@ -2,6 +2,8 @@
 
 # for Example
 /example/_book/
+/example/book.*
+!/example/book.json
 
 # for NPM
 node_modules/

.travis.yml

@@ -21,6 +21,7 @@ install:
   - npm install gitbook@$GITBOOK_VERSION
 script:
   - npm test
+  - npm run example
   - npm run coverage
 after_script:
   - npm install -g istanbul-coveralls

example/book.json

@@ -1,4 +1,5 @@
 {
-	"title": "Example Documentation",
-	"plugins": ["anchors"]
+  "title": "Example Documentation",
+  "description": "Example of gulp-gitbook plugin",
+  "plugins": ["anchors"]
 }

example/config.js

@@ -5,15 +5,47 @@
 var gulp = require('gulp');
 var gulpGitbook = require('..');
 
+var runSequence = require('run-sequence');
+
 /**
  * Simple example of GitBook
  */
 gulp.task('basic', function (cb) {
   gulpGitbook('.', cb);
 });
 
-gulp.task('default', [
-  'basic'
-], function () {
-  console.log('All tasks completed successfully.');
+/**
+ * Generate PDF example
+ */
+gulp.task('pdf', function (cb) {
+  gulpGitbook.pdf('.', cb);
+});
+
+/**
+ * Generate EPUB example
+ */
+gulp.task('epub', function (cb) {
+  gulpGitbook.epub('.', cb);
+});
+
+/**
+ * Without install task example
+ */
+gulp.task('noinstall', function (cb) {
+  gulpGitbook('.', {
+    noInstall: true
+  }, cb);
+});
+
+gulp.task('default', function (cb) {
+  runSequence(
+    'basic',
+    'pdf',
+    'epub',
+    'noinstall',
+    function () {
+      console.log('All tasks completed successfully');
+      cb();
+    }
+  );
 });

index.js

@@ -87,12 +87,10 @@ var pluginError = function (message) {
   return GulpUtil.PluginError(PLUGIN_NAME, message);
 };
 
-var gulpGitbook = function (book, options, callback) {
-  options = validateOptions(book, options, callback);
-
+var _gulpGitbook = function (options) {
   var p = Promise.resolve();
 
-  if (options.noInstall) {
+  if (!options.noInstall) {
     p = p.then(function () {
       return gitbookExec('install', [
         options.book
@@ -141,31 +139,36 @@ var gulpGitbook = function (book, options, callback) {
   });
 };
 
+var gulpGitbook = function (book, options, callback) {
+  options = validateOptions(book, options, callback);
+  return _gulpGitbook(options);
+};
+
 var gulpGitbookWebsite = function (book, options, callback) {
-  options = extend({}, options);
+  options = validateOptions(book, options, callback);
   options.format = 'website';
-  return gulpGitbook(book, options, callback);
+  return _gulpGitbook(options);
 };
 gulpGitbook.website = gulpGitbookWebsite;
 
 var gulpGitbookPdf = function (book, options, callback) {
-  options = extend({}, options);
+  options = validateOptions(book, options, callback);
   options.format = 'pdf';
-  return gulpGitbook(book, options, callback);
+  return _gulpGitbook(options);
 };
 gulpGitbook.pdf = gulpGitbookPdf;
 
 var gulpGitbookEpub = function (book, options, callback) {
-  options = extend({}, options);
+  options = validateOptions(book, options, callback);
   options.format = 'epub';
-  return gulpGitbook(book, options, callback);
+  return _gulpGitbook(options);
 };
 gulpGitbook.epub = gulpGitbookEpub;
 
 var gulpGitbookMobi = function (book, options, callback) {
-  options = extend({}, options);
+  options = validateOptions(book, options, callback);
   options.format = 'mobi';
-  return gulpGitbook(book, options, callback);
+  return _gulpGitbook(options);
 };
 gulpGitbook.mobi = gulpGitbookMobi;
 
@@ -225,6 +228,7 @@ module.exports = gulpGitbook;
 
 if (process.env.GULPGITBOOK_TEST_ENV) {
   module.exports._private = {
+    _gulpGitbook: _gulpGitbook,
     promiseCallback: promiseCallback,
     isNullable: isNullable,
     validateOptions: validateOptions,

package.json

@@ -16,7 +16,6 @@
     "testonly": "mocha --require ./test/index.js test/**/*.test.js",
     "pretest": "npm run lint",
     "test": "npm run testonly",
-    "posttest": "npm run example",
     "example": "gulp --gulpfile=example/config.js",
     "coverage": "istanbul cover _mocha -- --require ./test/index.js"
   },
@@ -50,6 +49,7 @@
     "gulp": "^3.9.1",
     "istanbul": "^0.4.5",
     "mocha": "^3.1.0",
+    "run-sequence": "^1.2.2",
     "sinon": "^1.17.6",
     "sinon-chai": "^2.8.0"
   },