manifester 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 29824867c809881b67054ed4b5afe7da25f2522c8942c2a97ffabc3cb77e318e
-  data.tar.gz: 0f7e32d8feaf9d0808b4c280ca3ea8b480b2f43ef449e6294f1c2071498df8e4
+  metadata.gz: 2711d54f33a2cb64f451cbb1bde44463f7b23cac683526a91263ff96f440d016
+  data.tar.gz: 0dd7c6aa348ce3b9ce6275ca208ac5e43ab6090c60133511f722530fdfcad957
 SHA512:
-  metadata.gz: 43ec8577fc3597f5ee45875c6d057c8c08da99f437a817fd8239f069925e47dbca35409420a6cf0905ea3928059ed662835ac3192413d937b8723a53516269f3
-  data.tar.gz: b582bb945ae72312d85ac10ecd117e07faf4061511818281d13d57718e2d1e904a1e89c8c17b976cb10104ccbc8682a56917a9be56d2a9fb8721974bcb65ad4a
+  metadata.gz: fa700a55fc8603fd1b77e9e3e737870474a9573e90630333b213b619c575c445c2b9337d97a5d6396dd664c2d7884ab544929fe811dcfe9334d1fff0a14ad003
+  data.tar.gz: 96e262a0e445bdbf83bef0e68fa086402fce68655be1eec23a11b66c5ce5074416e56dbe5a34d09932d28a8e10fdd1413ce16ca7c1d1835cc32ca76ccb03827e

data/README.md

@@ -1,12 +1,13 @@
 # Manifester
-Manifester was born from the need to ship webpacker generated assets without webpacker.
+Manifester was born from the need to ship webpacker generated assets without webpacker for our Rails engines.
 
 When we first shipped [Avo](https://github.com/avo-hq/avo) we shipped it with the whole Webpacker pipeline. That meant rebuilding the assets on every deploy of the parent app and other nasty unwanted behaviors (conflicting pipelines, etc.).
 
-We just needed something that would take the packed files when we  and
+We just needed something that would take the packed files and add it to the layout.
 
-## Usage
-How to use my plugin.
+Most of the code has been extracted from [webpacker](https://github.com/rails/webpacker/).
+
+**Important**: I assume you have followed [this](https://github.com/rails/webpacker/blob/5-x-stable/docs/engines.md) guide to add webpacker to your engine.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -20,13 +21,72 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install manifester
+```ruby
+  # your engine's gemspec
+  spec.add_dependency "manifester"
+```
+
+Instantiate the plugin in your main file using a few config values. Also have the webpacker instance side by side for development.
+
+```ruby
+# lib/your_engine.rb
+
+module YourEngine
+  ROOT_PATH = Pathname.new(File.join(__dir__, ".."))
+  IN_DEVELOPMENT = ENV["ENGINE_IN_DEVELOPMENT"] == "1"
+
+  class << self
+    # have a webpacker instance for your development env
+    def webpacker
+      @webpacker ||= ::Webpacker::Instance.new(
+        root_path: ROOT_PATH,
+        config_path: ROOT_PATH.join("config/webpacker.yml")
+      )
+    end
+
+    def manifester
+      @manifester ||= ::Manifester::Instance.new(
+        root_path: ROOT_PATH,
+        public_output_dir: "your-engine-packs", # the path where your packed files live
+        cache_manifest: Rails.env.production?,
+        fallback_to_webpacker: -> { YourEngine::IN_DEVELOPMENT || Rails.env.test? } # fallback to webpacker in development
+      )
+    end
+  end
+end
 ```
 
+In your application helper override the `current_webpacker_instance` method to return your engine's instance **only in development** and the parent app webpacker in production.
+
+Add the `current_manifester_instance` method.
+
+```ruby
+# app/helpers/your_engine/application_helper
+module YourEngine
+  module ApplicationHelper
+    include ::Manifester::Helper # add the manifester helpers
+
+    # add your current webpacker instance for development
+    def current_webpacker_instance
+      return YourEngine.webpacker if YourEngine::IN_DEVELOPMENT || Rails.env.test?
+
+      super
+    end
+
+    def current_manifester_instance
+      YourEngine.manifester
+    end
+  end
+end
+```
+
+## Usage
+
+Now you should have webpacker work as usual in development and testing environments and manifester in the production env.
+
 ## Contributing
-Contribution directions go here.
+
+Clone the repo, run `bundle install`.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/manifester/version.rb

@@ -1,3 +1,3 @@
 module Manifester
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manifester
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Adrian Marin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2021-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails