rs-webpack-rails 0.10.0

data/lib/generators/webpack_rails/install_generator.rb

@@ -0,0 +1,69 @@
+module WebpackRails
+  # :nodoc:
+  class InstallGenerator < ::Rails::Generators::Base
+    source_root File.expand_path("../../../../example", __FILE__)
+
+    desc "Install everything you need for a basic webpack-rails integration"
+
+    def add_foreman_to_gemfile
+      gem 'foreman'
+    end
+
+    def copy_procfile
+      copy_file "Procfile", "Procfile"
+    end
+
+    def copy_package_json
+      copy_file "package.json", "package.json"
+    end
+
+    def copy_webpack_conf
+      copy_file "webpack.config.js", "config/webpack.config.js"
+    end
+
+    def create_webpack_application_js
+      empty_directory "webpack"
+      create_file "webpack/application.js" do
+        <<-EOF.strip_heredoc
+        console.log("Hello world!");
+        EOF
+      end
+    end
+
+    def add_to_gitignore
+      append_to_file ".gitignore" do
+        <<-EOF.strip_heredoc
+        # Added by webpack-rails
+        /node_modules
+        /public/webpack
+        EOF
+      end
+    end
+
+    def run_yarn_install
+      run "yarn install" if yes?("Would you like us to run 'yarn install' for you?")
+    end
+
+    def run_bundle_install
+      run "bundle install" if yes?("Would you like us to run 'bundle install' for you?")
+    end
+
+    def whats_next
+      puts <<-EOF.strip_heredoc
+
+        We've set up the basics of webpack-rails for you, but you'll still
+        need to:
+
+          1. Add the 'application' entry point in to your layout, and
+          2. Run 'foreman start' to run the webpack-dev-server and rails server
+
+        See the README.md for this gem at
+        https://github.com/mipearson/webpack-rails/blob/master/README.md
+        for more info.
+
+        Thanks for using webpack-rails!
+
+      EOF
+    end
+  end
+end

data/lib/rs-webpack-rails.rb

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

data/lib/tasks/webpack.rake

@@ -0,0 +1,19 @@
+namespace :webpack do
+  desc "Compile webpack bundles"
+  task compile: :environment do
+    ENV["TARGET"] = 'production' # TODO: Deprecated, use NODE_ENV instead
+    ENV["NODE_ENV"] ||= 'production'
+    webpack_bin = ::Rails.root.join(::Rails.configuration.webpack.binary)
+    config_file = ::Rails.root.join(::Rails.configuration.webpack.config_file)
+
+    unless File.exist?(webpack_bin)
+      raise "Can't find our webpack executable at #{webpack_bin} - have you run `npm install`?"
+    end
+
+    unless File.exist?(config_file)
+      raise "Can't find our webpack config file at #{config_file}"
+    end
+
+    sh "#{webpack_bin} --config #{config_file} --bail"
+  end
+end

data/lib/webpack-rails.rb

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

data/lib/webpack/rails.rb

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

data/lib/webpack/rails/helper.rb

@@ -0,0 +1,42 @@
+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, extension: nil)
+        return "" unless source.present?
+
+        if ::Rails.configuration.webpack.manifest_type == "manifest"
+          extension = "js" if extension.nil?
+          paths = Webpack::Rails::Manifest.manifest_asset_paths(source + "." + extension)
+        elsif ::Rails.configuration.webpack.manifest_type == "stats"
+          paths = Webpack::Rails::Manifest.asset_paths(source)
+          paths = paths.select { |p| p.ends_with? ".#{extension}" } if extension
+        end
+
+        port = ::Rails.configuration.webpack.dev_server.port
+        protocol = ::Rails.configuration.webpack.dev_server.https ? 'https' : 'http'
+
+        host = ::Rails.configuration.webpack.dev_server.host
+        host = instance_eval(&host) if host.respond_to?(:call)
+
+        if ::Rails.configuration.webpack.dev_server.enabled && ::Rails.configuration.webpack.manifest_type == "stats"
+          paths.map! do |p|
+            "#{protocol}://#{host}:#{port}#{p}"
+          end
+        end
+
+        paths
+      end
+    end
+  end
+end

data/lib/webpack/rails/manifest.rb

@@ -0,0 +1,114 @@
+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 webpack couldn't build one of your entry points
+      class WebpackError < StandardError
+        def initialize(errors)
+          super "Error in webpack compile, details follow below:\n#{errors.join("\n\n")}"
+        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)
+          raise WebpackError, manifest["errors"] unless manifest_bundled?
+
+          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
+
+        def manifest_asset_paths(source)
+          raise WebpackError, manifest["errors"] unless manifest_bundled?
+
+          paths = manifest[source]
+          if paths
+            paths
+          else
+            raise EntryPointMissingError, "Can't find entry point '#{source}' in webpack manifest"
+          end
+        end
+
+        private
+
+        def manifest_bundled?
+          return true unless manifest.key?("errors")
+          !manifest["errors"].any? { |error| error.include? "Module build failed" }
+        end
+
+        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
+          host = ::Rails.configuration.webpack.dev_server.manifest_host
+          port = ::Rails.configuration.webpack.dev_server.manifest_port
+          http = Net::HTTP.new(host, port)
+          http.use_ssl = ::Rails.configuration.webpack.dev_server.https
+          http.verify_mode = ::Rails.configuration.webpack.dev_server.https_verify_peer ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
+          http.get(dev_server_path).body
+        rescue => e
+          raise ManifestLoadError.new("Could not load manifest from webpack-dev-server at http://#{host}:#{port}#{dev_server_path} - 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://#{::Rails.configuration.webpack.dev_server.host}:#{::Rails.configuration.webpack.dev_server.port}#{dev_server_path}"
+        end
+      end
+    end
+  end
+end

data/lib/webpack/rails/version.rb

@@ -0,0 +1,6 @@
+module Webpack
+  # :nodoc:
+  module Rails
+    VERSION = "0.10.0"
+  end
+end

data/lib/webpack/railtie.rb

@@ -0,0 +1,51 @@
+require 'rails'
+require 'rails/railtie'
+require 'webpack/rails/helper'
+
+module Webpack
+  # :nodoc:
+  class Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        include Webpack::Rails::Helper
+      end
+    end
+
+    config.webpack = ActiveSupport::OrderedOptions.new
+    config.webpack.dev_server = ActiveSupport::OrderedOptions.new
+
+    config.webpack.config_file = 'config/webpack.config.js'
+    config.webpack.binary = 'node_modules/.bin/webpack'
+
+    # Host & port to use when generating asset URLS in the manifest helpers in dev
+    # server mode. Defaults to the requested host rather than localhost, so
+    # that requests from remote hosts work.
+    config.webpack.dev_server.host = proc { respond_to?(:request) ? request.host : 'localhost' }
+    config.webpack.dev_server.port = 3808
+
+    # The host and port to use when fetching the manifest
+    # This is helpful for e.g. docker containers, where the host and port you
+    # use via the web browser is not the same as those that the containers use
+    # to communicate among each other
+    config.webpack.dev_server.manifest_host = 'localhost'
+    config.webpack.dev_server.manifest_port = 3808
+
+    config.webpack.dev_server.https = false
+    # Below will default to 'true' in 1.0 release
+    config.webpack.dev_server.https_verify_peer = false
+    config.webpack.dev_server.binary = 'node_modules/.bin/webpack-dev-server'
+    config.webpack.dev_server.enabled = ::Rails.env.development? || ::Rails.env.test?
+
+    config.webpack.output_dir = "public/webpack"
+    config.webpack.public_path = "webpack"
+    config.webpack.manifest_filename = "manifest.json"
+
+    # manifest: https://github.com/danethurber/webpack-manifest-plugin
+    # stats: https://github.com/unindented/stats-webpack-plugin
+    config.webpack.manifest_type = "stats"
+
+    rake_tasks do
+      load "tasks/webpack.rake"
+    end
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: rs-webpack-rails
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Michael Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-27 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.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+description: No longer maintained - use webpacker instead.
+email:
+- mipearson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- example/Procfile
+- example/dot_gitignore
+- example/package.json
+- example/public/webpack/manifest.json
+- example/webpack.config.js
+- example/webpack/application.js
+- example/yarn.lock
+- lib/generators/webpack_rails/install_generator.rb
+- lib/rs-webpack-rails.rb
+- lib/tasks/webpack.rake
+- lib/webpack-rails.rb
+- lib/webpack/rails.rb
+- lib/webpack/rails/helper.rb
+- lib/webpack/rails/manifest.rb
+- lib/webpack/rails/version.rb
+- lib/webpack/railtie.rb
+homepage: http://github.com/mipearson/webpack-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: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: No longer maintained - use webpacker instead.
+test_files: []