sprockets 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb84129a09e33080f696f5eec822299e24279dba
-  data.tar.gz: fc5e73588c47c119874882bacdc8d8fd8da77567
+  metadata.gz: 8b7fa38f3206ba320ebf468c054262dda8eb21b1
+  data.tar.gz: b28f04553ef0f97e2d27826f49ce9b17c7ff83a6
 SHA512:
-  metadata.gz: e2166e7a2f5b2bea3e6eda0a29d0fd4816709bd9e93e6d99cfd00a85ff7df26747ef7d386c8a9812081726948465f887f0721a46a00c6cf06c832ed5f29b6ea0
-  data.tar.gz: 19c40eff6ab900018c2e7e0210e5ece20eb7780729daa0b2402cc2819012291adb145863c718340fdce43787acbc25e5407b88794df53558cea8e12c4cd5c545
+  metadata.gz: 7a3e8d417bd789f73e322d0f1da0bfdfc4f9542cfdbe785ecc4c71d89603caf66765de776db5b03ce93a534b1d45ad9fa9aac1c8017e91cf7bc28a309bef86d8
+  data.tar.gz: e5ec4b5327b80ff10b3f0a3d417ef4f8f429836c5ae6779d570cbfddb576504317fb890e27afdb0a406f2ac7c7c6246d6b98ba5738b6af9b123f1a2b40a50aff

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+**Master**
+
+**3.5.0** (December 3, 2015)
+
+* Reintroduce Gzip file generation for non-binary assets.
+
 **3.4.1** (November 25, 2015)
 
 * PathUtils::Entries will no longer error on an empty directory.

data/README.md

@@ -20,6 +20,16 @@ Or include it in your project's `Gemfile` with Bundler:
 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.
+
+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 documentation is to view the appropriate guide first and then supplement with docs from the README.
+
 ## Behavior
 
 ### Index files are proxies for folders

data/lib/sprockets/compressing.rb

@@ -51,6 +51,21 @@ module Sprockets
       end
     end
 
+    def gzip?
+      return @gzip if defined?(@gzip)
+      true
+    end
+
+    def skip_gzip?
+      !gzip?
+    end
+
+    # Enable or disable the creation of gzip files,
+    # on by default.
+    def gzip=(gzip)
+      @gzip = gzip
+    end
+
     # Assign a compressor to run on `application/javascript` assets.
     #
     # The compressor object must respond to `compress`.

data/lib/sprockets/manifest.rb

@@ -1,6 +1,10 @@
 require 'json'
 require 'time'
+
+require 'concurrent/future'
+
 require 'sprockets/manifest_utils'
+require 'sprockets/utils/gzip'
 
 module Sprockets
   # The Manifest logs the contents of assets compiled to a single directory. It
@@ -157,7 +161,9 @@ module Sprockets
         raise Error, "manifest requires environment for compilation"
       end
 
-      filenames = []
+      filenames              = []
+      concurrent_compressors = []
+      concurrent_writers     = []
 
       find(*args) do |asset|
         files[asset.digest_path] = {
@@ -183,12 +189,26 @@ module Sprockets
           logger.debug "Skipping #{target}, already exists"
         else
           logger.info "Writing #{target}"
-          asset.write_to target
+          write_file = Concurrent::Future.execute { asset.write_to target }
+          concurrent_writers << write_file
         end
-
         filenames << asset.filename
+
+        next if environment.skip_gzip?
+        gzip = Utils::Gzip.new(asset)
+        next if gzip.cannot_compress?(environment.mime_types)
+
+        if File.exist?("#{target}.gz")
+          logger.debug "Skipping #{target}.gz, already exists"
+        else
+          logger.info "Writing #{target}.gz"
+          concurrent_compressors << Concurrent::Future.execute { write_file.wait; gzip.compress(target) }
+        end
+
       end
-      save
+      concurrent_writers.each(&:wait)
+      concurrent_compressors.each(&:wait)
+      Concurrent::Future.execute { self.save }.wait
 
       filenames
     end
@@ -200,6 +220,7 @@ module Sprockets
     #
     def remove(filename)
       path = File.join(dir, filename)
+      gzip = "#{path}.gz"
       logical_path = files[filename]['logical_path']
 
       if assets[logical_path] == filename
@@ -208,6 +229,7 @@ module Sprockets
 
       files.delete(filename)
       FileUtils.rm(path) if File.exist?(path)
+      FileUtils.rm(gzip) if File.exist?(gzip)
 
       save
 

data/lib/sprockets/utils/gzip.rb

@@ -0,0 +1,56 @@
+module Sprockets
+  module Utils
+    class Gzip
+      # Private: Generates a gzipped file based off of reference file.
+      def initialize(asset)
+        @content_type  = asset.content_type
+        @mtime         = asset.mtime
+        @source        = asset.source
+        @charset       = asset.charset
+      end
+
+      # Private: Returns whether or not an asset can be compressed.
+      #
+      # We want to compress any file that is text based.
+      # You do not want to compress binary
+      # files as they may already be compressed and running them
+      # through a compression algorithm would make them larger.
+      #
+      # Return Boolean.
+      def can_compress?(mime_types)
+        # The "charset" of a mime type is present if the value is
+        # encoded text. We can check this value to see if the asset
+        # can be compressed.
+        #
+        # SVG images are text but do not have
+        # a charset defined, this is special cased.
+        @charset || @content_type == "image/svg+xml".freeze
+      end
+
+      # Private: Opposite of `can_compress?`.
+      #
+      # Returns Boolean.
+      def cannot_compress?(mime_types)
+        !can_compress?(mime_types)
+      end
+
+      # Private: Generates a gzipped file based off of reference asset.
+      #
+      # Compresses the target asset's contents and puts it into a file with
+      # the same name plus a `.gz` extension in the same folder as the original.
+      # Does not modify the target asset.
+      #
+      # Returns nothing.
+      def compress(target)
+        PathUtils.atomic_write("#{target}.gz") do |f|
+          gz = Zlib::GzipWriter.new(f, Zlib::BEST_COMPRESSION)
+          gz.mtime = @mtime.to_i
+          gz.write(@source)
+          gz.close
+        end
+
+        nil
+      end
+    end
+  end
+end

data/lib/sprockets/version.rb

@@ -1,3 +1,3 @@
 module Sprockets
-  VERSION = "3.4.1"
+  VERSION = "3.5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprockets
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - Sam Stephenson
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -31,6 +31,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: closure-compiler
   requirement: !ruby/object:Gem::Requirement
@@ -295,6 +309,7 @@ files:
 - lib/sprockets/uri_tar.rb
 - lib/sprockets/uri_utils.rb
 - lib/sprockets/utils.rb
+- lib/sprockets/utils/gzip.rb
 - lib/sprockets/version.rb
 - lib/sprockets/yui_compressor.rb
 homepage: https://github.com/rails/sprockets