propshaft 0.6.4 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bee1e0c2fcf39062df053618528b93dd5977bd8968fea03a67d31b7196f04f9
-  data.tar.gz: ad9c5f3b7bc878a359931d2c1edc2a2ecb98004b8cfba38dd226acd0a19e43ff
+  metadata.gz: 56736cd8d13ffa9511e5cd47d39e3d3849f66484f0ba489686b75aa5a5c57936
+  data.tar.gz: 7adfc7103ca6694027ad577b7cd14bf6972227f02bdf0bd0659d508371afdfad
 SHA512:
-  metadata.gz: 41a54360ed2d9424f1c190af2606c5d2bc88a2d01d61a1396ed60fc64ba1531e815cc259ac41904fe3a49053d057ee2f838be0c8763b37a1ebbe79067f52301f
-  data.tar.gz: be6381394ff2c2dfa9bf0ca23d2023b196492d83012970091eca5ce03822ee127fa40103382dd85d6093ae1edc5b91545a59be21beb0a9736fa3037a322d5678
+  metadata.gz: 67c4c686072bc75784519f8043225b9bb462a19a74a2617ec1628a25cb701bad1aabe05a873126038718b6bd18ba9d51f47cdd0daa89418186996832a0f5707c
+  data.tar.gz: f476c9aff5b7975df5815095bdf1917eeb748ee1c9ebab0f058aa670863597a6d4794c77b3bd379eafb355c83b9fa8008b366796ad52188d7804410f93c8ec33

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
 
@@ -39,7 +49,7 @@ But for greenfield apps using the default import-map approach, Propshaft can als
 
 ## Will Propshaft replace Sprockets as the Rails default?
 
-Most likely, but Sprockets need to be supported as well for a long time to come. Plenty of apps and gems were built on Sprocket features, and they won't be migrating soon. Still working out the compatibility story. This is very much alpha software at the moment.
+Most likely, but Sprockets need to be supported as well for a long time to come. Plenty of apps and gems were built on Sprocket features, and they won't be migrating soon. Still working out the compatibility story. This is very much beta software at the moment.
 
 
 ## License

data/lib/propshaft/assembly.rb

@@ -4,8 +4,8 @@ require "propshaft/resolver/static"
 require "propshaft/server"
 require "propshaft/processor"
 require "propshaft/compilers"
-require "propshaft/compilers/css_asset_urls"
-require "propshaft/compilers/source_mapping_urls"
+require "propshaft/compiler/css_asset_urls"
+require "propshaft/compiler/source_mapping_urls"
 
 class Propshaft::Assembly
   attr_reader :config

data/lib/propshaft/{compilers → compiler}/css_asset_urls.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-class Propshaft::Compilers::CssAssetUrls
-  attr_reader :assembly
+require "propshaft/compiler"
 
-  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|data|http))([^"'\s?#)]+)([#?][^"']+)?\s*["']?\)/
-
-  def initialize(assembly)
-    @assembly = assembly
-  end
+class Propshaft::Compiler::CssAssetUrls < Propshaft::Compiler
+  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|%23|data|http|\/\/))([^"'\s?#)]+)([#?][^"')]+)?\s*["']?\)/
 
   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 +20,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/{compilers → compiler}/source_mapping_urls.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
-class Propshaft::Compilers::SourceMappingUrls
-  attr_reader :assembly
+require "propshaft/compiler"
 
-  SOURCE_MAPPING_PATTERN = %r{^(//|/\*)# sourceMappingURL=(.+\.map)}
-
-  def initialize(assembly)
-    @assembly = assembly
-  end
+class Propshaft::Compiler::SourceMappingUrls < Propshaft::Compiler
+  SOURCE_MAPPING_PATTERN = %r{(//|/\*)# sourceMappingURL=(.+\.map)(\s*?\*\/)?\s*?\Z}
 
   def compile(logical_path, input)
-    input.gsub(SOURCE_MAPPING_PATTERN) { source_mapping_url(asset_path($2, logical_path), $1) }
+    input.gsub(SOURCE_MAPPING_PATTERN) { source_mapping_url(asset_path($2, logical_path), $1, $3) }
   end
 
   private
@@ -22,12 +18,12 @@ class Propshaft::Compilers::SourceMappingUrls
       end
     end
 
-    def source_mapping_url(resolved_path, comment)
+    def source_mapping_url(resolved_path, comment_start, comment_end)
       if asset = assembly.load_path.find(resolved_path)
-        "#{comment}# sourceMappingURL=#{assembly.config.prefix}/#{asset.digested_path}"
+        "#{comment_start}# sourceMappingURL=#{url_prefix}/#{asset.digested_path}#{comment_end}"
       else
         Propshaft.logger.warn "Removed sourceMappingURL comment for missing asset '#{resolved_path}' from #{resolved_path}"
-        nil
+        "#{comment_start}#{comment_end}"
       end
     end
 end

data/lib/propshaft/compiler.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Base compiler from which other compilers can inherit
+class Propshaft::Compiler
+  attr_reader :assembly
+
+  def initialize(assembly)
+    @assembly = assembly
+  end
+
+  # Override this in a specific compiler
+  def compile(logical_path, input)
+    raise NotImplementedError
+  end
+
+  private
+    def url_prefix
+      @url_prefix ||= File.join(assembly.config.relative_url_root.to_s, assembly.config.prefix.to_s).chomp("/")
+    end
+end

data/lib/propshaft/helper.rb

@@ -3,5 +3,23 @@ module Propshaft
     def compute_asset_path(path, options = {})
       Rails.application.assets.resolver.resolve(path) || raise(MissingAssetError.new(path))
     end
+
+    # Add an option to call `stylesheet_link_tag` with `:all` to include every css file found on the load path.
+    def stylesheet_link_tag(*sources)
+      if sources.first == :all
+        super *all_stylesheets_paths
+      else
+        super
+      end
+    end
+
+    # Returns a sorted and unique array of logical paths for all stylesheets in the load path.
+    def all_stylesheets_paths
+      Rails.application.assets.load_path
+        .assets(content_types: [ Mime::EXTENSION_LOOKUP["css"] ])
+        .collect { |css| css.logical_path.to_s }
+        .sort
+        .uniq
+    end
   end
 end

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

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,13 +9,15 @@ 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 ],
-      [ "text/javascript", Propshaft::Compilers::SourceMappingUrls ]
+      [ "text/css", Propshaft::Compiler::CssAssetUrls ],
+      [ "text/css", Propshaft::Compiler::SourceMappingUrls ],
+      [ "text/javascript", Propshaft::Compiler::SourceMappingUrls ]
     ]
     config.assets.sweep_cache = Rails.env.development?
     config.assets.server = Rails.env.development? || Rails.env.test?
+    config.assets.relative_url_root = 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.relative_url_root ||= app.config.relative_url_root
       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#{Rails.application.config.assets.prefix}/.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"
+          Rack::CONTENT_LENGTH  => compiled_content.length.to_s,
+          Rack::CONTENT_TYPE    => asset.content_type.to_s,
+          VARY                  => "Accept-Encoding",
+          Rack::ETAG            => asset.digest,
+          Rack::CACHE_CONTROL   => "public, max-age=31536000, immutable"
         },
         [ compiled_content ]
       ]
     else
-      [ 404, { "Content-Type" => "text/plain", "Content-Length" => "9" }, [ "Not found" ] ]
+      [ 404, { Rack::CONTENT_TYPE => "text/plain", Rack::CONTENT_LENGTH => "9" }, [ "Not found" ] ]
     end
   end
 
@@ -39,4 +39,10 @@ class Propshaft::Server
 
       [ path, digest ]
     end
+
+    if Gem::Version.new(Rack::RELEASE) < Gem::Version.new("3")
+      VARY = "Vary"
+    else
+      VARY = "vary"
+    end
 end

data/lib/propshaft/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.8.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2023-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -78,14 +78,16 @@ files:
 - lib/propshaft.rb
 - lib/propshaft/assembly.rb
 - lib/propshaft/asset.rb
+- lib/propshaft/compiler.rb
+- lib/propshaft/compiler/css_asset_urls.rb
+- lib/propshaft/compiler/source_mapping_urls.rb
 - lib/propshaft/compilers.rb
-- lib/propshaft/compilers/css_asset_urls.rb
-- lib/propshaft/compilers/source_mapping_urls.rb
 - lib/propshaft/errors.rb
 - lib/propshaft/helper.rb
 - 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 +114,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.4.20
 signing_key:
 specification_version: 4
 summary: Deliver assets for Rails.