propshaft 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14ffc5b071d45f08f18e5f52fa2668f4630debf23d501c08e000d309c3a9b8fd
-  data.tar.gz: c210e3cd12d58e3df3c2a20c2b42d182ee66e13ae3d6653fd05272b3ad513e37
+  metadata.gz: 963ec537db8637fe43844f1b46e290c600c04b5f8b170c79583d4370dbcefbbf
+  data.tar.gz: c6f48c154b847a715317ba44d041287f82f009ee760b9b9d8e7a319c7f354ff2
 SHA512:
-  metadata.gz: bea78212ba31154621e6878b7e721abbc787e0594da6dadf6d6e587b213c9f587d6d554e74f5b79d361944ae43514c82efa30b49978d4faa776e21774ceb4fd6
-  data.tar.gz: 46de0996122fe99868d6a74a1d4f3c37c8897c6b760e0a7de9db36cc8794995ea6c753d792fd21ddde22d2d9fa1fd599aef055d94a42da49b36e1badeb5f5ca9
+  metadata.gz: 5e08613dd985ef975477b9a1886ffa5def8aef4889c6d4cbfd585d716c711e5806265d52370c819642ebcade755062c08358809823bbb4bc4ecece4892dbe3b5
+  data.tar.gz: 16f7245a2a4c9aa69f066a566e9781a1cb1327141b6daf865fd6917f3b1d5eaec560f5ee1cf8600c484e43f60d3acea55fca4b8262dd8ec88ef714839a57ee61

data/README.md

@@ -22,6 +22,29 @@ You can however exempt directories that have been added through the `config.asse
 
 These assets can be referenced through their logical path using the normal helpers like `asset_path`, `image_tag`, `javascript_include_tag`, and all the other asset helper tags. These logical references are automatically converted into digest-aware paths in production when `assets:precompile` has been run (through a JSON mapping file found in `public/assets/.manifest.json`).
 
+## Referencing digested assets in CSS and JavaScript
+
+Propshaft will automatically convert asset references in CSS to use the digested file names. So `background: url("/bg/pattern.svg")` is converted to `background: url("/assets/bg/pattern-2169cbef.svg")` before the stylesheet is served.
+
+For JavaScript, you'll have to manually trigger this transformation by using the `RAILS_ASSET_URL` pseudo-method. It's used like this:
+
+```javascript
+export default class extends Controller {
+  init() {
+    this.img = RAILS_ASSET_URL("/icons/trash.svg")
+  }
+}
+```
+
+That'll turn into:
+
+```javascript
+export default class extends Controller {
+  init() {
+    this.img = "/assets/icons/trash-54g9cbef.svg"
+  }
+}
+```
 
 ## Bypassing the digest step
 

data/lib/propshaft/assembly.rb

@@ -5,6 +5,7 @@ require "propshaft/server"
 require "propshaft/processor"
 require "propshaft/compilers"
 require "propshaft/compiler/css_asset_urls"
+require "propshaft/compiler/js_asset_urls"
 require "propshaft/compiler/source_mapping_urls"
 
 class Propshaft::Assembly

data/lib/propshaft/compiler/js_asset_urls.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "propshaft/compiler"
+
+class Propshaft::Compiler::JsAssetUrls < Propshaft::Compiler
+  ASSET_URL_PATTERN = %r{RAILS_ASSET_URL\(\s*["']?(?!(?:\#|%23|data|http|//))([^"'\s?#)]+)([#?][^"')]+)?\s*["']?\)}
+
+  def compile(asset, input)
+    input.gsub(ASSET_URL_PATTERN) { asset_url(resolve_path(asset.logical_path.dirname, $1), asset.logical_path, $2, $1) }
+  end
+
+  def referenced_by(asset, references: Set.new)
+    asset.content.scan(ASSET_URL_PATTERN).each do |referenced_asset_url, _|
+      referenced_asset = load_path.find(resolve_path(asset.logical_path.dirname, referenced_asset_url))
+
+      if referenced_asset && references.exclude?(referenced_asset)
+        references << referenced_asset
+        references.merge referenced_by(referenced_asset, references: references)
+      end
+    end
+
+    references
+  end
+
+  private
+    def resolve_path(directory, filename)
+      if filename.start_with?("../")
+        Pathname.new(directory + filename).relative_path_from("").to_s
+      elsif filename.start_with?("/")
+        filename.delete_prefix("/").to_s
+      else
+        (directory + filename.delete_prefix("./")).to_s
+      end
+    end
+
+    def asset_url(resolved_path, logical_path, fingerprint, pattern)
+      asset = load_path.find(resolved_path)
+      if asset
+        %["#{url_prefix}/#{asset.digested_path}#{fingerprint}"]
+      else
+        Propshaft.logger.warn("Unable to resolve '#{pattern}' for missing asset '#{resolved_path}' in #{logical_path}")
+        %["#{pattern}"]
+      end
+    end
+end

data/lib/propshaft/railtie.rb

@@ -1,6 +1,5 @@
 require "rails"
 require "active_support/ordered_options"
-require "propshaft"
 require "propshaft/quiet_assets"
 
 module Propshaft
@@ -14,7 +13,8 @@ module Propshaft
     config.assets.compilers      = [
       [ "text/css", Propshaft::Compiler::CssAssetUrls ],
       [ "text/css", Propshaft::Compiler::SourceMappingUrls ],
-      [ "text/javascript", Propshaft::Compiler::SourceMappingUrls ]
+      [ "text/javascript", Propshaft::Compiler::JsAssetUrls ],
+      [ "text/javascript", Propshaft::Compiler::SourceMappingUrls ],
     ]
     config.assets.sweep_cache = Rails.env.development?
     config.assets.server = Rails.env.development? || Rails.env.test?
@@ -33,7 +33,7 @@ module Propshaft
 
     config.after_initialize do |app|
       # Prioritize assets from within the application over assets of the same path from engines/gems.
-      config.assets.paths.sort_by! { |path| path.to_s.start_with?(Rails.root.to_s) ? 0 : 1 }
+      config.assets.paths.sort_by!.with_index { |path, i| [path.to_s.start_with?(Rails.root.to_s) ? 0 : 1, i] }
 
       config.assets.relative_url_root ||= app.config.relative_url_root
       config.assets.output_path ||=

data/lib/propshaft/version.rb

@@ -1,3 +1,3 @@
 module Propshaft
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-29 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -80,6 +80,7 @@ files:
 - lib/propshaft/asset.rb
 - lib/propshaft/compiler.rb
 - lib/propshaft/compiler/css_asset_urls.rb
+- lib/propshaft/compiler/js_asset_urls.rb
 - lib/propshaft/compiler/source_mapping_urls.rb
 - lib/propshaft/compilers.rb
 - lib/propshaft/errors.rb