sprockets 4.0.0.beta2 → 4.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06325c03db04bdfa682ae1244a2645283542c960
-  data.tar.gz: c17ca6d3798591d677981fa783e97a0a64972f8b
+  metadata.gz: 190eb10207d44db44036ce106c1dcc7947ffc52e
+  data.tar.gz: 49cc56e570a817c030e35b7be44d4adee429285b
 SHA512:
-  metadata.gz: a9330a81697f56e97ee07707d7f6ed54b3cdebe6c0a6726e7b74f3372c2fbbb738a4d3a54afdc383bf539f66719bc73592f1994fc3a4a2dabfed19a02f73dda9
-  data.tar.gz: 965f0aa60b2bdcc3841681c8070af54253748c28deefb16e9908e8695eb87560d572203fe56cdb811c0fbc5e5d490809ea36f3a1d62869fc67ed530ec565c077
+  metadata.gz: 20c3b7704e5aa45a458001cfa1213aa04226f5616bb339a818b1333abfe33b0d3f58305165d5170888f8d947f936372f83e39639c40afdb68fc61a3cf6f98348
+  data.tar.gz: 127f4dd25e9d3129b0a65859fc65e31442ca22021debee813d15abf48473a8bd606d862d985156358df406803135f5a2cf5ed363c6ce59010f21f5a8ef60cbdd

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Get upgrade notes from Sprockets 3.x to 4.x at https://github.com/rails/sprockets/blob/master/UPGRADING.md
 
+## 4.0.0.beta3
+
+- Source Map fixes [#255] [#367]
+- Performance improvements
+
 ## 4.0.0.beta2
 
 - Fix load_paths on Sass processors [#223]

data/README.md

@@ -22,19 +22,19 @@ gem 'sprockets', '~> 3.0'
 
 ## Using Sprockets
 
-For most people interested in using Sprockets you will want to see [End User Asset Generation](guides/end_user_asset_generation.md) guide. This contains information about sprocket's directive syntax, and default processing behavior.
+For most people interested in using Sprockets, you will want to see [End User Asset Generation](guides/end_user_asset_generation.md) guide. This contains information about Sprockets' directive syntax and default processing behavior.
 
 If you are a framework developer that is using Sprockets, see [Building an Asset Processing Framework](guides/building_an_asset_processing_framework.md).
 
 If you are a library developer who is extending the functionality of Sprockets, see [Extending Sprockets](guides/extending_sprockets.md).
 
-Below is a disjointed mix of documentation for all three of these roles. Eventually they will be moved to an appropriate guide, for now the recommended way to consume this documentation is to view the appropriate guide first and then supplement with docs from the README.
+Below is a disjointed mix of documentation for all three of these roles. Eventually they will be moved to an appropriate guide, but for now, the recommended way to consume this documentation is to view the appropriate guide first and then supplement with docs from the README.
 
 ## Behavior
 
 ### Index files are proxies for folders
 
-In Sprockets index files such as `index.js` or `index.css` files inside of a folder will generate a file with the folder's name. So if you have a `foo/index.js` file it will compile down to `foo.js`. This is similar to Node.js's behavior of using [folders as modules](https://nodejs.org/api/modules.html#modules_folders_as_modules). It is also somewhat similar to the way that a file in `public/my_folder/index.html` can be reached by a request to `/my_folder`. This means that you cannot directly use an index file. For example this would not work:
+In Sprockets, index files such as `index.js` or `index.css` inside of a folder will generate a file with the folder's name. So if you have a file named `foo/index.js`, it will compile down to `foo.js`. This is similar to Node.js's behavior of using [folders as modules](https://nodejs.org/api/modules.html#modules_folders_as_modules). It is also somewhat similar to the way that a file in `public/my_folder/index.html` can be reached by a request to `/my_folder`. This means that you cannot directly use an index file. For example this would not work:
 
 ```
 <%= asset_path("foo/index.js") %>
@@ -52,7 +52,7 @@ Why would you want to use this behavior?  It is common behavior where you might
 //= require_tree .
 ```
 
-This has the problem that files are required alphabetically. If your directory has `jquery-ui.js` and `jquery.min.js` then Sprockets will require `jquery-ui.js` before `jquery` is required which won't work (because jquery-ui depends on jquery). Previously the only way to get the correct ordering would be to rename your files, something like `0-jquery-ui.js`. Instead of doing that you can use an index file.
+This has the problem that files are required alphabetically. If your directory has `jquery-ui.js` and `jquery.min.js`, then Sprockets will require `jquery-ui.js` before `jquery` is required, which won't work (because jquery-ui depends on jquery). Previously the only way to get the correct ordering would be to rename your files, something like `0-jquery-ui.js`. Instead of doing that you can use an index file.
 
 For example, if you have an `application.js` and want all the files in the `foo/` folder you could do this:
 
@@ -67,7 +67,7 @@ Then create a file `foo/index.js` that requires all the files in that folder in
 //= require foo-ui.js
 ```
 
-Now in your `application.js` will correctly load the `foo.min.js` before `foo-ui.js`. If you used `require_tree` it would not work correctly.
+Now, your `application.js` will correctly load the `foo.min.js` before `foo-ui.js`. If you used `require_tree` it would not work correctly.
 
 ## Understanding the Sprockets Environment
 
@@ -204,8 +204,8 @@ environment.js_compressor  = :uglify
 environment.css_compressor = :scss
 ```
 
-If you are using Sprockets directly with Rack app, don't forget to add
-`uglifier` and `sass` gems to your Gemfile when using above options.
+If you are using Sprockets directly with a Rack app, don't forget to add
+the `uglifier` and `sass` gems to your Gemfile when using above options.
 
 ### Styling with Sass and SCSS
 
@@ -362,7 +362,7 @@ reference files relative to the location of the current file.
 specified by *path*. If the file is required multiple times, it will
 appear in the bundle only once.
 
-### The `require_directory` Directive ###
+#### The `require_directory` Directive
 
 `require_directory` *path* requires all source files of the same
 format in the directory specified by *path*. Files are required in
@@ -404,6 +404,16 @@ automatically be defined for you.
 }
 ```
 
+#### The `link_directory` Directive
+
+`link_directory` *path* links all the files inside the directory specified by the *path*
+
+#### The `link_tree` Directive
+
+`link_tree` *path* works like `link_directory`, but operates
+recursively to link all files in all subdirectories of the
+directory specified by *path*.
+
 #### The `depend_on` Directive
 
 `depend_on` *path* declares a dependency on the given *path* without
@@ -424,9 +434,9 @@ within any subdependencies.
 
 ## Processor Interface
 
-Sprockets 2.x was originally design around [Tilt](https://github.com/rtomayko/tilt)'s engine interface. However, starting with 3.x, a new interface has been introduced deprecating Tilt.
+Sprockets 2.x was originally designed around [Tilt](https://github.com/rtomayko/tilt)'s engine interface. However, starting with 3.x, a new interface has been introduced deprecating Tilt.
 
-Similar to Rack, a processor is a any "callable" (an object that responds to `call`). This maybe a simple Proc or a full class that defines a `def self.call(input)` method. The `call` method accepts an `input` Hash and returns a Hash of metadata.
+Similar to Rack, a processor is any "callable" (an object that responds to `call`). This may be a simple Proc or a full class that defines a `def self.call(input)` method. The `call` method accepts an `input` Hash and returns a Hash of metadata.
 
 Also see [`Sprockets::ProcessorUtils`](https://github.com/rails/sprockets/blob/master/lib/sprockets/processor_utils.rb) for public helper methods.
 
@@ -434,11 +444,11 @@ Also see [`Sprockets::ProcessorUtils`](https://github.com/rails/sprockets/blob/m
 
 The `input` Hash defines the following public fields.
 
-* `:data` - String asset contents
+* `:data` - String asset contents.
 * `:environment` - Current `Sprockets::Environment` instance.
 * `:cache` - A `Sprockets::Cache` instance. See [`Sprockets::Cache#fetch`](https://github.com/rails/sprockets/blob/master/lib/sprockets/cache.rb).
 * `:uri` - String Asset URI.
-* `:filename` - String full path to original file.
+* `:source_path` - String full path to original file.
 * `:load_path` - String current load path for filename.
 * `:name` - String logical path for filename.
 * `:content_type` - String content type of the output asset.
@@ -455,7 +465,7 @@ end
 
 ### return Hash
 
-The processor should return metadata `Hash`. With the exception of the `:data` key, the processor can store arbitrary JSON valid values in this Hash. The data will be stored and exposed on `Asset#metadata`.
+The processor should return metadata `Hash`. With the exception of the `:data` key, the processor can store arbitrary valid JSON values in this Hash. The data will be stored and exposed on `Asset#metadata`.
 
 The returned `:data` replaces the assets `input[:data]` to the next processor in the chain. Returning a `String` is shorthand for returning `{ data: str }`. And returning `nil` is shorthand for a no-op where the input data is not transformed, `{ data: input[:data] }`.
 
@@ -467,6 +477,8 @@ The metadata Hash provides an open format for processors to extend the pipeline
 * `:stubbed` - A `Set` of String Asset URIs that will be omitted from the `:required` set.
 * `:links` - A `Set` of String Asset URIs that should be compiled along with this asset.
 * `:dependencies` - A `Set` of String Cache URIs that should be monitored for caching.
+* `:map` - An `Array` of source maps for the asset.
+* `:charset` - The mime charset for an asset.
 
 ``` ruby
 def self.call(input)

data/lib/rake/sprocketstask.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rake'
 require 'rake/tasklib'
 

data/lib/sprockets.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+# frozen_string_literal: true
+
 require 'sprockets/version'
 require 'sprockets/cache'
 require 'sprockets/environment'
@@ -121,8 +123,8 @@ module Sprockets
   register_bundle_processor 'application/javascript', Bundle
   register_bundle_processor 'text/css', Bundle
 
-  register_bundle_metadata_reducer '*/*', :data, proc { "" }, :concat
-  register_bundle_metadata_reducer 'application/javascript', :data, proc { "" }, Utils.method(:concat_javascript_sources)
+  register_bundle_metadata_reducer '*/*', :data, proc { String.new("") }, :concat
+  register_bundle_metadata_reducer 'application/javascript', :data, proc { String.new("") }, Utils.method(:concat_javascript_sources)
   register_bundle_metadata_reducer '*/*', :links, :+
   register_bundle_metadata_reducer '*/*', :map, SourceMapUtils.method(:concat_source_maps)
 

data/lib/sprockets/asset.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'sprockets/digest_utils'
 

data/lib/sprockets/autoload.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sprockets
   module Autoload
     autoload :Babel, 'sprockets/autoload/babel'

data/lib/sprockets/autoload/babel.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'babel/transpiler'
 
 module Sprockets

data/lib/sprockets/autoload/closure.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'closure-compiler'
 
 module Sprockets

data/lib/sprockets/autoload/coffee_script.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'coffee_script'
 
 module Sprockets

data/lib/sprockets/autoload/eco.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'eco'
 
 module Sprockets

data/lib/sprockets/autoload/ejs.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'ejs'
 
 module Sprockets

data/lib/sprockets/autoload/jsminc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'jsminc'
 
 module Sprockets

data/lib/sprockets/autoload/sass.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sass'
 
 module Sprockets

data/lib/sprockets/autoload/sassc.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sassc'
 
 module Sprockets

data/lib/sprockets/autoload/uglifier.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'uglifier'
 
 module Sprockets

data/lib/sprockets/autoload/yui.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'yui/compressor'
 
 module Sprockets

data/lib/sprockets/babel_processor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
 require 'sprockets/path_utils'
 require 'sprockets/source_map_utils'
@@ -38,7 +39,8 @@ module Sprockets
           'sourceRoot' => input[:load_path],
           'moduleRoot' => nil,
           'filename' => input[:filename],
-          'filenameRelative' => PathUtils.split_subpath(input[:load_path], input[:filename])
+          'filenameRelative' => PathUtils.split_subpath(input[:load_path], input[:filename]),
+          'sourceFileName' => input[:source_path]
         }.merge(@options)
 
         if opts['moduleIds'] && opts['moduleRoot']

data/lib/sprockets/base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/asset'
 require 'sprockets/bower'
 require 'sprockets/cache'
@@ -14,7 +15,7 @@ require 'sprockets/source_map_utils'
 require 'sprockets/uri_tar'
 
 module Sprockets
-  # `Base` class for `Environment` and `Cached`.
+  # `Base` class for `Environment` and `CachedEnvironment`.
   class Base
     include PathUtils, PathDependencyUtils, PathDigestUtils, DigestUtils, SourceMapUtils
     include Configuration
@@ -34,7 +35,7 @@ module Sprockets
       @cache = Cache.new(cache, logger)
     end
 
-    # Return an `Cached`. Must be implemented by the subclass.
+    # Return an `CachedEnvironment`. Must be implemented by the subclass.
     def cached
       raise NotImplementedError
     end

data/lib/sprockets/bower.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'json'
 
 module Sprockets

data/lib/sprockets/bundle.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'set'
 require 'sprockets/utils'
 

data/lib/sprockets/cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'logger'
 require 'sprockets/digest_utils'
 
@@ -153,7 +154,9 @@ module Sprockets
       #
       # Returns a String with a length less than 250 characters.
       def expand_key(key)
-        "sprockets/v#{VERSION}/#{DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))}"
+        digest_key = DigestUtils.pack_urlsafe_base64digest(DigestUtils.digest(key))
+        namespace = digest_key[0, 2]
+        "sprockets/v#{VERSION}/#{namespace}/#{digest_key}"
       end
 
       PEEK_SIZE = 100

data/lib/sprockets/cache/file_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'fileutils'
 require 'logger'
 require 'sprockets/encoding_utils'

data/lib/sprockets/cache/memory_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sprockets
   class Cache
     # Public: Basic in memory LRU cache.

data/lib/sprockets/cache/null_store.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Sprockets
   class Cache
     # Public: A compatible cache store that doesn't store anything. Used by

data/lib/sprockets/cached_environment.rb

@@ -1,14 +1,15 @@
+# frozen_string_literal: true
 require 'sprockets/base'
 
 module Sprockets
-  # `Cached` is a special cached version of `Environment`.
+  # `CachedEnvironment` is a special cached version of `Environment`.
   #
   # The expection is that all of its file system methods are cached
-  # for the instances lifetime. This makes `Cached` much faster. This
+  # for the instances lifetime. This makes `CachedEnvironment` much faster. This
   # behavior is ideal in production environments where the file system
   # is immutable.
   #
-  # `Cached` should not be initialized directly. Instead use
+  # `CachedEnvironment` should not be initialized directly. Instead use
   # `Environment#cached`.
   class CachedEnvironment < Base
     def initialize(environment)

data/lib/sprockets/closure_compressor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
 require 'sprockets/digest_utils'
 
@@ -35,11 +36,12 @@ module Sprockets
     attr_reader :cache_key
 
     def initialize(options = {})
-      @compiler = Autoload::Closure::Compiler.new(options)
+      @options = options
       @cache_key = "#{self.class.name}:#{Autoload::Closure::VERSION}:#{Autoload::Closure::COMPILER_VERSION}:#{VERSION}:#{DigestUtils.digest(options)}".freeze
     end
 
     def call(input)
+      @compiler ||= Autoload::Closure::Compiler.new(@options)
       @compiler.compile(input[:data])
     end
   end

data/lib/sprockets/coffee_script_processor.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/autoload'
 require 'sprockets/source_map_utils'
 
@@ -7,7 +8,7 @@ module Sprockets
   #
   # For more infomation see:
   #
-  #   https://github.com/josh/ruby-coffee-script
+  #   https://github.com/rails/ruby-coffee-script
   #
   module CoffeeScriptProcessor
     VERSION = '2'

data/lib/sprockets/compressing.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/utils'
 
 module Sprockets
@@ -10,6 +11,24 @@ module Sprockets
       config[:compressors]
     end
 
+    # Public: Register a new compressor `klass` at `sym` for `mime_type`.
+    #
+    # Registering a processor allows it to be looked up by `sym` later when
+    # assigning a JavaScript or CSS compressor.
+    #
+    # Compressors only operate on JavaScript and CSS. If you want to compress a
+    # different type of asset, use a processor instead.
+    #
+    # Examples
+    #
+    #     register_compressor 'text/css', :my_sass, MySassCompressor
+    #     css_compressor = :my_sass
+    #
+    # mime_type - String MIME Type (one of: 'test/css' or 'application/javascript').
+    # sym       - Symbol registration address.
+    # klass     - The compressor class.
+    #
+    # Returns nothing.
     def register_compressor(mime_type, sym, klass)
       self.config = hash_reassoc(config, :compressors, mime_type) do |compressors|
         compressors[sym] = klass

data/lib/sprockets/configuration.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/compressing'
 require 'sprockets/dependencies'
 require 'sprockets/mime'

data/lib/sprockets/context.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rack/utils'
 require 'set'
 require 'sprockets/errors'
@@ -99,7 +100,7 @@ module Sprockets
     # including it.
     #
     # This is used for caching purposes. Any changes made to
-    # the dependency file with invalidate the cache of the
+    # the dependency file will invalidate the cache of the
     # source file.
     def depend_on(path)
       if environment.absolute_path?(path) && environment.stat(path)
@@ -115,7 +116,7 @@ module Sprockets
     #
     # This is used for caching purposes. Any changes that would
     # invalidate the dependency asset will invalidate the source
-    # file. Unlike `depend_on`, this will include recursively include
+    # file. Unlike `depend_on`, this will recursively include
     # the target asset's dependencies.
     def depend_on_asset(path)
       load(resolve(path))

data/lib/sprockets/dependencies.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'sprockets/digest_utils'
 require 'sprockets/path_digest_utils'
 require 'sprockets/uri_utils'