sprockets-rails 2.3.2 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 480e5ad0e2f9fa910adadff1df528c2fdbdcd7ba
-  data.tar.gz: 13ffd578bddc43427ba93d2ee3d1cff0e120fcee
+SHA256:
+  metadata.gz: 73feab57944f69ac95583179fd64af5d7e927b6e352260ce8d061e95b2dbdfd8
+  data.tar.gz: 4cec001efd7cd64ee755114ccdaa80dac093abf39efd0e982223329508e3ddb1
 SHA512:
-  metadata.gz: a4fadc3c38141890f8f6f6c8d9cb8053eb8444893e8657d280f90c1c222eee8948553760b7e564137bf08caa684df89fab9f1b7f391291c55ab4eea54dd3ad4b
-  data.tar.gz: 05ce457e78078a598d208915a24577a67d298b0ca3dd188be9efe9a9e72451110f5f9c3660820b97440501d6dc38ece225eca30a6fdf1fcbfef331db6d051770
+  metadata.gz: 551eeb4f6d09b58157c6fbe2797f4e7ec69dde50cb9a160862e75cd2fe73063e1935582e3bf69533a835d3045d8562ce73de636caa89320e0d1a8b19cb875326
+  data.tar.gz: 2ea2f80c41a29207772023a344a5404d0aeae3c32987c5dae511f7941637a3ac744e02d66681d667e1b583fe91b2b606c43ab708436766cf708a76408628cb42

data/{LICENSE → MIT-LICENSE}

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Joshua Peek
+Copyright (c) 2014-2016 Joshua Peek
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -27,7 +27,7 @@ Only removes old assets (keeps the most recent 3 copies) from `public/assets`. U
 
 **`rake assets:clobber`**
 
-Nuke `public/assets` and clear the Sprockets file system cache.
+Nuke `public/assets`.
 
 #### Customize
 
@@ -37,11 +37,6 @@ You can also redefine the task with the built in task generator.
 
 ``` ruby
 require 'sprockets/rails/task'
-# clean the old tasks
-Rake::Task["assets:environment"].clear
-Rake::Task["assets:precompile"].clear
-Rake::Task["assets:clean"].clear
-Rake::Task["assets:clobber"].clear
 Sprockets::Rails::Task.new(Rails.application) do |t|
   t.environment = lambda { Rails.application.assets }
   t.assets = %w( application.js application.css )
@@ -51,23 +46,25 @@ end
 
 Each asset task will invoke `assets:environment` first. By default this loads the Rails environment. You can override this task to add or remove dependencies for your specific compilation environment.
 
-Also see [Sprockets::Rails::Task](https://github.com/rails/sprockets-rails/blob/master/lib/sprockets/rails/task.rb) and [Rake::SprocketsTask](https://github.com/sstephenson/sprockets/blob/master/lib/rake/sprocketstask.rb).
-
+Also see [Sprockets::Rails::Task](https://github.com/rails/sprockets-rails/blob/master/lib/sprockets/rails/task.rb) and [Rake::SprocketsTask](https://github.com/rails/sprockets/blob/master/lib/rake/sprocketstask.rb).
 
 ### Initializer options
 
-**`config.assets.precompile`**
+**`config.assets.unknown_asset_fallback`**
 
-Add additional assets to compile on deploy. Defaults to `application.js`, `application.css` and any other non-js/css file under `app/assets`.
+When set to a truthy value, a result will be returned even if the requested asset is not found in the asset pipeline. When set to a falsey value it will raise an error when no asset is found in the pipeline. Defaults to `true`.
 
-**`config.assets.raise_runtime_errors`**
+**`config.assets.precompile`**
 
-Set to `true` to enable additional runtime error checking. Recommended in the `development` environment to minimize unexpected behavior when deploying to `production`.
+Add additional assets to compile on deploy. Defaults to `application.js`, `application.css` and any other non-js/css file under `app/assets`.
 
 **`config.assets.paths`**
 
 Add additional load paths to this Array. Rails includes `app/assets`, `lib/assets` and `vendor/assets` for you already. Plugins might want to add their custom paths to this.
 
+**`config.assets.quiet`**
+
+Suppresses logger output for asset requests. Uses the `config.assets.prefix` path to match asset requests. Defaults to `false`.
 
 **`config.assets.version`**
 
@@ -83,21 +80,17 @@ config.assets.version = 'v2'
 
 Defaults to `/assets`. Changes the directory to compile assets to.
 
-**`config.assets.manifest`**
-
-Defines the full path to be used for the asset precompiler's manifest file. Defaults to a randomly-generated filename in the `config.assets.prefix` directory within the public folder.
-
 **`config.assets.digest`**
 
-Link to undigest asset filenames. This option will eventually go away. Unless when `compile` is disabled.
+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`**
 
-Enables Sprockets compile environment. If disabled, `Rails.application.assets` will be unavailable to any ActionView helpers. View helpers will depend on assets being precompiled to `public/assets` in order to link to them. You can still access the environment by directly calling `Rails.application.assets`.
+Enables Sprockets compile environment. If disabled, `Rails.application.assets` will be `nil` to prevent inadvertent compilation calls. View helpers will depend on assets being precompiled to `public/assets` in order to link to them. Initializers expecting `Rails.application.assets` during boot should be accessing the environment in a `config.assets.configure` block. See below.
 
 **`config.assets.configure`**
 
@@ -105,18 +98,42 @@ Invokes block with environment when the environment is initialized. Allows direc
 
 ``` ruby
 config.assets.configure do |env|
-  env.js_compressor  = :uglify # or :closure, :yui
+  env.js_compressor  = :uglifier # or :closure, :yui
   env.css_compressor = :sass   # or :yui
 
   require 'my_processor'
   env.register_preprocessor 'application/javascript', MyProcessor
 
   env.logger = Rails.logger
-
-  env.cache = ActiveSupport::Cache::FileStore.new("tmp/cache/assets")
 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
+we try to find assets: manifest first, environment second? Manifest only?
+
+By default, we check the manifest first if asset digests are enabled and debug
+is not enabled, then we check the environment if compiling is enabled:
+```
+# Dev where debug is true, or digests are disabled
+%i[ environment ]
+
+# Dev default, or production with compile enabled.
+%i[ manifest environment ]
+
+# Production default.
+%i[ manifest ]
+```
+If the resolver list is empty (e.g. if debug is true and compile is false), the standard rails public path resolution will be used.
+
+**`config.assets.check_precompiled_asset`**
+
+When enabled, an exception is raised for missing assets. This option is enabled by default.
 
 ## Complementary plugins
 
@@ -125,36 +142,51 @@ 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
 
 * Only compiles digest filenames. Static non-digest assets should simply live in public/.
 * Unmanaged asset paths and urls fallback to linking to public/. This should make it easier to work with both compiled assets and simple static assets. As a side effect, there will never be any "asset not precompiled errors" when linking to missing assets. They will just link to a public file which may or may not exist.
-* JS and CSS compressors must be explicitly set. Magic detection has been removed to avoid loading compressors in environments where you want to avoid loading any of the asset libraries. Assign `config.assets.js_compressor = :uglify` or `config.assets.css_compressor = :sass` for the standard compressors.
+* JS and CSS compressors must be explicitly set. Magic detection has been removed to avoid loading compressors in environments where you want to avoid loading any of the asset libraries. Assign `config.assets.js_compressor = :uglifier` or `config.assets.css_compressor = :sass` for the standard compressors.
 * The manifest file is now in a JSON format. Since it lives in public/ by default, the initial filename is also randomized to obfuscate public access to the resource.
 * `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 and clears your filesystem cache. The clean task allows for rolling deploys that may still be linking to an old asset while the new assets are being built.
+* 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/`.
 
-## Contributing
+## Experimental
 
-Usual bundler workflow.
+### [SRI](http://www.w3.org/TR/SRI/) support
 
-``` shell
-$ git clone https://github.com/rails/sprockets-rails.git
-$ cd sprockets-rails/
-$ bundle install
-$ bundle exec rake test
+Sprockets 3.x adds experimental support for subresource integrity checks. The spec is still evolving and the API may change in backwards incompatible ways.
+
+``` ruby
+javascript_include_tag :application, integrity: true
+# => "<script src="/assets/application.js" integrity="sha256-TvVUHzSfftWg1rcfL6TIJ0XKEGrgLyEq6lEpcmrG9qs="></script>"
 ```
 
-[![Build Status](https://secure.travis-ci.org/rails/sprockets-rails.png)](http://travis-ci.org/rails/sprockets-rails)
+Note that sprockets-rails only adds integrity hashes to assets when served in a secure context (over an HTTPS connection or localhost).
+
+
+## Contributing to Sprockets Rails
 
+Sprockets Rails is work of many contributors. You're encouraged to submit pull requests, propose
+features and discuss issues.
+
+See [CONTRIBUTING](CONTRIBUTING.md).
 
 ## Releases
 
-sprockets-rails 2.x will primarily target sprockets 2.x with future compatibility for 3.x. Consider upgrading to sprockets-rails 3.x to take full advantage of 3.x features.
+sprockets-rails 3.x will primarily target sprockets 3.x. And future versions will target the corresponding sprockets release line.
 
 The minor and patch version will be updated according to [semver](http://semver.org/).
 
@@ -162,9 +194,10 @@ The minor and patch version will be updated according to [semver](http://semver.
 * Any time the sprockets dependency is bumped, there will be a new minor release
 * Simple bug fixes will be patch releases
 
-
 ## License
 
-Copyright &copy; 2014 Joshua Peek.
+Sprockets Rails is released under the [MIT License](MIT-LICENSE).
+
+## Code Status
 
-Released under the MIT license. See `LICENSE` for details.
+* [![Gem Version](https://badge.fury.io/rb/sprockets-rails.svg)](http://badge.fury.io/rb/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/context.rb

@@ -0,0 +1,48 @@
+require 'action_view/helpers'
+require 'sprockets'
+
+module Sprockets
+  module Rails
+    module Context
+      include ActionView::Helpers::AssetUrlHelper
+      include ActionView::Helpers::AssetTagHelper
+
+      def self.included(klass)
+        klass.class_eval do
+          class_attribute :config, :assets_prefix, :digest_assets
+        end
+      end
+
+      def compute_asset_path(path, options = {})
+        @dependencies << 'actioncontroller-asset-url-config'
+
+        begin
+          asset_uri = resolve(path)
+        rescue FileNotFound
+          # TODO: eh, we should be able to use a form of locate that returns
+          # nil instead of raising an exception.
+        end
+
+        if asset_uri
+          asset = link_asset(path)
+          digest_path = asset.digest_path
+          path = digest_path if digest_assets
+          File.join(assets_prefix || "/", path)
+        else
+          super
+        end
+      end
+    end
+  end
+
+  register_dependency_resolver 'actioncontroller-asset-url-config' do |env|
+    config = env.context_class.config
+    [config.relative_url_root,
+    (config.asset_host unless config.asset_host.respond_to?(:call))]
+  end
+
+  # fallback to the default pipeline when using Sprockets 3.x
+  unless config[:pipelines].include? :debug
+    register_pipeline :debug, config[:pipelines][:default]
+  end
+end