sprockets 4.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f59adc73cec32bd913421523e00e2615eb6557cce967d6b59b8244a9f969051d
-  data.tar.gz: d970c5ed6ba67c58afd8c3529634f450d9ed1357000cb5952916efa9dca77d4e
+  metadata.gz: bd427dc138e916f8edb7b07dd2139da83fa2cad386de0321eeb8dc668cbfc57f
+  data.tar.gz: 176fe20e253fde5bd04945f29de4aef9720e77480e2a6f9ef3353fe17bd5b61f
 SHA512:
-  metadata.gz: 3fb439abcba98f893e88ee2bc75af8e3b59760c82f510fd4de510706e49a4fb28fbc84d9c0eefcc172dd981aec04bcaec2f5afc572d03081d6600249b3eb9632
-  data.tar.gz: f28698f721422b64b05de921d7e91ff8972415ba3a82e47d196095f4e6a487103078d69dfcd54b9027341c7852b079d6ef35d6626b68508a63627e44a75c0891
+  metadata.gz: a84a1038484ba2649a87f2db4b53f1737b3b38fcd26c22cca5402a9ccb48d6ba3051e59b84e04ef09efcb7bb625cd3a2ecebd51be0c2b46e4950c549d7eb3ea1
+  data.tar.gz: d99e8c141117d55f7c10fa8b687f5acb7090f6dd1d7a39f0e2443f2bca8dc6af0d5a00cf9f42f137c3dda9dffe722fc1ab4744a739ca013f8549341c8d759444

data/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 Get upgrade notes from Sprockets 3.x to 4.x at https://github.com/rails/sprockets/blob/master/UPGRADING.md
 
+## 4.1.0
+
+- Allow age to be altered in asset:clean rake task.
+- Fix `Sprockets::Server` to return lower-cased response headers to comply with Rack::Lint 3.0. [#744](https://github.com/rails/sprockets/pull/744)
+- Adding new directive `depend_on_directory` [#668](https://github.com/rails/sprockets/pull/668)
+- Fix `application/js-sourcemap+json` charset [#669](https://github.com/rails/sprockets/pull/669)
+- Fix `CachedEnvironment` caching nil values [#723](https://github.com/rails/sprockets/pull/723)
+- Process `*.jst.ejs.erb` files with ERBProcessor [#674](https://github.com/rails/sprockets/pull/674)
+- Fix cache key for coffee script processor to be dependent on the filename [#670](https://github.com/rails/sprockets/pull/670)
+
 ## 4.0.3
 
 - Fix `Manifest#find` yielding from a Promise causing issue on Ruby 3.1.0-dev. [#720](https://github.com/rails/sprockets/pull/720)

data/README.md

@@ -119,6 +119,7 @@ Here is a list of the available directives:
 - [`link_directory`](#link_directory) - Make target directory compile and be publicly available without adding contents to current
 - [`link_tree`](#link_tree) - Make target tree compile and be publicly available without adding contents to current
 - [`depend_on`](#depend_on) - Recompile current file if target has changed
+- [`depend_on_directory`](#depend_on_directory) - Recompile current file if any files in target directory has changed
 - [`stub`](#stub) - Ignore target file
 
 You can see what each of these does below.
@@ -239,7 +240,7 @@ The first time this file is compiled the `application.js` output will be written
 
 So, if `b.js` changes it will get recompiled. However instead of having to recompile the other files from `a.js` to `z.js` since they did not change, we can use the prior intermediary files stored in the cached values . If these files were expensive to generate, then this "partial" asset cache strategy can save a lot of time.
 
-Directives such as `require`, `link`, and `depend_on` tell Sprockets what assets need to be re-compiled when a file changes. Files are considered "fresh" based on their mtime on disk and a combination of cache keys.
+Directives such as `require`, `link`, `depend_on`, and `depend_on_directory` tell Sprockets what assets need to be re-compiled when a file changes. Files are considered "fresh" based on their mtime on disk and a combination of cache keys.
 
 On Rails you can force a "clean" install by clearing the `public/assets` and `tmp/cache/assets` directories.
 
@@ -381,6 +382,14 @@ the current file won't work, it must be a logical path.
 
 **Caution**: the "link" directive should always have an explicit extension on the end.
 
+`link` can also be used to include manifest files from mounted Rails engines:
+
+```
+//= link my_engine
+```
+
+This would find a manifest file at `my_engine/app/assets/config/my_engine.js` and include its directives.
+
 ### link_directory
 
 `link_directory` *path* links all the files inside the directory specified by the *path*. By "link", we mean they are specified as compilation targets to be written out to disk, and made available to be served to user-agents.
@@ -445,11 +454,53 @@ you need to tell sprockets that it needs to re-compile the file if `bar.data` ch
 var bar = '<%= File.read("bar.data") %>'
 ```
 
+To depend on an entire directory containing multiple files, use `depend_on_directory`
+
 ### depend_on_asset
 
 `depend_on_asset` *path* works like `depend_on`, but operates
 recursively reading the file and following the directives found. This is automatically implied if you use `link`, so consider if it just makes sense using `link` instead of `depend_on_asset`.
 
+### depend_on_directory
+
+`depend_on_directory` *path* declares all files in the given *path* without
+including them in the bundle. This is useful when you need to expire an
+asset's cache in response to a change in multiple files in a single directory.
+
+All paths are relative to your declaration and must begin with `./`
+
+Also, your must include these directories in your [load path](guides/building_an_asset_processing_framework.md#the-load-path).
+
+**Example:**
+
+If we've got a directory called `data` with files `a.data` and `b.data`
+
+```
+// ./data/a.data
+A
+```
+
+```
+// ./data/b.data
+B
+```
+
+```
+// ./file.js.erb
+//= depend_on_directory ./data
+var a = '<% File.read('data/a.data') %>'
+var b = '<% File.read('data/b.data') %>'
+```
+
+Would produce:
+
+```js
+var a = "A";
+var b = "B";
+```
+
+You can also see [Index files are proxies for folders](#index-files-are-proxies-for-folders) for another method of organizing folders that will give you more control.
+
 ### stub
 
 `stub` *path* excludes that asset and its dependencies from the asset bundle.
@@ -491,9 +542,9 @@ When you modify the `logo.png` on disk, it will force `application.css` to be
 recompiled so that the fingerprint will be correct in the generated asset.
 
 You can manually make sprockets depend on any other file that is generated
-by sprockets by using the `depend_on` directive. Rails implements the above
-feature by auto calling `depend_on` on the original asset when the `asset_url`
-is used inside of an asset.
+by sprockets by using the `depend_on` or `depend_on_directory` directive. Rails
+implements the above feature by auto calling `depend_on` on the original asset
+when the `asset_url` is used inside of an asset.
 
 ### Styling with Sass and SCSS
 

data/lib/rake/sprocketstask.rb

@@ -69,9 +69,12 @@ module Rake
     #
     attr_accessor :assets
 
-    # Number of old assets to keep.
+    # Minimum number of old assets to keep. See Sprockets::Manifest#clean for more information.
     attr_accessor :keep
 
+    # Assets created within this age will be kept. See Sprockets::Manifest#clean for more information.
+    attr_accessor :age
+
     # Logger to use during rake tasks. Defaults to using stderr.
     #
     #   t.logger = Logger.new($stdout)
@@ -103,6 +106,7 @@ module Rake
       @logger       = Logger.new($stderr)
       @logger.level = Logger::INFO
       @keep         = 2
+      @age          = 3600
 
       yield self if block_given?
 
@@ -130,7 +134,7 @@ module Rake
       desc name == :assets ? "Clean old assets" : "Clean old #{name} assets"
       task "clean_#{name}" do
         with_logger do
-          manifest.clean(keep)
+          manifest.clean(keep, age)
         end
       end
 

data/lib/sprockets/cached_environment.rb

@@ -31,27 +31,27 @@ module Sprockets
 
     # Internal: Cache Environment#entries
     def entries(path)
-      @entries[path] ||= super(path)
+      @entries.fetch(path){ @entries[path] = super(path) }
     end
 
     # Internal: Cache Environment#stat
     def stat(path)
-      @stats[path] ||= super(path)
+      @stats.fetch(path){ @stats[path] = super(path) }
     end
 
     # Internal: Cache Environment#load
     def load(uri)
-      @uris[uri] ||= super(uri)
+      @uris.fetch(uri){ @uris[uri] = super(uri) }
     end
 
     # Internal: Cache Environment#processor_cache_key
     def processor_cache_key(str)
-      @processor_cache_keys[str] ||= super(str)
+      @processor_cache_keys.fetch(str){ @processor_cache_keys[str] = super(str) }
     end
 
     # Internal: Cache Environment#resolve_dependency
     def resolve_dependency(str)
-      @resolved_dependencies[str] ||= super(str)
+      @resolved_dependencies.fetch(str){ @resolved_dependencies[str] = super(str) }
     end
 
     private

data/lib/sprockets/coffee_script_processor.rb

@@ -20,7 +20,7 @@ module Sprockets
     def self.call(input)
       data = input[:data]
 
-      js, map = input[:cache].fetch([self.cache_key, data]) do
+      js, map = input[:cache].fetch([self.cache_key, data, input[:filename]]) do
         result = Autoload::CoffeeScript.compile(
           data,
           sourceMap: "v3",

data/lib/sprockets/digest_utils.rb

@@ -183,7 +183,7 @@ module Sprockets
     #
     # Returns true if the name contains a digest like string and .digested before the extension
     def already_digested?(name)
-      return name =~ /-([0-9a-f]{7,128})\.digested/
+      return name =~ /-([0-9a-zA-Z]{7,128})\.digested/
     end
 
     private

data/lib/sprockets/directive_processor.rb

@@ -285,6 +285,24 @@ module Sprockets
         to_load(resolve(path))
       end
 
+      # Allows you to state a dependency on a relative directory
+      # without including it.
+      #
+      # This is used for caching purposes. Any changes made to
+      # the dependency directory will invalidate the cache of the
+      # source file.
+      #
+      # This is useful if you are using ERB and File.read to pull
+      # in contents from multiple files in a directory.
+      #
+      #     //= depend_on_directory ./data
+      #
+      def process_depend_on_directory_directive(path = ".", accept = nil)
+        path = expand_relative_dirname(:depend_on_directory, path)
+        accept = expand_accept_shorthand(accept)
+        resolve_paths(*@environment.stat_directory_with_dependencies(path), accept: accept)
+      end
+
       # Allows dependency to be excluded from the asset bundle.
       #
       # The `path` must be a valid asset and may or may not already
@@ -374,7 +392,7 @@ module Sprockets
           next if subpath == @filename || stat.directory?
           uri, deps = @environment.resolve(subpath, **kargs)
           @dependencies.merge(deps)
-          yield uri if uri
+          yield uri if uri && block_given?
         end
       end
 

data/lib/sprockets/path_utils.rb

@@ -162,7 +162,7 @@ module Sprockets
     def split_subpath(path, subpath)
       return "" if path == subpath
       path = File.join(path, ''.freeze)
-      if subpath.start_with?(path)
+      if subpath&.start_with?(path)
         subpath[path.length..-1]
       else
         nil

data/lib/sprockets/server.rb

@@ -148,39 +148,39 @@ module Sprockets
       # Returns a 400 Forbidden response tuple
       def bad_request_response(env)
         if head_request?(env)
-          [ 400, { "Content-Type" => "text/plain", "Content-Length" => "0" }, [] ]
+          [ 400, { "content-type" => "text/plain", "content-length" => "0" }, [] ]
         else
-          [ 400, { "Content-Type" => "text/plain", "Content-Length" => "11" }, [ "Bad Request" ] ]
+          [ 400, { "content-type" => "text/plain", "content-length" => "11" }, [ "Bad Request" ] ]
         end
       end
 
       # Returns a 403 Forbidden response tuple
       def forbidden_response(env)
         if head_request?(env)
-          [ 403, { "Content-Type" => "text/plain", "Content-Length" => "0" }, [] ]
+          [ 403, { "content-type" => "text/plain", "content-length" => "0" }, [] ]
         else
-          [ 403, { "Content-Type" => "text/plain", "Content-Length" => "9" }, [ "Forbidden" ] ]
+          [ 403, { "content-type" => "text/plain", "content-length" => "9" }, [ "Forbidden" ] ]
         end
       end
 
       # Returns a 404 Not Found response tuple
       def not_found_response(env)
         if head_request?(env)
-          [ 404, { "Content-Type" => "text/plain", "Content-Length" => "0", "X-Cascade" => "pass" }, [] ]
+          [ 404, { "content-type" => "text/plain", "content-length" => "0", "x-cascade" => "pass" }, [] ]
         else
-          [ 404, { "Content-Type" => "text/plain", "Content-Length" => "9", "X-Cascade" => "pass" }, [ "Not found" ] ]
+          [ 404, { "content-type" => "text/plain", "content-length" => "9", "x-cascade" => "pass" }, [ "Not found" ] ]
         end
       end
 
       def method_not_allowed_response
-        [ 405, { "Content-Type" => "text/plain", "Content-Length" => "18" }, [ "Method Not Allowed" ] ]
+        [ 405, { "content-type" => "text/plain", "content-length" => "18" }, [ "Method Not Allowed" ] ]
       end
 
       def precondition_failed_response(env)
         if head_request?(env)
-          [ 412, { "Content-Type" => "text/plain", "Content-Length" => "0", "X-Cascade" => "pass" }, [] ]
+          [ 412, { "content-type" => "text/plain", "content-length" => "0", "x-cascade" => "pass" }, [] ]
         else
-          [ 412, { "Content-Type" => "text/plain", "Content-Length" => "19", "X-Cascade" => "pass" }, [ "Precondition Failed" ] ]
+          [ 412, { "content-type" => "text/plain", "content-length" => "19", "x-cascade" => "pass" }, [ "Precondition Failed" ] ]
         end
       end
 
@@ -189,7 +189,7 @@ module Sprockets
       def javascript_exception_response(exception)
         err  = "#{exception.class.name}: #{exception.message}\n  (in #{exception.backtrace[0]})"
         body = "throw Error(#{err.inspect})"
-        [ 200, { "Content-Type" => "application/javascript", "Content-Length" => body.bytesize.to_s }, [ body ] ]
+        [ 200, { "content-type" => "application/javascript", "content-length" => body.bytesize.to_s }, [ body ] ]
       end
 
       # Returns a CSS response that hides all elements on the page and
@@ -242,7 +242,7 @@ module Sprockets
           }
         CSS
 
-        [ 200, { "Content-Type" => "text/css; charset=utf-8", "Content-Length" => body.bytesize.to_s }, [ body ] ]
+        [ 200, { "content-type" => "text/css; charset=utf-8", "content-length" => body.bytesize.to_s }, [ body ] ]
       end
 
       # Escape special characters for use inside a CSS content("...") string
@@ -258,18 +258,18 @@ module Sprockets
         headers = {}
 
         # Set caching headers
-        headers["Cache-Control"] = +"public"
-        headers["ETag"]          = %("#{etag}")
+        headers["cache-control"] = +"public"
+        headers["etag"]          = %("#{etag}")
 
         # If the request url contains a fingerprint, set a long
         # expires on the response
         if path_fingerprint(env["PATH_INFO"])
-          headers["Cache-Control"] << ", max-age=31536000, immutable"
+          headers["cache-control"] << ", max-age=31536000, immutable"
 
         # Otherwise set `must-revalidate` since the asset could be modified.
         else
-          headers["Cache-Control"] << ", must-revalidate"
-          headers["Vary"] = "Accept-Encoding"
+          headers["cache-control"] << ", must-revalidate"
+          headers["vary"] = "Accept-Encoding"
         end
 
         headers
@@ -279,7 +279,7 @@ module Sprockets
         headers = {}
 
         # Set content length header
-        headers["Content-Length"] = length.to_s
+        headers["content-length"] = length.to_s
 
         # Set content type header
         if type = asset.content_type
@@ -287,7 +287,7 @@ module Sprockets
           if type.start_with?("text/") && asset.charset
             type += "; charset=#{asset.charset}"
           end
-          headers["Content-Type"] = type
+          headers["content-type"] = type
         end
 
         headers.merge(cache_headers(env, asset.etag))
@@ -299,7 +299,7 @@ module Sprockets
       #     # => "0aa2105d29558f3eb790d411d7d8fb66"
       #
       def path_fingerprint(path)
-        path[/-([0-9a-f]{7,128})\.[^.]+\z/, 1]
+        path[/-([0-9a-zA-Z]{7,128})\.[^.]+\z/, 1]
       end
   end
 end

data/lib/sprockets/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Sprockets
-  VERSION = "4.0.3"
+  VERSION = "4.1.0"
 end

data/lib/sprockets.rb

@@ -51,6 +51,7 @@ module Sprockets
   register_mime_type 'application/json', extensions: ['.json'], charset: :unicode
   register_mime_type 'application/ruby', extensions: ['.rb']
   register_mime_type 'application/xml', extensions: ['.xml']
+  register_mime_type 'application/manifest+json', extensions: ['.webmanifest']
   register_mime_type 'text/css', extensions: ['.css'], charset: :css
   register_mime_type 'text/html', extensions: ['.html', '.htm'], charset: :html
   register_mime_type 'text/plain', extensions: ['.txt', '.text']
@@ -89,7 +90,7 @@ module Sprockets
   register_mime_type 'application/font-woff2', extensions: ['.woff2']
 
   require 'sprockets/source_map_processor'
-  register_mime_type 'application/js-sourcemap+json', extensions: ['.js.map']
+  register_mime_type 'application/js-sourcemap+json', extensions: ['.js.map'], charset: :unicode
   register_mime_type 'application/css-sourcemap+json', extensions: ['.css.map']
   register_transformer 'application/javascript', 'application/js-sourcemap+json', SourceMapProcessor
   register_transformer 'text/css', 'application/css-sourcemap+json', SourceMapProcessor
@@ -180,6 +181,7 @@ module Sprockets
     application/ecmascript-6
     application/javascript
     application/json
+    application/manifest+json
     application/xml
     text/coffeescript
     text/css
@@ -189,6 +191,7 @@ module Sprockets
     text/scss
     text/yaml
     text/eco
+    text/ejs
   ), 'application/\2+ruby', '.erb', ERBProcessor)
 
   register_mime_type 'application/html+ruby', extensions: ['.html.erb', '.erb', '.rhtml'], charset: :html

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sprockets
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.1.0
 platform: ruby
 authors:
 - Sam Stephenson
 - Joshua Peek
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-02 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -423,7 +423,7 @@ homepage: https://github.com/rails/sprockets
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -438,8 +438,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Rack-based asset packaging system
 test_files: []