propshaft 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2eb4dab520f6e9bc958d7ea65ed10531ab418ac34c3daefdcec0b4d61094bcdd
-  data.tar.gz: 8d76024de20625ee78b0cc8409a2e74b66ac0ccd8203ba14e263d89b649da21d
+  metadata.gz: f5ac96be7b15334f58662f5033d02375a23050328d28aca71058777cd1778ba6
+  data.tar.gz: bb4c8a1c289ce56c380da154c0174d6bef08a988cd7a4e53fe0193b05f62b092
 SHA512:
-  metadata.gz: 5f8fbd11cd6a8a9031be35139887e1cec8e3823a4eb68e79ad61df91a307aa1222927fd8d87316c6b55df979cdd91f57bc4d653e092190a1b7933db175e44f14
-  data.tar.gz: 70a5ad6e8382e5dafc4bed6b26e1f9ba5008f6bd536961393b807cbb47580dbfc95c1c1cbe04b1b4954968213c2aa112ed822e156fe8f044209bade7ccc79de8
+  metadata.gz: e082b706b8d3e1733805697fdb3f3520ba977531533ec1da6078277cf9e7d59c8a2cf79464653ec8d058ae98b40db10cf372bc3e260ea56194aa062cf7f501b0
+  data.tar.gz: eb18c451c949637476e936afcf88a656dad3f0ae7217d326fbb117390bfc3de7ae83e5fe71f66848739300d7d841ba113abf6704cb6c3e95ddae47d9ca674547

data/README.md

@@ -1,13 +1,13 @@
 # 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 processing: 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 compiler step: 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. **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.
 
 
 ## Installation
@@ -17,16 +17,16 @@ 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.
 
 
 ## 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/compilers/css_asset_urls.rb

@@ -7,7 +7,7 @@ class Propshaft::Compilers::CssAssetUrls
 
   def compile(input)
     input.gsub(/asset-path\(["']([^"')]+)["']\)/) do |match|
-      %[url("/#{assembly.config.prefix}/#{assembly.load_path.find($1).digested_path}")]
+      %[url("#{assembly.config.prefix}/#{assembly.load_path.find($1).digested_path}")]
     end
   end
 end

data/lib/propshaft/load_path.rb

@@ -11,8 +11,12 @@ class Propshaft::LoadPath
     assets_by_path[asset_name]
   end
 
-  def assets
-    assets_by_path.values
+  def assets(content_types: nil)
+    if content_types
+      assets_by_path.values.select { |asset| asset.content_type.in?(content_types) }
+    else
+      assets_by_path.values
+    end
   end
 
   def manifest

data/lib/propshaft/processor.rb

@@ -1,5 +1,6 @@
 class Propshaft::Processor
   MANIFEST_FILENAME = ".manifest.json"
+  COMPRESSABLE_CONTENT_TYPES = %i[ js css text json xml html svg otf ttf ].collect { |t| Mime[t] }
 
   attr_reader :load_path, :output_path, :compilers
 
@@ -41,10 +42,6 @@ class Propshaft::Processor
       compile_asset(asset) || copy_asset(asset)
     end
 
-    def copy_asset(asset)
-      FileUtils.copy asset.path, output_path.join(asset.digested_path)
-    end
-
     def compile_asset(asset)
       File.open(output_path.join(asset.digested_path), "w+") do |file|
         begin
@@ -56,10 +53,13 @@ class Propshaft::Processor
       end if compilers.compilable?(asset)
     end
 
+    def copy_asset(asset)
+      FileUtils.copy asset.path, output_path.join(asset.digested_path)
+    end
+
 
     def compress_assets
-      # FIXME: Only try to compress text assets with brotli
-      load_path.assets.each do |asset|
+      load_path.assets(content_types: COMPRESSABLE_CONTENT_TYPES).each do |asset|
         compress_asset output_path.join(asset.digested_path)
       end if compressor_available?
     end

data/lib/propshaft/railtie.rb

@@ -18,15 +18,6 @@ module Propshaft
     config.assets.prefix    = "/assets"
     config.assets.compilers = [ [ "text/css", Propshaft::Compilers::CssAssetUrls ] ]
 
-    # Compatibility shiming (need to provide log warnings when used)
-    config.assets.precompile     = []
-    config.assets.debug          = nil
-    config.assets.quiet          = nil
-    config.assets.compile        = nil
-    config.assets.version        = nil
-    config.assets.css_compressor = nil
-    config.assets.js_compressor  = nil
-
     config.after_initialize do |app|
       config.assets.output_path ||=
         Pathname.new(File.join(app.config.paths["public"].first, app.config.assets.prefix))
@@ -50,5 +41,14 @@ module Propshaft
         end
       end
     end
+
+    # Compatibility shiming (need to provide log warnings when used)
+    config.assets.precompile     = []
+    config.assets.debug          = nil
+    config.assets.quiet          = nil
+    config.assets.compile        = nil
+    config.assets.version        = nil
+    config.assets.css_compressor = nil
+    config.assets.js_compressor  = nil
   end
 end

data/lib/propshaft/resolver/dynamic.rb

@@ -8,7 +8,7 @@ module Propshaft::Resolver
 
     def resolve(logical_path)
       if asset = load_path.find(logical_path)
-        File.join prefix, asset.logical_path
+        File.join prefix, asset.digested_path
       end
     end
   end

data/lib/propshaft/server.rb

@@ -6,7 +6,9 @@ class Propshaft::Server
   end
 
   def call(env)
-    if asset = @assembly.load_path.find(requested_path(env))
+    path, digest = extract_path_and_digest(env)
+
+    if (asset = @assembly.load_path.find(path)) && asset.digest == digest
       compiled_content = @assembly.compilers.compile(asset)
 
       [ 
@@ -15,7 +17,7 @@ class Propshaft::Server
           "Content-Length" => compiled_content.length.to_s,
           "Content-Type"   => asset.content_type,
           "ETag"           => asset.digest,
-          "Cache-Control"  => "public, must-revalidate"
+          "Cache-Control"  => "public, max-age=31536000, immutable"
         },
         [ compiled_content ]
       ]
@@ -25,7 +27,11 @@ class Propshaft::Server
   end
 
   private
-    def requested_path(env)
-      Rack::Utils.unescape(env["PATH_INFO"].to_s.sub(/^\//, ""))
+    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]
+      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.0"
+  VERSION = "0.1.4"
 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.0
+  version: 0.1.4
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-19 00:00:00.000000000 Z
+date: 2021-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails