propshaft 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bee1e0c2fcf39062df053618528b93dd5977bd8968fea03a67d31b7196f04f9
-  data.tar.gz: ad9c5f3b7bc878a359931d2c1edc2a2ecb98004b8cfba38dd226acd0a19e43ff
+  metadata.gz: a149fdc0fb45487422a71e21df47105ee0071e23f752f596f54cd98400bc99e2
+  data.tar.gz: 9dcd99aa258a91aa99ac46f1da9379712d836f06c42cd8ce9e6df8b020cc94c6
 SHA512:
-  metadata.gz: 41a54360ed2d9424f1c190af2606c5d2bc88a2d01d61a1396ed60fc64ba1531e815cc259ac41904fe3a49053d057ee2f838be0c8763b37a1ebbe79067f52301f
-  data.tar.gz: be6381394ff2c2dfa9bf0ca23d2023b196492d83012970091eca5ce03822ee127fa40103382dd85d6093ae1edc5b91545a59be21beb0a9736fa3037a322d5678
+  metadata.gz: 79779f26c1d121049451c5a8d7545e9fbfbcdd2b01a966f89fa0a23aa2b140ea2932828bd4c1b9edbab8be106366f8f92f9daa91bfa1c7af2207619a6fcce9fe
+  data.tar.gz: 7f609b53f85ef6bdeb53972c11d9a54301cd974c7d5573d5d93fbeb043daed863e08407bb95b45d7c8a55a122770dcb5f9f8b2d55f6830c2adbb5465281613ad

data/README.md

@@ -27,6 +27,16 @@ These assets can be referenced through their logical path using the normal helpe
 
 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.
 
+## Improving performance in development
+
+Before every request Propshaft checks if any asset was updated to decide if a cache sweep is needed. This verification is done using the application's configured file watcher which, by default, is `ActiveSupport::FileUpdateChecker`. 
+
+If you have a lot of assets in your project, you can improve performance by adding the `listen` gem to the development group in your Gemfile, and this line to the `development.rb` environment file:
+
+```ruby
+config.file_watcher = ActiveSupport::EventedFileUpdateChecker
+```
+
 
 ## Migrating from Sprockets
 

data/lib/propshaft/asset.rb

@@ -2,10 +2,15 @@ require "digest/sha1"
 require "action_dispatch/http/mime_type"
 
 class Propshaft::Asset
+  PREDIGESTED_REGEX = /-([0-9a-zA-Z]{7,128}\.digested)/
+
   attr_reader :path, :logical_path, :version
 
   def initialize(path, logical_path:, version: nil)
-    @path, @logical_path, @version = path, Pathname.new(logical_path), version
+    @path         = path
+    @digest       = logical_path.to_s[PREDIGESTED_REGEX, 1]
+    @logical_path = Pathname.new(@digest ? logical_path.sub("-#{@digest}", "") : logical_path)
+    @version      = version
   end
 
   def content
@@ -25,23 +30,14 @@ class Propshaft::Asset
   end
 
   def digested_path
-    if already_digested?
-      logical_path
-    else
-      logical_path.sub(/\.(\w+)$/) { |ext| "-#{digest}#{ext}" }
-    end
+    logical_path.sub(/\.(\w+)$/) { |ext| "-#{digest}#{ext}" }
   end
 
   def fresh?(digest)
-    self.digest == digest || already_digested?
+    self.digest == digest
   end
 
   def ==(other_asset)
     logical_path.hash == other_asset.logical_path.hash
   end
-
-  private
-    def already_digested?
-      logical_path.to_s =~ /-([0-9a-zA-Z]{7,128})\.digested/
-    end
 end

data/lib/propshaft/compilers/css_asset_urls.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
 class Propshaft::Compilers::CssAssetUrls
-  attr_reader :assembly
+  attr_reader :assembly, :url_prefix
 
-  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|data|http))([^"'\s?#)]+)([#?][^"']+)?\s*["']?\)/
+  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|%23|data|http|\/\/))([^"'\s?#)]+)([#?][^"')]+)?\s*["']?\)/
 
   def initialize(assembly)
-    @assembly = assembly
+    @assembly   = assembly
+    @url_prefix = File.join(assembly.config.host.to_s, assembly.config.prefix.to_s).chomp("/")
   end
 
   def compile(logical_path, input)
-    input.gsub(ASSET_URL_PATTERN) { asset_url resolve_path(logical_path.dirname, $1), logical_path, $1 }
+    input.gsub(ASSET_URL_PATTERN) { asset_url resolve_path(logical_path.dirname, $1), logical_path, $2, $1 }
   end
 
   private
@@ -24,9 +25,9 @@ class Propshaft::Compilers::CssAssetUrls
       end
     end
 
-    def asset_url(resolved_path, logical_path, pattern)
+    def asset_url(resolved_path, logical_path, fingerprint, pattern)
       if asset = assembly.load_path.find(resolved_path)
-        %[url("#{assembly.config.prefix}/#{asset.digested_path}")]
+        %[url("#{url_prefix}/#{asset.digested_path}#{fingerprint}")]
       else
         Propshaft.logger.warn "Unable to resolve '#{pattern}' for missing asset '#{resolved_path}' in #{logical_path}"
         %[url("#{pattern}")]

data/lib/propshaft/load_path.rb

@@ -28,7 +28,7 @@ class Propshaft::LoadPath
     end
   end
 
-  # Returns a ActiveSupport::FileUpdateChecker object configured to clear the cache of the load_path
+  # Returns a file watcher 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
@@ -48,7 +48,8 @@ class Propshaft::LoadPath
         paths.each do |path|
           without_dotfiles(all_files_from_tree(path)).each do |file|
             logical_path = file.relative_path_from(path)
-            mapped[logical_path.to_s] ||= Propshaft::Asset.new(file, logical_path: logical_path, version: version)
+            asset = Propshaft::Asset.new(file, logical_path: logical_path, version: version)
+            mapped[asset.logical_path.to_s] ||= asset
           end if path.exist?
         end
       end

data/lib/propshaft/output_path.rb

@@ -42,7 +42,7 @@ class Propshaft::OutputPath
       modified_at = [ 0, Time.now - mtime ].max
       modified_at < expires_at || limit < count
     end
-  
+
     def remove(path)
       FileUtils.rm(@path.join(path))
       Propshaft.logger.info "Removed #{path}"

data/lib/propshaft/quiet_assets.rb

@@ -0,0 +1,14 @@
+class Propshaft::QuietAssets
+  def initialize(app)
+    @app = app
+    @assets_regex = %r(\A/{0,2}#{::Rails.application.config.assets.prefix})
+  end
+
+  def call(env)
+    if env['PATH_INFO'] =~ @assets_regex
+      ::Rails.logger.silence { @app.call(env) }
+    else
+      @app.call(env)
+    end
+  end
+end

data/lib/propshaft/railtie.rb

@@ -1,5 +1,6 @@
 require "rails"
 require "active_support/ordered_options"
+require "propshaft/quiet_assets"
 
 module Propshaft
   class Railtie < ::Rails::Railtie
@@ -8,6 +9,7 @@ module Propshaft
     config.assets.excluded_paths = []
     config.assets.version        = "1"
     config.assets.prefix         = "/assets"
+    config.assets.quiet          = false
     config.assets.compilers      = [
       [ "text/css", Propshaft::Compilers::CssAssetUrls ],
       [ "text/css", Propshaft::Compilers::SourceMappingUrls ],
@@ -15,6 +17,7 @@ module Propshaft
     ]
     config.assets.sweep_cache = Rails.env.development?
     config.assets.server = Rails.env.development? || Rails.env.test?
+    config.assets.host = nil
 
     # Register propshaft initializer to copy the assets path in all the Rails Engines.
     # This makes possible for us to keep all `assets` config in this Railtie, but still
@@ -28,6 +31,7 @@ module Propshaft
     end
 
     config.after_initialize do |app|
+      config.assets.host = app.config.asset_host
       config.assets.output_path ||=
         Pathname.new(File.join(app.config.paths["public"].first, app.config.assets.prefix))
 
@@ -54,6 +58,12 @@ module Propshaft
       Propshaft.logger = config.assets.logger || Rails.logger
     end
 
+    initializer :quiet_assets do |app|
+      if app.config.assets.quiet
+        app.middleware.insert_before ::Rails::Rack::Logger, Propshaft::QuietAssets
+      end
+    end
+
     rake_tasks do
       load "propshaft/railties/assets.rake"
     end
@@ -61,9 +71,7 @@ module Propshaft
     # Compatibility shiming (need to provide log warnings when used)
     config.assets.precompile     = []
     config.assets.debug          = nil
-    config.assets.quiet          = nil
     config.assets.compile        = nil
-    config.assets.version        = nil
     config.assets.css_compressor = nil
     config.assets.js_compressor  = nil
   end

data/lib/propshaft/railties/assets.rake

@@ -2,6 +2,10 @@ namespace :assets do
   desc "Compile all the assets from config.assets.paths"
   task precompile: :environment do
     Rails.application.assets.processor.process
+    if Rails.env.development?
+      puts "Warning: You are precompiling assets in development. Rails will not " \
+        "serve any changed assets until you delete public/assets/.manifest.json"
+    end
   end
 
   desc "Remove config.assets.output_path"

data/lib/propshaft/resolver/static.rb

@@ -20,7 +20,7 @@ module Propshaft::Resolver
 
     private
       def parsed_manifest
-        @parsed_manifest ||= JSON.parse(manifest_path.read)
+        @parsed_manifest ||= JSON.parse(manifest_path.read, symbolize_names: false)
       end
   end
 end

data/lib/propshaft/server.rb

@@ -11,19 +11,19 @@ class Propshaft::Server
     if (asset = @assembly.load_path.find(path)) && asset.fresh?(digest)
       compiled_content = @assembly.compilers.compile(asset)
 
-      [ 
-        200, 
+      [
+        200,
         {
-          "Content-Length"  => compiled_content.length.to_s,
-          "Content-Type"    => asset.content_type.to_s,
-          "Accept-Encoding" => "Vary",
-          "ETag"            => asset.digest,
-          "Cache-Control"   => "public, max-age=31536000, immutable"
+          "content-length"  => compiled_content.length.to_s,
+          "content-type"    => asset.content_type.to_s,
+          "accept-encoding" => "vary",
+          "etag"            => asset.digest,
+          "cache-control"   => "public, max-age=31536000, immutable"
         },
         [ compiled_content ]
       ]
     else
-      [ 404, { "Content-Type" => "text/plain", "Content-Length" => "9" }, [ "Not found" ] ]
+      [ 404, { "content-type" => "text/plain", "content-length" => "9" }, [ "Not found" ] ]
     end
   end
 
@@ -34,7 +34,7 @@ class Propshaft::Server
   private
     def extract_path_and_digest(env)
       full_path = Rack::Utils.unescape(env["PATH_INFO"].to_s.sub(/^\//, ""))
-      digest    = full_path[/-([0-9a-zA-Z]{7,128})\.(?!digested)[^.]+\z/, 1]
+      digest    = full_path[/-([0-9a-zA-Z]{7,128}(?:\.digested)?)\.[^.]+\z/, 1]
       path      = digest ? full_path.sub("-#{digest}", "") : full_path
 
       [ path, digest ]

data/lib/propshaft/version.rb

@@ -1,3 +1,3 @@
 module Propshaft
-  VERSION = "0.6.4"
+  VERSION = "0.7.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -86,6 +86,7 @@ files:
 - lib/propshaft/load_path.rb
 - lib/propshaft/output_path.rb
 - lib/propshaft/processor.rb
+- lib/propshaft/quiet_assets.rb
 - lib/propshaft/railtie.rb
 - lib/propshaft/railties/assets.rake
 - lib/propshaft/resolver/dynamic.rb
@@ -112,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Deliver assets for Rails.