sprockets 2.12.5 → 3.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 80bdc30a8aea68bb04398d467eea5a5e4cfe9b7dcef6ee41e2902debcec63342
-  data.tar.gz: 55a0f0b58e3e55c08ccfb30476017b814894b7ec98cf3bd22eecbc8bdcbe5c39
+SHA1:
+  metadata.gz: 221043e6f00af1601780ca6aeb8c68911c1eeab6
+  data.tar.gz: 480adcfe9d59b1381dc000142ca7c4df6fc69a08
 SHA512:
-  metadata.gz: a3ee63f44b0391509f3e80b1c6b403abf52168a66910da726221b7b45c6c51187f86a7896df45e8b6c7bed68d5218ad7915fa79602e3cf7a23c32622d23ab8a5
-  data.tar.gz: da30a4f95ef0691cec504b73b1d832cec2577aa0b2905050e74ad9a89322c6568e3ec250a760ac3a6f2080f738e8ed1580e3ae7ff2a53e8623820d98fea00b2d
+  metadata.gz: e1260c1e89442a746a8c5bf095cb72fc2fb04115dadec6874147b5a9794bea557255cf429af883e9f1216c6dee84ed2da3019ceb1a5ccd1dcbc14166058ceb24
+  data.tar.gz: 0eaa3ace51ff6477b1b411fc2b4bfc67f9e3a268b088dc2c6fc1848ed5ffe9939ac481676324107be54e53abe835c0b4b2cb44a60c34083557c5d1458fad480b

data/LICENSE

@@ -1,5 +1,5 @@
-Copyright (c) 2011 Sam Stephenson
-Copyright (c) 2011 Joshua Peek
+Copyright (c) 2014 Sam Stephenson
+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

data/README.md

@@ -3,7 +3,7 @@
 Sprockets is a Ruby library for compiling and serving web assets.
 It features declarative dependency management for JavaScript and CSS
 assets, as well as a powerful preprocessor pipeline that allows you to
-write assets in languages like CoffeeScript, Sass, SCSS and LESS.
+write assets in languages like CoffeeScript, Sass and SCSS.
 
 # Installation #
 
@@ -13,7 +13,7 @@ Install Sprockets from RubyGems:
 
 Or include it in your project's `Gemfile` with Bundler:
 
-    gem 'sprockets', '~> 2.0'
+    gem 'sprockets', '~> 3.0'
 
 # Understanding the Sprockets Environment #
 
@@ -126,7 +126,7 @@ get a `Sprockets::BundledAsset` instance back:
 
 Call `to_s` on the resulting asset to access its contents, `length` to
 get its length in bytes, `mtime` to query its last-modified time, and
-`pathname` to get its full path on the filesystem.
+`filename` to get its full path on the filesystem.
 
 # Using Engines #
 
@@ -139,6 +139,15 @@ filename. For example, a CSS file written in SCSS might have the name
 `layout.css.scss`, while a JavaScript file written in CoffeeScript
 might have the name `dialog.js.coffee`.
 
+## Minifying Assets ##
+
+Several JavaScript and CSS minifiers are available through shorthand.
+
+``` ruby
+environment.js_compressor  = :uglify
+environment.css_compressor = :scss
+```
+
 ## Styling with Sass and SCSS ##
 
 [Sass](http://sass-lang.com/) is a language that compiles to CSS and
@@ -152,19 +161,6 @@ Sprockets supports both Sass syntaxes. For the original
 whitespace-sensitive syntax, use the extension `.css.sass`. For the
 new SCSS syntax, use the extension `.css.scss`.
 
-## Styling with LESS ##
-
-[LESS](http://lesscss.org/) extends CSS with dynamic behavior such as
-variables, mixins, operations and functions.
-
-If the `less` gem is available to your application, you can use LESS
-to write CSS assets in Sprockets. Note that the LESS compiler is
-written in JavaScript and the `less` gem (on MRI) uses `therubyracer`
-which embeds the V8 JavaScript runtime in Ruby, while on JRuby you're
-going to need `therubyrhino` gem installed.
-
-To write CSS assets with LESS, use the extension `.css.less`.
-
 ## Scripting with CoffeeScript ##
 
 [CoffeeScript](http://jashkenas.github.com/coffee-script/) is a
@@ -237,7 +233,7 @@ include:
   database, in a JavaScript asset via JSON
 - embedding version constants loaded from another file
 
-See the [Helper Methods](#FIXME) section for more information about
+See the [Helper Methods](lib/sprockets/context.rb) section for more information about
 interacting with `Sprockets::Context` instances via ERB.
 
 ### String Interpolation Syntax ###
@@ -307,12 +303,6 @@ 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 `include` Directive ###
-
-`include` *path* works like `require`, but inserts the contents of the
-specified source file even if it has already been included or
-required.
-
 ### The `require_directory` Directive ###
 
 `require_directory` *path* requires all source files of the same
@@ -328,7 +318,32 @@ directory specified by *path*.
 ### The `require_self` Directive ###
 
 `require_self` tells Sprockets to insert the body of the current
-source file before any subsequent `require` or `include` directives.
+source file before any subsequent `require` directives.
+
+### The `link` Directive ###
+
+`link` *path* declares a dependency on the target *path* and adds it to a list
+of subdependencies to automatically be compiled when the asset is written out to
+disk.
+
+For an example, in a CSS file you might reference an external image that always
+need to be compiled along with the css file.
+
+``` css
+/* link "logo.png" */
+.logo {
+  background-image: url(logo.png)
+}
+```
+
+However, if you use a `asset-path/url` SCSS helper, these links will
+automatically be setup for you.
+
+``` css
+.logo {
+  background-image: asset-url("logo.png")
+}
+```
 
 ### The `depend_on` Directive ###
 
@@ -339,14 +354,14 @@ asset's cache in response to a change in another file.
 ### The `depend_on_asset` Directive ###
 
 `depend_on_asset` *path* works like `depend_on`, but operates
-recursively reading the the file and following the directives found.
+recursively reading the file and following the directives found.
 
 ### The `stub` Directive ###
 
 `stub` *path* allows dependency to be excluded from the asset bundle.
 The *path* must be a valid asset and may or may not already be part
-of the bundle. Once stubbed, it is blacklisted and can't be brought
-back by any other `require`.
+of the bundle. `stub` should only be used at the top level bundle, not
+within any subdependencies.
 
 # Development #
 
@@ -366,9 +381,19 @@ submit a pull request.
 
 ## Version History ##
 
-**2.12.3** (October 28, 2014)
+**3.0.0**
 
-* Security: Fix directory traversal bug in development mode server.
+* MIME Types now accept charset custom charset detecters. Improves support for UTF-16/32 files.
+* Environment#version no longer affects asset digests. Only used for busting the asset cache.
+* Removed builtin support for LESS.
+* Removed include directive support.
+* Deprecated BundledAsset#to_a. Use BundledAsset#included to access debugging subcomponents.
+* Support circular dependencies. For parity with ES6 modules.
+* Manifest compilation will no longer generate .gz files by default. [Mixing
+  Content-Encoding and ETags is just a bad
+  idea](https://issues.apache.org/bugzilla/show_bug.cgi?id=39727)
+* Added linked or referenced assets. When an asset is compiled, any of its links
+  will be compiled as well.
 
 **2.12.2** (September 5, 2014)
 
@@ -388,7 +413,9 @@ submit a pull request.
 
 **2.11.0** (February 19, 2014)
 
-* Support for `.bower.json`
+* Cache store must now be an LRU implementation.
+* Default digest changed to SHA1. To continue using MD5.
+  `env.digest_class = Digest::MD5`.
 
 **2.10.0** (May 24, 2013)
 
@@ -422,7 +449,7 @@ submit a pull request.
 
 **2.8.0** (October 16, 2012)
 
-* Allow manifest location to be seperated from output directory
+* Allow manifest location to be separated from output directory
 * Pass logical path and absolute path to each_logical_path iterator
 
 **2.7.0** (October 10, 2012)
@@ -495,7 +522,7 @@ submit a pull request.
 
 **2.1.2** (November 20, 2011)
 
-* Disabled If-Modified-Since server checks. Fixes some browser caching issues when serving the asset body only. If-None-Match caching is sufficent.
+* Disabled If-Modified-Since server checks. Fixes some browser caching issues when serving the asset body only. If-None-Match caching is sufficient.
 
 **2.1.1** (November 18, 2011)
 
@@ -528,9 +555,9 @@ submit a pull request.
 
 # License #
 
-Copyright &copy; 2011 Sam Stephenson <<sstephenson@gmail.com>>
+Copyright &copy; 2014 Sam Stephenson <<sstephenson@gmail.com>>
 
-Copyright &copy; 2011 Joshua Peek <<josh@joshpeek.com>>
+Copyright &copy; 2014 Joshua Peek <<josh@joshpeek.com>>
 
 Sprockets is distributed under an MIT-style license. See LICENSE for
 details.

data/lib/rake/sprocketstask.rb

@@ -37,10 +37,11 @@ module Rake
     end
     attr_writer :environment
 
-    # Returns cached indexed environment
-    def index
-      @index ||= environment.index if environment
+    # Returns cached cached environment
+    def cached
+      @cached ||= environment.cached if environment
     end
+    alias_method :index, :cached
 
     # `Manifest` instance used for already compiled assets.
     #
@@ -97,7 +98,7 @@ module Rake
     def initialize(name = :assets)
       @name         = name
       @environment  = lambda { Sprockets::Environment.new(Dir.pwd) }
-      @manifest     = lambda { Sprockets::Manifest.new(index, output) }
+      @manifest     = lambda { Sprockets::Manifest.new(cached, output) }
       @logger       = Logger.new($stderr)
       @logger.level = Logger::INFO
       @keep         = 2

data/lib/sprockets.rb

@@ -2,107 +2,145 @@ require 'sprockets/version'
 
 module Sprockets
   # Environment
-  autoload :Base,                    "sprockets/base"
-  autoload :Environment,             "sprockets/environment"
-  autoload :Index,                   "sprockets/index"
-  autoload :Manifest,                "sprockets/manifest"
-
-  # Assets
-  autoload :Asset,                   "sprockets/asset"
-  autoload :BundledAsset,            "sprockets/bundled_asset"
-  autoload :ProcessedAsset,          "sprockets/processed_asset"
-  autoload :StaticAsset,             "sprockets/static_asset"
+  autoload :Asset,                   'sprockets/asset'
+  autoload :Base,                    'sprockets/base'
+  autoload :CachedEnvironment,       'sprockets/cached_environment'
+  autoload :Environment,             'sprockets/environment'
+  autoload :Manifest,                'sprockets/manifest'
 
   # Processing
-  autoload :Context,                 "sprockets/context"
-  autoload :EcoTemplate,             "sprockets/eco_template"
-  autoload :EjsTemplate,             "sprockets/ejs_template"
-  autoload :JstProcessor,            "sprockets/jst_processor"
-  autoload :Processor,               "sprockets/processor"
-  autoload :SassCacheStore,          "sprockets/sass_cache_store"
-  autoload :SassFunctions,           "sprockets/sass_functions"
-  autoload :SassImporter,            "sprockets/sass_importer"
-  autoload :SassTemplate,            "sprockets/sass_template"
-  autoload :ScssTemplate,            "sprockets/scss_template"
+  autoload :Bundle,                  'sprockets/bundle'
+  autoload :ClosureCompressor,       'sprockets/closure_compressor'
+  autoload :CoffeeScriptTemplate,    'sprockets/coffee_script_template'
+  autoload :Context,                 'sprockets/context'
+  autoload :DirectiveProcessor,      'sprockets/directive_processor'
+  autoload :EcoTemplate,             'sprockets/eco_template'
+  autoload :EjsTemplate,             'sprockets/ejs_template'
+  autoload :ERBTemplate,             'sprockets/erb_template'
+  autoload :JstProcessor,            'sprockets/jst_processor'
+  autoload :SassCompressor,          'sprockets/sass_compressor'
+  autoload :SassTemplate,            'sprockets/sass_template'
+  autoload :ScssTemplate,            'sprockets/sass_template'
+  autoload :UglifierCompressor,      'sprockets/uglifier_compressor'
+  autoload :YUICompressor,           'sprockets/yui_compressor'
 
   # Internal utilities
-  autoload :ArgumentError,           "sprockets/errors"
-  autoload :AssetAttributes,         "sprockets/asset_attributes"
-  autoload :CircularDependencyError, "sprockets/errors"
-  autoload :ContentTypeMismatch,     "sprockets/errors"
-  autoload :EngineError,             "sprockets/errors"
-  autoload :Error,                   "sprockets/errors"
-  autoload :FileNotFound,            "sprockets/errors"
-  autoload :Utils,                   "sprockets/utils"
-
-  module Cache
-    autoload :FileStore, "sprockets/cache/file_store"
-  end
+  autoload :ArgumentError,           'sprockets/errors'
+  autoload :AssetURI,                'sprockets/asset_uri'
+  autoload :Cache,                   'sprockets/cache'
+  autoload :ContentTypeMismatch,     'sprockets/errors'
+  autoload :EncodingUtils,           'sprockets/encoding_utils'
+  autoload :Error,                   'sprockets/errors'
+  autoload :FileNotFound,            'sprockets/errors'
+  autoload :HTTPUtils,               'sprockets/http_utils'
+  autoload :LazyProcessor,           'sprockets/lazy_processor'
+  autoload :PathUtils,               'sprockets/path_utils'
+  autoload :Utils,                   'sprockets/utils'
 
   # Extend Sprockets module to provide global registry
-  require 'hike'
-  require 'sprockets/engines'
-  require 'sprockets/mime'
-  require 'sprockets/processing'
-  require 'sprockets/compressing'
-  require 'sprockets/paths'
-  extend Engines, Mime, Processing, Compressing, Paths
-
-  @trail             = Hike::Trail.new(File.expand_path('..', __FILE__))
-  @mime_types        = {}
-  @engines           = {}
-  @preprocessors     = Hash.new { |h, k| h[k] = [] }
-  @postprocessors    = Hash.new { |h, k| h[k] = [] }
-  @bundle_processors = Hash.new { |h, k| h[k] = [] }
-  @compressors       = Hash.new { |h, k| h[k] = {} }
-
-  register_mime_type 'text/css', '.css'
-  register_mime_type 'application/javascript', '.js'
-
-  require 'sprockets/directive_processor'
-  register_preprocessor 'text/css',               DirectiveProcessor
+  require 'sprockets/configuration'
+  extend Configuration
+
+  @root              = File.expand_path('..', __FILE__).freeze
+  @paths             = [].freeze
+  @mime_types        = {}.freeze
+  @mime_exts         = {}.freeze
+  @encodings         = {}.freeze
+  @engines           = {}.freeze
+  @engine_mime_types = {}.freeze
+  @transformers      = Hash.new { |h, k| {}.freeze }.freeze
+  @preprocessors     = Hash.new { |h, k| [].freeze }.freeze
+  @postprocessors    = Hash.new { |h, k| [].freeze }.freeze
+  @bundle_reducers   = Hash.new { |h, k| {}.freeze }.freeze
+  @bundle_processors = Hash.new { |h, k| [].freeze }.freeze
+  @compressors       = Hash.new { |h, k| {}.freeze }.freeze
+  @context_class     = Context
+  @version           = ''
+
+  # Set the default digest
+  require 'digest/sha1'
+  @digest_class = Digest::SHA1
+
+  require 'logger'
+  @logger = Logger.new($stderr)
+  @logger.level = Logger::FATAL
+
+  # Common asset text types
+  register_mime_type 'application/javascript', extensions: ['.js'], charset: EncodingUtils::DETECT_UNICODE
+  register_mime_type 'application/json', extensions: ['.json'], charset: EncodingUtils::DETECT_UNICODE
+  register_mime_type 'application/xml', extensions: ['.xml']
+  register_mime_type 'text/css', extensions: ['.css'], charset: EncodingUtils::DETECT_CSS
+  register_mime_type 'text/html', extensions: ['.html', '.htm'], charset: EncodingUtils::DETECT_HTML
+  register_mime_type 'text/plain', extensions: ['.txt', '.text']
+  register_mime_type 'text/yaml', extensions: ['.yml', '.yaml'], charset: EncodingUtils::DETECT_UNICODE
+
+  # Common image types
+  register_mime_type 'image/x-icon', extensions: ['.ico']
+  register_mime_type 'image/bmp', extensions: ['.bmp']
+  register_mime_type 'image/gif', extensions: ['.gif']
+  register_mime_type 'image/webp', extensions: ['.webp']
+  register_mime_type 'image/png', extensions: ['.png']
+  register_mime_type 'image/jpeg', extensions: ['.jpg', '.jpeg']
+  register_mime_type 'image/tiff', extensions: ['.tiff', '.tif']
+  register_mime_type 'image/svg+xml', extensions: ['.svg']
+
+  # Common audio/video types
+  register_mime_type 'video/webm', extensions: ['.webm']
+  register_mime_type 'audio/basic', extensions: ['.snd', '.au']
+  register_mime_type 'audio/aiff', extensions: ['.aiff']
+  register_mime_type 'audio/mpeg', extensions: ['.mp3', '.mp2', '.m2a', '.m3a']
+  register_mime_type 'application/ogg', extensions: ['.ogx']
+  register_mime_type 'audio/midi', extensions: ['.midi', '.mid']
+  register_mime_type 'video/avi', extensions: ['.avi']
+  register_mime_type 'audio/wave', extensions: ['.wav', '.wave']
+  register_mime_type 'video/mp4', extensions: ['.mp4', '.m4v']
+
+  # Common font types
+  register_mime_type 'application/vnd.ms-fontobject', extensions: ['.eot']
+  register_mime_type 'application/x-font-ttf', extensions: ['.ttf']
+  register_mime_type 'application/font-woff', extensions: ['.woff']
+
+  # HTTP content encodings
+  register_encoding :deflate, EncodingUtils::DEFLATE
+  register_encoding :gzip,    EncodingUtils::GZIP
+  register_encoding :base64,  EncodingUtils::BASE64
+
+  register_preprocessor 'text/css', DirectiveProcessor
   register_preprocessor 'application/javascript', DirectiveProcessor
 
-  require 'sprockets/safety_colons'
-  register_postprocessor 'application/javascript', SafetyColons
-
-  require 'sprockets/charset_normalizer'
-  register_bundle_processor 'text/css', CharsetNormalizer
-
-  require 'sprockets/sass_compressor'
-  register_compressor 'text/css', :sass, SassCompressor
-  register_compressor 'text/css', :scss, SassCompressor
-
-  require 'sprockets/yui_compressor'
-  register_compressor 'text/css', :yui, YUICompressor
-
-  require 'sprockets/closure_compressor'
-  register_compressor 'application/javascript', :closure, ClosureCompressor
-
-  require 'sprockets/uglifier_compressor'
-  register_compressor 'application/javascript', :uglifier, UglifierCompressor
-  register_compressor 'application/javascript', :uglify, UglifierCompressor
+  register_bundle_processor 'application/javascript', Bundle
+  register_bundle_processor 'text/css', Bundle
 
-  require 'sprockets/yui_compressor'
-  register_compressor 'application/javascript', :yui, YUICompressor
+  register_bundle_reducer '*/*', :data, :+
+  register_bundle_reducer 'application/javascript', :data, Utils.method(:concat_javascript_sources)
+  register_bundle_reducer '*/*', :dependency_paths, :+
+  register_bundle_reducer '*/*', :links, :+
 
-  # Cherry pick the default Tilt engines that make sense for
-  # Sprockets. We don't need ones that only generate html like HAML.
+  register_compressor 'text/css', :sass, LazyProcessor.new { SassCompressor }
+  register_compressor 'text/css', :scss, LazyProcessor.new { SassCompressor }
+  register_compressor 'text/css', :yui, LazyProcessor.new { YUICompressor }
+  register_compressor 'application/javascript', :closure, LazyProcessor.new { ClosureCompressor }
+  register_compressor 'application/javascript', :uglifier, LazyProcessor.new { UglifierCompressor }
+  register_compressor 'application/javascript', :uglify, LazyProcessor.new { UglifierCompressor }
+  register_compressor 'application/javascript', :yui, LazyProcessor.new { YUICompressor }
 
   # Mmm, CoffeeScript
-  register_engine '.coffee', Tilt::CoffeeScriptTemplate
+  register_mime_type 'text/coffeescript', extensions: ['.coffee']
+  register_engine '.coffee', LazyProcessor.new { CoffeeScriptTemplate }, mime_type: 'application/javascript'
 
   # JST engines
-  register_engine '.jst',    JstProcessor
-  register_engine '.eco',    EcoTemplate
-  register_engine '.ejs',    EjsTemplate
+  register_mime_type 'text/eco', extensions: ['.eco']
+  register_mime_type 'text/ejs', extensions: ['.ejs']
+  register_engine '.jst',    LazyProcessor.new { JstProcessor }, mime_type: 'application/javascript'
+  register_engine '.eco',    LazyProcessor.new { EcoTemplate },  mime_type: 'application/javascript'
+  register_engine '.ejs',    LazyProcessor.new { EjsTemplate },  mime_type: 'application/javascript'
 
   # CSS engines
-  register_engine '.less',   Tilt::LessTemplate
-  register_engine '.sass',   SassTemplate
-  register_engine '.scss',   ScssTemplate
+  register_mime_type 'text/sass', extensions: ['.sass']
+  register_mime_type 'text/scss', extensions: ['.scss']
+  register_engine '.sass',   LazyProcessor.new { SassTemplate }, mime_type: 'text/css'
+  register_engine '.scss',   LazyProcessor.new { ScssTemplate }, mime_type: 'text/css'
 
   # Other
-  register_engine '.erb',    Tilt::ERBTemplate
-  register_engine '.str',    Tilt::StringTemplate
+  register_engine '.erb',    LazyProcessor.new { ERBTemplate }, mime_type: 'text/plain'
 end