sprockets-rails 3.0.0.beta2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25923aeac0b56b286d1fa13aed70e9473d34ead2
-  data.tar.gz: 9dfd806b0fd3a1839680622882d7a01db8670f44
+  metadata.gz: f20d1344a104a96a8fdc6ca1140776f9bee0b095
+  data.tar.gz: b2a9b8a9c86913d9ec6d55a221e2f433cac8201f
 SHA512:
-  metadata.gz: 5f8c7541800873483a0032d728d776c5578f770708d83804d8aa77ca41d709726af9a1db5c1ad2e600afd0995f506db10e2ebeda08c8a65de9aa9bc61d41c44e
-  data.tar.gz: b7888a09152ca3686aa43e5df660dacbfcf185162e87c3818cddc9aa0698ffb183b19a8a03c6a2c5a4af3aa4fac99bfdb80fddf23f1755c9543ee0cbac677be3
+  metadata.gz: 5f0bfaac5eaaaa8db5681deb71749e0e1195b8f4e0c819125d70102359094baa1a535ad6a5d6163b60d24b5474848c7db2fc12d9bf917aa9c53d3809e69fa2f0
+  data.tar.gz: 8966809de396e82b543ccac54823f99c0abad6696f58bfdc40a1db9e884d196b2570b8c62720c2ac04c35de942a8a4469805c31418d070f09a262afb486124c4

data/README.md

@@ -74,10 +74,6 @@ 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`**
 
 When enabled, fingerprints will be added to asset filenames.
@@ -108,6 +104,24 @@ config.assets.configure do |env|
 end
 ```
 
+**`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 ]
+```
+
 
 ## Complementary plugins
 
@@ -136,23 +150,16 @@ Sprockets 3.x adds experimental support for subresource integrity checks. The sp
 
 ``` ruby
 javascript_include_tag :application, integrity: true
-# => "<script src="/assets/application.js" integrity="sha-256-TvVUHzSfftWg1rcfL6TIJ0XKEGrgLyEq6lEpcmrG9qs="></script>"
+# => "<script src="/assets/application.js" integrity="sha256-TvVUHzSfftWg1rcfL6TIJ0XKEGrgLyEq6lEpcmrG9qs="></script>"
 ```
 
 
-## Contributing
+## Contributing to Sprockets Rails
 
-Usual bundler workflow.
-
-``` shell
-$ git clone https://github.com/rails/sprockets-rails.git
-$ cd sprockets-rails/
-$ bundle install
-$ bundle exec rake test
-```
-
-[![Build Status](https://travis-ci.org/rails/sprockets-rails.svg?branch=master)](https://travis-ci.org/rails/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
 
@@ -164,9 +171,12 @@ 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.
+* [![Travis CI](https://api.travis-ci.org/rails/sprockets-rails.svg)](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/helper.rb

@@ -7,11 +7,25 @@ module Sprockets
   module Rails
     module Helper
       class AssetNotPrecompiled < StandardError
+        include Sprockets::Rails::Utils
         def initialize(source)
-          msg = "Asset was not declared to be precompiled in production.\n" +
-                "Add `Rails.application.config.assets.precompile += " +
-                "%w( #{source} )` to `config/initializers/assets.rb` and " +
-                "restart your server"
+          msg =
+          if using_sprockets4?
+            "Asset `#{source}` was not declared to be precompiled in production.\n" +
+            "Declare links to your assets in `assets/config/manifest.js`.\n" +
+            "Examples:\n" +
+            "`//= link ../javascripts/application.js`\n" +
+            "`//= link_directory ../javascripts .js`\n" +
+            "`//= link_directory ../stylesheets .css`\n" +
+            "`//= link_tree ../javascripts .js`\n" +
+            "`//= link_tree ../images`\n" +
+            "and restart your server"
+          else
+            "Asset was not declared to be precompiled in production.\n" +
+            "Add `Rails.application.config.assets.precompile += " +
+            "%w( #{source} )` to `config/initializers/assets.rb` and " +
+            "restart your server"
+          end
           super(msg)
         end
       end
@@ -20,9 +34,12 @@ module Sprockets
       include ActionView::Helpers::AssetTagHelper
       include Sprockets::Rails::Utils
 
-      VIEW_ACCESSORS = [:assets_environment, :assets_manifest,
-                        :assets_precompile, :precompiled_assets,
-                        :assets_prefix, :digest_assets, :debug_assets]
+      VIEW_ACCESSORS = [
+        :assets_environment, :assets_manifest,
+        :assets_precompile, :precompiled_asset_checker,
+        :assets_prefix, :digest_assets, :debug_assets,
+        :resolve_assets_with
+      ]
 
       def self.included(klass)
         klass.class_attribute(*VIEW_ACCESSORS)
@@ -57,15 +74,23 @@ module Sprockets
       end
 
       def compute_asset_path(path, options = {})
-        if digest_path = asset_digest_path(path, options)
-          path = digest_path if digest_assets
-          path += "?body=1" if options[:debug] && !using_sprockets4?
-          File.join(assets_prefix || "/", path)
+        debug = options[:debug]
+
+        if asset_path = resolve_asset_path(path, debug)
+          File.join(assets_prefix || "/", legacy_debug_path(asset_path, debug))
         else
           super
         end
       end
 
+      # Resolve the asset path against the Sprockets manifest or environment.
+      # Returns nil if it's an asset we don't know about.
+      def resolve_asset_path(path, allow_non_precompiled = false) #:nodoc:
+        resolve_asset do |resolver|
+          resolver.asset_path path, digest_assets, allow_non_precompiled
+        end
+      end
+
       # Expand asset path to digested form.
       #
       # path    - String path
@@ -73,21 +98,8 @@ module Sprockets
       #
       # Returns String path or nil if no asset was found.
       def asset_digest_path(path, options = {})
-        if manifest = assets_manifest
-          if digest_path = manifest.assets[path]
-            return digest_path
-          end
-        end
-
-        if environment = assets_environment
-          if asset = environment[path]
-            unless options[:debug]
-              if !precompiled_assets.include?(asset.logical_path)
-                raise AssetNotPrecompiled.new(asset.logical_path)
-              end
-            end
-            return asset.digest_path
-          end
+        resolve_asset do |resolver|
+          resolver.digest_path path, options[:debug]
         end
       end
 
@@ -98,26 +110,11 @@ module Sprockets
       #
       # Returns String integrity attribute or nil if no asset was found.
       def asset_integrity(path, options = {})
-        path = path.to_s
-        if extname = compute_asset_extname(path, options)
-          path = "#{path}#{extname}"
-        end
-
-        if manifest = assets_manifest
-          if digest_path = manifest.assets[path]
-            if metadata = manifest.files[digest_path]
-              return metadata["integrity"]
-            end
-          end
-        end
+        path = path_with_extname(path, options)
 
-        if environment = assets_environment
-          if asset = environment[path]
-            return asset.integrity
-          end
+        resolve_asset do |resolver|
+          resolver.integrity path
         end
-
-        nil
       end
 
       # Override javascript tag helper to provide debugging support.
@@ -125,15 +122,7 @@ module Sprockets
       # Eventually will be deprecated and replaced by source maps.
       def javascript_include_tag(*sources)
         options = sources.extract_options!.stringify_keys
-
-        unless request_ssl?
-          options.delete("integrity")
-        end
-
-        case options["integrity"]
-        when true, false, nil
-          compute_integrity = options.delete("integrity")
-        end
+        integrity = compute_integrity?(options)
 
         if options["debug"] != false && request_debug_assets?
           sources.map { |source|
@@ -151,9 +140,8 @@ module Sprockets
           }.flatten.uniq.join("\n").html_safe
         else
           sources.map { |source|
-            super(source, compute_integrity ?
-              options.merge("integrity" => asset_integrity(source, :type => :javascript)) :
-              options)
+            options = options.merge('integrity' => asset_integrity(source, :type => :javascript)) if integrity
+            super source, options
           }.join("\n").html_safe
         end
       end
@@ -163,15 +151,7 @@ module Sprockets
       # Eventually will be deprecated and replaced by source maps.
       def stylesheet_link_tag(*sources)
         options = sources.extract_options!.stringify_keys
-
-        unless request_ssl?
-          options.delete("integrity")
-        end
-
-        case options["integrity"]
-        when true, false, nil
-          compute_integrity = options.delete("integrity")
-        end
+        integrity = compute_integrity?(options)
 
         if options["debug"] != false && request_debug_assets?
           sources.map { |source|
@@ -189,15 +169,34 @@ module Sprockets
           }.flatten.uniq.join("\n").html_safe
         else
           sources.map { |source|
-            super(source, compute_integrity ?
-              options.merge("integrity" => asset_integrity(source, :type => :stylesheet)) :
-              options)
+            options = options.merge('integrity' => asset_integrity(source, :type => :stylesheet)) if integrity
+            super source, options
           }.join("\n").html_safe
         end
       end
 
       protected
-        def request_ssl?
+        # This is awkward: `integrity` is a boolean option indicating whether
+        # we want to include or omit the subresource integrity hash, but the
+        # options hash is also passed through as literal tag attributes.
+        # That means we have to delete the shortcut boolean option so it
+        # doesn't bleed into the tag attributes, but also check its value if
+        # it's boolean-ish.
+        def compute_integrity?(options)
+          if secure_subresource_integrity_context?
+            case options['integrity']
+            when nil, false, true
+              options.delete('integrity') == true
+            end
+          else
+            options.delete 'integrity'
+            false
+          end
+        end
+
+        # Only serve integrity metadata for HTTPS requests:
+        #   http://www.w3.org/TR/SRI/#non-secure-contexts-remain-non-secure
+        def secure_subresource_integrity_context?
           respond_to?(:request) && self.request && self.request.ssl?
         end
 
@@ -205,28 +204,152 @@ module Sprockets
         # and replaced by source maps in Sprockets 3.x.
         def request_debug_assets?
           debug_assets || (defined?(controller) && controller && params[:debug_assets])
-        rescue
-          return false
+        rescue # FIXME: what exactly are we rescuing?
+          false
         end
 
         # Internal method to support multifile debugging. Will
         # eventually be removed w/ Sprockets 3.x.
         def lookup_debug_asset(path, options = {})
-          return unless env = assets_environment
+          path = path_with_extname(path, options)
+
+          resolve_asset do |resolver|
+            resolver.find_debug_asset path
+          end
+        end
+
+        # compute_asset_extname is in AV::Helpers::AssetUrlHelper
+        def path_with_extname(path, options)
           path = path.to_s
-          if extname = compute_asset_extname(path, options)
-            path = "#{path}#{extname}"
+          "#{path}#{compute_asset_extname(path, options)}"
+        end
+
+        # Try each asset resolver and return the first non-nil result.
+        def resolve_asset
+          asset_resolver_strategies.detect do |resolver|
+            if result = yield(resolver)
+              break result
+            end
           end
+        end
 
-          if asset = env[path, pipeline: :debug]
-            original_path = asset.logical_path.gsub('.debug', '')
-            unless precompiled_assets.include?(original_path)
-              raise AssetNotPrecompiled.new(original_path)
+        # List of resolvers in `config.assets.resolve_with` order.
+        def asset_resolver_strategies
+          @asset_resolver_strategies ||=
+            Array(resolve_assets_with).map do |name|
+              HelperAssetResolvers[name].new(self)
             end
+        end
+
+        # Append ?body=1 if debug is on and we're on old Sprockets.
+        def legacy_debug_path(path, debug)
+          if debug && !using_sprockets4?
+            "#{path}?body=1"
+          else
+            path
           end
+        end
+    end
+
+    # Use a separate module since Helper is mixed in and we needn't pollute
+    # the class namespace with our internals.
+    module HelperAssetResolvers #:nodoc:
+      def self.[](name)
+        case name
+        when :manifest
+          Manifest
+        when :environment
+          Environment
+        else
+          raise ArgumentError, "Unrecognized asset resolver: #{name.inspect}. Expected :manifest or :environment"
+        end
+      end
+
+      class Manifest #:nodoc:
+        def initialize(view)
+          @manifest = view.assets_manifest
+          raise ArgumentError, 'config.assets.resolve_with includes :manifest, but app.assets_manifest is nil' unless @manifest
+        end
+
+        def asset_path(path, digest, allow_non_precompiled = false)
+          if digest
+            digest_path path, allow_non_precompiled
+          end
+        end
+
+        def digest_path(path, allow_non_precompiled = false)
+          @manifest.assets[path]
+        end
+
+        def integrity(path)
+          if meta = metadata(path)
+            meta["integrity"]
+          end
+        end
+
+        def find_debug_asset(path)
+          nil
+        end
+
+        private
+          def metadata(path)
+            if digest_path = digest_path(path)
+              @manifest.files[digest_path]
+            end
+          end
+      end
+
+      class Environment #:nodoc:
+        def initialize(view)
+          raise ArgumentError, 'config.assets.resolve_with includes :environment, but app.assets is nil' unless view.assets_environment
+          @env = view.assets_environment
+          @precompiled_asset_checker = view.precompiled_asset_checker
+        end
+
+        def asset_path(path, digest, allow_non_precompiled = false)
+          # Digests enabled? Do the work to calculate the full asset path.
+          if digest
+            digest_path path, allow_non_precompiled
+
+          # Otherwise, ask the Sprockets environment whether the asset exists
+          # and check whether it's also precompiled for production deploys.
+          elsif find_asset(path)
+            raise_unless_precompiled_asset path unless allow_non_precompiled
+            path
+          end
+        end
+
+        def digest_path(path, allow_non_precompiled = false)
+          if asset = find_asset(path)
+            raise_unless_precompiled_asset path unless allow_non_precompiled
+            asset.digest_path
+          end
+        end
 
-          asset
+        def integrity(path)
+          find_asset(path).try :integrity
         end
+
+        def find_debug_asset(path)
+          if asset = find_asset(path, pipeline: :debug)
+            raise_unless_precompiled_asset asset.logical_path.sub('.debug', '')
+            asset
+          end
+        end
+
+        private
+          def find_asset(path, options = {})
+            @env[path, options]
+          end
+
+          def precompiled?(path)
+            @precompiled_asset_checker.call path
+          end
+
+          def raise_unless_precompiled_asset(path)
+            raise Helper::AssetNotPrecompiled.new(path) unless precompiled?(path)
+          end
+      end
     end
   end
 end

data/lib/sprockets/rails/utils.rb

@@ -6,11 +6,6 @@ module Sprockets
       def using_sprockets4?
         Gem::Version.new(Sprockets::VERSION) >= Gem::Version.new('4.0.0')
       end
-
-      # Internal: Generate a Set of all precompiled assets logical paths.
-      def build_precompiled_list(manifest, assets)
-        manifest.find(assets || []).map(&:logical_path)
-      end
     end
   end
 end

data/lib/sprockets/rails/version.rb

@@ -1,5 +1,5 @@
 module Sprockets
   module Rails
-    VERSION = "3.0.0.beta2"
+    VERSION = "3.0.0"
   end
 end

data/lib/sprockets/railtie.rb

@@ -8,6 +8,7 @@ require 'sprockets/rails/context'
 require 'sprockets/rails/helper'
 require 'sprockets/rails/route_wrapper'
 require 'sprockets/rails/version'
+require 'set'
 
 module Rails
   class Application
@@ -27,8 +28,18 @@ module Rails
     # Returns Sprockets::Manifest for app config.
     attr_accessor :assets_manifest
 
-    # Returns array of already precompiled assets
-    attr_accessor :precompiled_assets
+    # Called from asset helpers to alert you if you reference an asset URL that
+    # isn't precompiled and hence won't be available in production.
+    def asset_precompiled?(logical_path)
+      precompiled_assets.include? logical_path
+    end
+
+    # Lazy-load the precompile list so we don't cause asset compilation at app
+    # boot time, but ensure we cache the list so we don't recompute it for each
+    # request or test case.
+    def precompiled_assets
+      @precompiled_assets ||= assets_manifest.find(config.assets.precompile).map(&:logical_path).to_set
+    end
   end
 
   class Engine < Railtie
@@ -37,7 +48,6 @@ module Rails
       initializer :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"].existent_directories.grep(/\/assets\z/))
         app.config.assets.paths.unshift(*paths["app/assets"].existent_directories)
       end
     end
@@ -79,11 +89,6 @@ module Sprockets
       config.assets.paths.each { |path| env.append_path(path) }
     end
 
-    config.assets.configure do |env|
-      env.js_compressor  = config.assets.js_compressor
-      env.css_compressor = config.assets.css_compressor
-    end
-
     config.assets.configure do |env|
       env.context_class.send :include, ::Sprockets::Rails::Context
       env.context_class.assets_prefix = config.assets.prefix
@@ -123,16 +128,23 @@ module Sprockets
 
       env = Sprockets::Environment.new(app.root.to_s)
 
+      config = app.config
+
       # Run app.assets.configure blocks
-      app.config.assets._blocks.each do |block|
+      config.assets._blocks.each do |block|
         block.call(env)
       end
 
+      # Set compressors after the configure blocks since they can
+      # define new compressors and we only accept existent compressors.
+      env.js_compressor  = config.assets.js_compressor
+      env.css_compressor = config.assets.css_compressor
+
       # No more configuration changes at this point.
       # With cache classes on, Sprockets won't check the FS when files
       # change. Preferable in production when the FS only changes on
       # deploys when the app restarts.
-      if app.config.cache_classes
+      if config.cache_classes
         env = env.cached
       end
 
@@ -153,10 +165,14 @@ module Sprockets
         app.routes.prepend do
           mount app.assets => config.assets.prefix
         end
-        app.assets_manifest = build_manifest(app)
-        app.precompiled_assets = build_precompiled_list(app.assets_manifest, config.assets.precompile)
-      else
-        app.assets_manifest = build_manifest(app)
+      end
+
+      app.assets_manifest = build_manifest(app)
+
+      if config.assets.resolve_with.nil?
+        config.assets.resolve_with = []
+        config.assets.resolve_with << :manifest if config.assets.digest && !config.assets.debug
+        config.assets.resolve_with << :environment if config.assets.compile
       end
 
       ActionDispatch::Routing::RouteWrapper.class_eval do
@@ -182,7 +198,11 @@ module Sprockets
 
         self.assets_environment = app.assets
         self.assets_manifest = app.assets_manifest
-        self.precompiled_assets = app.precompiled_assets
+
+        self.resolve_assets_with = config.assets.resolve_with
+
+        # Expose the app precompiled asset check to the view
+        self.precompiled_asset_checker = -> logical_path { app.asset_precompiled? logical_path }
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sprockets-rails
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta2
+  version: 3.0.0
 platform: ruby
 authors:
 - Joshua Peek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-15 00:00:00.000000000 Z
+date: 2015-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sprockets
@@ -114,7 +114,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE
 - README.md
 - lib/sprockets/rails.rb
 - lib/sprockets/rails/context.rb
@@ -139,14 +138,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Sprockets Rails integration
 test_files: []
-has_rdoc: 

data/LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2014 Joshua Peek
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.