webpacker_helpers 3.0.0.beta.1

data/lib/webpacker_helpers/helper.rb

@@ -0,0 +1,67 @@
+require "webpacker_helpers/manifest"
+require "webpacker_helpers/env"
+
+module WebpackerHelpers::Helper
+  # Computes the full path for a given webpacker asset.
+  # Return relative path using manifest.json and passes it to asset_url helper
+  # This will use asset_path internally, so most of their behaviors will be the same.
+  # Examples:
+  #
+  # In development mode:
+  #   <%= asset_pack_path 'calendar.js' %> # => "/public/webpack/development/calendar-1016838bab065ae1e122.js"
+  # In production mode:
+  #   <%= asset_pack_path 'calendar.css' %> # => "/public/webpack/production/calendar-1016838bab065ae1e122.css"
+  def asset_pack_path(name, **options)
+    path = WebpackerHelpers::Configuration.base_path
+    file = WebpackerHelpers::Manifest.lookup(name)
+    asset_path("#{path}/#{file}", **options)
+  end
+
+  # Creates a script tag that references the named pack file, as compiled by Webpack.
+  #
+  # Examples:
+  #
+  #   In development mode:
+  #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/public/webpack/development/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
+  #
+  #   # In production mode:
+  #   <%= javascript_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <script src="/public/webpack/production/calendar-1016838bab065ae1e314.js" data-turbolinks-track="reload"></script>
+  def javascript_pack_tag(name, **options)
+    javascript_include_tag(asset_source(name, :javascript), **options)
+  end
+
+  # Creates a link tag that references the named pack file(s), as compiled by Webpack per the entries list
+  # in client/webpack.client.base.config.js.
+  #
+  # Examples:
+  #
+  #   # In production mode:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/public/webpack/production/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
+  #
+  #   # In development mode:
+  #   <%= stylesheet_pack_tag 'calendar', 'data-turbolinks-track': 'reload' %> # =>
+  #   <link rel="stylesheet" media="screen" href="/public/webpack/development/calendar-1016838bab065ae1e122.css" data-turbolinks-track="reload" />
+  #
+  #   # In development mode with hot-reloading
+  #   <%= stylesheet_pack_tag('main') %> <% # Default is false for enabled_when_hot_loading%>
+  #   # No output
+  #
+  #   # In development mode with hot-reloading and enabled_when_hot_loading
+  #   # <%= stylesheet_pack_tag('main', enabled_when_hot_loading: true) %>
+  #   <link rel="stylesheet" media="screen" href="/public/webpack/development/calendar-1016838bab065ae1e122.css" />
+  #
+  def stylesheet_pack_tag(name, **options)
+    return "" if WebpackerHelpers::Env.hot_loading? && !options[:enabled_when_hot_loading].presence
+    stylesheet_link_tag(asset_source(name, :stylesheet), **options)
+  end
+
+  private
+    def asset_source(name, type)
+      url = WebpackerHelpers::Configuration.base_url
+      path = WebpackerHelpers::Manifest.lookup("#{name}#{compute_asset_extname(name, type: type)}")
+      "#{url}/#{path}"
+    end
+end

data/lib/webpacker_helpers/manifest.rb

@@ -0,0 +1,72 @@
+# Singleton registry for accessing the output path using generated manifest.
+# This allows javascript_pack_tag, stylesheet_pack_tag, asset_pack_path to take a reference to,
+# say, "calendar.js" or "calendar.css" and turn it into "/public/webpack/calendar.js" or
+# "/public/webpack/calendar.css" in development. In production mode, it returns compiles
+# files, # "/public/webpack/calendar-1016838bab065ae1e314.js" and
+# "/webpack/calendar-1016838bab065ae1e314.css" for long-term caching
+
+require "webpacker_helpers/file_loader"
+require "webpacker_helpers/env"
+require "webpacker_helpers/configuration"
+
+class WebpackerHelpers::Manifest < WebpackerHelpers::FileLoader
+  class << self
+    # Helper method to determine if the manifest file exists.
+    def exist?
+      path_object = WebpackerHelpers::Configuration.manifest_path
+      path_object.exist?
+    end
+
+    def file_path
+      WebpackerHelpers::Configuration.manifest_path
+    end
+
+    def missing_file_from_manifest_error(bundle_name)
+      msg = <<-MSG
+        WebpackerHelpers can't find #{bundle_name} in your manifest #{file_path}. Possible causes:
+          1. You are hot reloading.
+          2. Webpack has not re-run to reflect updates.
+          3. You have misconfigured WebpackerHelpers's config/webpacker_helpers.yml file.
+          4. Your Webpack configuration is not creating a manifest.
+      MSG
+      raise(WebpackerHelpers::FileLoader::NotFoundError.new(msg))
+    end
+
+    # Same as lookup, but raises an error.
+    def lookup!(name)
+      lookup(name) || missing_file_from_manifest_error(name)
+    end
+
+    # Find the real file name from the manifest key.
+    def lookup(name)
+      instance.confirm_manifest_exists
+
+      load_instance
+      raise WebpackerHelpers::FileLoader::FileLoaderError.new("WebpackerHelpers::Manifest.load must be called first") unless instance
+      instance.data[name.to_s]
+    end
+  end
+
+  def confirm_manifest_exists
+    raise missing_manifest_file_error(@path) unless File.exist?(@path)
+  end
+
+  private
+
+    def missing_manifest_file_error(path_object)
+      msg = <<-MSG
+
+        WebpackerHelpers can't find the manifest file: #{path_object}
+        Possible causes:
+          1. You have not invoked webpack.
+          2. You have misconfigured WebpackerHelpers's config/webpacker_helpers.yml file.
+          3. Your Webpack configuration is not creating a manifest.
+    MSG
+      raise(WebpackerHelpers::FileLoader::NotFoundError.new(msg))
+    end
+
+    def load_data
+      return super unless File.exist?(@path)
+      JSON.parse(File.read(@path))
+    end
+end

data/lib/webpacker_helpers/railtie.rb

@@ -0,0 +1,18 @@
+require "rails/railtie"
+
+require "webpacker_helpers/helper"
+
+class WebpackerHelpers::Engine < ::Rails::Engine
+  initializer :webpacker_helpers do |app|
+    ActiveSupport.on_load :action_controller do
+      ActionController::Base.helper WebpackerHelpers::Helper
+    end
+
+    ActiveSupport.on_load :action_view do
+      include WebpackerHelpers::Helper
+    end
+
+    WebpackerHelpers.bootstrap
+    Spring.after_fork {  WebpackerHelpers.bootstrap } if defined?(Spring)
+  end
+end

data/lib/webpacker_helpers/version.rb

@@ -0,0 +1,3 @@
+module WebpackerHelpers
+  VERSION = "3.0.0.beta.1".freeze
+end

data/test/configuration_test.rb

@@ -0,0 +1,13 @@
+require "webpacker_test"
+
+class ConfigurationTest < Minitest::Test
+  def test_manifest_path
+    manifest_path = File.join(File.dirname(__FILE__), "test_app/public/webpack/test", "manifest.json").to_s
+    assert_equal manifest_path, WebpackerHelpers::Configuration.manifest_path.to_s
+  end
+
+  def test_output_path
+    output_path = File.join(File.dirname(__FILE__), "test_app/public/webpack/test").to_s
+    assert_equal output_path, WebpackerHelpers::Configuration.webpack_public_output_dir.to_s
+  end
+end

data/test/env_test.rb

@@ -0,0 +1,12 @@
+require "webpacker_test"
+
+class EnvTest < Minitest::Test
+  def test_current_env
+    assert_equal Rails.env, WebpackerHelpers::Env.current
+  end
+
+  def test_file_path
+    correct_path = File.join(File.dirname(__FILE__), "test_app", "config", "webpacker_helpers.yml").to_s
+    assert_equal correct_path, WebpackerHelpers::Env.file_path.to_s
+  end
+end

data/test/helper_test.rb

@@ -0,0 +1,23 @@
+require "webpacker_test"
+
+class HelperTest < ActionView::TestCase
+  def setup
+    @view = ActionView::Base.new
+    @view.extend WebpackerHelpers::Helper
+  end
+
+  def test_asset_pack_path
+    assert_equal @view.asset_pack_path("bootstrap.js"), "/webpack/test/bootstrap-300631c4f0e0f9c865bc.js"
+    assert_equal @view.asset_pack_path("bootstrap.css"), "/webpack/test/bootstrap-c38deda30895059837cf.css"
+  end
+
+  def test_javascript_pack_tag
+    script = %(<script src="/webpack/test/bootstrap-300631c4f0e0f9c865bc.js"></script>)
+    assert_equal @view.javascript_pack_tag("bootstrap.js"), script
+  end
+
+  def test_stylesheet_pack_tag
+    expected_style = %(<link rel="stylesheet" media="screen" href="/webpack/test/bootstrap-c38deda30895059837cf.css" />)
+    assert_equal @view.stylesheet_pack_tag("bootstrap.css"), expected_style
+  end
+end

data/test/manifest_test.rb

@@ -0,0 +1,44 @@
+require "webpacker_test"
+
+class ManifestTest < Minitest::Test
+  def test_file_path
+    file_path = File.join(File.dirname(__FILE__), "test_app/public/webpack/test", "manifest.json").to_s
+    assert_equal WebpackerHelpers::Manifest.file_path.to_s, file_path
+  end
+
+  def test_file_not_existing
+    begin
+      file_path = File.join(File.dirname(__FILE__), "test_app/public/webpack/test", "manifest.json")
+      temp_path = "#{file_path}.backup"
+      FileUtils.mv(file_path, temp_path)
+      # Point of this test is to ensure no crash
+      WebpackerHelpers::Manifest.load_instance
+      assert_equal({}, WebpackerHelpers::Manifest.instance.data)
+    ensure
+      FileUtils.mv(temp_path, file_path)
+    end
+  end
+
+  def test_lookup_exception
+    manifest_path = File.join(File.dirname(__FILE__), "test_app/public/webpack/test", "manifest.json").to_s
+    asset_file = "calendar.js"
+    msg = <<-MSG
+        WebpackerHelpers can't find #{asset_file} in your manifest #{manifest_path}. Possible causes:
+          1. You are hot reloading.
+          2. Webpack has not re-run to reflect updates.
+          3. You have misconfigured WebpackerHelpers's config/webpacker_helpers.yml file.
+          4. Your Webpack configuration is not creating a manifest.
+    MSG
+
+    error = assert_raises WebpackerHelpers::FileLoader::NotFoundError do
+      WebpackerHelpers::Manifest.lookup!(asset_file)
+    end
+
+    assert_equal error.message, msg
+  end
+
+  def test_lookup_success
+    asset_file = "bootstrap.js"
+    assert_equal WebpackerHelpers::Manifest.lookup!(asset_file), "bootstrap-300631c4f0e0f9c865bc.js"
+  end
+end

data/test/test_app/config/secrets.yml

@@ -0,0 +1,5 @@
+development:
+  secret_key_base: 'abcdef'
+
+test:
+  secret_key_base: 'abcdef'

data/test/test_app/config/webpacker_lite.yml

@@ -0,0 +1,27 @@
+# Note: Base output directory of /public is assumed for static files
+default: &default
+  manifest: manifest.json
+  # Used in your webpack configuration. Must be created in the
+  # webpack_public_output_dir folder
+
+development:
+  <<: *default
+  # generated files for development, in /public/webpack/development
+  webpack_public_output_dir: webpack/development
+
+  # Default is localhost:3500
+  hot_reloading_host: localhost:3500
+
+  # Developer note: considering removing this option so it can ONLY be turned by using an ENV value.
+  # Default is false, ENV 'HOT_RELOAD' will always override
+  hot_reloading_enabled_by_default: false
+
+test:
+  <<: *default
+  # generated files for tests, in /public/webpack/test
+  webpack_public_output_dir: webpack/test
+
+production:
+  <<: *default
+  # generated files for tests, in /public/webpack/production
+  webpack_public_output_dir: webpack/production

data/test/test_app/public/webpack/test/manifest.json

@@ -0,0 +1,4 @@
+{
+  "bootstrap.css": "bootstrap-c38deda30895059837cf.css",
+  "bootstrap.js": "bootstrap-300631c4f0e0f9c865bc.js"
+}

data/test/webpacker_test.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+if ENV["USE_PRY"]
+  require "pry"
+end
+
+require "minitest/autorun"
+require "rails"
+require "rails/test_help"
+require "webpacker_helpers"
+
+Rails.env = "test"
+
+module TestApp
+  class Application < ::Rails::Application
+    config.root = File.join(File.dirname(__FILE__), "test_app")
+  end
+end
+
+TestApp::Application.initialize!

data/webpacker.gemspec

@@ -0,0 +1,23 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "webpacker_helpers/version"
+
+Gem::Specification.new do |s|
+  s.name     = "webpacker_helpers"
+  s.version  = WebpackerHelpers::VERSION
+  s.authors  = "David Heinemeier Hansson, Justin Gordon"
+  s.email    = "justin@shakacode.com"
+  s.summary  = "Asset Helpers for Webpack"
+  s.homepage = "https://github.com/shakacode/webpacker_helpers"
+  s.license  = "MIT"
+
+  s.required_ruby_version = ">= 1.9.3"
+
+  s.add_dependency "activesupport", ">= 4.2"
+  s.add_dependency "multi_json",    "~> 1.2"
+  s.add_dependency "railties",      ">= 4.2"
+
+  s.add_development_dependency "bundler", "~> 1.12"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+end

data/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: webpacker_helpers
+version: !ruby/object:Gem::Version
+  version: 3.0.0.beta.1
+platform: ruby
+authors:
+- David Heinemeier Hansson, Justin Gordon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: 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'
+- !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: justin@shakacode.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CONTRIBUTING.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/tasks/webpacker.rake
+- lib/tasks/webpacker_lite/check_node.rake
+- lib/tasks/webpacker_lite/check_yarn.rake
+- lib/tasks/webpacker_lite/clobber.rake
+- lib/tasks/webpacker_lite/verify_install.rake
+- lib/webpacker_helpers.rb
+- lib/webpacker_helpers/configuration.rb
+- lib/webpacker_helpers/env.rb
+- lib/webpacker_helpers/file_loader.rb
+- lib/webpacker_helpers/helper.rb
+- lib/webpacker_helpers/manifest.rb
+- lib/webpacker_helpers/railtie.rb
+- lib/webpacker_helpers/version.rb
+- test/configuration_test.rb
+- test/env_test.rb
+- test/helper_test.rb
+- test/manifest_test.rb
+- test/test_app/config/secrets.yml
+- test/test_app/config/webpacker_lite.yml
+- test/test_app/public/webpack/test/manifest.json
+- test/webpacker_test.rb
+- webpacker.gemspec
+- yarn.lock
+homepage: https://github.com/shakacode/webpacker_helpers
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Asset Helpers for Webpack
+test_files:
+- test/configuration_test.rb
+- test/env_test.rb
+- test/helper_test.rb
+- test/manifest_test.rb
+- test/test_app/config/secrets.yml
+- test/test_app/config/webpacker_lite.yml
+- test/test_app/public/webpack/test/manifest.json
+- test/webpacker_test.rb