propshaft 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a482b12e3d939c6286f02d4e6ca66a141b9124527503f64ceb262277366fca6
-  data.tar.gz: a0d5ad9626de08fbab61cf450d95abab5ea77a1e5b90a162cbdc79ee1e424e07
+  metadata.gz: f01db7988c70a623917c5239f4b76cef03e3364b86f3bb1b9850691d1045d3e1
+  data.tar.gz: 066dab4410e31551036e8f539cb351b8c4a6d7c53ae9bd02343b228be16fc85f
 SHA512:
-  metadata.gz: 3e60fdc05df54c428a898d460f2df85bdaf1d65a39c4a1025e8e70b758b10e1f39453ee7665c052c6d4b090257cac0b34accb896a25f7362dade2e0fc06b5276
-  data.tar.gz: d501ae6047c543b522f791d23d8cd6856a0d3c9101c5cbf3fdb3d632a942fa995dc0707c6bdc872040efb8c63d859ace32be66a93b51788f57aa452ce0930850
+  metadata.gz: 7b09d882ebf32f6afda261a3dbf32ab322e25b1756b802b70e4b6b16f73f3d91404e8b51be6e5c54a1335332744305d3d149712136cbbdabc67b258229178b9f
+  data.tar.gz: 65a13d00417ff13f2678660038ebb7f33074e56b0277b7c51e9df170f9e393ec17cd5ff5ddc888b4e24c469df33ba4f5d8acb19ecf5a2b7626d41c22dac0d781

data/README.md

@@ -24,6 +24,11 @@ These assets can be referenced through their logical path using the normal helpe
 Additionally, Propshaft ships with a CSS function called `asset-path("image.svg")` that'll be compiled into `url("/assets/image-f2e1ec14d6856e1958083094170ca6119c529a73.svg")` when doing `assets:precompile`. This function is applied to all `.css` files.
 
 
+## Bypassing the digest step
+
+If you need to put multiple files that refer to each other through Propshaft, like a JavaScript file and its source map, you have to digest these files in advance to retain stable file names. Propshaft looks for the specific pattern of `-[digest].digested.js` as the postfix to any asset file as an indication that the file has already been digested.
+
+
 ## Migrating from Sprockets
 
 Propshaft does a lot less than Sprockets, by design, so it might well be a fair bit of work to migrate if it's even desirable. This is particularly true if you rely on Sprockets to provide any form of transpiling, like CoffeeScript or Sass, or if you rely on any gems that do. You'll need to either stop transpiling or use a Node-based transpiler, like those in `jsbundling-rails` and `cssbundling-rails`.

data/lib/propshaft/assembly.rb

@@ -14,7 +14,7 @@ class Propshaft::Assembly
   end
 
   def load_path
-    Propshaft::LoadPath.new(config.paths)
+    @load_path ||= Propshaft::LoadPath.new(config.paths)
   end
 
   def resolver

data/lib/propshaft/asset.rb

@@ -25,10 +25,19 @@ class Propshaft::Asset
   end
 
   def digested_path
-    logical_path.sub(/\.(\w+)$/) { |ext| "-#{digest}#{ext}" }
+    if already_digested?
+      logical_path
+    else
+      logical_path.sub(/\.(\w+)$/) { |ext| "-#{digest}#{ext}" }
+    end
   end
 
   def ==(other_asset)
     logical_path.hash == other_asset.logical_path.hash
   end
+
+  private
+    def already_digested?
+      logical_path.to_s =~ /-([0-9a-f]{7,128})\.digested\.[^.]+\z/
+    end
 end

data/lib/propshaft/load_path.rb

@@ -27,9 +27,23 @@ class Propshaft::LoadPath
     end
   end
 
+  # Returns a ActiveSupport::FileUpdateChecker object configured to clear the cache of the load_path
+  # when the directories passed during its initialization have changes. This is used in development
+  # and test to ensure the map caches are reset when javascript files are changed.
+  def cache_sweeper
+    @cache_sweeper ||= begin
+      exts_to_watch  = Mime::EXTENSION_LOOKUP.map(&:first)
+      files_to_watch = Array(paths).collect { |dir| [ dir.to_s, exts_to_watch ] }.to_h
+
+      Rails.application.config.file_watcher.new([], files_to_watch) do
+        clear_cache
+      end
+    end
+  end
+
   private
     def assets_by_path
-      Hash.new.tap do |mapped|
+      @cached_assets_by_path ||= Hash.new.tap do |mapped|
         paths.each do |path|
           all_files_from_tree(path).each do |file|
             logical_path = file.relative_path_from(path)
@@ -42,4 +56,8 @@ class Propshaft::LoadPath
     def all_files_from_tree(path)
       path.children.flat_map { |child| child.directory? ? all_files_from_tree(child) : child }
     end
+
+    def clear_cache
+      @cached_assets_by_path = nil
+    end
 end

data/lib/propshaft/railtie.rb

@@ -14,9 +14,10 @@ end
 module Propshaft
   class Railtie < ::Rails::Railtie
     config.assets = ActiveSupport::OrderedOptions.new
-    config.assets.paths     = []
-    config.assets.prefix    = "/assets"
-    config.assets.compilers = [ [ "text/css", Propshaft::Compilers::CssAssetUrls ] ]
+    config.assets.paths       = []
+    config.assets.prefix      = "/assets"
+    config.assets.compilers   = [ [ "text/css", Propshaft::Compilers::CssAssetUrls ] ]
+    config.assets.sweep_cache = Rails.env.development? || Rails.env.test?
 
     config.after_initialize do |app|
       config.assets.output_path ||=
@@ -31,6 +32,12 @@ module Propshaft
       ActiveSupport.on_load(:action_view) do
         include Propshaft::Helper
       end
+
+      if config.assets.sweep_cache
+        ActiveSupport.on_load(:action_controller_base) do
+          before_action { Rails.application.assets.load_path.cache_sweeper.execute_if_updated }
+        end
+      end
     end
 
     rake_tasks do |app|

data/lib/propshaft/version.rb

@@ -1,3 +1,3 @@
 module Propshaft
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails