skyfire 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2515c91100fd3b1c8346ade82c53084bfaf96af6
-  data.tar.gz: 2e0ce80fe5d792560353fde338c8f0d81ee56d42
+  metadata.gz: 4645e9ec2b2dac694f5a67b597dc26b74b0235c2
+  data.tar.gz: ef49995995ae9e274eb40e5e587e295c1e9d802e
 SHA512:
-  metadata.gz: 9ca23ce0105c89129fceedff9c2bf92bcf9dd1b882cc103a7b913af3e3596c666e79bbce4c59bac211f7f1da79a6683bdde21c2fb3a881231fd9f691eed83fc1
-  data.tar.gz: 1cdc1c9c6b21ab65b5214f09ddc0d2fb6ba2b223f9934d2cfce6dbf7c93c504a604e8e86ba8e9667072a217b9c3fd48fd26a1141518272382610f8aed2a3b176
+  metadata.gz: 7767fb1325d16c1b83f24fc45a383cf44c50467931c699fbc3a4594360d09a1d2d744f3ea004e4e20e6cf48b3f979a6d099e1a55cfbc9d4e4c370d8a0f3f11b7
+  data.tar.gz: 9e9a5149812a07e26c31d1e45978277499f7fe11d1141991bcdf5ab2913f319b47b3bdeb41b322048633ee3e38a66d47eea5eaef3b91681c7546eccfe140c0bc

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 JobReady
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,8 +1,27 @@
-# Npm::Assets
+# Skyfire
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/npm/assets`. To experiment with that code, run `bin/console` for an interactive prompt.
+Skyfire is a ruby gem (and node package) that replaces the asset pipeline in Ruby On Rails applications.
 
-TODO: Delete this and the text above, and describe your gem
+It uses node utilities (npm, browserify) to manage assets and js/css packages.
+
+## Rationale
+
+### Language
+
+We love ES6 and integration into the existing asset pipeline can be a bit hit and miss.
+
+We aim to avoid mixing import concepts between files and standardising on a common approach to developing javascript applications.
+
+### Packages
+
+We build a lot of reusable javascript libraries, and distribution with npm is increasingly becoming the defacto standard
+for deploying packages.
+
+We tried Bower, it has its own issues.
+
+### Testing
+
+Testing javascript in javascript.
 
 ## Installation
 
@@ -22,7 +41,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+see `doc/usage.md`
 
 ## Development
 
@@ -32,5 +51,5 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/skyfire.
+Bug reports and pull requests are welcome on GitHub at https://github.com/jobready/skyfire.
 

data/gulp/config.js

@@ -0,0 +1,29 @@
+require('shelljs/global');
+var rootDir = exec('git rev-parse --show-toplevel', {silent:true}).output.replace(/\n$/, '');
+var publicAssets = rootDir+"/public/assets";
+var sourceFiles  = rootDir+"/app/assets";
+
+module.exports = {
+    publicAssets: publicAssets,
+    sass: {
+        src: sourceFiles + "/stylesheets/**/*.{css,sass,scss}",
+        dest: publicAssets + "/stylesheets",
+        settings: {
+            sourceComments: true,
+            indentedSyntax: true, // Enable .sass syntax!
+            imagePath: '/assets/images' // Used by the image-url helper
+        }
+    },
+    images: {
+        src: sourceFiles + "/images/**",
+        dest: publicAssets + "/images"
+    },
+    browserify: {
+        bundleConfigs: [{
+            entries: sourceFiles + '/javascripts/application.js',
+            dest: publicAssets + '/javascripts',
+            outputName: 'bundle.js',
+            extensions: ['.js','.jsx']
+        }]
+    }
+};

data/gulp/rev/index.js

@@ -0,0 +1,10 @@
+var config       = require('../../config');
+var gulp         = require('gulp');
+var revCollector = require('gulp-rev-collector');
+
+// Replace asset references in compiled css and js files
+gulp.task('rev', ['rev-assets'], function() {
+    return gulp.src([config.publicAssets + '/rev-manifest.json', config.publicAssets + '/**/*.{css,js}'])
+        .pipe(revCollector())
+        .pipe(gulp.dest(config.publicAssets));
+});

data/gulp/rev/rev-assets.js

@@ -0,0 +1,12 @@
+var config       = require('../../config');
+var gulp         = require('gulp');
+var rev          = require('gulp-rev');
+
+// Add md5 hashes to assets
+gulp.task('rev-assets', function(){
+    return gulp.src(config.publicAssets + '/**/**.!(css|js|eot|woff|ttf)')
+        .pipe(rev())
+        .pipe(gulp.dest(config.publicAssets))
+        .pipe(rev.manifest())
+        .pipe(gulp.dest(config.publicAssets));
+});

data/gulp/tasks/browserify.js

@@ -0,0 +1,64 @@
+var _            = require('lodash');
+var browserify   = require('browserify');
+var browserSync  = require('browser-sync');
+var bundleLogger = require('../util/bundleLogger');
+var config       = require('../config').browserify;
+var gulp         = require('gulp');
+var handleErrors = require('../util/handleErrors');
+var source       = require('vinyl-source-stream');
+var watchify     = require('watchify');
+
+var browserifyTask = function(callback, devMode) {
+
+    var bundleQueue = config.bundleConfigs.length;
+
+    var browserifyThis = function(bundleConfig) {
+
+        if(devMode) {
+            _.extend(bundleConfig, watchify.args, { debug: true });
+            bundleConfig = _.omit(bundleConfig, ['external', 'require']);
+        }
+
+        var b = browserify(bundleConfig);
+
+        var bundle = function() {
+            bundleLogger.start(bundleConfig.outputName);
+
+            return b
+                .bundle()
+                .on('error', handleErrors)
+                .pipe(source(bundleConfig.outputName))
+                .pipe(gulp.dest(bundleConfig.dest))
+                .on('end', reportFinished)
+                .pipe(browserSync.reload({stream:true}));
+        };
+
+        if(devMode) {
+            b = watchify(b);
+            b.on('update', bundle);
+            bundleLogger.watch(bundleConfig.outputName);
+        } else {
+            if(bundleConfig.require) b.require(bundleConfig.require);
+            if(bundleConfig.external) b.external(bundleConfig.external);
+        }
+
+        var reportFinished = function() {
+            bundleLogger.end(bundleConfig.outputName);
+
+            if(bundleQueue) {
+                bundleQueue--;
+                if(bundleQueue === 0) {
+                    callback();
+                }
+            }
+        };
+
+        return bundle();
+    };
+
+    config.bundleConfigs.forEach(browserifyThis);
+};
+
+gulp.task('browserify', browserifyTask);
+
+module.exports = browserifyTask;

data/gulp/tasks/build.js

@@ -0,0 +1,9 @@
+var gulp         = require('gulp');
+var gulpSequence = require('gulp-sequence')
+
+gulp.task('build', function(cb) {
+    var tasks = ['clean', ['sass', 'browserify']];
+    if(process.env.RAILS_ENV === 'production') tasks.push('rev');
+    tasks.push(cb);
+    gulpSequence.apply(this, tasks);
+});

data/gulp/tasks/clean.js

@@ -0,0 +1,7 @@
+var gulp = require('gulp');
+var del = require('del');
+var config = require('../config');
+
+gulp.task('clean', function (cb) {
+    del([config.publicAssets], cb);
+});

data/gulp/tasks/default.js

@@ -0,0 +1,3 @@
+var gulp = require('gulp');
+
+gulp.task('default', ['sass', 'watch']);

data/gulp/tasks/sass.js

@@ -0,0 +1,18 @@
+var gulp         = require('gulp');
+var browserSync  = require('browser-sync');
+var sass         = require('gulp-sass');
+var sourcemaps   = require('gulp-sourcemaps');
+var handleErrors = require('../util/handleErrors');
+var config       = require('../config').sass;
+var autoprefixer = require('gulp-autoprefixer');
+
+gulp.task('sass', function () {
+    return gulp.src(config.src)
+        .pipe(sourcemaps.init())
+        .pipe(sass(config.settings))
+        .on('error', handleErrors)
+        .pipe(sourcemaps.write())
+        .pipe(autoprefixer({ browsers: ['last 2 version'] }))
+        .pipe(gulp.dest(config.dest))
+        .pipe(browserSync.reload({stream:true}));
+});

data/gulp/tasks/watch.js

@@ -0,0 +1,15 @@
+/* Notes:
+ - gulp/tasks/browserify.js handles js recompiling with watchify
+ - gulp/tasks/browserSync.js watches and reloads compiled files
+ */
+
+var gulp   = require('gulp');
+var config = require('../config');
+var watch  = require('gulp-watch');
+
+gulp.task('watch', ['watchify'], function(callback) {
+    watch(config.sass.src, function() { gulp.start('sass'); });
+    //watch(config.images.src, function() { gulp.start('images'); });
+    //watch(config.iconFont.src, function() { gulp.start('iconFont'); });
+    // Watchify will watch and recompile our JS, so no need to gulp.watch it
+});

data/gulp/tasks/watchify.js

@@ -0,0 +1,7 @@
+var gulp           = require('gulp');
+var browserifyTask = require('./browserify');
+
+gulp.task('watchify', function(callback) {
+    // Start browserify task with devMode === true
+    browserifyTask(callback, true);
+});

data/gulp/util/bundleLogger.js

@@ -0,0 +1,25 @@
+/* bundleLogger
+ ------------
+ Provides gulp style logs to the bundle method in browserify.js
+ */
+
+var gutil        = require('gulp-util');
+var prettyHrtime = require('pretty-hrtime');
+var startTime;
+
+module.exports = {
+    start: function(filepath) {
+        startTime = process.hrtime();
+        gutil.log('Bundling', gutil.colors.green(filepath) + '...');
+    },
+
+    watch: function(bundleName) {
+        gutil.log('Watching files required by', gutil.colors.yellow(bundleName));
+    },
+
+    end: function(filepath) {
+        var taskTime = process.hrtime(startTime);
+        var prettyTime = prettyHrtime(taskTime);
+        gutil.log('Bundled', gutil.colors.green(filepath), 'in', gutil.colors.magenta(prettyTime));
+    }
+};

data/gulp/util/handleErrors.js

@@ -0,0 +1,15 @@
+var notify = require("gulp-notify");
+
+module.exports = function() {
+
+    var args = Array.prototype.slice.call(arguments);
+
+    // Send error to notification center with gulp-notify
+    notify.onError({
+        title: "Compile Error",
+        message: "<%= error %>"
+    }).apply(this, args);
+
+    // Keep gulp from hanging on this task
+    this.emit('end');
+};

data/lib/generators/skyfire/install/install_generator.rb

@@ -6,6 +6,11 @@ module Skyfire
       desc "Copy Skyfire package manifest."
       source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
 
+
+      def copy_build_script
+        template 'gulpfile.js', 'gulpfile.js'
+      end
+
       def copy_package_json
         template 'package.json', 'package.json'
         in_root do

data/lib/generators/skyfire/install/templates/gulpfile.js

@@ -0,0 +1,2 @@
+var requireDir = require('require-dir');
+requireDir('node_modules/skyfire/gulp/tasks', {recurse: true});

data/lib/generators/skyfire/install/templates/package.json

@@ -1,10 +1,35 @@
 {
   "scripts": {
-    "build": "skyfire build",
-    "build-min": "skyfire build-min",
-    "build-dist": "skyfire build-dist"
+    "gulp": "gulp"
   },
-  "dependencies": {
+  "devDependencies": {
+    "gulp-watch": "^4.1.1",
+    "browser-sync": "~2.4.0",
+    "browserify": "^8.0.2",
+    "coffeeify": "~0.7.0",
+    "del": "^1.1.1",
+    "gulp": "^3.8.7",
+    "gulp-autoprefixer": "^2.0.0",
+    "gulp-changed": "^0.4.1",
+    "gulp-filesize": "0.0.6",
+    "gulp-iconfont": "^3.0.0",
+    "gulp-imagemin": "^0.6.2",
+    "gulp-notify": "^1.4.2",
+    "gulp-rename": "^1.2.0",
+    "gulp-rev": "^3.0.1",
+    "gulp-rev-collector": "^0.1.3",
+    "gulp-sass": "~1.3.1",
+    "gulp-sequence": "^0.3.2",
+    "gulp-sourcemaps": "^1.2.8",
+    "gulp-swig": "^0.7.4",
+    "gulp-util": "^3.0.0",
+    "lodash": "^2.4.1",
+    "merge-stream": "^0.1.7",
+    "pretty-hrtime": "~0.2.1",
+    "require-dir": "^0.1.0",
+    "vinyl-source-stream": "~0.1.1",
+    "shelljs": "^0.5.1",
+    "watchify": "^2.2.1",
     "private": "jobready/skyfire.git#feature/asset-scripts"
   }
 }

data/lib/skyfire/assets_helper.rb

@@ -1,5 +1,5 @@
 module Skyfire
-  module ApplicationHelper
+  module AssetsHelper
     extend ::ActiveSupport::Concern
 
     included do

data/lib/skyfire/version.rb

@@ -1,3 +1,3 @@
 module Skyfire
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

data/package.json

@@ -3,19 +3,22 @@
   "version": "1.0.0",
   "description": "NPM rails assets pipeline CLI",
   "main": "index.js",
-  "bin": {
-    "skyfire" : "bin/assets/skyfire"
-  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "gulp"
   },
-  "dependencies": {
+  "devDependencies": {
     "babelify": "^6.1.3",
-    "browserify": "^11.0.0",
-    "nodemon": "^1.3.8",
-    "uglify-js": "^2.4.23",
-    "uglifyify": "^3.0.1",
-    "node-sass": "^3.2.0"
+    "browserify": "^10.2.6",
+    "classnames": "^2.1.3",
+    "del": "^1.2.0",
+    "gulp": "^3.9.0",
+    "gulp-rename": "^1.2.2",
+    "gulp-rev": "^3.0.1",
+    "gulp-rev-collector": "^0.1.3",
+    "gulp-uglify": "^1.2.0",
+    "path": "^0.11.14",
+    "shelljs": "^0.5.1",
+    "vinyl-source-stream": "^1.1.0"
   },
   "author": "",
   "license": "ISC",

data/skyfire.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |spec|
   spec.summary       = %q{Rails asset pipeline replacement}
   spec.description   = %q{Rails asset pipeline replacement.}
   spec.homepage      = "https://github.com/jobready/skyfire"
+  spec.licenses = ['MIT']
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skyfire
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andrew McNamara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,28 +64,38 @@ files:
 - ".rspec"
 - ".travis.yml"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
-- bin/assets/css/build.sh
-- bin/assets/includes/common.sh
-- bin/assets/js/build-debug.sh
-- bin/assets/js/build-dist.sh
-- bin/assets/js/build-min.sh
-- bin/assets/js/build.sh
-- bin/assets/skyfire
 - bin/console
 - bin/setup
+- doc/usage.md
+- gulp/config.js
+- gulp/rev/index.js
+- gulp/rev/rev-assets.js
+- gulp/tasks/browserify.js
+- gulp/tasks/build.js
+- gulp/tasks/clean.js
+- gulp/tasks/default.js
+- gulp/tasks/sass.js
+- gulp/tasks/watch.js
+- gulp/tasks/watchify.js
+- gulp/util/bundleLogger.js
+- gulp/util/handleErrors.js
 - index.js
 - lib/generators/skyfire/install/install_generator.rb
+- lib/generators/skyfire/install/templates/gulpfile.js
 - lib/generators/skyfire/install/templates/package.json
 - lib/skyfire.rb
 - lib/skyfire/asset_manifest.rb
 - lib/skyfire/assets_helper.rb
 - lib/skyfire/version.rb
 - package.json
+- skyfire-0.2.0.gem
 - skyfire.gemspec
 homepage: https://github.com/jobready/skyfire
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/bin/assets/css/build.sh

@@ -1,4 +0,0 @@
-#!/usr/bin/env bash -e
-source $(dirname $BASH_SOURCE)/../includes/common.sh
-echo "Building CSS"
-

data/bin/assets/includes/common.sh

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-export ROOT_PATH=$(git rev-parse --show-toplevel)
-export ASSETS_PATH=${ROOT_PATH}/assets
-export JAVASCRIPTS_PATH=${ASSETS_PATH}/javascripts
-export CSS_PATH=${ASSETS_PATH}/stylesheets
-export DIST_PATH=${ROOT_PATH}/public/vendor

data/bin/assets/js/build-debug.sh

@@ -1,2 +0,0 @@
-#!/usr/bin/env bash
-browserify index.js -d --s pizza > dist/pizza.js

data/bin/assets/js/build-dist.sh

@@ -1 +0,0 @@
-#!/usr/bin/env bash

data/bin/assets/js/build-min.sh

@@ -1 +0,0 @@
-#!/usr/bin/env bash

data/bin/assets/js/build.sh

@@ -1,5 +0,0 @@
-#!/usr/bin/env bash -e
-source $(dirname $BASH_SOURCE)/../includes/common.sh
-
-echo "Building JS"
-browserify -d -t babelify -g uglifyify -e ${JAVASCRIPTS_PATH}/application.js | uglifyjs --compress > ${DIST_PATH}/bundle.min.js

data/bin/assets/skyfire

@@ -1,12 +0,0 @@
-#!/usr/bin/env bash -e
-export ROOT_PATH=$(git rev-parse --show-toplevel)
-export ASSETS_PATH=${ROOT_PATH}/assets
-export JAVASCRIPTS_PATH=${ASSETS_PATH}/javascripts
-export CSS_PATH=${ASSETS_PATH}/stylesheets
-export DIST_PATH=${ROOT_PATH}/public/vendor
-
-BIN_DIR=$(dirname $BASH_SOURCE)
-
-echo "Building Javascripts"
-
-browserify -d -t babelify -g uglifyify -e ${JAVASCRIPTS_PATH}/application.js | uglifyjs --compress > ${DIST_PATH}/bundle.min.js