npm-pipeline-rails 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46d50e558878bb7067e545c5e6d23b8bab48c620
+  data.tar.gz: d4af91051596cb74e6125ea7c88b770d5ee9555f
+SHA512:
+  metadata.gz: 7ab31053f7879fc3575446561e3b6aaa2170bc807fea510bea2dcf13c8a8bb196047df4dcc2261d0a8ea21e42a70867126e6fe56182f4f022785abbce1560d82
+  data.tar.gz: 9e8f5151e74246cbca3cb474f91ed359c54af627ed59e41492ecaf21acb9868cddfbabd463ff48c08ee0ddabc741b60be4be302b8c89ce553b6e42c95e653439

data/.gitignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/HISTORY.md

@@ -0,0 +1,6 @@
+## [v1.0.0]
+> Mar 22, 2016
+
+- Initial release.
+
+[v1.0.0]: https://github.com/rstacruz/npm-pipeline-rails/tree/v1.0.0

data/README.md

@@ -0,0 +1,87 @@
+# npm-pipeline-rails
+
+> Use npm as part of your Rails asset pipeline
+
+npm-pipeline-rails allows you to use any toolchain to bulid your asset files. This allows you to:
+
+- Use [webpack][] with Rails
+- Use [brunch][] with Rails ([instructions](docs/brunch.md))
+- Use [browserify][] with Rails
+- Use any other asset tool with Rails
+
+[webpack]: https://webpack.github.io/
+[brunch]: http://brunch.io/
+[browserify]: http://browserify.org/
+
+> ![](docs/screenshots/full.png)
+
+## Usage
+
+Add to your `Gemfile`.
+
+  ```rb
+  gem 'npm-pipeline-rails'
+  ```
+
+You may do a manual setup:
+
+* Create a `package.json` with `start` and `build` commands.
+* Add compiled assets to `.gitignore`.
+
+Or an automated setup:
+
+* Run `./bin/rails generate npm_pipeline:brunch` to add a sample integration with [Brunch]. ([info](docs/brunch.md))
+
+## Configuration
+
+npm-pipeline-rails provides these configuration options:
+
+```rb
+# These are defaults; in most cases, you don't need to configure anything.
+
+Rails.application.configure do
+  # Command to install dependencies
+  config.npm.install = ['npm install']
+
+  # Command to build production
+  config.npm.build = ['npm run build']
+
+  # Command to start a file watcher
+  config.npm.watch = ['npm run start']
+
+  # The commands are arrays; you may add more commands as needed:
+  config.npm.watch = [
+    'npm run webpack:start',
+    'npm run brunch:start'
+  ]
+end
+```
+
+## How it works
+
+npm-pipeline-rails allows you to hook certain commands, usually npm scripts, during the Rails app lifecycle. It assumes that your tool will build plain JS and CSS files into `vendor/assets`, allowing it to be picked up by Rails's asset pipeline.
+
+#### In development
+
+When starting a Rails development server (`bundle exec rails s`), it runs the `install` command. After that, it starts a background process that runs your `watch` command.
+
+#### In production
+
+When running `rake assets:precompile`, it will first run the `install` command then the `build` command.
+
+## Integration examples
+
+* [Brunch](docs/brunch.md)
+* more to come soon
+
+## Thanks
+
+**npm-pipeline-rails** © 2016+, Rico Sta. Cruz. Released under the [MIT] License.<br>
+Authored and maintained by Rico Sta. Cruz with help from contributors ([list][contributors]).
+
+> [ricostacruz.com](http://ricostacruz.com) &nbsp;&middot;&nbsp;
+> GitHub [@rstacruz](https://github.com/rstacruz) &nbsp;&middot;&nbsp;
+> Twitter [@rstacruz](https://twitter.com/rstacruz)
+
+[MIT]: http://mit-license.org/
+[contributors]: http://github.com/rstacruz/npm-pipeline-rails/contributors

data/docs/brunch.md

@@ -0,0 +1,91 @@
+# Brunch example
+
+Run `./bin/rails generate npm_pipeline:brunch`.
+
+## Manual setup
+
+If you don't want to use the generator, here's what it does.
+
+### `brunch-config.js`
+
+Set it up to watch source files in `app/brunch`, then put built files into `vendor/assets`.
+
+```js
+// See http://brunch.io for documentation.
+module.exports = {
+  paths: {
+    watched: ['app/brunch'],
+    public: 'vendor/assets'
+  },
+
+  files: {
+    javascripts: {joinTo: 'javascripts/brunch/app.js'},
+    stylesheets: {joinTo: 'stylesheets/brunch/app.css'}
+  }
+}
+```
+
+### `package.json`
+
+```js
+{
+  "name": "brunch-app",
+  "description": "Description",
+  "author": "Your Name",
+  "version": "0.1.0",
+  "scripts": {
+    "start": "brunch watch",
+    "build": "brunch build --production"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "brunch": "^2.5.1",
+    "javascript-brunch": "^2.0.0",
+    "css-brunch": "^2.0.0",
+    "auto-reload-brunch": "^2.0.0"
+  }
+}
+```
+
+### `.gitignore`
+
+Set it up to ignore Brunch's built files.
+
+```
+/vendor/assets/stylesheets/brunch/
+/vendor/assets/javascripts/brunch/
+```
+
+### `app/assets/stylesheets/application.css`
+
+Set it up to include Brunch's built files. This will load from `vendor/assets/stylesheets`, as built by Brunch.
+
+```css
+/*
+ *= require brunch/app
+ */
+```
+
+### `app/assets/javascripts/application.js`
+
+Set it up to include Brunch's built files. This will load from `vendor/assets/javascripts`, as built by Brunch.
+
+```css
+//= require brunch/app
+```
+
+### `app/brunch`
+
+Put your source files into `app/brunch`. For instance:
+
+* `app/brunch/example.css`
+
+  ```css
+  * { color: blue }
+  ```
+
+* `app/brunch/example.js`
+
+  ```js
+  alert('it works!')
+  ```

data/lib/generators/npm_pipeline/brunch/brunch-config.js

@@ -0,0 +1,16 @@
+// See http://brunch.io for documentation.
+module.exports = {
+  paths: {
+    watched: ['app/brunch'],
+    public: 'vendor/assets'
+  },
+
+  modules: {
+    wrapper: false
+  },
+
+  files: {
+    javascripts: {joinTo: 'javascripts/brunch/app.js'},
+    stylesheets: {joinTo: 'stylesheets/brunch/app.css'}
+  }
+}

data/lib/generators/npm_pipeline/brunch/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "brunch-app",
+  "description": "Description",
+  "author": "Your Name",
+  "version": "0.1.0",
+  "scripts": {
+    "start": "brunch watch",
+    "build": "brunch build --production"
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "brunch": "^2.5.1",
+    "javascript-brunch": "^2.0.0",
+    "css-brunch": "^2.0.0",
+    "auto-reload-brunch": "^2.0.0"
+  }
+}

data/lib/generators/npm_pipeline/brunch_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators/base'
+
+module NpmPipeline
+  module Generators
+    class BrunchGenerator < Rails::Generators::Base
+      desc 'Creates'
+      source_root File.expand_path('../brunch', __FILE__)
+
+      def create_package_json
+        template 'package.json', 'package.json'
+      end
+
+      def create_brunch_config
+        template 'brunch-config.js', 'brunch-config.js'
+      end
+
+      def update_assets
+        append_to_file 'app/assets/stylesheets/application.css',
+          "/*\n *= require brunch/app\n */\n"
+        append_to_file 'app/assets/javascripts/application.js',
+          "//= require brunch/app\n"
+      end
+
+      def create_sample_brunch_css
+        create_file 'app/brunch/example.css',
+          %(html:before { content: 'Brunch assets added successfully! Edit app/brunch/example.css or remove it.'; display: block; padding: 20px; background: #ffc; color: #111; position: fixed; top: 16px; right: 16px; max-width: 600px; z-index: 10000; font-family: sans-serif; font-size: 14px; line-height: 1.6; }\n)
+      end
+
+      def create_sample_brunch_js
+        create_file 'app/brunch/example.js',
+          "alert('Brunch works!')"
+      end
+
+      def update_gitignore
+        append_to_file '.gitignore',
+          "/vendor/assets/stylesheets/brunch\n" +
+          "/vendor/assets/javascripts/brunch\n"
+      end
+    end
+  end
+end

data/lib/npm-pipeline-rails.rb

@@ -0,0 +1,5 @@
+require_relative './npm-pipeline-rails/railtie'
+require_relative './npm-pipeline-rails/version'
+
+module NpmPipelineRails
+end

data/lib/npm-pipeline-rails/railtie.rb

@@ -0,0 +1,46 @@
+require 'rails'
+require 'rails/railtie'
+
+module NpmPipelineRails
+  module Utils
+    def do_system(commands)
+      [*commands].each do |cmd|
+        system cmd
+        exit $? unless $? == 0
+
+      end
+    end
+  end
+
+  class Railtie < ::Rails::Railtie
+    include ::NpmPipelineRails::Utils
+
+    config.npm = ActiveSupport::OrderedOptions.new
+
+    config.npm.build = ['npm run build']
+    config.npm.watch = ['npm run start']
+    config.npm.install = ['npm install']
+
+    rake_tasks do |app|
+      namespace :assets do
+        desc 'Build assets prerequisites using npm'
+        task :npm_build do
+          do_system app.config.npm.install
+          do_system app.config.npm.build
+        end
+
+        task(:precompile).enhance ['npm_build']
+      end
+    end
+
+    initializer 'npm_pipeline.watch' do |app|
+      if ::Rails.env.development? && ::Rails.const_defined?(:Server)
+        do_system app.config.npm.install
+        exit $? unless $? == 0
+        [*app.config.npm.watch].each do |cmd|
+          fork { do_system [cmd] }
+        end
+      end
+    end
+  end
+end

data/lib/npm-pipeline-rails/version.rb

@@ -0,0 +1,3 @@
+module NpmPipelineRails
+  VERSION = '1.0.0'
+end

data/npm-pipeline-rails.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'npm-pipeline-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'npm-pipeline-rails'
+  spec.version       = NpmPipelineRails::VERSION
+  spec.authors       = ['Rico Sta. Cruz']
+  spec.email         = ['rstacruz@users.noreply.github.com']
+
+  spec.summary       = 'Build your Rails assets with npm'
+  spec.description   = '...'
+  spec.homepage      = 'https://github.com/rstacruz/npm-pipeline-rails'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(example|test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'railties', '~> 4.0'
+  spec.add_runtime_dependency 'sprockets', '~> 3.5'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rails', '~> 4.2'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: npm-pipeline-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Rico Sta. Cruz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: "..."
+email:
+- rstacruz@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- HISTORY.md
+- README.md
+- docs/brunch.md
+- docs/screenshots/build.png
+- docs/screenshots/full.png
+- docs/screenshots/server.png
+- lib/generators/npm_pipeline/brunch/brunch-config.js
+- lib/generators/npm_pipeline/brunch/package.json
+- lib/generators/npm_pipeline/brunch_generator.rb
+- lib/npm-pipeline-rails.rb
+- lib/npm-pipeline-rails/railtie.rb
+- lib/npm-pipeline-rails/version.rb
+- npm-pipeline-rails.gemspec
+homepage: https://github.com/rstacruz/npm-pipeline-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Build your Rails assets with npm
+test_files: []