webpack-rails-react 0.9.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a11fdc7f90667286b9ead38db9f12d238b2f9122
-  data.tar.gz: c6940d59b10f4f1578a762b62f33440524ebce2d
+  metadata.gz: d23277a4284c9caef4383ca8d2bda3752ff30011
+  data.tar.gz: afd4a1123d9adebbbc20f78049983e7a9a73c487
 SHA512:
-  metadata.gz: a5e9a18c7cc297c191ee8ee46fd28fbe8bd595ee609826bee233206bbcf69c60cbdb9122777e073adb386c4f314071be27eb27502c3c3fe8d6d6fc36e23e6212
-  data.tar.gz: 84b15d55ad4aa77194f9fb819afaf5073076a056c33a167b8fcb5e00b68443be3c2a55142523a681a639be8d938b304d8a9d3ab068f7010f8ebc8a78e08e91c4
+  metadata.gz: b306c9405d3358b76914c6f139f0314c48b30ef031797ac186e6c354c67a1deab5caa39916bad5df86ec0e69da87206ecc6aba4d8926a743a10b8a0141ade174
+  data.tar.gz: b5c6a79127db665d8f381c3a22155d244507a3d6690dc031ec88e8ebadddef654cbb343687f39b3ae45789179db7b4e2de257bbd4b1ee1ea3e4b44deb560179e

data/README.md

@@ -1,28 +1,22 @@
-[![Build Status](https://travis-ci.org/mipearson/webpack-rails.svg?branch=master)](https://travis-ci.org/mipearson/webpack-rails) [![Gem Version](https://badge.fury.io/rb/webpack-rails.svg)](http://badge.fury.io/rb/webpack-rails)
+# webpack-rails-react
 
-# webpack-rails
+**webpack-rails-react** gives you tools to integrate Webpack and React in to an existing Ruby on Rails application.
 
-**webpack-rails** gives you tools to integrate Webpack in to an existing Ruby on Rails application.
-
-It will happily co-exist with sprockets but does not use it for production fingerprinting or asset serving. **webpack-rails** is designed with the assumption that if you're using Webpack you treat Javascript as a first-class citizen. This means that you control the webpack config, package.json, and use npm to install Webpack & its plugins.
+It will happily co-exist with sprockets but does not use it for production fingerprinting or asset serving. **webpack-rails-react** is designed with the assumption that if you're using Webpack you treat Javascript as a first-class citizen. This means that you control the webpack config, package.json, and use npm to install Webpack & its plugins.
 
 In development mode [webpack-dev-server](http://webpack.github.io/docs/webpack-dev-server.html) is used to serve webpacked entry points and offer hot module reloading. In production entry points are built in to `public/webpack`. **webpack-rails** uses [stats-webpack-plugin](https://www.npmjs.com/package/stats-webpack-plugin) to translate entry points in to asset paths.
 
-It was designed for use at [Marketplacer](http://www.marketplacer.com) to assist us in migrating our Javascript (and possibly our SCSS) off of Sprockets. It first saw production use in June 2015.
-
-Our examples show **webpack-rails** co-existing with sprockets (as that's how environment works), but sprockets is not used or required for development or production use of this gem.
+It was forked from the [Marketplacer](http://www.marketplacer.com) repo: (https://github.com/mipearson/webpack-rails) and support for React / Babel / ES6 was added.
 
 This gem has been tested against Rails 4.2 and Ruby 2.2. Earlier versions of Rails (>= 3.2) and Ruby (>= 1.9) may work, but we haven't tested them.
 
-## Using webpack-rails
-
-**We have a demo application: [webpack-rails-demo](https://github.com/mipearson/webpack-rails-demo)**
+## Using webpack-rails-react
 
 ### Installation
 
-  1. Add `webpack-rails` to your gemfile
+  1. Add `webpack-rails-react` to your gemfile
   1. Run `bundle install` to install the gem
-  1. Run `bundle exec rails generate webpack_rails:install` to copy across example files
+  1. Run `bundle exec rails generate webpack_rails_react:install` to copy across example files
   1. Run `foreman start` to start `webpack-dev-server` and `rails server` at the same time
   1. Add the webpack entry point to your layout (see next section)
   1. Edit `client/application.js` and write some code
@@ -46,14 +40,6 @@ If you're using the webpack dev server's live reload feature (not the React hot
 <script src="http://localhost:3808/webpack-dev-server.js"></script>
 ```
 
-### How it works
-
-Have a look at the files in the `examples` directory. Of note:
-
-  * We use [foreman](https://github.com/ddollar/foreman) and a `Procfile` to run our rails server & the webpack dev server in development at the same time
-  * The webpack and gem configuration must be in sync - look at our railtie for configuration options
-  * We require that **stats-webpack-plugin** is loaded to automatically generate a production manifest & resolve paths during development
-
 ### Configuration Defaults
 
   * Webpack configuration lives in `config/webpack.config.js`
@@ -96,6 +82,5 @@ Please ensure that pull requests pass both rubocop & rspec. New functionality sh
 
 ## Acknowledgements
 
-* Len Garvey for his [webpack-rails](https://github.com/lengarvey/webpack-rails) gem which inspired this implementation
-* Sebastian Porto for [Rails with Webpack](https://reinteractive.net/posts/213-rails-with-webpack-why-and-how)
-* Clark Dave for [How to use Webpack with Rails](http://clarkdave.net/2015/01/how-to-use-webpack-with-rails/)
+* mipearson for his [webpack-rails](https://github.com/mipearson/webpack-rails) gem which inspired this implementation
+* David Jungst for his fork of [webpack-rails](https://github.com/wdjungst/webpack-rails-react) and idea / implementation to add React / Babel / ES6 boilerplate.

data/example/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "webpack-rails-react",
+  "name": "webpack-rails",
   "version": "0.0.1",
   "license": "MIT",
   "dependencies": {

data/lib/generators/{webpack_rails → webpack_rails_react}/install_generator.rb

@@ -1,4 +1,4 @@
-module WebpackRails
+module WebpackRailsReact
   # :nodoc:
   class InstallGenerator < ::Rails::Generators::Base
     source_root File.expand_path("../../../../example", __FILE__)
@@ -31,7 +31,7 @@ module WebpackRails
 
         ReactDOM.render(
           <App />,
-          Document.findElementById('app')
+          document.getElementById('app')
         )
         EOF
       end

data/lib/webpack/rails.rb

@@ -1,2 +1,2 @@
-require 'webpack/rails/version'
-require 'webpack/railtie' if defined? ::Rails::Railtie
+require 'webpack/rails/react/version'
+require 'webpack/railtie' if defined? ::Rails::Railtie

data/lib/webpack/rails/react/helper.rb

@@ -0,0 +1,36 @@
+require 'action_view'
+require 'webpack/rails/react/manifest'
+
+module Webpack
+  module Rails
+    module React
+      # Asset path helpers for use with webpack
+      module Helper
+        # Return asset paths for a particular webpack entry point.
+        #
+        # Response may either be full URLs (eg http://localhost/...) if the dev server
+        # is in use or a host-relative URl (eg /webpack/...) if assets are precompiled.
+        #
+        # Will raise an error if our manifest can't be found or the entry point does
+        # not exist.
+        def webpack_asset_paths(source, extension: nil)
+          return "" unless source.present?
+
+          paths = Webpack::Rails::React::Manifest.asset_paths(source)
+          paths = paths.select {|p| p.ends_with? ".#{extension}" } if extension
+
+          host = ::Rails.configuration.webpack.dev_server.host
+          port = ::Rails.configuration.webpack.dev_server.port
+
+          if ::Rails.configuration.webpack.dev_server.enabled
+            paths.map! do |p|
+              "//#{host}:#{port}#{p}"
+            end
+          end
+
+          paths
+        end
+      end
+    end
+  end
+end

data/lib/webpack/rails/react/manifest.rb

@@ -0,0 +1,91 @@
+require 'net/http'
+require 'uri'
+
+module Webpack
+  module Rails
+    module React
+      # Webpack manifest loading, caching & entry point retrieval
+      class Manifest
+        # Raised if we can't read our webpack manifest for whatever reason
+        class ManifestLoadError < StandardError
+          def initialize(message, orig)
+            super "#{message} (original error #{orig})"
+          end
+        end
+
+        # Raised if a supplied entry point does not exist in the webpack manifest
+        class EntryPointMissingError < StandardError
+        end
+
+        class << self
+          # :nodoc:
+          def asset_paths(source)
+            paths = manifest["assetsByChunkName"][source]
+            if paths
+              # Can be either a string or an array of strings.
+              # Do not include source maps as they are not javascript
+              [paths].flatten.reject { |p| p =~ /.*\.map$/ }.map do |p|
+                "/#{::Rails.configuration.webpack.public_path}/#{p}"
+              end
+            else
+              raise EntryPointMissingError, "Can't find entry point '#{source}' in webpack manifest"
+            end
+          end
+
+          private
+
+          def manifest
+            if ::Rails.configuration.webpack.dev_server.enabled
+              # Don't cache if we're in dev server mode, manifest may change ...
+              load_manifest
+            else
+              # ... otherwise cache at class level, as JSON loading/parsing can be expensive
+              @manifest ||= load_manifest
+            end
+          end
+
+          def load_manifest
+            data = if ::Rails.configuration.webpack.dev_server.enabled
+              load_dev_server_manifest
+            else
+              load_static_manifest
+            end
+            JSON.parse(data)
+          end
+
+          def load_dev_server_manifest
+            http = Net::HTTP.new(
+              "localhost",
+              ::Rails.configuration.webpack.dev_server.port)
+            http.use_ssl = ::Rails.configuration.webpack.dev_server.https
+            http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            http.get(dev_server_path).body
+          rescue => e
+            raise ManifestLoadError.new("Could not load manifest from webpack-dev-server at #{dev_server_url} - is it running, and is stats-webpack-plugin loaded?", e)
+          end
+
+          def load_static_manifest
+            File.read(static_manifest_path)
+          rescue => e
+            raise ManifestLoadError.new("Could not load compiled manifest from #{static_manifest_path} - have you run `rake webpack:compile`?", e)
+          end
+
+          def static_manifest_path
+            ::Rails.root.join(
+              ::Rails.configuration.webpack.output_dir,
+              ::Rails.configuration.webpack.manifest_filename
+            )
+          end
+
+          def dev_server_path
+            "/#{::Rails.configuration.webpack.public_path}/#{::Rails.configuration.webpack.manifest_filename}"
+          end
+
+          def dev_server_url
+            "http://localhost:#{::Rails.configuration.webpack.dev_server.port}#{dev_server_path}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/webpack/rails/{version.rb → react/version.rb}

@@ -1,6 +1,8 @@
 module Webpack
   # :nodoc:
   module Rails
-    VERSION = "0.9.9"
+    module React
+      VERSION = "1.0.0"
+    end
   end
 end

data/lib/webpack/railtie.rb

@@ -1,13 +1,13 @@
 require 'rails'
 require 'rails/railtie'
-require 'webpack/rails/helper'
+require 'webpack/rails/react/helper'
 
 module Webpack
   # :nodoc:
   class Railtie < ::Rails::Railtie
     config.after_initialize do
       ActiveSupport.on_load(:action_view) do
-        include Webpack::Rails::Helper
+        include Webpack::Rails::React::Helper
       end
     end
 
@@ -30,4 +30,4 @@ module Webpack
       load "tasks/webpack.rake"
     end
   end
-end
+end

metadata

@@ -1,10 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: webpack-rails-react
 version: !ruby/object:Gem::Version
-  version: 0.9.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Dave Jugnst
+- Jake Sorce
 autorequire: 
 bindir: bin
 cert_chain: []
@@ -28,6 +29,7 @@ description: Production-tested, JavaScript-first tooling to use webpack within y
   Rails application
 email:
 - djungst@gmail.com
+- jakesorce@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -39,15 +41,15 @@ files:
 - example/dot_gitignore
 - example/package.json
 - example/webpack.config.js
-- lib/generators/webpack_rails/install_generator.rb
+- lib/generators/webpack_rails_react/install_generator.rb
 - lib/tasks/webpack.rake
-- lib/webpack-rails.rb
+- lib/webpack-rails-react.rb
 - lib/webpack/rails.rb
-- lib/webpack/rails/helper.rb
-- lib/webpack/rails/manifest.rb
-- lib/webpack/rails/version.rb
+- lib/webpack/rails/react/helper.rb
+- lib/webpack/rails/react/manifest.rb
+- lib/webpack/rails/react/version.rb
 - lib/webpack/railtie.rb
-homepage: https://github.com/wdjungst/webpack-rails-react
+homepage: https://github.com/jakesorce/webpack-rails-react
 licenses:
 - MIT
 metadata: {}
@@ -59,7 +61,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -72,3 +74,4 @@ signing_key:
 specification_version: 4
 summary: Webpack / Rails / React
 test_files: []
+has_rdoc: 

data/lib/webpack/rails/helper.rb

@@ -1,32 +0,0 @@
-require 'action_view'
-require 'webpack/rails/manifest'
-
-module Webpack
-  module Rails
-    # Asset path helpers for use with webpack
-    module Helper
-      # Return asset paths for a particular webpack entry point.
-      #
-      # Response may either be full URLs (eg http://localhost/...) if the dev server
-      # is in use or a host-relative URl (eg /webpack/...) if assets are precompiled.
-      #
-      # Will raise an error if our manifest can't be found or the entry point does
-      # not exist.
-      def webpack_asset_paths(source)
-        return "" unless source.present?
-
-        paths = Webpack::Rails::Manifest.asset_paths(source)
-        host = ::Rails.configuration.webpack.dev_server.host
-        port = ::Rails.configuration.webpack.dev_server.port
-
-        if ::Rails.configuration.webpack.dev_server.enabled
-          paths.map! do |p|
-            "//#{host}:#{port}#{p}"
-          end
-        end
-
-        paths
-      end
-    end
-  end
-end

data/lib/webpack/rails/manifest.rb

@@ -1,89 +0,0 @@
-require 'net/http'
-require 'uri'
-
-module Webpack
-  module Rails
-    # Webpack manifest loading, caching & entry point retrieval
-    class Manifest
-      # Raised if we can't read our webpack manifest for whatever reason
-      class ManifestLoadError < StandardError
-        def initialize(message, orig)
-          super "#{message} (original error #{orig})"
-        end
-      end
-
-      # Raised if a supplied entry point does not exist in the webpack manifest
-      class EntryPointMissingError < StandardError
-      end
-
-      class << self
-        # :nodoc:
-        def asset_paths(source)
-          paths = manifest["assetsByChunkName"][source]
-          if paths
-            # Can be either a string or an array of strings.
-            # Do not include source maps as they are not javascript
-            [paths].flatten.reject { |p| p =~ /.*\.map$/ }.map do |p|
-              "/#{::Rails.configuration.webpack.public_path}/#{p}"
-            end
-          else
-            raise EntryPointMissingError, "Can't find entry point '#{source}' in webpack manifest"
-          end
-        end
-
-        private
-
-        def manifest
-          if ::Rails.configuration.webpack.dev_server.enabled
-            # Don't cache if we're in dev server mode, manifest may change ...
-            load_manifest
-          else
-            # ... otherwise cache at class level, as JSON loading/parsing can be expensive
-            @manifest ||= load_manifest
-          end
-        end
-
-        def load_manifest
-          data = if ::Rails.configuration.webpack.dev_server.enabled
-            load_dev_server_manifest
-          else
-            load_static_manifest
-          end
-          JSON.parse(data)
-        end
-
-        def load_dev_server_manifest
-          http = Net::HTTP.new(
-            "localhost",
-            ::Rails.configuration.webpack.dev_server.port)
-          http.use_ssl = ::Rails.configuration.webpack.dev_server.https
-          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-          http.get(dev_server_path).body
-        rescue => e
-          raise ManifestLoadError.new("Could not load manifest from webpack-dev-server at #{dev_server_url} - is it running, and is stats-webpack-plugin loaded?", e)
-        end
-
-        def load_static_manifest
-          File.read(static_manifest_path)
-        rescue => e
-          raise ManifestLoadError.new("Could not load compiled manifest from #{static_manifest_path} - have you run `rake webpack:compile`?", e)
-        end
-
-        def static_manifest_path
-          ::Rails.root.join(
-            ::Rails.configuration.webpack.output_dir,
-            ::Rails.configuration.webpack.manifest_filename
-          )
-        end
-
-        def dev_server_path
-          "/#{::Rails.configuration.webpack.public_path}/#{::Rails.configuration.webpack.manifest_filename}"
-        end
-
-        def dev_server_url
-          "http://localhost:#{::Rails.configuration.webpack.dev_server.port}#{dev_server_path}"
-        end
-      end
-    end
-  end
-end