Proper build for bower with browserify

Author: cardil

gulp/build.js

@@ -8,81 +8,39 @@ var buffer = require('vinyl-buffer');
 var uglify = require('gulp-uglify');
 var sourcemaps = require('gulp-sourcemaps');
 var gutil = require('gulp-util');
-var through = require('through2');
-var globby = require('globby');
 var config = require('./config');
 
+var toplevel = 'gulp/build/toplevel.js';
+
 module.exports = {
   browserify: function() {
-    // gulp expects tasks to return a stream, so we create one here.
-    var bundledStream = through();
+    // set up the browserify instance on a task basis
+    var b = browserify({
+      entries: toplevel,
+      debug: true
+    });
 
-    bundledStream
-      // turns the output bundle stream into a stream containing
-      // the normal attributes gulp plugins expect.
+    return b.bundle()
       .pipe(source('eid.js'))
-      // the rest of the gulp task, as you would normally write it.
-      // here we're copying from the Browserify + Uglify2 recipe.
       .pipe(buffer())
-        .on('error', gutil.log)
-      .pipe(gulp.dest(config.dist + '/browser/js'));
-
-    // "globby" replaces the normal "gulp.src" as Browserify
-    // creates it's own readable stream.
-    globby(config.sources).then(function(entries) {
-      // create the Browserify instance.
-      var b = browserify({
-        entries: entries,
-        debug: true
-      });
-
-      // pipe the Browserify stream into the stream we created earlier
-      // this starts our gulp pipeline.
-      b.bundle().pipe(bundledStream);
-    }).catch(function(err) {
-      // ensure any errors from globby are handled
-      bundledStream.emit('error', err);
-    });
-
-    // finally, we return the stream, so gulp knows when this task is done.
-    return bundledStream;
+          .on('error', gutil.log)
+      .pipe(gulp.dest(config.dist + '/browser/toplevel'));
   },
   minified: function() {
-    // gulp expects tasks to return a stream, so we create one here.
-    var bundledStream = through();
+    // set up the browserify instance on a task basis
+    var b = browserify({
+      entries: toplevel,
+      debug: true
+    });
 
-    bundledStream
-      // turns the output bundle stream into a stream containing
-      // the normal attributes gulp plugins expect.
+    return b.bundle()
       .pipe(source('eid.min.js'))
-      // the rest of the gulp task, as you would normally write it.
-      // here we're copying from the Browserify + Uglify2 recipe.
       .pipe(buffer())
       .pipe(sourcemaps.init({loadMaps: true}))
-        // Add gulp plugins to the pipeline here.
-        .pipe(uglify())
-        .on('error', gutil.log)
+          // Add transformation tasks to the pipeline here.
+          .pipe(uglify())
+          .on('error', gutil.log)
       .pipe(sourcemaps.write('./'))
-      .pipe(gulp.dest(config.dist + '/browser/js'));
-
-    // "globby" replaces the normal "gulp.src" as Browserify
-    // creates it's own readable stream.
-    globby(config.sources).then(function(entries) {
-      // create the Browserify instance.
-      var b = browserify({
-        entries: entries,
-        debug: true
-      });
-
-      // pipe the Browserify stream into the stream we created earlier
-      // this starts our gulp pipeline.
-      b.bundle().pipe(bundledStream);
-    }).catch(function(err) {
-      // ensure any errors from globby are handled
-      bundledStream.emit('error', err);
-    });
-
-    // finally, we return the stream, so gulp knows when this task is done.
-    return bundledStream;
+      .pipe(gulp.dest(config.dist + '/browser/toplevel'));
   }
 };

gulp/build/toplevel.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2016 Wave Software
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+(function(wnd) {
+  'use strict';
+
+  wnd.Eid = require('../../lib/eid');
+  wnd.EidNullPointerException = require('../../lib/eid/exceptions').EidNullPointerException;
+  wnd.EidIllegalArgumentException = require('../../lib/eid/exceptions').EidIllegalArgumentException;
+  wnd.EidIllegalStateException = require('../../lib/eid/exceptions').EidIllegalStateException;
+  wnd.EidIndexOutOfBoundsException = require('../../lib/eid/exceptions').EidIndexOutOfBoundsException;
+  wnd.EidRuntimeException = require('../../lib/eid/exceptions').EidRuntimeException;
+  wnd.EidPreconditions = require('../../lib/eid/preconditions');
+})(window);

gulp/clean.js

@@ -23,4 +23,4 @@ var deleteFolderRecursive = function(path) {
 module.exports = function() {
   deleteFolderRecursive(config.target);
   deleteFolderRecursive(config.dist);
-}
+};

gulp/config.js

@@ -1,9 +1,18 @@
 /* eslint-disable no-var, strict, prefer-arrow-callback */
 'use strict';
 
-module.exports = {
-  sources: ['lib/**/*.js'],
-  testSources: ['test/**/*.js'],
+var directory = {
+  lib: 'lib',
+  test: 'test',
   target: 'target',
   dist: 'dist'
 };
+
+module.exports = {
+  sources: [ directory.lib + '/**/*.js' ],
+  testSources: [ directory.test + '/**/*.js' ],
+  lib: directory.lib,
+  test: directory.test,
+  target: directory.target,
+  dist: directory.dist
+};

gulp/serve.js

@@ -0,0 +1,7 @@
+/* eslint-disable no-var, strict, prefer-arrow-callback */
+'use strict';
+
+var serve = require('gulp-serve');
+var config = require('./config');
+
+module.exports = serve([ config.test, config.dist ]);

gulp/tests.js

@@ -16,7 +16,8 @@ module.exports = {
           strict: 2
         },
         env: {
-      		node: true
+      		node: true,
+          browser: true
       	}
       }))
       .pipe(eslint.format())
@@ -25,8 +26,9 @@ module.exports = {
   specs: function (done) {
     var prependToAll = function(path, globs) {
       var ret = [];
-      for (var v of globs) {
-        ret.push(path + '/' + v);
+      for (var i = 0; i < globs.length; i++) {
+        var value = globs[i];
+        ret.push(path + '/' + value);
       }
       return ret;
     };

gulpfile.js

@@ -6,6 +6,7 @@ var gulp = require('gulp');
 var tests = require('./gulp/tests');
 var build = require('./gulp/build');
 var clean = require('./gulp/clean');
+var serve = require('./gulp/serve');
 
 gulp.task('clean', clean);
 gulp.task('lint', tests.lint);
@@ -16,5 +17,6 @@ gulp.task('watch', function() {
 });
 gulp.task('build-browser', ['test'], build.browserify);
 gulp.task('build-minified', ['test'], build.minified);
+gulp.task('serve', serve);
 gulp.task('build', ['build-browser', 'build-minified']);
 gulp.task('default', ['test', 'build']);

package.json

@@ -15,6 +15,7 @@
     "gulp-coverage": "^0.3.38",
     "gulp-eslint": "^1.1.1",
     "gulp-mocha": "^2.2.0",
+    "gulp-serve": "^1.2.0",
     "gulp-sourcemaps": "^1.6.0",
     "gulp-uglify": "^1.5.1",
     "gulp-util": "^3.0.7",

test/index.html

@@ -0,0 +1,106 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="UTF-8">
+    <title>ExceptionID.js - manual test page</title>
+    <link rel="stylesheet" type="text/css" href="https://raw.githubusercontent.com/twbs/bootstrap/master/dist/css/bootstrap.min.css" />
+    <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.1.0/styles/default.min.css">
+    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.1.0/highlight.min.js"></script>
+    <script type="application/javascript" src="browser/toplevel/eid.min.js"></script>
+    <style type="text/css">
+      @import url(https://fonts.googleapis.com/css?family=PT+Sans|Source+Code+Pro);
+      body {
+        font-family: 'PT Sans', sans-serif;
+        font-size: 1.3em;
+        padding: 1em;
+      }
+      pre, code {
+        font-family: 'Source Code Pro', monospace;
+      }
+      pre#console {
+        display:block;
+        font:normal 1em/1.5em 'Source Code Pro', monospace;
+        color: #CFDBEC;
+        background-color:#2f2f2f;
+        background-image:-webkit-repeating-linear-gradient(top, #353535 0em, #353535 1.5em, #2f2f2f 1.5em, #2f2f2f 3em);
+        background-image:-moz-repeating-linear-gradient(top, #353535 0em, #353535 1.5em, #2f2f2f 1.5em, #2f2f2f 3em);
+        background-image:-ms-repeating-linear-gradient(top, #353535 0em, #353535 1.5em, #2f2f2f 1.5em, #2f2f2f 3em);
+        background-image:-o-repeating-linear-gradient(top, #353535 0em, #353535 1.5em, #2f2f2f 1.5em, #2f2f2f 3em);
+        background-image:repeating-linear-gradient(top, #353535 0em, #353535 1.5em, #2f2f2f 1.5em, #2f2f2f 3em);
+        padding:0em 1em;
+        overflow:auto;
+        white-space: pre-wrap;
+      }
+    </style>
+  </head>
+  <body>
+    <h1>ExceptionID.js - showcase</h1>
+
+    <h3>Code:</h3>
+    <pre><code class="javascript" id="code">
+    try {
+      // Example entity objects
+      var users = [];
+      for (var i = 0; i < 5; i++) {
+        var user = { id: 67112 - i };
+        user.toString = function() { return '[User id=' + this.id + ']'; };
+        users.push(user);
+      }
+
+      // logging support
+      for (var i = 0; i < users.length; i++) {
+        var user = users[i];
+        var eid = new Eid('20160111:223928', 'WJS-17');
+        log.debug(eid.makeLogMessage('An entity: %s', user));
+        log.debug(eid.makeLogMessage('%s has even ID: %s', user, user.id % 2 === 0));
+      }
+
+      // preconditions!
+      EidPreconditions.checkArgument(true, '20160111:223749');
+      EidPreconditions.checkState(false, '20160111:224215', 'A extra message');
+    } catch(e) {
+      // Top level of your application
+      log.error(e.toString() + ' - ' + e.stack);
+      // or better save your exceptions!
+      logGateway.put(e, {eid: e.eid});
+    }
+    </code></pre>
+    <h3>Console:</h3>
+    <pre id="console"></pre>
+    <script type="application/javascript">
+    (function() {
+    var line = 1;
+    function pad(n, width, z) {
+      z = z || '0';
+      n = n + '';
+      return n.length >= width ? n : new Array(width - n.length + 1).join(z) + n;
+    }
+    var println = function(message) {
+      var pre = document.getElementById('console');
+      pre.textContent += message + "\n";
+    };
+    var logentry = function(level, msg) {
+      var date = new Date().toISOString().slice(0, 23);
+      println(pad(line, 3) + ': ' + level + ' ' + date + ' ' + msg);
+      line += 1;
+    };
+    var log = {
+      debug: function(message) {
+        logentry('DEBUG', message);
+      },
+      error: function(message) {
+        logentry('ERROR', message);
+      }
+    };
+    var logGateway = {
+      put: function(ex, extra) {
+        logentry('INFO', 'LogzGetewayFake.io sucessfully PUT an exception: `' + ex.toString() + '` with extra data of: `' + JSON.stringify(extra) + '`');
+      }
+    };
+    var code = document.getElementById('code').textContent;
+    eval(code);
+    hljs.initHighlightingOnLoad();
+    })();
+    </script>
+  </body>
+</html>