propshaft 0.5.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed27e836fd19bb9d9293ca1fad143a3aa6454c40e671891cd47cfd279524d16f
-  data.tar.gz: fa7b4f0f3dd48634b0d9f5ba012bc1d90d43445aee137846c6a9e66c96754e6a
+  metadata.gz: 2e186c6a8b298be03fa1f414751bf99e425614701c2283eafeafc49d14a10dd9
+  data.tar.gz: d447859d4a45ae4d7f62b54d71a9ce5c4d15d2151c98a3369cd33229587a1441
 SHA512:
-  metadata.gz: daea545ac84a7c13ddb0198544f3058fbde3ccf9dfa42302f705613f4ec06c8c9962e2ffebe8276a9cc97912122ee8b8591c246f0ff09d6a91124c49b142bd09
-  data.tar.gz: '09355d57890f7b5ac3372f9d76dd08784f2e2b1de7b83f099ef8c9f3eebd73d53a2247e58df0e7ca0c59247bbb1478d4e6ec68e260d599e8002c2ad367779439'
+  metadata.gz: 337241f55febf946b0b4e508012d3f8737882c8fc92665f84a6d407ec52a93acd9c11840f456897f8100294665ce4dac5ae6b70c79ca08b25479c6cf4689877e
+  data.tar.gz: e436e82a80404f84eb27e32e493d38bda181e80b08b8c0ca788a69354bd97eef51b2c73ddfff62ebeb6407ecf553b15a290bf5680d7e2fcd7150ede657675dcb

data/README.md

@@ -7,21 +7,20 @@ So that's what Propshaft doesn't do. Here's what it does provide:
 1. **Configurable load path**: You can register directories from multiple places in your app and gems, and reference assets from all of these paths as though they were one.
 1. **Digest stamping**: All assets in the load path will be copied (or compiled) in a precompilation step for production that also stamps all of them with a digest hash, so you can use long-expiry cache headers for better performance. The digested assets can be referred to through their logical path because the processing leaves a manifest file that provides a way to translate.
 1. **Development server**: There's no need to precompile the assets in development. You can refer to them via the same asset_path helpers and they'll be served by a development server.
-1. **Basic compilers**: Propshaft was explicitly not designed to provide full transpiler capabilities. You can get that better elsewhere. But it does offer a simple input->output compiler setup that by default is used to translate `asset-path` function calls in CSS to `url(digested-asset)` instead.
+1. **Basic compilers**: Propshaft was explicitly not designed to provide full transpiler capabilities. You can get that better elsewhere. But it does offer a simple input->output compiler setup that by default is used to translate `url(asset)` function calls in CSS to `url(digested-asset)` instead and source mapping comments likewise.
 
 
 ## Installation
 
-With Rails 7+, you can start a new application with propshaft using `rails new myapp -a propshaft`.
-
+With Rails 7+, you can start a new application with propshaft using `rails new myapp -a propshaft`. For existing applications, check the [upgrade guide](https://github.com/rails/propshaft/blob/main/UPGRADING.md) which contains step-by-step instructions.
 
 ## Usage
 
-Propshaft makes all the assets from all the paths it's been configured with through `config.assets.paths` available for serving and will copy all of them into `public/assets` when precompiling. This is unlike Sprockets, which did not copy over assets that hadn't been explicitly included in one of the bundled assets.
+Propshaft makes all the assets from all the paths it's been configured with through `config.assets.paths` available for serving and will copy all of them into `public/assets` when precompiling. This is unlike Sprockets, which did not copy over assets that hadn't been explicitly included in one of the bundled assets. 
 
-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`).
+You can however exempt directories that have been added through the `config.assets.excluded_paths`. This is useful if you're for example using `app/assets/stylesheets` exclusively as a set of inputs to a compiler like Dart Sass for Rails, and you don't want these input files to be part of the load path. (Remember you need to add full paths, like `Rails.root.join("app/assets/stylesheets")`).
 
-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.
+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`).
 
 
 ## Bypassing the digest step

data/lib/propshaft/assembly.rb

@@ -15,7 +15,7 @@ class Propshaft::Assembly
   end
 
   def load_path
-    @load_path ||= Propshaft::LoadPath.new(config.paths)
+    @load_path ||= Propshaft::LoadPath.new(config.paths, version: config.version)
   end
 
   def resolver
@@ -47,8 +47,8 @@ class Propshaft::Assembly
   def reveal(path_type = :logical_path)
     path_type = path_type.presence_in(%i[ logical_path path ]) || raise(ArgumentError, "Unknown path_type: #{path_type}")
     
-    load_path.assets.each do |asset|
-      Propshaft.logger.info asset.send(path_type)
+    load_path.assets.collect do |asset|
+      asset.send(path_type)
     end
   end
 

data/lib/propshaft/asset.rb

@@ -2,10 +2,10 @@ require "digest/sha1"
 require "action_dispatch/http/mime_type"
 
 class Propshaft::Asset
-  attr_reader :path, :logical_path
+  attr_reader :path, :logical_path, :version
 
-  def initialize(path, logical_path:)
-    @path, @logical_path = path, Pathname.new(logical_path)
+  def initialize(path, logical_path:, version: nil)
+    @path, @logical_path, @version = path, Pathname.new(logical_path), version
   end
 
   def content
@@ -21,7 +21,7 @@ class Propshaft::Asset
   end
 
   def digest
-    @digest ||= Digest::SHA1.hexdigest(content)
+    @digest ||= Digest::SHA1.hexdigest("#{content}#{version}")
   end
 
   def digested_path

data/lib/propshaft/compilers/css_asset_urls.rb

@@ -1,10 +1,9 @@
 # frozen_string_literal: true
-require "propshaft/errors"
 
 class Propshaft::Compilers::CssAssetUrls
   attr_reader :assembly
 
-  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|data|http))([^"'\s)]+)\s*["']?\)/
+  ASSET_URL_PATTERN = /url\(\s*["']?(?!(?:\#|data|http))([^"'\s?#)]+)([#?][^"']+)?\s*["']?\)/
 
   def initialize(assembly)
     @assembly = assembly

data/lib/propshaft/helper.rb

@@ -1,5 +1,7 @@
-module Propshaft::Helper
-  def compute_asset_path(path, options = {})
-    Rails.application.assets.resolver.resolve(path)
+module Propshaft
+  module Helper
+    def compute_asset_path(path, options = {})
+      Rails.application.assets.resolver.resolve(path) || raise(MissingAssetError.new(path))
+    end
   end
 end

data/lib/propshaft/load_path.rb

@@ -1,10 +1,11 @@
 require "propshaft/asset"
 
 class Propshaft::LoadPath
-  attr_reader :paths
+  attr_reader :paths, :version
 
-  def initialize(paths = [])
-    @paths = Array(paths).collect { |path| Pathname.new(path) }
+  def initialize(paths = [], version: nil)
+    @paths = dedup(paths)
+    @version = version
   end
 
   def find(asset_name)
@@ -45,9 +46,9 @@ class Propshaft::LoadPath
     def assets_by_path
       @cached_assets_by_path ||= Hash.new.tap do |mapped|
         paths.each do |path|
-          all_files_from_tree(path).each do |file|
+          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)
+            mapped[logical_path.to_s] ||= Propshaft::Asset.new(file, logical_path: logical_path, version: version)
           end if path.exist?
         end
       end
@@ -57,7 +58,19 @@ class Propshaft::LoadPath
       path.children.flat_map { |child| child.directory? ? all_files_from_tree(child) : child }
     end
 
+    def without_dotfiles(files)
+      files.reject { |file| file.basename.to_s.starts_with?(".") }
+    end
+
     def clear_cache
       @cached_assets_by_path = nil
     end
+
+    def dedup(paths)
+      [].tap do |deduped|
+        Array(paths).map(&:to_s).sort.each do |path|
+          deduped << Pathname.new(path) if deduped.blank? || !path.start_with?(deduped.last.to_s)
+        end
+      end
+    end
 end

data/lib/propshaft/railtie.rb

@@ -4,9 +4,11 @@ require "active_support/ordered_options"
 module Propshaft
   class Railtie < ::Rails::Railtie
     config.assets = ActiveSupport::OrderedOptions.new
-    config.assets.paths       = []
-    config.assets.prefix      = "/assets"
-    config.assets.compilers   = [
+    config.assets.paths          = []
+    config.assets.excluded_paths = []
+    config.assets.version        = "1"
+    config.assets.prefix         = "/assets"
+    config.assets.compilers      = [
       [ "text/css", Propshaft::Compilers::CssAssetUrls ],
       [ "text/css", Propshaft::Compilers::SourceMappingUrls ],
       [ "text/javascript", Propshaft::Compilers::SourceMappingUrls ]
@@ -21,6 +23,8 @@ module Propshaft
       app.config.assets.paths.unshift(*paths["vendor/assets"].existent_directories)
       app.config.assets.paths.unshift(*paths["lib/assets"].existent_directories)
       app.config.assets.paths.unshift(*paths["app/assets"].existent_directories)
+
+      app.config.assets.paths = app.config.assets.paths.without(Array(app.config.assets.excluded_paths).collect(&:to_s))
     end
 
     config.after_initialize do |app|

data/lib/propshaft/railties/assets.rake

@@ -16,13 +16,13 @@ namespace :assets do
 
   desc "Print all the assets available in config.assets.paths"
   task reveal: :environment do
-    Rails.application.assets.reveal(:logical_path)
+    puts Rails.application.assets.reveal(:logical_path).join("\n")
   end
 
   namespace :reveal do
     desc "Print the full path of assets available in config.assets.paths"
     task full: :environment do
-      Rails.application.assets.reveal(:path)
+      puts Rails.application.assets.reveal(:path).join("\n")
     end
   end
 end

data/lib/propshaft/resolver/dynamic.rb

@@ -9,8 +9,12 @@ 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
+
+    def read(logical_path)
+      if asset = load_path.find(logical_path)
+        asset.content
       end
     end
   end

data/lib/propshaft/resolver/static.rb

@@ -9,8 +9,12 @@ 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
+
+    def read(logical_path)
+      if asset_path = parsed_manifest[logical_path]
+        manifest_path.dirname.join(asset_path).read
       end
     end
 

data/lib/propshaft/version.rb

@@ -1,3 +1,3 @@
 module Propshaft
-  VERSION = "0.5.0"
+  VERSION = "0.6.3"
 end

data/lib/propshaft.rb

@@ -7,5 +7,6 @@ module Propshaft
 end
 
 require "propshaft/assembly"
+require "propshaft/errors"
 require "propshaft/helper"
 require "propshaft/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.3
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack