propshaft 0.1.3 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 263dfd4ede27b9d76a03f09280a5db8ec28f510833dbe9942de5a210af92e26a
-  data.tar.gz: e9dc23f7db673a8b3d3a0680e9a00836150ba058e62536c53ae3c09a2b0c6de6
+  metadata.gz: f01db7988c70a623917c5239f4b76cef03e3364b86f3bb1b9850691d1045d3e1
+  data.tar.gz: 066dab4410e31551036e8f539cb351b8c4a6d7c53ae9bd02343b228be16fc85f
 SHA512:
-  metadata.gz: c37707a704e9a65c1e98c90c486a691fdc164c113580a94ea03442bc08ba179dc57351c176671cb17dc21eda7375da066cc4611799622f85a61fe0e5be3c977a
-  data.tar.gz: a84ac7c0da1a2e166c65bdb99098f4692a993d147d503d7b143fa06127eb91d7055033e0922eb2927f5ab3792f494fb68fab9d2386460d1cd8988d1976a94036
+  metadata.gz: 7b09d882ebf32f6afda261a3dbf32ab322e25b1756b802b70e4b6b16f73f3d91404e8b51be6e5c54a1335332744305d3d149712136cbbdabc67b258229178b9f
+  data.tar.gz: 65a13d00417ff13f2678660038ebb7f33074e56b0277b7c51e9df170f9e393ec17cd5ff5ddc888b4e24c469df33ba4f5d8acb19ecf5a2b7626d41c22dac0d781

data/README.md

@@ -1,8 +1,8 @@
 # Propshaft
 
-Propshaft is an asset pipeline library for Rails. It's built for era where bundling assets to save on HTTP connections is no longer urgent, where JavaScript and CSS is either compiled by dedicated Node.js bundlers or served directly to the browsers, and where increases in bandwidth has 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.
 
-So that's what Propshaft doesn't do. Here's what it actually does provide:
+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.
@@ -17,16 +17,21 @@ With Rails 7+, you can start a new application with propshaft using `rails new m
 
 ## Usage
 
-Propshaft makes all the assets from all the paths its 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 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`).
+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`).
 
 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`.
+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`.
 
 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

@@ -14,7 +14,7 @@ class Propshaft::Assembly
   end
 
   def load_path
-    Propshaft::LoadPath.new(config.paths)
+    @load_path ||= Propshaft::LoadPath.new(config.paths)
   end
 
   def resolver

data/lib/propshaft/asset.rb

@@ -25,10 +25,19 @@ class Propshaft::Asset
   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 ==(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\.[^.]+\z/
+    end
 end

data/lib/propshaft/load_path.rb

@@ -27,15 +27,28 @@ 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)
-
             mapped[logical_path.to_s] ||= Propshaft::Asset.new(file, logical_path: logical_path)
-          end
+          end if path.exist?
         end
       end
     end
@@ -43,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/railtie.rb

@@ -4,7 +4,7 @@ require "active_support/ordered_options"
 
 # FIXME: There's gotta be a better way than this hack?
 class Rails::Engine < Rails::Railtie
-  initializer :append_assets_path, group: :all do |app|
+  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)
@@ -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? || Rails.env.test?
 
     config.after_initialize do |app|
       config.assets.output_path ||=
@@ -31,6 +32,12 @@ 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
 
     rake_tasks do |app|

data/lib/propshaft/version.rb

@@ -1,3 +1,3 @@
 module Propshaft
-  VERSION = "0.1.3"
+  VERSION = "0.1.7"
 end

data/lib/propshaft.rb

@@ -1,3 +1,6 @@
+module Propshaft
+end
+
 require "propshaft/assembly"
 require "propshaft/helper"
 require "propshaft/railtie"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: propshaft
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.7
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-21 00:00:00.000000000 Z
+date: 2021-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails