npm-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70d1fb460960933460cc23ca9ee750dab26586b1
+  data.tar.gz: 11d347004b9b980843bd29938d993305bc53a408
+SHA512:
+  metadata.gz: 336cc59ff6029d3cdb0964bf85fd0502689b2246f0e12a6f7277624c542e4a3ddae66c7f0adbdd9f6aa47fb2c3ccc4b0a846f0ff9fcb42916328e4b8584b7236
+  data.tar.gz: 0c04248b38f8b1acd31baea9a12ac3b05b60b230ccd48a258767e01883bdd09afd257f17034f252c7fa8c014e019d53fe1058db341317b770517270c94f1946b

data/README.md

@@ -0,0 +1,71 @@
+# npm-rails
+
+NPM support for Rails projects. It let you use Bundler-like DSL and rake tasks
+for including npm packages. This gem based on Browserify for bundling packages
+and resolve dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'npm-rails'
+```
+
+Then run:
+
+    rails g npm_rails:initialize
+
+And require `npm-dependencies.js`:
+
+    //=require npm-dependencies
+
+## Usage
+
+1. Add a package to `npm_packages` file
+2. Run `rake npm:install`
+3. Use the package in your javascript code by calling the camelize name
+or `build_name` if you set it
+
+**Example `npm_packages` file**
+
+```ruby
+# call 'React' in your js code to use it
+npm 'react'
+
+# Set version
+npm 'redux', '3.3.1'
+
+# Set build_name to a package.
+# Call '_' to get Underscore
+npm 'underscore', build_name: '_'
+
+# You can add a package for development
+npm 'jasmine', development: true
+
+# Or in block
+development do
+  npm 'jasmine'
+end
+
+# Install a package but do not require it
+npm 'browserify', require: false
+```
+
+## Configuration Options
+
+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) |
+
+## 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`.
+
+
+

data/lib/generators/npm_rails/initialize_generator.rb

@@ -0,0 +1,20 @@
+module NpmRails
+  class InitializeGenerator < Rails::Generators::Base
+    desc 'Adds a boilerplate package_file to the root of Rails project'
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_package_file
+      copy_file 'npm_packages', 'npm_packages'
+    end
+
+    def add_to_gitignore
+      append_to_file ".gitignore" do
+        <<-EOF.strip_heredoc
+        # Added by npm-rails
+        /node_modules
+        /vendor/assets/javascripts/npm-dependencies.js
+        EOF
+      end
+    end
+  end
+end

data/lib/generators/npm_rails/templates/npm_packages

@@ -0,0 +1,5 @@
+# Browserify is required.
+# You can install it globally and delete from here.
+npm 'browserify', require: false, development: true
+
+# Add some npm packages

data/lib/npm-rails.rb

@@ -0,0 +1 @@
+require 'npm/rails'

data/lib/npm/rails.rb

@@ -0,0 +1,7 @@
+require 'npm/rails/version'
+require 'npm/rails/railtie'
+require 'npm/rails/package_bundler'
+require 'npm/rails/package_manager'
+require 'npm/rails/errors'
+require 'npm/rails/package_file_parser'
+require 'npm/rails/package'

data/lib/npm/rails/errors.rb

@@ -0,0 +1,6 @@
+module Npm
+  module Rails
+    class BrowserifyNotFound < StandardError ; end
+    class PackageFileNotFound < StandardError ; end
+  end
+end

data/lib/npm/rails/package.rb

@@ -0,0 +1,32 @@
+module Npm
+  module Rails
+    class Package
+
+      attr_reader :name
+      attr_reader :version
+      attr_reader :build_name
+
+      def initialize(name, version, options = {})
+        @name = name
+        @version = version
+        @development = options.fetch(:development, false)
+        @build_name = options.fetch(:build_name, create_build_name_from_name)
+        @require = options.fetch(:require, true)
+      end
+
+      def development?
+        @development
+      end
+
+      def should_require?
+        @require
+      end
+
+      private
+
+      def create_build_name_from_name
+        @name.gsub("-", "_").camelize
+      end
+    end
+  end
+end

data/lib/npm/rails/package_bundler.rb

@@ -0,0 +1,32 @@
+
+module Npm
+  module Rails
+    class PackageBundler
+
+      def self.bundle(root_path, package_file, env, &block)
+        new.bundle(root_path, package_file, env, &block)
+      end
+
+      def bundle(root_path, package_file, env, &block)
+        @root_path = root_path
+        @package_file = package_file
+        @env = env
+
+        if File.exist?("#{ root_path }/#{ package_file }")
+          bundle_file_path = package_manager.write_bundle_file
+          if block_given?
+            yield package_manager.to_npm_format, bundle_file_path
+          end
+        else
+          raise PackageFileNotFound, "#{ package_file } not found! Make sure you have it at the root of your project"
+        end
+      end
+
+      private
+
+      def package_manager
+        @package_manager ||= PackageManager.build(@root_path, @package_file, @env)
+      end
+    end
+  end
+end

data/lib/npm/rails/package_file_parser.rb

@@ -0,0 +1,40 @@
+module Npm
+  module Rails
+    class PackageFileParser
+
+      attr_reader :packages
+
+      def self.parse(package_file_path)
+        parser = new
+        parser.parse(package_file_path)
+        parser.packages
+      end
+
+      def initialize
+        @packages = []
+        @development = false
+      end
+
+      def parse(package_file_path)
+       @package_file = File.open(package_file_path, "r", &:read)
+       eval(@package_file)
+      end
+
+      private
+
+      def npm(package_name, *args)
+        options = args.last.is_a?(Hash) ? args.pop : {}
+        options.merge!(development: @development)
+        version = args.empty? ? "latest" : args.pop
+
+        @packages << Npm::Rails::Package.new(package_name, version, options)
+      end
+
+      def development
+        @development = true
+        yield
+        @development = false
+      end
+    end
+  end
+end

data/lib/npm/rails/package_manager.rb

@@ -0,0 +1,55 @@
+module Npm
+  module Rails
+    class PackageManager
+
+      def self.build(root_path, package_file, env)
+        package_file_path = "#{ root_path }/#{ package_file }"
+        packages = PackageFileParser.parse(package_file_path)
+        new(packages, root_path, env)
+      end
+
+      def initialize(packages, root_path, env)
+        @packages = packages
+        @root_path = root_path
+        @env = env
+      end
+
+      def write_bundle_file
+        bundle_file_path = "#{ @root_path }/tmp/npm-rails/bundle.js"
+        Dir.mkdir("tmp/npm-rails") unless File.exist?("tmp/npm-rails")
+        File.open(bundle_file_path, "w") do |file|
+          packages_for_bundle_file.each do |package|
+            file.write "window.#{ package.build_name } = require('#{ package.name }')\n"
+          end
+        end
+        bundle_file_path
+      end
+
+      # Return string of packages for 'npm install' command
+      def to_npm_format
+        @packages.inject "" do |string, package|
+          # do not add development packages in production environment
+          if (@env.production? and package.development?)
+            string
+          else
+            string << "#{ package.name }@\"#{ package.version }\" "
+          end
+        end
+      end
+
+      private
+
+      def packages_for_bundle_file
+        if @env.production?
+          @packages.select do |package|
+            package.should_require? && !package.development?
+          end
+        else
+          @packages.select do |package|
+            package.should_require?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/npm/rails/railtie.rb

@@ -0,0 +1,16 @@
+require "rails"
+require "rails/railtie"
+
+module Npm
+  module Rails
+    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"
+
+      rake_tasks do
+        load "tasks/npm.rake"
+      end
+    end
+  end
+end

data/lib/npm/rails/version.rb

@@ -0,0 +1,5 @@
+module Npm
+  module Rails
+    VERSION = "0.1.0"
+  end
+end

data/lib/tasks/npm.rake

@@ -0,0 +1,34 @@
+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
+
+    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
+
+      if Rails.env.production?
+        browserify_comamnd = "NODE_ENV=production #{ browserify } #{ browserify_options } #{ bundle_file_path } > #{ output_file_path }"
+      else
+        browserify_command = "#{ browserify } #{ browserify_options } #{ bundle_file_path } > #{ output_file_path }"
+      end
+
+      sh browserify_command
+    end
+  end
+end
+
+task "assets:precompile" => ["npm:install"]

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: npm-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stepan Lusnikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: Use NPM packages in you Ruby on Rails application
+email:
+- endenwer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/npm_rails/initialize_generator.rb
+- lib/generators/npm_rails/templates/npm_packages
+- lib/npm-rails.rb
+- lib/npm/rails.rb
+- lib/npm/rails/errors.rb
+- lib/npm/rails/package.rb
+- lib/npm/rails/package_bundler.rb
+- lib/npm/rails/package_file_parser.rb
+- lib/npm/rails/package_manager.rb
+- lib/npm/rails/railtie.rb
+- lib/npm/rails/version.rb
+- lib/tasks/npm.rake
+homepage: https://github.com/endenwer/npm-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.4.6
+signing_key: 
+specification_version: 4
+summary: NPM & Ruby on Rails integration
+test_files: []