propshaft 0.1.6 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a482b12e3d939c6286f02d4e6ca66a141b9124527503f64ceb262277366fca6
-  data.tar.gz: a0d5ad9626de08fbab61cf450d95abab5ea77a1e5b90a162cbdc79ee1e424e07
+  metadata.gz: 4b51bb39ebb02eaa2eb0491eb6af28b1d6034d8b6dbed1da92161cc9d6ece2a7
+  data.tar.gz: 80426c2f10fe259bb7aec42c86f15581686680a4bb017117c677df2cc95150e1
 SHA512:
-  metadata.gz: 3e60fdc05df54c428a898d460f2df85bdaf1d65a39c4a1025e8e70b758b10e1f39453ee7665c052c6d4b090257cac0b34accb896a25f7362dade2e0fc06b5276
-  data.tar.gz: d501ae6047c543b522f791d23d8cd6856a0d3c9101c5cbf3fdb3d632a942fa995dc0707c6bdc872040efb8c63d859ace32be66a93b51788f57aa452ce0930850
+  metadata.gz: 35ca25b6bc30528fa870343793320c59265819b1154ac14d0f2fefa4288a66c686e63b87ddc264d3ab3a467df1be0399b8bb37a0e3d157f5c5240eb6756db7d8
+  data.tar.gz: 9d3abd851135146a1bacf62c73c755679d4bc76f920b89f969a4f4b34700c09a3334025a15531f85196a420a63c2d5f77f7f7bacdff91ab4c8537117982c0948

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,11 +14,11 @@ class Propshaft::Assembly
   end
 
   def load_path
-    Propshaft::LoadPath.new(config.paths)
+    @load_path ||= Propshaft::LoadPath.new(config.paths)
   end
 
   def resolver
-    if manifest_path.exist?
+    @resolver ||= if manifest_path.exist?
       Propshaft::Resolver::Static.new manifest_path: manifest_path, prefix: config.prefix
     else
       Propshaft::Resolver::Dynamic.new load_path: load_path, prefix: config.prefix
@@ -43,6 +43,12 @@ class Propshaft::Assembly
       end
   end
 
+  def reveal
+    load_path.assets.each do |asset|
+      Propshaft.logger.info asset.logical_path
+    end
+  end
+
   private
     def manifest_path
       config.output_path.join(Propshaft::Processor::MANIFEST_FILENAME)

data/lib/propshaft/asset.rb

@@ -21,14 +21,27 @@ class Propshaft::Asset
   end
 
   def digest
-    Digest::SHA1.hexdigest(content)
+    @digest ||= Digest::SHA1.hexdigest(content)
   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 fresh?(digest)
+    self.digest == digest || already_digested?
   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/
+    end
 end

data/lib/propshaft/compilers/css_asset_urls.rb

@@ -1,13 +1,35 @@
+# frozen_string_literal: true
+require "propshaft/errors"
+
 class Propshaft::Compilers::CssAssetUrls
   attr_reader :assembly
 
+  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|data|http))([^"'\s)]+)\s*["']?\)/
+
   def initialize(assembly)
     @assembly = assembly
   end
 
-  def compile(input)
-    input.gsub(/asset-path\(["']([^"')]+)["']\)/) do |match|
-      %[url("#{assembly.config.prefix}/#{assembly.load_path.find($1).digested_path}")]
-    end
+  def compile(logical_path, input)
+    input.gsub(ASSET_URL_PATTERN) { asset_url resolve_path(logical_path.dirname, $1) }
   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)
+      if asset = assembly.load_path.find(resolved_path)
+        %[url("#{assembly.config.prefix}/#{asset.digested_path}")]
+      else
+        raise Propshaft::MissingAssetError.new(resolved_path)
+      end
+    end
 end

data/lib/propshaft/compilers.rb

@@ -23,7 +23,7 @@ class Propshaft::Compilers
     if relevant_registrations = registrations[asset.content_type.to_s]
       asset.content.dup.tap do |input|
         relevant_registrations.each do |compiler|
-          input.replace compiler.new(assembly).compile(input)
+          input.replace compiler.new(assembly).compile(asset.logical_path, input)
         end
       end
     else

data/lib/propshaft/errors.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Propshaft
+  # Generic base class for all Propshaft exceptions.
+  class Error < StandardError; end
+
+  # Raised when LoadPath cannot find the requested asset
+  class MissingAssetError < Error
+    def initialize(path)
+      super
+      @path = path
+    end
+
+    def message
+      "The asset '#{@path}' was not found in the load path."
+    end
+  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/processor.rb

@@ -16,6 +16,10 @@ class Propshaft::Processor
     compress_assets
   end
 
+  def clean
+    FileUtils.rm_r(output_path) if File.exist?(output_path)
+  end
+
   private
     def ensure_output_path_exists
       FileUtils.mkdir_p output_path
@@ -32,6 +36,7 @@ class Propshaft::Processor
     def output_assets
       load_path.assets.each do |asset|
         unless output_path.join(asset.digested_path).exist?
+          Propshaft.logger.info "Writing #{asset.digested_path}"
           FileUtils.mkdir_p output_path.join(asset.digested_path.parent)
           output_asset(asset)
         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?
 
     config.after_initialize do |app|
       config.assets.output_path ||=
@@ -31,6 +32,16 @@ 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
+
+    initializer "propshaft.logger" do
+      Propshaft.logger = config.assets.logger || Rails.logger
     end
 
     rake_tasks do |app|
@@ -39,6 +50,16 @@ module Propshaft
         task precompile: :environment do
           Rails.application.assets.processor.process
         end
+
+        desc "Remove config.assets.output_path"
+        task clean: :environment do
+          Rails.application.assets.processor.clean
+        end
+
+        desc "Print all the assets available in config.assets.paths"
+        task reveal: :environment do
+          Rails.application.assets.reveal
+        end
       end
     end
 

data/lib/propshaft/resolver/dynamic.rb

@@ -9,6 +9,8 @@ module Propshaft::Resolver
     def resolve(logical_path)
       if asset = load_path.find(logical_path)
         File.join prefix, asset.digested_path
+      else
+        raise Propshaft::MissingAssetError.new(logical_path)
       end
     end
   end

data/lib/propshaft/resolver/static.rb

@@ -9,6 +9,8 @@ module Propshaft::Resolver
     def resolve(logical_path)
       if asset_path = parsed_manifest[logical_path]
         File.join prefix, asset_path
+      else
+        raise Propshaft::MissingAssetError.new(logical_path)
       end
     end
 

data/lib/propshaft/server.rb

@@ -8,16 +8,17 @@ class Propshaft::Server
   def call(env)
     path, digest = extract_path_and_digest(env)
 
-    if (asset = @assembly.load_path.find(path)) && asset.digest == digest
+    if (asset = @assembly.load_path.find(path)) && asset.fresh?(digest)
       compiled_content = @assembly.compilers.compile(asset)
 
       [ 
         200, 
         {
-          "Content-Length" => compiled_content.length.to_s,
-          "Content-Type"   => asset.content_type,
-          "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 ]
       ]
@@ -29,9 +30,9 @@ 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-f]{7,128})\.[^.]+\z/, 1]
+      digest    = full_path[/-([0-9a-f]{7,128})\.(?!digested)[^.]+\z/, 1]
       path      = digest ? full_path.sub("-#{digest}", "") : full_path
-      
+
       [ path, digest ]
     end
 end

data/lib/propshaft/version.rb

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

data/lib/propshaft.rb

@@ -1,4 +1,9 @@
+require "active_support"
+require "active_support/core_ext/module/attribute_accessors"
+require "logger"
+
 module Propshaft
+  mattr_accessor :logger, default: Logger.new(STDOUT)
 end
 
 require "propshaft/assembly"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.2
 platform: ruby
 authors:
 - David Heinemeier Hansson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-30 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,7 +24,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 7.0.0.alpha2
-description: 
+description:
 email: dhh@hey.com
 executables: []
 extensions: []
@@ -38,6 +38,7 @@ files:
 - lib/propshaft/asset.rb
 - lib/propshaft/compilers.rb
 - lib/propshaft/compilers/css_asset_urls.rb
+- lib/propshaft/errors.rb
 - lib/propshaft/helper.rb
 - lib/propshaft/load_path.rb
 - lib/propshaft/processor.rb
@@ -50,7 +51,7 @@ homepage: https://github.com/rails/propshaft
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,8 +66,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Deliver assets for Rails.
 test_files: []