propshaft 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed27e836fd19bb9d9293ca1fad143a3aa6454c40e671891cd47cfd279524d16f
-  data.tar.gz: fa7b4f0f3dd48634b0d9f5ba012bc1d90d43445aee137846c6a9e66c96754e6a
+  metadata.gz: f7f4103bd65db2fdda3e1e8817f9d14951c48c2e823794c6167b90363931f48d
+  data.tar.gz: dd2503eb87c35fbf647618c2d840f05705583dfabcaac41ae68624923d92736f
 SHA512:
-  metadata.gz: daea545ac84a7c13ddb0198544f3058fbde3ccf9dfa42302f705613f4ec06c8c9962e2ffebe8276a9cc97912122ee8b8591c246f0ff09d6a91124c49b142bd09
-  data.tar.gz: '09355d57890f7b5ac3372f9d76dd08784f2e2b1de7b83f099ef8c9f3eebd73d53a2247e58df0e7ca0c59247bbb1478d4e6ec68e260d599e8002c2ad367779439'
+  metadata.gz: 5d0a9695812b4fa23ada2001d8f6f8adcc6d4cd8d724fe433fc08aeef48262e3b24e9de5a48ebde7b1d2aafee0ee5d58216ed9b252bdd7ba9fc10b0e87334250
+  data.tar.gz: 905a4681b68df4fa2020fc7a17e7b3fb50e6b67b9b332a903cbf2752aca3c6d83e03c5d198fa680e06299d1743a1ec0787e88f4f43ca2498dd94e46e73d09b63

data/README.md

@@ -12,12 +12,13 @@ So that's what Propshaft doesn't do. Here's what it does provide:
 
 ## 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. 
+
+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.
 
 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`).
 

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,5 +1,4 @@
 # frozen_string_literal: true
-require "propshaft/errors"
 
 class Propshaft::Compilers::CssAssetUrls
   attr_reader :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   = Array(paths).collect { |path| Pathname.new(path) }
+    @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,6 +58,10 @@ 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

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,6 @@ 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,8 +9,6 @@ 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/version.rb

@@ -1,3 +1,3 @@
 module Propshaft
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 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.0
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack