webpack-rails-helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cd694a44510dcf73b8765e931ef75f095d8082fa
+  data.tar.gz: 85b6586048fc817f92f21c0b37589089ac2c38bf
+SHA512:
+  metadata.gz: 3bc47eb214e6368e1f114f5eec61b46fcd8558eefe70b56f9d4aa944ef0bb0419e0717fddf6f3aa1f79c7782f4020c310438ae6b943ef79db3b3c4733a76b277
+  data.tar.gz: 704fc44f673d3481cdbc58e411c57480d260e5a7b73c72675d1d591189448730bef69b59faea11369e3efae1e615aacf5af4c7f48a3326586a6388f65017a654

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (C) 2017 shellyBits
+Copyright (C) 2015 Michael Pearson
+
+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,135 @@
+# webpack-rails-helper
+
+This gem integrates assets from webpack into a Ruby on Rails application. This
+basically converts between the asset name and the asset name as emitted by
+webpack with hashes and stuff added.
+
+
+This works by using a JSON manifest file. When using together with
+`webpack-dev-server`, the manifest is re-read on every call to one of the
+helpers. This isn't exactly efficient but isn't much of a problem in development
+mode. In production mode, the manifest is read once.
+
+
+## Installation
+
+
+  * Add this to `Gemfile`:
+
+	```
+    gem 'webpack-rails-helper'
+	```
+
+  * Run `bundle`
+
+  * Add this to `"devDependencies"` of `package.json`:
+
+	```
+	"webpack-manifest-plugin": "^1.2.1"
+	```
+
+  * Run `yarn` (or `npm install` if you must)
+
+  * In `webpack.config.js`, add the plugin
+
+	```
+	...
+	plugins: [
+		// other plugins here
+		new ManifestPlugin()
+	]
+	...
+	```
+
+## Configuration
+
+In `config/application.rb` or in a `config/environments/*.rb`, configure it.
+Defaults are as follows:
+
+```
+    config.webpack.dev_server.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. Uses 'host' and 'port' when set to nil.
+    config.webpack.dev_server.manifest_host = nil
+    config.webpack.dev_server.manifest_port = nil
+
+    config.webpack.dev_server.https = false # note - this will use OpenSSL::SSL::VERIFY_NONE
+    config.webpack.dev_server.enabled = ::Rails.env.development?
+
+    config.webpack.output_dir = 'public/webpack'
+    config.webpack.public_path = 'webpack'
+    config.webpack.manifest_filename = 'manifest.json'
+```
+
+## Running
+
+It's recommended to use `foreman` or something similar to start Rails and the
+webpack server during development. When using `foreman`, the `Procfile` could
+look like this:
+
+```
+rails: ./bin/rails server
+webpack: ./node_modules/.bin/webpack-dev-server --hot --inline --config config/webpack.config.js
+```
+
+
+## API
+
+The gem provides helper methods, available in views and controllers:
+
+
+  * Generic asset:
+
+	```
+    webpack_asset_path(source, optional = false)
+	```
+
+	When using this method, the full name must be specified, including the file
+	extension. When `optional` is set to `true`, a non-existing asset will not
+	raise an exception. This is useful when some assets are only available in
+	production mode, e.g. extracted CSS.
+
+  * Javascript tag:
+
+	```
+    javascript_webpack_tag(*names, **options)
+	```
+
+	This creates a javascript include tag, just like `javascript_include_tag`
+	would, but using an asset from webpack. The `.js` extension is added
+	automatically if required.
+
+
+  * Javascript tag:
+
+	```
+    stylesheet_webpack_tag(*names, **options)
+	```
+
+	This creates a stylesheet link tag, just like `stylesheet_link_tag`
+	would, but using an asset from webpack. The `.css` extension is added
+	automatically if required. CSS assets are considered optional when the
+	dev_server is running for reasons stated above.
+
+
+# Acknowledgements
+
+This started as a fork of <https://github.com/mipearson/webpack-rails.git>
+
+
+The reason for the fork is the usage of a different webpack manifest format. The
+original depends on 'stats-webpack-plugin' while this uses
+'webpack-manifest-plugin'. Since the file formats are so different, it results
+in an incompatible API.
+
+This code has lived inside an application and has been extracted back out into
+this gem.
+
+
+# License
+
+This gem is released under the [MIT license](LICENSE).

data/lib/webpack-rails-helper.rb

@@ -0,0 +1,13 @@
+module Webpack
+  module RailsHelper
+    extend self
+
+    def bootstrap
+      Webpack::RailsHelper::Manifest.load_manifest
+    end
+  end
+end
+
+require 'webpack/rails_helper/config'
+require 'webpack/rails_helper/manifest'
+require 'webpack/rails_helper/railtie'

data/lib/webpack/rails_helper/config.rb

@@ -0,0 +1,49 @@
+require 'uri'
+
+class Webpack::RailsHelper::Config
+  class << self
+    def dev_server_enabled?
+      ::Rails.configuration.webpack.dev_server.enabled
+    end
+
+    def asset_prefix
+      @asset_prefix ||=
+        if config_root.dev_server.enabled
+          port = config_root.dev_server.port
+          protocol = config_root.dev_server.https ? 'https' : 'http'
+
+          host = config_root.dev_server.host
+          host = instance_eval(&host) if host.respond_to?(:call)
+
+          "#{protocol}://#{host}:#{port}"
+        else
+          ''
+        end + "/#{config_root.public_path}/"
+    end
+
+    def static_manifest_path
+      ::Rails.root.join(config_root.output_dir, config_root.manifest_filename)
+    end
+
+    def manifest_uri
+      @manifest_uri ||= URI::Generic.build(
+        scheme: config_root.dev_server.https ? 'https' : 'http',
+        host: manifest_host,
+        port: config_root.dev_server.manifest_port || config_root.dev_server.port,
+        path: "/#{config_root.public_path}/#{config_root.manifest_filename}"
+      )
+    end
+
+    private
+
+    def config_root
+      ::Rails.configuration.webpack
+    end
+
+    def manifest_host
+      host = config_root.dev_server.manifest_host || config_root.dev_server.host
+      host = instance_eval(&host) if host.respond_to?(:call)
+      host
+    end
+  end
+end

data/lib/webpack/rails_helper/helper.rb

@@ -0,0 +1,24 @@
+require 'action_view'
+require_relative 'manifest'
+
+module Webpack
+  module RailsHelper::Helper
+    def webpack_asset_path(sources, optional = false)
+      return '' unless source.present?
+      asset_path(Webpack::RailsHelper::Manifest.asset_paths(sources, optional), skip_pipeline: true)
+    end
+
+    def javascript_webpack_tag(*names, **options)
+      js = names.map { |s| s.end_with?('.js') ? s : s + '.js' }
+      sources = Webpack::RailsHelper::Manifest.asset_paths(js)
+      javascript_include_tag(*sources, **options)
+    end
+
+    def stylesheet_webpack_tag(*names, **options)
+      css = names.map { |s| s.end_with?('.css') ? s : s + '.css' }
+      sources = Webpack::RailsHelper::Manifest.asset_paths(css,
+        Webpack::RailsHelper::Config.dev_server_enabled?)
+      stylesheet_link_tag(*sources, **options)
+    end
+  end
+end

data/lib/webpack/rails_helper/manifest.rb

@@ -0,0 +1,70 @@
+require 'net/http'
+require 'uri'
+
+module Webpack
+  class RailsHelper::Manifest
+    class ManifestLoadError < StandardError; end
+    class EntryPointMissingError < StandardError; end
+
+    class << self
+      def asset_paths(source, optional = false)
+        manif = manifest
+        if source.is_a? Enumerable
+          source.map { |s| single_asset_path(manif, s, optional) }
+        else
+          single_asset_path(manif, source, optional)
+        end
+      end
+
+      def load_manifest
+        manifest unless Webpack::RailsHelper::Config.dev_server_enabled?
+        nil
+      end
+
+      private
+
+      def single_asset_path(manif, source, optional)
+        path = manif[source]
+        if path
+          Webpack::RailsHelper::Config.asset_prefix + path
+        elsif !optional
+          raise EntryPointMissingError, "Can't find entry point '#{source}' in webpack manifest"
+        else
+          ''
+        end
+      end
+
+
+      def manifest
+        if Webpack::RailsHelper::Config.dev_server_enabled?
+          # Always reload from dev_server as manifest may change
+          load_dev_server_manifest
+        else
+          @manifest ||= load_static_manifest
+        end
+      end
+
+      def parse_manifest(data)
+        JSON.parse(data)
+      end
+
+      def load_dev_server_manifest
+        uri = Webpack::RailsHelper::Config.manifest_uri
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = uri.scheme == 'https'
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        parse_manifest(http.get(uri.path).body)
+      rescue => e
+        raise ManifestLoadError,
+          "Could not load manifest from webpack-dev-server at #{Webpack::RailsHelper::Config.manifest_uri}: #{e}"
+      end
+
+      def load_static_manifest
+        parse_manifest(File.read(Webpack::RailsHelper::Config.static_manifest_path))
+      rescue => e
+        raise ManifestLoadError,
+          "Could not load compiled manifest from #{Webpack::RailsHelper::Config.static_manifest_path}: #{e}"
+      end
+    end
+  end
+end

data/lib/webpack/rails_helper/railtie.rb

@@ -0,0 +1,43 @@
+require 'rails/railtie'
+
+require 'webpack/rails_helper/helper'
+
+module Webpack
+  class RailsHelper::Railtie < ::Rails::Railtie
+    config.after_initialize do
+      ActiveSupport.on_load(:action_view) do
+        ActionController::Base.helper Webpack::RailsHelper::Helper
+      end
+
+      ActiveSupport.on_load :action_view do
+        include Webpack::RailsHelper::Helper
+      end
+
+      Webpack::RailsHelper.bootstrap
+      Spring.after_fork { Webpack::RailsHelper.bootstrap } if defined?(Spring)
+    end
+
+    config.webpack = ActiveSupport::OrderedOptions.new
+    config.webpack.dev_server = ActiveSupport::OrderedOptions.new
+
+    # 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. Uses 'host' and 'port' when set to nil.
+    config.webpack.dev_server.manifest_host = nil
+    config.webpack.dev_server.manifest_port = nil
+
+    config.webpack.dev_server.https = false # note - this will use OpenSSL::SSL::VERIFY_NONE
+    config.webpack.dev_server.enabled = ::Rails.env.development?
+
+    config.webpack.output_dir = 'public/webpack'
+    config.webpack.public_path = 'webpack'
+    config.webpack.manifest_filename = 'manifest.json'
+  end
+end

data/lib/webpack/rails_helper/version.rb

@@ -0,0 +1,5 @@
+module Webpack
+  module RailsHelper
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: webpack-rails-helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Ritz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+description: 
+email:
+- daniel.ritz@gmx.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/webpack-rails-helper.rb
+- lib/webpack/rails_helper/config.rb
+- lib/webpack/rails_helper/helper.rb
+- lib/webpack/rails_helper/manifest.rb
+- lib/webpack/rails_helper/railtie.rb
+- lib/webpack/rails_helper/version.rb
+homepage: http://gitlab.com/shellyBits/webpack-rails-helper
+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.12
+signing_key: 
+specification_version: 4
+summary: Helper for using webpack in Rails
+test_files: []