webpackrails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e569323b6234dc24370f3b4dc766f74727fd5078
+  data.tar.gz: b1744dd6544f0a0fdb4019a353bc4f54f6fafc92
+SHA512:
+  metadata.gz: 820dcdd02d7d11b75498a155ca11a392294517cdc8a258b5c0fafb6d1c2eb073af14454bb4beb54b91bdfd5040491074a291b3b5e84d1c33e4121e4d28f9374a
+  data.tar.gz: 56ffbbd95569dc345987f14a3116029f8cc66ba76600cbbc014c83828073d54f7a145e8d1a1a250b10631d5412a780f54cc245769a0a1f05d7ad33fb835a03a2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*/.DS_Store

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://ruby.taobao.org/'
+
+# Specify your gem's dependencies in webpack-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 towry
+
+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

@@ -0,0 +1,59 @@
+# WebpackRails
+
+This gem make [Webpack](http://webpack.github.io) works with [Rails](http://github.com/rails/rails).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'webpack-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install webpack-rails
+
+Create `package.json` in your Rails root:
+
+```json
+{
+  "name": "app",
+  "dependencies": {
+    "webpack": "^1.11.0"
+  }
+}
+```
+
+Run `npm i` to install the dependencies.
+
+## Usage
+
+Make sure you have a `webpack.config.js` file in your Rails root dir, or specific your
+webpack config file within `application.rb`
+
+`config.webpack_rails.config_file = "path_to_the_config_file"`
+
+### Config
+
+See [source](https://raw.githubusercontent.com/webpack-rails/webpack-rails/master/lib/webpack-rails/railtie.rb)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/webpack-rails/webpack-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "webpack-rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/webpack-rails.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+require 'sprockets'
+
+require 'webpack-rails/webpack_processor'
+require 'webpack-rails/webpack_logger'
+require 'webpack-rails/webpack_error'
+require 'webpack-rails/railtie'
+require 'webpack-rails/version'
+
+module WebpackRails
+end

data/lib/webpack-rails/railtie.rb

@@ -0,0 +1,23 @@
+# encoding: utf-8
+
+module WebpackRails
+  class Railtie < Rails::Engine
+    config.webpack_rails = ActiveSupport::OrderedOptions.new 
+
+    # Webpack config file location
+    config.webpack_rails.config_file = ''
+
+    # Process every file?
+    config.webpack_rails.force = false
+
+    # paths to be parse
+    config.webpack_rails.paths = [lambda { |p| p.start_with?(Rails.root.join("app").to_s) },
+                                  lambda { |p| p.start_with?(Rails.root.join('node_modules').to_s) }]
+
+    config.webpack_rails.node_bin = "node_modules/.bin/"
+
+    initializer :setup_webpack do |app|
+      app.assets.register_postprocessor "application/javascript", WebapckProcessor
+    end
+  end
+end

data/lib/webpack-rails/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module WebpackRails
+  VERSION = "0.1.0"
+end

data/lib/webpack-rails/webpack_error.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+module WebpackRails
+  class WebpackError < RuntimeError
+  end
+end

data/lib/webpack-rails/webpack_logger.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+module WebpackRails
+  module Logger
+    def self.log(message)
+      Rails.logger.debug message
+    end
+  end
+end

data/lib/webpack-rails/webpack_processor.rb

@@ -0,0 +1,126 @@
+# encoding: utf-8
+
+require 'tilt'
+require 'open3'
+require 'tempfile'
+require 'fileutils'
+require 'shellwords'
+
+module WebpackRails
+  class WebapckProcessor < Tilt::Template
+    attr_accessor :config
+
+    def initialize(template)
+      self.config = Rails.application.config.webpack_rails
+      super(template)
+    end
+
+    def prepare
+      ensure_tmp_dir_exists!
+      ensure_commands_exists!
+      ensure_webpack_config_exists!
+    end
+
+    def evaluate(context, locals, &block)
+      # return if there is nothing to do
+      return data unless should_webpack?
+
+      run_webpack(context.logical_path)
+    end
+
+    private 
+
+    # Set the temp path
+    def tmp_path
+      @tmp_path ||= Rails.root.join('tmp', 'cache', 'webpack-rails').freeze
+    end
+
+    # return the webpack command path
+    def webpack_cmd
+      @webpack_cmd ||= rails_path(config.node_bin, "webpack").freeze
+    end
+
+    # make sure the temp dir exists
+    def ensure_tmp_dir_exists!
+      FileUtils.mkdir_p(rails_path(tmp_path))
+    end
+
+    # make sure the webpack config file exists
+    def ensure_webpack_config_exists!
+      @config_file ||= config.config_file
+
+      if @config_file.blank?
+        @config_file = Rails.root.join('webpack.config.js').freeze
+      end
+
+      if !File.exists?(@config_file)
+        raise WebpackRails::WebpackError.new("Webpack config file not found.")
+      end
+    end
+
+    # make sure the `webpack` command exists
+    def ensure_commands_exists!
+      error = ->(cmd) { "Unable to run #{cmd}. Ensure you have installed it with npm." }
+
+      if !File.exists?(rails_path(webpack_cmd))
+        raise WebpackRails::WebpackError.new(error.call(webpack_cmd))
+      end
+    end
+
+    # should we use webpack to parse that file?
+    def should_webpack?
+      config.force || (in_path? && !webpacked? && commonjs_module?)
+    end
+
+    def in_path?
+      config.paths.any? { |p| p === file  }
+    end
+
+    # Need check.
+    def webpacked?
+      data.to_s.include?("__webpack_require__")
+    end
+    
+    def commonjs_module?
+      data.to_s.include?("module.exports") || data.present? && data.to_s.include?("require")
+    end
+
+    def asset_paths
+      @asset_paths ||= Rails.application.config.assets.paths.collect { |p| p.to_s }.join(":") || ""
+    end
+
+    def env
+      env_hash = {}
+      env_hash["NODE_PATH"] = asset_paths unless uses_exorcist
+      env_hash["NODE_ENV"] = config.node_env || Rails.env
+      env_hash
+    end
+
+    def uses_exorcist
+      false 
+    end
+
+    def run_webpack(logical_path=nil)
+      command_options = "--config #{@config_file} #{logical_path} --output-filename"
+      output_file = Tempfile.new("output", rails_path(tmp_path))
+      command_options << " #{output_file.path.inspect}"
+
+      command = "#{Shellwords.escape(webpack_cmd)} #{command_options}"
+
+      base_directory = File.dirname(file)
+
+      Logger::log "Webpack: #{command}"
+      stdout, stderr, status = Open3.capture3(env, command, stdin_data: data, chdir: base_directory)
+
+      if !status.success?
+        raise WebpackRails::WebpackError.new("Error while running `#{command}`:\n\n#{stderr}")
+      end
+
+      output_file.read
+    end
+
+    def rails_path(*paths)
+      Rails.root.join(*paths).to_s
+    end
+  end
+end

data/webpack-rails.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'webpack-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "webpackrails"
+  spec.version       = WebpackRails::VERSION
+  spec.authors       = ["towry"]
+  spec.email         = ["tovvry@gmail.com"]
+
+  spec.summary       = %q{Make Webpack work with Rails for you}
+  spec.description   = %q{Webpack + Rails ≠ CommonJS Heaven}
+  spec.homepage      = "https://github.com/webpack-rails/webpack-rails"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(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", "~> 3.2", "<= 5.0.0"
+  spec.add_runtime_dependency "sprockets", "~> 2.0"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.3"
+  spec.add_development_dependency "rails"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "tilt"
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: webpackrails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- towry
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: sprockets
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  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: pry
+  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: tilt
+  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'
+description: Webpack + Rails ≠ CommonJS Heaven
+email:
+- tovvry@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/webpack-rails.rb
+- lib/webpack-rails/railtie.rb
+- lib/webpack-rails/version.rb
+- lib/webpack-rails/webpack_error.rb
+- lib/webpack-rails/webpack_logger.rb
+- lib/webpack-rails/webpack_processor.rb
+- webpack-rails.gemspec
+homepage: https://github.com/webpack-rails/webpack-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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: Make Webpack work with Rails for you
+test_files: []