webpack_manifest 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: f921dccf167c3824b5b4be27adbbd0dafe54bb7334fc4ca2569d03cd18a6874f
-  data.tar.gz: 52cc757897893892813beffd7b41fe69f98392466409cb0f681b23f3e07417db
+SHA1:
+  metadata.gz: 94b6f1ca07113997a519c7df6ea709bd8738a1b1
+  data.tar.gz: d3080e24d148ef749589c257251c78d22709a148
 SHA512:
-  metadata.gz: 821d92a75d9f50206124c7f32063bb547b7419f01312355b7493b5b8481bc8dc2df99ec9eb7f939199395814f11f45fc6ca30089bb7e8513ca7ea6953b0aa611
-  data.tar.gz: f22f3e0a9b465d6b7b915cd4a5703e1f3877f6085e23e9eada3a1485485acf8ef5f1e7325a4aedb7be343dd865f53ea9acd37c4f77c62fcc0ca08cf1746654f6
+  metadata.gz: 844abcff5624053ea4e095415b99c10f15b74583189eb76128b545ea74c14bea96d087f0aeb4a19ba049beb89843005fbda9fc2b3f46477da8415cfc7714a393
+  data.tar.gz: e7ad9abb3e50eb55fd506af86957c180fbfb3debcc81e08680fc99a7f1564007de63e4a55df81a1e65ca0be30f900f16a20251e63f98d77f6d74e9d78c444f72

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.2.2 / 2018-11-05
+
+## Enhancements
+
+* Support reading manifest.json from an uri (#4)
+
 # 0.2.1 / 2018-10-18
 
 * Improve exceptional case handling

data/README.md

@@ -1,10 +1,10 @@
 # WebpackManifest [![Build Status](https://travis-ci.org/nikushi/webpack_manifest.svg?branch=master)](https://travis-ci.org/nikushi/webpack_manifest) [![Gem Version](https://badge.fury.io/rb/webpack_manifest.svg)](https://badge.fury.io/rb/webpack_manifest)
 
-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).
+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
 
-* Rails view helpers to access assets which are built by webpack according a manifest file.
+* Rails view helpers to resolve paths to assets which are built by webpack according to a manifest file.
 * Multiple manifest files support
 
 ## Installation
@@ -23,6 +23,22 @@ Or install it yourself as:
 
     $ gem install webpack_manifest
 
+## Configuration
+
+After installed, configure your Rails app below as a new file `config/initializers/webpack_manifest.rb`.
+
+```rb
+WebpackManifest::Rails.configuration do |c|
+  # By default c.cache is set to `false`, which means an application always parses a
+  # manifest.json. In development, you should set cache false usually.
+  # Instead, setting it `true` which caches the manifest in memory is recommended basically.
+  c.cache = !Rails.env.development?
+
+  # Register a path to a manifest file here.
+  c.manifest = Rails.root.join('public', 'assets', 'manifest.json')
+end
+```
+
 ## Usage
 
 ### Rails view helpers
@@ -31,7 +47,7 @@ Or install it yourself as:
 
 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.
+A given entry point name is resolved according to definition of manifest.
 
 ```ruby
 asset_bundle_path 'calendar.css'
@@ -60,7 +76,7 @@ javascript_bundle_tag 'orders/app'
 
 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.
+A given entry point name is resolved according to definition of manifest.
 
 ```ruby
 stylesheet_bundle_tag 'calendar', 'data-turbolinks-track': 'reload'
@@ -77,7 +93,7 @@ stylesheet_bundle_tag 'orders/style'
 
 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.
+A given entry point name is resolved according to definition of manifest.
 
 ```ruby
 image_bundle_tag 'icon.png'
@@ -88,27 +104,31 @@ image_bundle_tag "icon.png", size: "16x10", alt: "Edit Entry"
         height="10" alt="Edit Entry" />
 ```
 
-### Configuration
+## Advanced Configuration
 
-After installed, configure your Rails app by adding a new file `config/initializers/webpack_manifest.rb` as below.
+### Hot Module Replacement in development
+
+Optionally you can integrate the gem with [webpack-dev-server](https://github.com/webpack/webpack-dev-server) to enable live reloading by setting an manifest url served by webpack-dev-server, instead of a local file path. This should be used for development only.
+
+Note that WebpackManifest itself does not launches webpack-dev-server, so it must be started along with Rails server by yourself.
 
 ```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')
+  c.manifest = if Rails.env.development?
+                 'http://localhost:8080/packs/manifest.json'
+               else
+                 Rails.root.join('public', 'assets', 'manifest.json')
+               end
 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.
+This is optional. You can register multiple manifest files for the view helpers. This feature must be useful if your Rails project serves for several sites, then asset bundling process is isolated every site.
 
-For example, your project serve for two sites, `shop` and `admin` from each separated manifest file. You can register each as below.
+For example, your project serve for two sites, `shop` and `admin` from each individual manifest file. You can register each as
 
 ```rb
 # In config/initializers/webpack_manifest.rb
@@ -116,7 +136,7 @@ For example, your project serve for two sites, `shop` and `admin` from each sepa
 WebpackManifest::Rails.configuration do |c|
   c.cache = !Rails.env.development?
 
-  # If you have manifest files more than one, register them by `c.add` instead
+  # In order for Raild to handle multiple manifests, you must call `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')
@@ -124,7 +144,7 @@ WebpackManifest::Rails.configuration do |c|
 end
 ```
 
-Then you can resolve paths with view helpers by passing `manifest:` option.
+Then you can resolve a path with view helpers by passing `manifest:` option.
 
 ```
 # This resolves a path by shop's manifest json.

data/lib/webpack_manifest/manifest.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'pathname'
+require 'open-uri'
+require 'uri'
 
 module WebpackManifest
   class Manifest
@@ -12,7 +13,7 @@ module WebpackManifest
     attr_writer :cache
 
     def initialize(path, cache: false)
-      @path = Pathname.new(path)
+      @path = path.to_s
       @cache = cache
     end
 
@@ -43,8 +44,16 @@ module WebpackManifest
     end
 
     def load_data
-      raise(FileNotFoundError, "#{@path}: no such manifest found") unless File.exist?(@path)
-      JSON.parse(File.read(@path))
+      u = URI.parse(@path)
+      data = nil
+      if u.scheme == 'file' || u.path == @path  # file path
+        raise(FileNotFoundError, "#{@path}: no such manifest found") unless File.exist?(@path)
+        data = File.read(@path)
+      else
+        # http url
+        data = u.read
+      end
+      JSON.parse(data)
     end
 
     def handle_missing_entry(name)

data/lib/webpack_manifest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpack_manifest
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Nobuhiro Nikushi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-18 00:00:00.000000000 Z
+date: 2018-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -106,7 +106,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: WebpackManifest is a gem that integrates Rails with npm's webpack-manifest-plugin