propshaft 0.4.3 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64b20599050fe01e901ae888401cbb42d70afe00a2865a02c72731a397d575d8
-  data.tar.gz: b8d2e9685fa4c35823988833e88c25af61aa869e557b3f50d84748b16ab0bc24
+  metadata.gz: 4fb19ffec4a1b49b3b461cb49ef3f726923bbb3b3a0c4b86e26eaed855208572
+  data.tar.gz: 9412606330821085f921519f5a09e96080f49be193a2a675be063dabe8fc1dcd
 SHA512:
-  metadata.gz: df7a65b2077f7724a1b123ce3106f1eef57c73599eb6fd87836364d61e1fc4412da84af2ce1f78e3d538905a2e2d4c1ba18f82f0d4bafc899c89a8c63ae25347
-  data.tar.gz: edf2d528c8e1a925baac66f229e42ce3d817b59e764e676c90e4c87d00b06e7897ba5d649bfc32479b1c20adc5166a3bbb4dd5d13907ed00faae30ba8f1122f3
+  metadata.gz: 6fa6e1ab77e53f99a3270567dfda307e798af395e87ff4ecebc47ddadf33839be364d23f24168d7c9050d8844ae9d2ebd119b9bd5bf722ac61c1a98fc7a82312
+  data.tar.gz: 4cdb5cc250bef4cfb43cf4d58cbecaa0fe001ac3f3fae51906733ff64b53f06388899f1c26f0aa5e06b4f98b000e294ccb2688e93c15bd4c546500b40c085f19

data/README.md

@@ -1,27 +1,26 @@
 # Propshaft
 
-Propshaft is an asset pipeline library for Rails. It's built for an era where bundling assets to save on HTTP connections is no longer urgent, where JavaScript and CSS are either compiled by dedicated Node.js bundlers or served directly to the browsers, and where increases in bandwidth have made the need for minification less pressing. These factors allow for a dramatically simpler and faster asset pipeline compared to previous options, like Sprockets.
+Propshaft is an asset pipeline library for Rails. It's built for an era where bundling assets to save on HTTP connections is no longer urgent, where JavaScript and CSS are either compiled by dedicated Node.js bundlers or served directly to the browsers, and where increases in bandwidth have made the need for minification less pressing. These factors allow for a dramatically simpler and faster asset pipeline compared to previous options, like [Sprockets](https://github.com/rails/sprockets-rails).
 
 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` (pending the merge of [rails/rails#43261](https://github.com/rails/rails/pull/43261)).
-
+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.
 
-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
@@ -31,7 +30,7 @@ If you need to put multiple files that refer to each other through Propshaft, li
 
 ## 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`.
+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`](https://github.com/rails/jsbundling-rails) and [`cssbundling-rails`](https://github.com/rails/cssbundling-rails).
 
 On the other hand, if you're already bundling JavaScript and CSS through a Node-based setup, then Propshaft is going to slot in easily. Since you don't need another tool to bundle or transpile. Just to digest and serve.
 

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
@@ -44,9 +44,11 @@ class Propshaft::Assembly
       end
   end
 
-  def reveal
-    load_path.assets.each do |asset|
-      Propshaft.logger.info asset.logical_path
+  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.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
@@ -42,6 +42,6 @@ class Propshaft::Asset
 
   private
     def already_digested?
-      logical_path.to_s =~ /-([0-9a-f]{7,128})\.digested/
+      logical_path.to_s =~ /-([0-9a-zA-Z]{7,128})\.digested/
     end
 end

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

@@ -1,27 +1,31 @@
 require "rails"
-require "rails/railtie"
 require "active_support/ordered_options"
 
-# FIXME: There's gotta be a better way than this hack?
-class Rails::Engine < Rails::Railtie
-  initializer "propshaft.append_assets_path", group: :all do |app|
-    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)
-  end
-end
-
 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 ]
     ]
     config.assets.sweep_cache = Rails.env.development?
+    config.assets.server = Rails.env.development? || Rails.env.test?
+
+    # 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
+    # allow engines to automatically register their own paths.
+    Rails::Engine.initializer "propshaft.append_assets_path", group: :all do |app|
+      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|
       config.assets.output_path ||=
@@ -29,8 +33,10 @@ module Propshaft
 
       app.assets = Propshaft::Assembly.new(app.config.assets)
 
-      app.routes.prepend do
-        mount app.assets.server => app.assets.config.prefix
+      if config.assets.server
+        app.routes.prepend do
+          mount app.assets.server => app.assets.config.prefix
+        end
       end
 
       ActiveSupport.on_load(:action_view) do

data/lib/propshaft/railties/assets.rake

@@ -16,6 +16,13 @@ namespace :assets do
 
   desc "Print all the assets available in config.assets.paths"
   task reveal: :environment do
-    Rails.application.assets.reveal
+    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
+      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/server.rb

@@ -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-f]{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.4.3"
+  VERSION = "0.6.1"
 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.4.3
+  version: 0.6.1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.alpha2
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.alpha2
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.alpha2
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.alpha2
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.alpha2
+        version: 7.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.0.alpha2
+        version: 7.0.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -112,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Deliver assets for Rails.