isolate_assets 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b42e51e51aa619c08d02e6d2e7c02aca58aab0cbab94b7d629449940bb2d32df
-  data.tar.gz: a5872849a66dd7b213a3341e6e905af3403b1d66bf2d00c911e137b8b9411fd5
+  metadata.gz: 3ac311515e556ca2199cbfdb72559a19bffed148c18184c1ac364e742b31d2d6
+  data.tar.gz: ff9aeb49469e913c4b48c20ee1b82790778410f553606b62f10702a37373623a
 SHA512:
-  metadata.gz: 03bce00b9fb6117c4c0e2b202e38a99dd37b89dd60d4f767f94d3a7ca253d4b48dbd5da62d83852f054ded4466151cdc6c4aa65e20ad96564e65e806f7414dea
-  data.tar.gz: af6aae32f9f05cac171c7e9f761f877ae07afa7419656bf6996424e2c474ab082cb431794e7b339b7e43d9c9744e6341e2183d36b0654638e134088586746113
+  metadata.gz: 0f25291c4ff1393aa72c764d52492e9baaba70f61880ce31403292b15796120a3f1e751cc53db01a8a9fe2e3eb4524ef20767a60bd739cbe3dc2dd96e0b915e5
+  data.tar.gz: c4aac80bac4d4fc9cf59367afa765024e6f2f3574da76637159875c617a3ddae5b0bbbfd175cd4afad1eed32aae5bb0fa316c53a753045ea738383dcb4401b1c

data/README.md

@@ -41,12 +41,12 @@ end
 
 ### 2. Add your assets
 
-Place assets in `app/engine_assets/`:
+Place assets in the standard `app/assets/` directory:
 
 ```
 my_engine/
   app/
-    engine_assets/
+    assets/
       javascripts/
         application.js
         components/
@@ -56,6 +56,8 @@ my_engine/
         theme.css
 ```
 
+IsolateAssets automatically excludes your engine's `app/assets/` directory from the host app's asset pipeline (Sprockets/Propshaft), so your assets won't conflict with or be processed by the host application.
+
 ### 3. Include the helper
 
 In your engine's application helper:
@@ -101,6 +103,16 @@ Example output:
 </script>
 ```
 
+## How it works
+
+IsolateAssets automatically excludes your engine's asset directories from `config.assets.paths`, so Sprockets, Propshaft, and dartsass-rails won't process them. Your assets are served exclusively through the isolate_assets controller with their own fingerprinting and caching.
+
+This exclusion relies on filtering `config.assets.paths` after engines register their directories. While this works with current Rails asset tools, future versions could change path discovery. For guaranteed isolation, use a non-standard directory:
+
+```ruby
+isolate_assets assets_subdir: "isolated_assets"  # uses app/isolated_assets/
+```
+
 ## Requirements
 
 - Ruby 3.2+

data/lib/isolate_assets/assets.rb

@@ -4,7 +4,7 @@ module IsolateAssets
   class Assets
     attr_reader :engine, :assets_subdir
 
-    def initialize(engine:, assets_subdir: "engine_assets")
+    def initialize(engine:, assets_subdir: "assets")
       @engine = engine
       @assets_subdir = assets_subdir
       @fingerprints = {}

data/lib/isolate_assets/engine_extension.rb

@@ -2,32 +2,47 @@
 
 module IsolateAssets
   module EngineExtension
-    def isolate_assets(assets_subdir: "engine_assets")
+    def isolate_assets(assets_subdir: "assets")
       engine_class = self
 
-      # Create a unique controller class for this engine
-      controller_class = Class.new(IsolateAssets::Controller)
+      # Exclude engine assets from host's asset pipeline
+      initializer "#{engine_name}.isolate_assets.exclude_from_pipeline", before: :load_config_initializers do |app|
+        asset_base = engine_class.root.join("app", assets_subdir)
+        app.config.assets.excluded_paths ||= []
+        if asset_base.exist?
+          asset_base.children.select(&:directory?).each do |subdir|
+            app.config.assets.excluded_paths << subdir.to_s
+          end
+        end
+      end
+
+      # Sprockets doesn't respect excluded_paths, so filter manually
+      initializer "#{engine_name}.isolate_assets.filter_asset_paths", after: :load_config_initializers do |app|
+        if app.config.assets.excluded_paths.present?
+          excluded = app.config.assets.excluded_paths.map(&:to_s)
+          app.config.assets.paths = app.config.assets.paths.reject do |path|
+            excluded.include?(path.to_s)
+          end
+        end
+      end
 
-      # Register an initializer to set up assets when Rails boots
       initializer "#{engine_name}.isolate_assets", before: :set_routes_reloader do
         assets = IsolateAssets::Assets.new(engine: engine_class, assets_subdir: assets_subdir)
 
-        # Create a unique helper module for this engine with the assets baked in
+        # Subclass the controller so that multiple engines using this gem get their own controller
+        controller_class = Class.new(IsolateAssets::Controller)
+        controller_class.isolated_assets = assets
+
+        # Hack in the helpers. There's gotta be a better way than this...
         helper_module = Module.new do
           define_method(:isolated_assets) { assets }
           include IsolateAssets::Helper
         end
-
-        # Wire up the controller
-        controller_class.isolated_assets = assets
-
-        # Store on the engine's namespace module
         if engine_class.respond_to?(:railtie_namespace) && engine_class.railtie_namespace
           engine_class.railtie_namespace.singleton_class.define_method(:isolated_assets) { assets }
           engine_class.railtie_namespace.singleton_class.define_method(:isolated_assets_helper) { helper_module }
         end
 
-        # Draw routes
         engine_class.routes.prepend do
           get "/assets/*file", to: controller_class.action(:show), as: :isolated_asset
         end

data/lib/isolate_assets/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: isolate_assets
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Micah Geisel