npm-rails 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 531ae45eee201ef671482c29382cd0d1a5f32912
-  data.tar.gz: ec7de754048db5cdc81de420c379f44e547e5bd6
+  metadata.gz: c32cc65625bf1da90f6aa9e1c6ebd49798857cde
+  data.tar.gz: 53418cb5e60aadc395693ea90ec76ad8253509fb
 SHA512:
-  metadata.gz: ae8bf4bb16d8f73a14112c619458319f7f84bf556f5c0aa5500a638da7c8e7c2f50dcc131bb7d60193299c522369e980c956260f609a1da4f8be1469a89e1482
-  data.tar.gz: c87489e1d5ab28dfa5856c06e26d1e4a7c8ac2b29ba8408ac0441885b6088f4c86e72de4bc2a42a9d26a32934a1f2578269ee68afa4ec6d2faa47ad913bafdb7
+  metadata.gz: 07b2fd711a6d4c1f35de14426fdbb96e8c135014f60f3c20907d54a1b42b12e7524736009eaa06673f6f37d777188b71bfecd21027ee20f3d49c62837df73d65
+  data.tar.gz: 26e4b27eb5c1a9571c098057d085f0bca80d2179d6301f2b297383d912562a7d416dddfc59c8c7d62fa6672b45ed86660e92b3b061224b5e9de0541969cae0a7

data/README.md

@@ -63,15 +63,15 @@ npm 'browserify', require: false
 The following options are available for configuration in your application or environment-level
 config files (`config/application.rb`, `config/environments/development.rb`, etc.):
 
-| Configuration Option            | Description                                                                                                                                  |
-|---------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------- |
-| `config.npm.package_file`       | Specificies a package file. Default value: `npm_packages`                                                                                    |
-| `config.npm.output_file`        | Specifies a file where to bundle npm packages. Default value: `vendor/assets/javascripts/npm-dependencies.js`.                               |
-| `config.npm.browserify_options` | Sets options for browserify command. See all available options in [Browserify documentation](https://github.com/substack/node-browserify#usage) |
+| Configuration Option                      | Description                                                                                                                                  |
+|-------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------- |
+| `config.npm.package_file`                 | Specificies a package file. Default value: `npm_packages`                                                                                    |
+| `config.npm.output_file`                  | Specifies a file where to bundle npm packages. Default value for production: `vendor/assets/javascripts/npm-rails/production/npm-dependencies.js`. Default value for other environments: `vendor/assets/javascripts/npm-rails/development/npm-dependencies.js`                               |
+| `config.npm.browserify_options`           | Sets options for browserify command. See all available options in [Browserify documentation](https://github.com/substack/node-browserify#usage) |
+| `config.npm.run_berofe_assets_precompile` | If set to `true` then run `rake npm:install` before assets precompilation. Default value: `false` |
 
 ## How it works
 
-The generator creates `npm_packages` file. This file contains a list of packages. Rake uses NPM to install the packages and Browserify to bundle them and output the bundled results to `vendor/assets/javascripts/npm-dependencies.js`, which are then loaded by sprockets. These generated bundle file have been added to your `.gitignore` for your convenience. All packages attached to `window`.
-
+The generator creates `npm_packages` file. This file contains a list of packages. Rake uses NPM to install the packages and Browserify to bundle them. Browserify output the bundled results to `output_file`(see configuration options), which are then loaded by sprockets. All packages attached to `window` by `build_name`, which by default is the camelize package name.
 
 

data/lib/generators/npm_rails/initialize_generator.rb

@@ -12,7 +12,6 @@ module NpmRails
         <<-EOF.strip_heredoc
         # Added by npm-rails
         /node_modules
-        /vendor/assets/javascripts/npm-dependencies.js
         EOF
       end
     end

data/lib/npm/rails.rb

@@ -5,3 +5,4 @@ require 'npm/rails/package_manager'
 require 'npm/rails/errors'
 require 'npm/rails/package_file_parser'
 require 'npm/rails/package'
+require 'npm/rails/task_helpers'

data/lib/npm/rails/package.rb

@@ -25,7 +25,7 @@ module Npm
       private
 
       def create_build_name_from_name
-        @name.gsub("-", "_").camelize
+        @name.tr("-", "_").camelize
       end
     end
   end

data/lib/npm/rails/package_file_parser.rb

@@ -24,7 +24,7 @@ module Npm
 
       def npm(package_name, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
-        options.merge!(development: @development)
+        options = { development: @development }.merge(options)
         version = args.empty? ? "latest" : args.pop
 
         @packages << Npm::Rails::Package.new(package_name, version, options)

data/lib/npm/rails/railtie.rb

@@ -6,7 +6,18 @@ module Npm
     class Railtie < ::Rails::Railtie
       config.npm = ActiveSupport::OrderedOptions.new
       config.npm.package_file = "npm_packages"
-      config.npm.output_file = "vendor/assets/javascripts/npm-dependencies.js"
+      config.npm.run_before_assets_precompile = false
+
+      output_path = "vendor/assets/javascripts/npm-rails"
+      if ::Rails.env.production?
+        config.npm.output_path = output_path << "/production"
+      else
+        config.npm.output_path = output_path << "/development"
+      end
+
+      initializer "npm_rails.add_assets_path", after: :engines_blank_point, group: :all do |app|
+        app.config.assets.paths << app.config.npm.output_path
+      end
 
       rake_tasks do
         load "tasks/npm.rake"

data/lib/npm/rails/task_helpers.rb

@@ -0,0 +1,29 @@
+require "mkmf"
+require 'fileutils'
+
+module Npm
+  module Rails
+    module TaskHelpers
+
+      def self.find_browserify(npm_directory)
+        browserify = find_executable0("browserify") ||
+          find_executable0("#{ npm_directory }/.bin/browserify")
+
+        if browserify.nil?
+          raise Npm::Rails::BrowserifyNotFound, "Browserify not found! You can install Browserify using npm: npm install browserify -g"
+        else
+          browserify
+        end
+      end
+
+      def self.create_file(path, file)
+        unless File.directory?(path)
+          FileUtils.mkdir_p(path)
+        end
+
+        file_path = path.join(file)
+        FileUtils.touch(file_path)
+      end
+    end
+  end
+end

data/lib/npm/rails/version.rb

@@ -1,5 +1,5 @@
 module Npm
   module Rails
-    VERSION = "0.1.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/tasks/npm.rake

@@ -1,29 +1,24 @@
 require 'fileutils'
-require "mkmf"
 
 namespace :npm do
   desc "Install npm packages"
   task :install do
     package_file = ::Rails.configuration.npm.package_file
-    output_file_path = ::Rails.root.join(::Rails.configuration.npm.output_file)
     browserify_options = ::Rails.configuration.npm.browserify_options
+    output_path = ::Rails.root.join(::Rails.configuration.npm.output_path)
+    output_file = "npm-dependencies.js"
+    output_file_path = output_path.join(output_file)
+
+    Npm::Rails::TaskHelpers.create_file(output_path, output_file) unless File.exist?(output_file_path)
 
     Npm::Rails::PackageBundler.bundle(::Rails.root, package_file, ::Rails.env) do |packages, bundle_file_path|
-      FileUtils.touch(output_file_path) unless File.exist?(output_file_path)
       sh "cd #{ ::Rails.root }"
       sh "npm install --loglevel error #{ packages }"
 
-      browserify = find_executable0("browserify") ||
-        find_executable0("#{ ::Rails.root }/node_modules/.bin/browserify")
-
-      if browserify.nil?
-        raise Npm::Rails::BrowserifyNotFound, "Browserify not found! You can install Browserify using npm: npm install browserify -g"
-      end
-
+      browserify = Npm::Rails::TaskHelpers.find_browserify(::Rails.root.join("node_modules"))
+      browserify_command = "#{ browserify } #{ browserify_options } #{ bundle_file_path } > #{ output_file_path }"
       if Rails.env.production?
-        browserify_command = "NODE_ENV=production #{ browserify } #{ browserify_options } #{ bundle_file_path } > #{ output_file_path }"
-      else
-        browserify_command = "#{ browserify } #{ browserify_options } #{ bundle_file_path } > #{ output_file_path }"
+        browserify_command = "NODE_ENV=production #{ browserify_command }"
       end
 
       sh browserify_command
@@ -31,4 +26,6 @@ namespace :npm do
   end
 end
 
-task "assets:precompile" => ["npm:install"]
+if ::Rails.configuration.npm.run_before_assets_precompile
+  task "assets:precompile" => ["npm:install"]
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: npm-rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Stepan Lusnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - lib/npm/rails/package_file_parser.rb
 - lib/npm/rails/package_manager.rb
 - lib/npm/rails/railtie.rb
+- lib/npm/rails/task_helpers.rb
 - lib/npm/rails/version.rb
 - lib/tasks/npm.rake
 homepage: https://github.com/endenwer/npm-rails