npm-pipeline-rails 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf569c96c85c02b65915d854b5ed6023012bc7aa
-  data.tar.gz: d0e38db04bb99ed44153f96d65740caddda891a2
+  metadata.gz: 87487679b6a5d6d28e33ac1e5a5159c196d4a7bb
+  data.tar.gz: 217798c9d06c247379afa503fd9564a9841c8539
 SHA512:
-  metadata.gz: 1ef48bbe254b7960785f489b19401423419baa51776ebbe69837810c9bc78094fcd95107fc28376ca7a3b00f82a9b48b96d000c550fce141f5b57fa7ca5378ed
-  data.tar.gz: b8f655d71c5eab1cd5b1ecc7bd1fc8832a44e035fae1435b2e16fd9e7ee36d0315fcf2a1d2183f7ab7902ac239bab37809b348777a10b03946e423f7ce9bfbf6
+  metadata.gz: d08900a5c70f9f8d3ef96a26adcba6708ffb631669fc0b730a7b64578dd87dcfda16fc01955f5f2ca3bc7344ec2cc3d91f4eb093f04a963c6ebdf2314469673c
+  data.tar.gz: 256921cb8f32fd7081fc6396f9d17fcd61b88942e57b1f3eee317ed3e8fa3e9aa04f8837ae61ffd85fc48601d62cbce424f7fac6134378fcf09e54ba9e497c44

data/HISTORY.md

@@ -1,3 +1,10 @@
+## [v1.1.1]
+> Mar 22, 2016
+
+- Update documentation and gem description; no functional changes.
+
+[v1.1.1]: https://github.com/rstacruz/npm-pipeline-rails/compare/v1.1.0...v1.1.1
+
 ## [v1.1.0]
 > Mar 22, 2016
 

data/README.md

@@ -36,13 +36,22 @@ gem 'npm-pipeline-rails'
 
 #### Automated setup
 
-* Run `./bin/rails generate npm_pipeline:brunch` to add a sample integration with [Brunch]. ([info](docs/brunch.md))
+Use the generators for your preferred build tool:
+
+- __[Brunch](docs/brunch.md)__ - `./bin/rails generate npm_pipeline:brunch`
+- __[Gulp](docs/gulp.md)__ - `./bin/rails generate npm_pipeline:gulp`
 
 #### Manual setup
 
 * Create a `package.json` with `start` and `build` scripts. ([See example](lib/generators/npm_pipeline/brunch/package.json))
 * Add your expected compiled assets to `.gitignore`.
 
+#### Set up support for tests
+
+If you're using continuous integration for your tests, configure it to run `bundle exec rake assets:npm_build` before your tests.
+
+For tests running in your development machine, ensure that asset files are available when running your tests. This means starting your dev server at least once before running tests, or invoking `rake assets:npm_build` manually.
+
 <br>
 
 ## Configuration
@@ -92,12 +101,6 @@ Consult [railtie.rb](https://github.com/rstacruz/npm-pipeline-rails/blob/master/
 
 <br>
 
-## Integration examples
-
-* [Brunch](docs/brunch.md)
-
-<br>
-
 ## Motivation
 
 Rails's asset pipeline was a great step forward for Rails 3. For today's requirements however, it doesn't always come with all the tools you need. npm-pipeline-rails lets you outsource asset building complexities to Node.js-based tools.

data/docs/brunch.md

@@ -1,24 +1,30 @@
 # Brunch integration
 
-Run `./bin/rails generate npm_pipeline:brunch`.
+Run this to set your project up with a simple Brunch config.
+
+```sh
+./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
+#### package.json
+
+> Set it up with `brunch` and some basic plugins.
+
+_See:_ [sample package.json](../lib/generators/npm_pipeline/brunch/package.json)
 
-Set it up to watch source files in `app/brunch`, then put built files into `vendor/assets`.
-[See example.](../lib/generators/npm_pipeline/brunch/brunch-config.js)
+#### brunch-config.js
 
-### package.json
+> Set it up to watch source files in `app/brunch`, then put built files into `vendor/assets`.
 
-Set it up with `brunch` and some basic plugins.
-[See example.](../lib/generators/npm_pipeline/brunch/package.json)
+_See:_ [sample brunch-config.js](../lib/generators/npm_pipeline/brunch/brunch-config.js)
 
-### .gitignore
+#### .gitignore
 
-Set it up to ignore Brunch's built files.
+> Set it up to ignore Brunch's built files.
 
 ```
 /node_modules
@@ -26,9 +32,9 @@ Set it up to ignore Brunch's built files.
 /vendor/assets/javascripts/brunch
 ```
 
-### app/assets/stylesheets/application.css
+#### 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.
+> Set it up to include Brunch's built files. This will load from `vendor/assets/stylesheets/brunch/app.css`, as built by Brunch.
 
 ```css
 /*
@@ -36,17 +42,17 @@ Set it up to include Brunch's built files. This will load from `vendor/assets/st
  */
 ```
 
-### app/assets/javascripts/application.js
+#### 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.
+> Set it up to include Brunch's built files. This will load from `vendor/assets/javascripts/brunch/app.js`, as built by Brunch.
 
 ```css
 //= require brunch/app
 ```
 
-### app/brunch/
+#### app/brunch/
 
-Put your source files into `app/brunch`. For instance:
+> Put your source files into `app/brunch`. For instance:
 
 * `app/brunch/example.css`
 

data/docs/gulp.md

@@ -1,23 +1,30 @@
 # Gulp integration
 
-Run `./bin/rails generate npm_pipeline:gulp`.
+Run this to set your project up with a simple Gulp config.
+
+```sh
+./bin/rails generate npm_pipeline:gulp
+```
 
 ## Manual setup
 
 If you don't want to use the generator, here's what it does.
 
-### package.json
+#### package.json
+
+> Set up `gulp`, `gulp-cli`, and some basic Gulp plugins.
+
+_See:_ [sample package.json](../lib/generators/npm_pipeline/gulp/package.json)
 
-Set up `gulp`, `gulp-cli`, and some basic Gulp plugins.
-[See example.](../lib/generators/npm_pipeline/gulp/package.json)
+#### gulpfile.js
 
-### gulpfile.js
+> Set it up to watch source files in `app/gulp`, then put built files into `vendor/assets`.
 
-Set it up to watch source files in `app/gulp`, then put built files into `vendor/assets`. [See example.](../lib/generators/npm_pipeline/gulp/gulpfile.js)
+_See:_ [sample gulpfile.js](../lib/generators/npm_pipeline/gulp/gulpfile.js)
 
-### .gitignore
+#### .gitignore
 
-Set it up to ignore Gulp's built files.
+> Set it up to ignore Gulp's built files.
 
 ```
 /node_modules
@@ -25,9 +32,9 @@ Set it up to ignore Gulp's built files.
 /vendor/assets/javascripts/gulp
 ```
 
-### app/assets/stylesheets/application.css
+#### app/assets/stylesheets/application.css
 
-Set it up to include Gulp's built files. This will load from `vendor/assets/stylesheets/gulp/app.css`, as built by Gulp.
+> Set it up to include Gulp's built files. This will load from `vendor/assets/stylesheets/gulp/app.css`, as built by Gulp.
 
 ```css
 /*
@@ -35,25 +42,25 @@ Set it up to include Gulp's built files. This will load from `vendor/assets/styl
  */
 ```
 
-### app/assets/javascripts/application.js
+#### app/assets/javascripts/application.js
 
-Set it up to include Gulp's built files. This will load from `vendor/assets/javascripts/gulp/app.js`, as built by Gulp.
+> Set it up to include Gulp's built files. This will load from `vendor/assets/javascripts/gulp/app.js`, as built by Gulp.
 
 ```css
 //= require gulp/app
 ```
 
-### app/gulp/
+#### app/gulp/
 
-Put your source files into `app/gulp`. For instance:
+> Put your source files into `app/gulp`. For instance:
 
-* `app/brunch/example.css`
+* `app/gulp/example.css`
 
  ```css
   * { color: blue }
   ```
 
-* `app/brunch/example.js`
+* `app/gulp/example.js`
 
   ```js
   alert('it works!')

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

@@ -1,3 +1,3 @@
 module NpmPipelineRails
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 end

data/npm-pipeline-rails.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Rico Sta. Cruz']
   spec.email         = ['rstacruz@users.noreply.github.com']
 
-  spec.summary       = 'Build your Rails assets with npm'
-  spec.description   = '...'
+  spec.summary       = 'Use npm as part of your Rails asset pipeline'
+  spec.description   = 'Use any toolchain to bulid your asset files in Rails 4.2. Integrate Brunch, Gulp, Grunt, Webpack, Browserify and others seamlessly into Rails apps.'
   spec.homepage      = 'https://github.com/rstacruz/npm-pipeline-rails'
   spec.license       = 'MIT'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: npm-pipeline-rails
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Rico Sta. Cruz
@@ -94,7 +94,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-description: "..."
+description: Use any toolchain to bulid your asset files in Rails 4.2. Integrate Brunch,
+  Gulp, Grunt, Webpack, Browserify and others seamlessly into Rails apps.
 email:
 - rstacruz@users.noreply.github.com
 executables: []
@@ -144,5 +145,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Build your Rails assets with npm
+summary: Use npm as part of your Rails asset pipeline
 test_files: []