Merge pull request #10 from firebase/jw-catapult

Updated repo to work with Catapult

Author: Chris Raynor

.gitignore

@@ -2,5 +2,6 @@
 .idea
 *.iml
 
-node_modules/
+dist/
 coverage/
+node_modules/

.travis.yml

@@ -5,4 +5,6 @@ node_js:
 install:
 - npm install
 script:
-- npm test
+- npm run travis
+after_script:
+- cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js

changelog.txt

@@ -0,0 +1 @@
+feature - Initial 1.0.0 release.

gulpfile.js

@@ -16,10 +16,12 @@ var istanbul = require('gulp-istanbul');
 /*  FILE PATHS  */
 /****************/
 var paths = {
-  js: [
-    'queue.js',
-    'lib/*.js'
-  ],
+  js: {
+    srcFiles: [
+      'src/**/*.js'
+    ],
+    destDir: 'dist'
+  },
 
   tests: [
     'test/queue.spec.js',
@@ -31,32 +33,33 @@ var paths = {
 /***********/
 /*  TASKS  */
 /***********/
-// Lints the JavaScript files
-gulp.task('lint', function() {
-  return gulp.src(paths.js)
+// Lints the JavaScript files and copies them to the destination directory
+gulp.task('build', function() {
+  return gulp.src(paths.js.srcFiles)
     .pipe(jshint())
     .pipe(jshint.reporter('jshint-stylish'))
     .pipe(jshint.reporter('fail'))
     .on('error', function(error) {
       throw error;
-    });
+    })
+    .pipe(gulp.dest(paths.js.destDir));
 });
 
 // Runs the Mocha test suite
 gulp.task('test', function() {
-  return gulp.src(paths.js)
+  return gulp.src(paths.js.srcFiles)
     .pipe(istanbul())
     .pipe(istanbul.hookRequire())
     .on('finish', function () {
       gulp.src(paths.tests)
         .pipe(mocha({
           reporter: 'spec',
-          timeout: 10000
+          timeout: 2000
         }))
         .pipe(istanbul.writeReports())
         .pipe(exit());
     });
 });
 
 // Default task
-gulp.task('default', ['lint', 'test']);
+gulp.task('default', ['build', 'test']);

package.json

@@ -1,15 +1,17 @@
 {
   "name": "firebase-queue",
   "version": "0.0.0",
-  "description": "A fault-tolerant, multi-worker, multi-stage job pipeline built on Firebase.",
+  "description": "A fault-tolerant, multi-worker, multi-stage job pipeline built on Firebase",
   "keywords": [
-    "firebase",
+    "job",
+    "task",
     "queue",
     "worker",
-    "job",
+    "firebase",
+    "realtime",
     "pipeline"
   ],
-  "license" : "MIT",
+  "license": "MIT",
   "author": "Firebase <[email protected]>",
   "contributors": [
     {
@@ -21,12 +23,20 @@
       "email": "[email protected]"
     },
     {
-      "name": "Mike Mcdonald",
+      "name": "Mike McDonald",
       "email": "[email protected]"
     }
   ],
   "repository": "https://github.com/firebase/firebase-queue.git",
   "homepage": "https://github.com/firebase/firebase-queue",
+  "main": "dist/queue.js",
+  "files": [
+    "dist/lib/**",
+    "dist/queue.js",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
   "dependencies": {
     "firebase": "2.x",
     "lodash": "~3.7.0",
@@ -37,6 +47,7 @@
   "devDependencies": {
     "chai": "2.2.0",
     "chai-as-promised": "5.0.0",
+    "coveralls": "^2.11.2",
     "gulp": "3.8.11",
     "gulp-exit": "0.0.2",
     "gulp-istanbul": "0.8.1",
@@ -47,10 +58,7 @@
     "sinon-chai": "2.7.0"
   },
   "scripts": {
-    "test": "gulp"
-  },
-  "main": "queue.js",
-  "engines": {
-    "node": ">=0.10.0"
+    "test": "gulp test",
+    "travis": "gulp"
   }
 }

lib/queue_worker.js renamed to src/lib/queue_worker.js

@@ -1,3 +1,10 @@
+/*!
+ * Firebase Queue is a fault-tolerant, multi-worker, multi-stage job pipeline built on Firebase.
+ *
+ * Firebase Queue 0.0.0
+ * https://github.com/firebase/firebase-queue/
+ * License: MIT
+ */
 'use strict';
 
 var _ = require('lodash'),

queue.js renamed to src/queue.js

@@ -10,8 +10,8 @@ module.exports = function() {
   self.testRef.child('.info/serverTimeOffset').on('value', function(snapshot) {
     self.offset = snapshot.val();
   });
-  this.Queue = require('../queue.js');
-  this.QueueWorker = require('../lib/queue_worker.js');
+  this.Queue = require('../src/queue.js');
+  this.QueueWorker = require('../src/lib/queue_worker.js');
 
   this.QueueWorkerWithoutProcessingOrTimeouts = function() {
     self.QueueWorker.apply(this, arguments);