webpack_manifest 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: eb2ef747217989c47a8781f7e049328a6794f4e069cfe014776dfa4e8670c85e
-  data.tar.gz: d465f2d48d57638ab060f146a19f5eee0b41e5f2b8f43626522d054f62c4bdb2
+SHA1:
+  metadata.gz: 3013414efc1024e5d354d79e7f5fc1a2101550ff
+  data.tar.gz: 36a6b4a171d94efd5f04f3e7c5dd86ff3e09ef7b
 SHA512:
-  metadata.gz: 2b5a3fc1c9dca56074dc26efd3a8127a3a81775e45de0aa3ede5de04818281c35e9cb4e9425d0b7f398355c99eaf6f0ac0dce587f80aaebf8908ea707a800aaa
-  data.tar.gz: f224eaa75f9f44118f7f13e9b8f1f658a02b9462bf495bdd92a36d94de1617fe03f1049f09fee5ef32a51562ef4f31f446d2d41660283d85b58810129da8e263
+  metadata.gz: 7296e015122881f20c785bc7c764c43b87eda0abae490db1a228bb764d90a5626e2e65927d9ffffeecfd534cfa11ddbaa9e029de95cb76cc6adfd4c239b9e370
+  data.tar.gz: 3e93b85fbd321b7367e347268053d4380e51082199ab55ad8ef7926616c8f00878c9cd6d6a8f4d708fc647ceada2b582da71dcaa95f19ad078fc1cb859d69e12

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.2.0 / 2018-10-18
+
+## Enhancements
+
+* Multiple manifest files support
+
+## Breaking changes
+
+* Changed internal and public APIs
+
 # 0.1.0 / 2018-10-17
 
 Initial release

data/README.md

@@ -1,6 +1,6 @@
 # WebpackManifest
 
-WebpackManifest is a gem that integrate ruby with npm's [webpack-manifest-plugin](https://www.npmjs.com/package/webpack-manifest-plugin).
+WebpackManifest is a gem that integrates Rails with npm's [webpack-manifest-plugin](https://www.npmjs.com/package/webpack-manifest-plugin) without [webpacker](https://github.com/rails/webpacker).
 
 ## Features
 
@@ -27,39 +27,127 @@ Or install it yourself as:
 
 ### Rails view helpers
 
-* `#asset_bundle_path`
-* `#javascript_bundle_tag`
-* `#stylesheet_bundle_tag`
-* `#image_bundle_tag`
+#### `asset_bundle_path`
+
+This is a wrapper of [asset_path](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path). You can set any options of `asset_path`.
+
+Given entry point name is resolved according to definition of manifest.
+
+```ruby
+asset_bundle_path 'calendar.css'
+  # => "/assets/web/pack/calendar-1016838bab065ae1e122.css"
+
+asset_bundle_path 'icon/favicon.ico'
+  # => "/assets/web/pack/icon/favicon-1016838bab065ae1e122.ico"
+```
+
+#### `javascript_bundle_tag`
+
+This is a wrapper of [javascript_include_tag](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-javascript_include_tag). You can set any options of `javascript_include_tag`.
+
+Given entry point name is resolved according to definition of manifest.
+
+```ruby
+javascript_bundle_tag 'calendar', 'data-turbolinks-track': 'reload'
+  # => <script src="/assets/web/pack/calendar-1016838bab065ae1e314.js"
+  #     data-turbolinks-track="reload"></script>
+
+javascript_bundle_tag 'orders/app'
+  # => <script src="/assets/web/pack/orders/app-1016838bab065ae1e314.js"></script>
+```
+
+#### `stylesheet_bundle_tag`
+
+This is a wrapper of [stylesheet_link_tag](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-stylesheet_link_tag). You can set any options of `stylesheet_link_tag`.
+
+Given entry point name is resolved according to definition of manifest.
+
+```ruby
+stylesheet_bundle_tag 'calendar', 'data-turbolinks-track': 'reload'
+  # => <link rel="stylesheet" media="screen"
+  #     href="/assets/web/pack/calendar-1016838bab065ae1e122.css"
+  #     data-turbolinks-track="reload" />
+
+stylesheet_bundle_tag 'orders/style'
+  # => <link rel="stylesheet" media="screen"
+  #    href="/assets/web/pack/orders/style-1016838bab065ae1e122.css" />
+```
+
+#### `image_bundle_tag`
+
+This is a wrapper of [image_tag](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-image_tag). You can set any options of `image_tag`.
+
+Given entry point name is resolved according to definition of manifest.
+
+```ruby
+image_bundle_tag 'icon.png'
+  # => <img src="/assets/pack/icon-1016838bab065ae1e314.png" />
+
+image_bundle_tag "icon.png", size: "16x10", alt: "Edit Entry"
+  # => <img src="/assets/pack/icon-1016838bab065ae1e314.png" width="16"
+        height="10" alt="Edit Entry" />
+```
 
 ### Configuration
 
+After installed, configure your Rails app by adding a new file `config/initializers/webpack_manifest.rb` as below.
+
+```rb
+WebpackManifest::Rails.configuration do |c|
+  # By default c.cache is `false`, which means application always parses given
+  # manifest json. Disableing cache is useful in development.
+  # Set `true` if you would like to cache manifest in memory, for example in production.
+  c.cache = !Rails.env.development?
+
+  # Register a path to a manifest file here.
+  c.manifest = Rails.root.join('public', 'assets', 'manifest.json')
+end
+```
+
+### Multiple manifest files support
+
+This is optional. You can register multiple manifest files for the view helpers. This feature must be useful if your Rails project have several sites, then asset bundling process is separated.
+
+For example, your project serve for two sites, `shop` and `admin` from each separated manifest file. You can register each as below.
+
 ```rb
 # In config/initializers/webpack_manifest.rb
 
-cache = if Rails.env.development?
-          false
-        else
-          true
-        end
-manifest = WebpackManifest::Manifest.new(
-  Rails.root.join('public', 'assets', 'manifest.json'),
-  cache: cache,
-)
+WebpackManifest::Rails.configuration do |c|
+  c.cache = !Rails.env.development?
+
+  # If you have manifest files more than one, register them by `c.add` instead
+  # of `c.manifest=`. Note that the first registered one(e.g. `shop` in this
+  # example) is recognized as a default manifest.
+  c.add :shop,  Rails.root.join('public', 'assets', 'manifest-shop.json')
+  c.add :admin, Rails.root.join('public', 'assets', 'manifest-admin.json')
+end
+```
+
+Then you can resolve paths with view helpers by passing `manifest:` option.
+
 ```
+# This resolves a path by shop's manifest json.
+javascript_bundle_tag('item_group_editor', manifest: :shop)
+
+# This resolves a path by admin's manifest json.
+asset_bundle_tag('favicon.ico', manifest: :admin)
+
+# This resolves a path by shop's manifest json implicitly because the first one is marked as a default.
+javascript_bundle_tag('item_group_editor')
+```
+
+## TODO
 
+* Provides configuration generator for Rails initializers
 
-### Multiple manifest support
+## Acknowledgement
 
-TBD
+Special thanks to [@f_subal](https://twitter.com/f_subal) and his awesome blog [post](https://inside.pixiv.blog/subal/4615)(japanese).
 
-## Roadmap
+## Alternatives
 
-* [x] Implement manifest class
-* [x] Implement Rails view helpers
-* [ ] Configuration generator for Rails initializers
-* [ ] Multiple manifest files support
-* [ ] Write document more
+* [ed-mare/webpack_manifest_plugin](https://github.com/ed-mare/webpack_manifest_plugin)
 
 ## Development
 

data/lib/webpack_manifest/manifest.rb

@@ -6,9 +6,12 @@ module WebpackManifest
   class Manifest
     class MissingEntryError < StandardError; end
 
-    def initialize(path_or_hash, cache: false)
-      @path_or_hash = path_or_hash
-      @cache_manifest = cache
+    attr_reader :path
+    attr_writer :cache
+
+    def initialize(path, cache: false)
+      @path = path
+      @cache = cache
     end
 
     def lookup!(name)
@@ -23,10 +26,14 @@ module WebpackManifest
       data.values
     end
 
+    def cache_enabled?
+      @cache
+    end
+
     private
 
     def data
-      if @cache_manifest
+      if cache_enabled?
         @data ||= load_data
       else
         load_data
@@ -34,14 +41,12 @@ module WebpackManifest
     end
 
     def load_data
-      return @path_or_hash if @path_or_hash.is_a? Hash
-      path = @path_or_hash
-      File.exist?(path) ? JSON.parse(File.read(path)) : {}
+      File.exist?(@path) ? JSON.parse(File.read(@path)) : {}
     end
 
     def handle_missing_entry(name)
       raise MissingEntryError, <<~MSG
-        Can not find #{name} in #{@path_or_hash}.
+        Can not find #{name} in #{@path}.
         Your manifest contains:
         #{JSON.pretty_generate(@data)}
       MSG

data/lib/webpack_manifest/rails.rb

@@ -2,11 +2,17 @@
 
 module WebpackManifest
   module Rails
+    require 'webpack_manifest/rails/configuration'
     require 'webpack_manifest/rails/helper'
+    require 'webpack_manifest/rails/manifest_repository'
 
     class << self
-      # TODO: multiple manifest files support
-      attr_accessor :manifest
+      def configuration(&block)
+        @configuration ||= Configuration.new
+        yield @configuration if block_given?
+        @configuration
+      end
+      attr_writer :configuration
     end
   end
 end

data/lib/webpack_manifest/rails/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WebpackManifest
+  module Rails
+    class Configuration
+      attr_reader :manifests
+
+      def initialize
+        # default values
+        @cache = false
+        @manifests = ManifestRepository.new
+      end
+
+      def cache
+        @cache
+      end
+
+      def cache=(v)
+        @manifests.all_manifests.each { |m| m.cache = v }
+        @cache = v
+      end
+
+      # Register a single manifest as a default.
+      def manifest=(path)
+        @manifests.default = @manifests.add '', path, cache: @cache
+      end
+
+      # Register a manfiest. You can register multiple files by calling `#add`.
+      def add(key, path)
+        @manifests.add(key, path, cache: @cache)
+      end
+    end
+  end
+ end

data/lib/webpack_manifest/rails/helper.rb

@@ -7,11 +7,9 @@ module WebpackManifest::Rails::Helper
   #
   #   <%= asset_bundle_path 'calendar.css' %> # => "/assets/web/pack/calendar-1016838bab065ae1e122.css"
   #   <%= asset_bundle_path 'icon/favicon.ico' %> # => "/assets/web/pack/icon/favicon-1016838bab065ae1e122.ico"
-  def asset_bundle_path(name, **options)
-    asset_path(
-      WebpackManifest::Rails.manifest.lookup!(name.to_s),
-      **options,
-    )
+  def asset_bundle_path(name, manifest: nil, **options)
+    manifest = get_manifest_by_key(manifest)
+    asset_path(manifest.lookup!(name.to_s), **options)
   end
 
   # Example:
@@ -21,8 +19,8 @@ module WebpackManifest::Rails::Helper
   #
   #   <%= javascript_bundle_tag 'orders/app'  %> # =>
   #   <script src="/assets/web/pack/orders/app-1016838bab065ae1e314.js"></script>
-  def javascript_bundle_tag(*names, **options)
-    javascript_include_tag(*sources_from_manifest(names, 'js'), **options)
+  def javascript_bundle_tag(*names, manifest: nil, **options)
+    javascript_include_tag(*sources_from_manifest(names, 'js', key: manifest), **options)
   end
 
   # Examples:
@@ -34,8 +32,8 @@ module WebpackManifest::Rails::Helper
   #   <%= stylesheet_bundle_tag 'orders/style' %> # =>
   #   <link rel="stylesheet" media="screen"
   #    href="/assets/web/pack/orders/style-1016838bab065ae1e122.css" />
-  def stylesheet_bundle_tag(*names, **options)
-    stylesheet_link_tag(*sources_from_manifest(names, 'css'), **options)
+  def stylesheet_bundle_tag(*names, manifest: nil, **options)
+    stylesheet_link_tag(*sources_from_manifest(names, 'css', key: manifest), **options)
   end
 
   # Examples:
@@ -45,16 +43,20 @@ module WebpackManifest::Rails::Helper
   #
   #   <%= image_bundle_tag "icon.png", size: "16x10", alt: "Edit Entry"
   #   <img src="/assets/pack/icon-1016838bab065ae1e314.png" width="16" height="10" alt="Edit Entry" />
-  def image_bundle_tag(name, **options)
-    image_tag(
-      WebpackManifest::Rails.manifest.lookup!(name.to_s),
-      **options,
-    )
+  def image_bundle_tag(name, manifest: nil, **options)
+    manifest = get_manifest_by_key(manifest)
+    image_tag(manifest.lookup!(name.to_s), **options)
   end
 
   private
 
-  def sources_from_manifest(names, ext)
-    names.map { |name| WebpackManifest::Rails.manifest.lookup!(name + '.' + ext) }
+  def sources_from_manifest(names, ext, key: nil)
+    manifest = get_manifest_by_key(key)
+    names.map { |name| manifest.lookup!(name + '.' + ext) }
+  end
+
+  def get_manifest_by_key(key = nil)
+    repository = WebpackManifest::Rails.configuration.manifests
+    key.nil? ? repository.default : repository.get(key)
   end
 end

data/lib/webpack_manifest/rails/manifest_repository.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WebpackManifest
+  module Rails
+    class ManifestRepository
+      attr_accessor :default
+
+      def initialize
+        @manifests = {}
+        @default = nil # a pointer to a default manifest
+      end
+
+      def all_manifests
+        @manifests.values
+      end
+
+      # @private
+      def add(key, path, **options)
+        manifest = WebpackManifest::Manifest.new(path, options)
+        # Mark a first one as a default
+        @default = manifest if @manifests.empty?
+        @manifests[key.to_sym] = manifest
+      end
+
+      def get(key)
+        @manifests[key.to_sym]
+      end
+    end
+  end
+end

data/lib/webpack_manifest/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WebpackManifest
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpack_manifest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nobuhiro Nikushi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-16 00:00:00.000000000 Z
+date: 2018-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -80,7 +80,9 @@ files:
 - lib/webpack_manifest.rb
 - lib/webpack_manifest/manifest.rb
 - lib/webpack_manifest/rails.rb
+- lib/webpack_manifest/rails/configuration.rb
 - lib/webpack_manifest/rails/helper.rb
+- lib/webpack_manifest/rails/manifest_repository.rb
 - lib/webpack_manifest/version.rb
 - webpack_manifest.gemspec
 homepage: https://github.com/nikushi/webpack_manifest
@@ -103,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: A gem to integrate ruby with npm's webpack-manifest-plugin package