webpacker 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b67ae76eb6b5825e3147654c956f617527bb5f1
+  data.tar.gz: a06d84b86eac617349551713e00c8f3bf42481b2
+SHA512:
+  metadata.gz: 041403069acab101703d356979b189b4635151818ff5c1fd06d22def7928fb1d9726c4e1f25e57dbfa8ca21045fb2dcc2592ec2a79ee2efce01c958668ea2dbe
+  data.tar.gz: f05bcb4779c5b9dad44fa599d837ce9b4114ce40ba4f62c6422791d300e265e8a2d39bcfdedc80faf616220b7627842ce7dc8978194cb2913469622d903cb0a0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 David Heinemeier Hansson, Basecamp
+
+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,18 @@
+# Webpacker
+
+Webpacker makes it easy to use the JavaScript preprocessor and bundler Webpack
+to manage application-like JavaScript in Rails. It coexists with the asset pipeline,
+as the purpose is only to use Webpack for app-like JavaScript, not images, css, or
+even JavaScript Sprinkles.
+
+It's designed to work with Rails 5.1+ and makes use of the Yarn dependency management
+that's been made default from that version forward. You can either make use of Webpacker
+during setup of a new application with --webpack or you can uncomment the gem and run
+`bin/rails webpacker:install` in an existing application.
+
+When Webpacker has been installed...
+
+FIXME: Write the rest...
+
+## License
+Webpacker is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/lib/install/bin/webpack-watcher.tt

@@ -0,0 +1,7 @@
+<%= shebang %>
+
+BIN_PATH = File.expand_path('.', __dir__)
+
+Dir.chdir(BIN_PATH) do
+  exec "./webpack --watch --progress --color #{ARGV.join(" ")}"
+end

data/lib/install/bin/webpack.tt

@@ -0,0 +1,15 @@
+<%= shebang %>
+
+RAILS_ENV   = ENV['RAILS_ENV'] || 'development'
+WEBPACK_ENV = ENV['WEBPACK_ENV'] || RAILS_ENV
+
+APP_PATH    = File.expand_path('../', __dir__)
+VENDOR_PATH = File.expand_path('../vendor', __dir__)
+
+SET_NODE_PATH  = "NODE_PATH=#{VENDOR_PATH}/node_modules"
+WEBPACK_BIN    = "./node_modules/webpack/bin/webpack.js"
+WEBPACK_CONFIG = "#{APP_PATH}/config/webpack/#{WEBPACK_ENV}.js"
+
+Dir.chdir(VENDOR_PATH) do
+  exec "#{SET_NODE_PATH} #{WEBPACK_BIN} --config #{WEBPACK_CONFIG} #{ARGV.join(" ")}"
+end

data/lib/install/config/development.js

@@ -0,0 +1,14 @@
+// Note: You must restart bin/webpack-watcher for changes to take effect
+
+var path    = require('path')
+var webpack = require('webpack')
+var _       = require('lodash')
+
+var config = module.exports = require('./shared.js')
+
+config = _.merge(config, {
+  debug: true,
+  displayErrorDetails: true,
+  outputPathinfo: true,
+  devtool: 'sourcemap',
+})

data/lib/install/config/production.js

@@ -0,0 +1,14 @@
+// Note: You must restart bin/webpack-watcher for changes to take effect
+
+var path    = require('path')
+var webpack = require('webpack')
+var _       = require('lodash')
+
+var config = module.exports = require('./shared.js');
+
+config.output = _.merge(config.output, { filename: '[name]-[hash].js' })
+
+config.plugins.push(
+  new webpack.optimize.UglifyJsPlugin(),
+  new webpack.optimize.OccurenceOrderPlugin()
+)

data/lib/install/config/shared.js

@@ -0,0 +1,31 @@
+// Note: You must restart bin/webpack-watcher for changes to take effect
+
+var path = require('path')
+var glob = require('glob')
+var _    = require('lodash')
+
+module.exports = {
+  entry: _.keyBy(glob.sync('../app/javascript/packs/*.js'), function(entry) { return path.basename(entry, '.js') }),
+
+  output: { filename: '[name].js', path: '../public/packs' },
+
+  module: {
+    loaders: [
+      { test: /\.coffee$/, loader: "coffee-loader" }
+    ]
+  },
+
+  plugins: [],
+
+  resolve: {
+    extensions: [ '', '.js', '.coffee' ],
+    root: [
+      path.resolve('../app/javascript'),
+      path.resolve('../vendor/node_modules')
+    ]
+  },
+
+  resolveLoader: {
+    modulesDirectories: [ path.resolve('../vendor/node_modules') ]
+  }
+}

data/lib/install/javascript/packs/application.js

@@ -0,0 +1 @@
+// var React = require('react')

data/lib/install/template.rb

@@ -0,0 +1,15 @@
+INSTALL_PATH = File.dirname(__FILE__)
+
+directory "#{INSTALL_PATH}/javascript", 'app/javascript'
+
+directory "#{INSTALL_PATH}/bin", 'bin'
+chmod 'bin', 0755 & ~File.umask, verbose: false
+
+directory "#{INSTALL_PATH}/config", 'config/webpack'
+
+run './bin/yarn add webpack lodash'
+
+environment \
+  "# Make javascript_pack_tag lookup digest hash to enable long-term caching\n" +
+  "  config.x.webpacker[:digesting] = true\n",
+  env: 'production'

data/lib/tasks/webpacker.rake

@@ -0,0 +1,22 @@
+PACKS_PATH        = Rails.root.join('public/packs')
+PACK_DIGESTS_PATH = PACKS_PATH.join('digests.json')
+
+WEBPACKER_APP_TEMPLATE_PATH = File.expand_path('../install/template.rb', File.dirname(__FILE__))
+
+namespace :webpacker do
+  desc "compile javascript packs using webpack for production with digests"
+  task :compile do
+    webpack_digests_json = JSON.parse(`WEBPACK_ENV=production ./bin/webpack --json`)['assetsByChunkName'].to_json
+
+    FileUtils.mkdir_p(PACKS_PATH)
+    File.open(PACK_DIGESTS_PATH, 'w+') { |file| file.write webpack_digests_json }
+
+    puts "Compiled digests for all packs in #{PACK_DIGESTS_PATH}: "
+    puts webpack_digests_json
+  end
+
+  desc "install webpacker in this application"
+  task :install do
+    exec "./bin/rails app:template LOCATION=#{WEBPACKER_APP_TEMPLATE_PATH}"
+  end
+end

data/lib/webpacker.rb

@@ -0,0 +1,4 @@
+module Webpacker
+end
+
+require 'webpacker/railtie' if defined?(Rails)

data/lib/webpacker/digests.rb

@@ -0,0 +1,36 @@
+class Webpacker::Digests
+  class_attribute :instance
+
+  class << self
+    def load(path)
+      self.instance = new(path)
+    end
+
+    def lookup(name)
+      if instance
+        instance.lookup(name)
+      else
+        raise "Webpacker::Digests.load(path) must be called first"
+      end
+    end
+  end
+
+  def initialize(path)
+    @path = path
+    load
+  end
+
+  def lookup(name)
+    @digests[name.to_s]
+  end
+
+  private
+    def load
+      begin
+        @digests = JSON.parse(File.read(@path))
+      rescue Errno::ENOENT
+        Rails.logger.error \
+          "Missing digests file at #{@path}! You must first compile the packs via rails webpacker:compile"
+      end
+    end
+end

data/lib/webpacker/helper.rb

@@ -0,0 +1,7 @@
+require 'webpacker/source'
+
+module Webpacker::Helper
+  def javascript_pack_tag(name, **options)
+    tag.script src: Webpacker::Source.new(name).path, **options
+  end
+end

data/lib/webpacker/railtie.rb

@@ -0,0 +1,18 @@
+require 'rails/railtie'
+
+require 'webpacker/helper'
+require 'webpacker/digests'
+
+class Webpacker::Engine < ::Rails::Engine
+  initializer :webpacker do
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper Webpacker::Helper
+    end
+
+    if Rails.configuration.x.webpacker[:digesting]
+      Webpacker::Digests.load \
+        Rails.application.config.x.webpacker[:digests_path] ||
+          Rails.root.join('public/packs/digests.json')
+    end
+  end
+end

data/lib/webpacker/source.rb

@@ -0,0 +1,28 @@
+class Webpacker::Source
+  def initialize(name)
+    @name = name
+  end
+
+  def path
+    if digesting?
+      "/packs/#{digested_filename}"
+    else
+      "/packs/#{filename}"
+    end
+  end
+
+  private
+    attr_accessor :name
+
+    def digesting?
+      Rails.configuration.x.webpacker[:digesting]
+    end  
+
+    def digested_filename
+      Webpacker::Digests.lookup(name)
+    end
+
+    def filename
+      "#{name}.js"
+    end
+end

data/webpacker.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name     = 'webpacker'
+  s.version  = '0.1'
+  s.authors  = 'David Heinemeier Hansson'
+  s.email    = 'david@basecamp.com'
+  s.summary  = 'Use Webpack to manage app-like JavaScript modules in Rails'
+  s.homepage = 'https://github.com/rails/webpacker'
+  s.license  = 'MIT'
+
+  s.required_ruby_version = '>= 1.9.3'
+
+  s.add_dependency 'activesupport', '>= 3.0.0', '< 5.1'
+  s.add_dependency 'multi_json',    '~> 1.2'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: webpacker
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- David Heinemeier Hansson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: 
+email: david@basecamp.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- lib/install/bin/webpack-watcher.tt
+- lib/install/bin/webpack.tt
+- lib/install/config/development.js
+- lib/install/config/production.js
+- lib/install/config/shared.js
+- lib/install/javascript/packs/application.js
+- lib/install/template.rb
+- lib/tasks/webpacker.rake
+- lib/webpacker.rb
+- lib/webpacker/digests.rb
+- lib/webpacker/helper.rb
+- lib/webpacker/railtie.rb
+- lib/webpacker/source.rb
+- webpacker.gemspec
+homepage: https://github.com/rails/webpacker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+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: Use Webpack to manage app-like JavaScript modules in Rails
+test_files: []