sprockets-rails 3.2.1 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d671d520900799dfead3c800f71b8cd5be242dbe
-  data.tar.gz: 65301c0eb28b55f83cb9782d0d086bdd0b21cbf4
+SHA256:
+  metadata.gz: 73feab57944f69ac95583179fd64af5d7e927b6e352260ce8d061e95b2dbdfd8
+  data.tar.gz: 4cec001efd7cd64ee755114ccdaa80dac093abf39efd0e982223329508e3ddb1
 SHA512:
-  metadata.gz: 98c1b63972086b59bcd065d6508aa3f5367ff69a1ed61e758b053c5c911735d667859623c7ce59f5f314169f02689f354c1815ec9ca97f5d2d0d5fd505a21a2a
-  data.tar.gz: b2b9a8b0d26554a21880ff43da22879100d5a66348b2c66fd3f0dde316abd3b8c1bf9acbc4384ed8b82c5bbe23c3bd1abc5830f2cacb0432d0cf511e91a0bc83
+  metadata.gz: 551eeb4f6d09b58157c6fbe2797f4e7ec69dde50cb9a160862e75cd2fe73063e1935582e3bf69533a835d3045d8562ce73de636caa89320e0d1a8b19cb875326
+  data.tar.gz: 2ea2f80c41a29207772023a344a5404d0aeae3c32987c5dae511f7941637a3ac744e02d66681d667e1b583fe91b2b606c43ab708436766cf708a76408628cb42

data/README.md

@@ -86,7 +86,7 @@ When enabled, fingerprints will be added to asset filenames.
 
 **`config.assets.debug`**
 
-Enable expanded asset debugging mode. Individual files will be served to make referencing filenames in the web console easier. This feature will eventually be deprecated and replaced by Source Maps in Sprockets 3.x.
+Enable asset debugging mode. A source map will be included with each asset when this is true.
 
 **`config.assets.compile`**
 
@@ -108,6 +108,10 @@ config.assets.configure do |env|
 end
 ```
 
+**`config.assets.resolve_assets_in_css_urls`**
+
+When this option is enabled, sprockets-rails will register a CSS postprocessor to resolve assets referenced in [`url()`](https://developer.mozilla.org/en-US/docs/Web/CSS/url()) function calls and replace them with the digested paths. Defaults to `true`.
+
 **`config.assets.resolve_with`**
 
 A list of `:environment` and `:manifest` symbols that defines the order that
@@ -138,7 +142,7 @@ The following plugins provide some extras for the Sprockets Asset Pipeline.
 * [coffee-rails](https://github.com/rails/coffee-rails)
 * [sass-rails](https://github.com/rails/sass-rails)
 
-**NOTE** That these plugins are optional. The core coffee-script, sass, less, uglify, (any many more) features are built into Sprockets itself. Many of these plugins only provide generators and extra helpers. You can probably get by without them.
+**NOTE** That these plugins are optional. The core coffee-script, sass, less, uglify, (and many more) features are built into Sprockets itself. Many of these plugins only provide generators and extra helpers. You can probably get by without them.
 
 
 ## Changes from Rails 3.x
@@ -150,6 +154,15 @@ The following plugins provide some extras for the Sprockets Asset Pipeline.
 * `config.assets.manifest` (if used) must now include the manifest filename, e.g. `Rails.root.join('config/manifest.json')`. It cannot be a directory.
 * Two cleanup tasks: `rake assets:clean` is now a safe cleanup that only removes older assets that are no longer used, while `rake assets:clobber` nukes the entire `public/assets` directory. The clean task allows for rolling deploys that may still be linking to an old asset while the new assets are being built.
 
+### But what if I want sprockets to generate non-digest assets?
+
+You have several options:
+
+* Use the [non-digest-assets gem](https://github.com/mvz/non-digest-assets).
+* Use the [sprockets-redirect gem](https://github.com/sikachu/sprockets-redirect).
+* Use the [smart_assets gem](https://github.com/zarqman/smart_assets).
+* Create [a rake task](https://github.com/rails/sprockets-rails/issues/49#issuecomment-20535134) to pre-generate a non-digest version in `public/`.
+
 ## Experimental
 
 ### [SRI](http://www.w3.org/TR/SRI/) support
@@ -187,6 +200,4 @@ Sprockets Rails is released under the [MIT License](MIT-LICENSE).
 
 ## Code Status
 
-* [![Travis CI](https://travis-ci.org/rails/sprockets-rails.svg?branch=master)](http://travis-ci.org/rails/sprockets-rails)
 * [![Gem Version](https://badge.fury.io/rb/sprockets-rails.svg)](http://badge.fury.io/rb/sprockets-rails)
-* [![Dependencies](https://gemnasium.com/rails/sprockets-rails.svg)](https://gemnasium.com/rails/sprockets-rails)

data/lib/sprockets/rails/asset_url_processor.rb

@@ -0,0 +1,17 @@
+module Sprockets
+  module Rails
+    # Resolve assets referenced in CSS `url()` calls and replace them with the digested paths
+    class AssetUrlProcessor
+      REGEX = /url\(\s*["']?(?!(?:\#|data|http))(?<relativeToCurrentDir>\.\/)?(?<path>[^"'\s)]+)\s*["']?\)/
+      def self.call(input)
+        context = input[:environment].context_class.new(input)
+        data    = input[:data].gsub(REGEX) do |_match|
+          path = Regexp.last_match[:path]
+          "url(#{context.asset_path(path)})"
+        end
+
+        context.metadata.merge(data: data)
+      end
+    end
+  end
+end

data/lib/sprockets/rails/helper.rb

@@ -7,15 +7,16 @@ module Sprockets
   module Rails
     module Helper
       class AssetNotFound < StandardError; end
+      class AssetNotPrecompiled < StandardError; end
 
-      class AssetNotPrecompiled < StandardError
+      class AssetNotPrecompiledError < AssetNotPrecompiled
         include Sprockets::Rails::Utils
         def initialize(source)
           msg =
           if using_sprockets4?
             "Asset `#{ source }` was not declared to be precompiled in production.\n" +
             "Declare links to your assets in `app/assets/config/manifest.js`.\n\n" +
-            "  //= link #{ source }\n" +
+            "  //= link #{ source }\n\n" +
             "and restart your server"
           else
             "Asset was not declared to be precompiled in production.\n" +
@@ -57,7 +58,7 @@ module Sprockets
       end
 
       def self.extended(obj)
-        obj.class_eval do
+        obj.singleton_class.class_eval do
           attr_accessor(*VIEW_ACCESSORS)
 
           remove_method :assets_environment
@@ -79,7 +80,7 @@ module Sprockets
         if asset_path = resolve_asset_path(path, debug)
           File.join(assets_prefix || "/", legacy_debug_path(asset_path, debug))
         else
-          message =  "The asset #{ path.inspect } is not present in the asset pipeline."
+          message =  "The asset #{ path.inspect } is not present in the asset pipeline.\n"
           raise AssetNotFound, message unless unknown_asset_fallback
 
           if respond_to?(:public_compute_asset_path)
@@ -351,8 +352,16 @@ module Sprockets
         end
 
         private
-          def find_asset(path, options = {})
-            @env[path, options]
+          if RUBY_VERSION >= "2.7"
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def find_asset(path, options = {})
+                @env[path, **options]
+              end
+            RUBY
+          else
+            def find_asset(path, options = {})
+              @env[path, options]
+            end
           end
 
           def precompiled?(path)
@@ -360,7 +369,7 @@ module Sprockets
           end
 
           def raise_unless_precompiled_asset(path)
-            raise Helper::AssetNotPrecompiled.new(path) if @check_precompiled_asset && !precompiled?(path)
+            raise Helper::AssetNotPrecompiledError.new(path) if @check_precompiled_asset && !precompiled?(path)
           end
       end
     end

data/lib/sprockets/rails/sourcemapping_url_processor.rb

@@ -0,0 +1,54 @@
+module Sprockets
+  module Rails
+    # Rewrites source mapping urls with the digested paths and protect against semicolon appending with a dummy comment line
+    class SourcemappingUrlProcessor
+      REGEX = /\/\/# sourceMappingURL=(.*\.map)/
+
+      class << self
+        def call(input)
+          env     = input[:environment]
+          context = env.context_class.new(input)
+          data    = input[:data].gsub(REGEX) do |_match|
+            sourcemap_logical_path = combine_sourcemap_logical_path(sourcefile: input[:name], sourcemap: $1)
+
+            begin
+              resolved_sourcemap_comment(sourcemap_logical_path, context: context)
+            rescue Sprockets::FileNotFound
+              removed_sourcemap_comment(sourcemap_logical_path, filename: input[:filename], env: env)
+            end
+          end
+
+          { data: data }
+        end
+
+        private
+          def combine_sourcemap_logical_path(sourcefile:, sourcemap:)
+            if (parts = sourcefile.split("/")).many?
+              parts[0..-2].append(sourcemap).join("/")
+            else
+              sourcemap
+            end
+          end
+
+          def resolved_sourcemap_comment(sourcemap_logical_path, context:)
+            "//# sourceMappingURL=#{sourcemap_asset_path(sourcemap_logical_path, context: context)}\n//!\n"
+          end
+
+          def sourcemap_asset_path(sourcemap_logical_path, context:)
+            # FIXME: Work-around for bug where if the sourcemap is nested two levels deep, it'll resolve as the source file
+            # that's being mapped, rather than the map itself. So context.resolve("a/b/c.js.map") will return "c.js?"
+            if context.resolve(sourcemap_logical_path) =~ /\.map/
+              context.asset_path(sourcemap_logical_path)
+            else
+              raise Sprockets::FileNotFound, "Failed to resolve source map asset due to nesting depth"
+            end
+          end
+
+          def removed_sourcemap_comment(sourcemap_logical_path, filename:, env:)
+            env.logger.warn "Removed sourceMappingURL comment for missing asset '#{sourcemap_logical_path}' from #{filename}"
+            nil
+          end
+      end
+    end
+  end
+end

data/lib/sprockets/rails/task.rb

@@ -2,7 +2,6 @@ require 'rake'
 require 'rake/sprocketstask'
 require 'sprockets'
 require 'action_view'
-require 'action_view/base'
 
 module Sprockets
   module Rails

data/lib/sprockets/rails/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Rails
-    VERSION = "3.2.1"
+    VERSION = "3.4.2"
   end
 end

data/lib/sprockets/railtie.rb

@@ -4,6 +4,9 @@ require 'action_controller/railtie'
 require 'active_support/core_ext/module/remove_method'
 require 'active_support/core_ext/numeric/bytes'
 require 'sprockets'
+
+require 'sprockets/rails/asset_url_processor'
+require 'sprockets/rails/sourcemapping_url_processor'
 require 'sprockets/rails/context'
 require 'sprockets/rails/helper'
 require 'sprockets/rails/quiet_assets'
@@ -76,7 +79,8 @@ module Sprockets
         "  //= link_tree ../images\n"  +
         "  //= link_directory ../javascripts .js\n" +
         "  //= link_directory ../stylesheets .css\n"  +
-        "and restart your server"
+        "and restart your server\n\n" +
+        "For more information see: https://github.com/rails/sprockets/blob/070fc01947c111d35bb4c836e9bb71962a8e0595/UPGRADING.md#manifestjs"
         super msg
       end
     end
@@ -93,12 +97,13 @@ module Sprockets
     end
 
     config.assets = OrderedOptions.new
-    config.assets._blocks     = []
-    config.assets.paths       = []
-    config.assets.precompile  = []
-    config.assets.prefix      = "/assets"
-    config.assets.manifest    = nil
-    config.assets.quiet       = false
+    config.assets._blocks                    = []
+    config.assets.paths                      = []
+    config.assets.precompile                 = []
+    config.assets.prefix                     = "/assets"
+    config.assets.manifest                   = nil
+    config.assets.quiet                      = false
+    config.assets.resolve_assets_in_css_urls = true
 
     initializer :set_default_precompile do |app|
       if using_sprockets4?
@@ -115,6 +120,16 @@ module Sprockets
       end
     end
 
+    initializer :asset_url_processor do |app|
+      if app.config.assets.resolve_assets_in_css_urls
+        Sprockets.register_postprocessor "text/css", ::Sprockets::Rails::AssetUrlProcessor
+      end
+    end
+
+    initializer :asset_sourcemap_url_processor do |app|
+      Sprockets.register_postprocessor "application/javascript", ::Sprockets::Rails::SourcemappingUrlProcessor
+    end
+
     config.assets.version     = ""
     config.assets.debug       = false
     config.assets.compile     = true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-rails
 version: !ruby/object:Gem::Version
-  version: 3.2.1
+  version: 3.4.2
 platform: ruby
 authors:
 - Joshua Peek
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-31 00:00:00.000000000 Z
+date: 2021-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -30,42 +30,42 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: josh@joshpeek.com
 executables: []
 extensions: []
@@ -117,10 +117,12 @@ files:
 - MIT-LICENSE
 - README.md
 - lib/sprockets/rails.rb
+- lib/sprockets/rails/asset_url_processor.rb
 - lib/sprockets/rails/context.rb
 - lib/sprockets/rails/helper.rb
 - lib/sprockets/rails/quiet_assets.rb
 - lib/sprockets/rails/route_wrapper.rb
+- lib/sprockets/rails/sourcemapping_url_processor.rb
 - lib/sprockets/rails/task.rb
 - lib/sprockets/rails/utils.rb
 - lib/sprockets/rails/version.rb
@@ -129,7 +131,7 @@ homepage: https://github.com/rails/sprockets-rails
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,16 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Sprockets Rails integration
 test_files: []