asset_sync 2.18.1 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1fb2743cc1cc656c27c392c0a4f6cd5cc07e57ed8dad28fc1ed9f01b268d6d42
-  data.tar.gz: 13067af05b7e16f1a12c62db2583f56ec5e995414d86e193110339efde7f8e16
+  metadata.gz: 9cdf3c86a21ba63d0de80b07420b5c4f1833f25dbbcefbc92a740599d2d166da
+  data.tar.gz: a4c394ecc38feadf42e70643c7485a9dc68d6cccb9e86d8c9d00b99f41e5064f
 SHA512:
-  metadata.gz: 57189c1fb4dbd6edab1f5cc262f6ef420f144631adf69d03fc504218018de8765ce15e9d8e38e19eacf4eb825d3ec46b1311cf492939fc537c30554ba26dbd99
-  data.tar.gz: 56eba25178ac8ee2a51222bfbd46342dc8836e67d52ea255000a710a341b158bee5043969574d111779c589f9223137a2c9a4ed9a1a259adb595ddaa9fd87b40
+  metadata.gz: 1cf38f1aa03aa20864cd1b6afadffff78bb032cfe7f15bea92c3f196c034c603d2a1d79e4393ace6f9fda35b8759b2ac5108efb86c9fdf260b898478fc0c3a2f
+  data.tar.gz: b26de287f9164b653e7404723672bd746cf899c57df8ed2b7100ba5a1470f0ca6619d6e7ed9b3bbb1c12f6af358e30665e449f4cfc235ff9db55b2b52c179c1a

data/CHANGELOG.md

@@ -18,6 +18,14 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [2.19.0] - 2023-08-15
+
+### Added
+
+- Add brotli support (new option `compression` which supports both gzip/brotli to replace now deprecated `gzip_compression`)
+  (https://github.com/AssetSync/asset_sync/pull/435)
+
+
 ## [2.18.1] - 2023-08-02
 
 ### Changed
@@ -1086,7 +1094,8 @@ Changes:
     * Merge branch 'sinatra'
 
 
-[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.18.1...HEAD
+[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.19.0...HEAD
+[2.19.0]: https://github.com/AssetSync/asset_sync/compare/v2.18.1...v2.19.0
 [2.18.1]: https://github.com/AssetSync/asset_sync/compare/v2.18.0...v2.18.1
 [2.18.0]: https://github.com/AssetSync/asset_sync/compare/v2.17.0...v2.18.0
 [2.17.0]: https://github.com/AssetSync/asset_sync/compare/v2.16.0...v2.17.0

data/README.md

@@ -165,7 +165,7 @@ heroku config:add FOG_DIRECTORY=xxxx
 heroku config:add FOG_PROVIDER=AWS
 # and optionally:
 heroku config:add FOG_REGION=eu-west-1
-heroku config:add ASSET_SYNC_GZIP_COMPRESSION=true
+heroku config:add ASSET_SYNC_COMPRESSION=gz
 heroku config:add ASSET_SYNC_MANIFEST=true
 heroku config:add ASSET_SYNC_EXISTING_REMOTE_FILES=keep
 ```
@@ -260,8 +260,8 @@ AssetSync.configure do |config|
   # Overrides any existing value (even those set by AssetSync)
   # config.fog_options = {}
   #
-  # Automatically replace files with their equivalent gzip compressed version
-  # config.gzip_compression = true
+  # Automatically replace files with their equivalent gzip/brotli compressed version
+  # config.compression = 'gz'
   #
   # Use the Rails generated 'manifest.yml' file to produce the list of files to
   # upload instead of searching the assets directory.
@@ -340,8 +340,8 @@ defaults: &defaults
   # existing_remote_files: delete
   # To ignore existing remote files and overwrite.
   # existing_remote_files: ignore
-  # Automatically replace files with their equivalent gzip compressed version
-  # gzip_compression: true
+  # Automatically replace files with their equivalent gzip/brotli compressed version
+  # compression: "gz"
   # Fail silently.  Useful for environments such as Heroku
   # fail_silently: true
   # Always upload. Useful if you want to overwrite specific remote assets regardless of their existence
@@ -379,13 +379,14 @@ AssetSync.config.fog_provider == ENV['FOG_PROVIDER']
 Simply **upcase** the ruby attribute names to get the equivalent environment variable to set. The only exception to that rule are the internal **AssetSync** config variables, they must be prepended with `ASSET_SYNC_*` e.g.
 
 ```ruby
-AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
+AssetSync.config.compression == ENV['ASSET_SYNC_COMPRESSION']
 ```
 
 #### AssetSync (optional)
 
 * **existing_remote_files**: (`'keep', 'delete', 'ignore'`) what to do with previously precompiled files. **default:** `'keep'`
-* **gzip\_compression**: (`true, false`) when enabled, will automatically replace files that have a gzip compressed equivalent with the compressed version. **default:** `'false'`
+* **gzip\_compression**: (deprecated, can still be used but use `compression` when possible)
+* **compression**: (`'gz', 'br'`) when enabled (non `nil` value set), will automatically replace files that have a gzip/brotli compressed equivalent with the compressed version. **default:** `nil`
 * **manifest**: (`true, false`) when enabled, will use the `manifest.yml` generated by Rails to get the list of local files to upload. **experimental**. **default:** `'false'`
 * **include_manifest**: (`true, false`) when enabled, will upload the `manifest.yml` generated by Rails. **default:** `'false'`
 * **concurrent_uploads**: (`true, false`) when enabled, will upload the files in different Threads, this greatly improves the upload speed. **default:** `'false'`
@@ -540,12 +541,17 @@ end
 ```
 
 
-## Automatic gzip compression
+## Automatic gzip/brotli compression
 
-With the `gzip_compression` option enabled, when uploading your assets. If a file has a gzip compressed equivalent we will replace that asset with the compressed version and sets the correct headers for S3 to serve it. For example, if you have a file **master.css** and it was compressed to **master.css.gz** we will upload the **.gz** file to S3 in place of the uncompressed file.
+With the `compression` option enabled, when uploading your assets. If a file has a gzip/brotli (only 1 of them, depending on the option value set) compressed equivalent we will replace that asset with the compressed version and sets the correct headers for S3 to serve it. For example, if you have a file **master.css** and it was compressed to **master.css.gz** we will upload the **.gz** file to S3 in place of the uncompressed file.
 
 If the compressed file is actually larger than the uncompressed file we will ignore this rule and upload the standard uncompressed version.
 
+Option `compression` supported values:
+- `nil` => Disabled
+- `'gz'` => Only consider gzip compressed one
+- `'br'` => Only consider brotli compressed one
+
 ## Fail Silently
 
 With the `fail_silently` option enabled, when running `rake assets:precompile` AssetSync will never throw an error due to missing configuration variables.

data/lib/asset_sync/config.rb

@@ -11,7 +11,7 @@ module AssetSync
 
     # AssetSync
     attr_accessor :existing_remote_files # What to do with your existing remote files? (keep or delete)
-    attr_accessor :gzip_compression
+    attr_accessor :compression
     attr_accessor :manifest
     attr_accessor :fail_silently
     attr_accessor :log_silently
@@ -94,7 +94,7 @@ module AssetSync
       self.fog_region = nil
       self.fog_public = true
       self.existing_remote_files = 'keep'
-      self.gzip_compression = false
+      self.compression = nil
       self.manifest = false
       self.fail_silently = false
       self.log_silently = true
@@ -126,8 +126,12 @@ module AssetSync
       end
     end
 
-    def gzip?
-      self.gzip_compression
+    def gzip_compression= bool
+      if bool
+        self.compression = 'gz'
+      else
+        self.compression = nil
+      end
     end
 
     def existing_remote_files?
@@ -246,7 +250,8 @@ module AssetSync
       self.google_storage_access_key_id     = yml["google_storage_access_key_id"] if yml.has_key?("google_storage_access_key_id")
       self.google_json_key_string           = yml["google_json_key_string"] if yml.has_key?("google_json_key_string")
       self.existing_remote_files  = yml["existing_remote_files"] if yml.has_key?("existing_remote_files")
-      self.gzip_compression       = yml["gzip_compression"] if yml.has_key?("gzip_compression")
+      self.compression            = 'gz' if yml.has_key?("gzip_compression")
+      self.compression            = yml["compression"] if yml.has_key?("compression")
       self.manifest               = yml["manifest"] if yml.has_key?("manifest")
       self.fail_silently          = yml["fail_silently"] if yml.has_key?("fail_silently")
       self.log_silently           = yml["log_silently"] if yml.has_key?("log_silently")

data/lib/asset_sync/engine.rb

@@ -44,7 +44,8 @@ module AssetSync
           config.enabled = (ENV['ASSET_SYNC_ENABLED'] == 'true') if ENV.has_key?('ASSET_SYNC_ENABLED')
 
           config.existing_remote_files = ENV['ASSET_SYNC_EXISTING_REMOTE_FILES'] || "keep"
-          config.gzip_compression = (ENV['ASSET_SYNC_GZIP_COMPRESSION'] == 'true') if ENV.has_key?('ASSET_SYNC_GZIP_COMPRESSION')
+          config.compression = 'gz' if ENV.has_key?('ASSET_SYNC_GZIP_COMPRESSION') && ENV['ASSET_SYNC_GZIP_COMPRESSION'] == 'true'
+          config.compression = ENV['ASSET_SYNC_COMPRESSION'] if ENV.has_key?('ASSET_SYNC_COMPRESSION')
           config.manifest = (ENV['ASSET_SYNC_MANIFEST'] == 'true') if ENV.has_key?('ASSET_SYNC_MANIFEST')
           config.prefix = ENV['ASSET_SYNC_PREFIX'] if ENV.has_key?('ASSET_SYNC_PREFIX')
           config.include_manifest = (ENV['ASSET_SYNC_INCLUDE_MANIFEST'] == 'true') if ENV.has_key?('ASSET_SYNC_INCLUDE_MANIFEST')

data/lib/asset_sync/storage.rb

@@ -7,6 +7,11 @@ module AssetSync
     REGEXP_FINGERPRINTED_FILES = /\A(.*)\/(.+)-[^\.]+\.([^\.]+)\z/m
     REGEXP_ASSETS_TO_CACHE_CONTROL = /-[0-9a-fA-F]{32,}$/
 
+    CONTENT_ENCODING = {
+      'gz' => 'gzip',
+      'br' => 'br',
+    }.freeze
+
     class BucketNotFound < StandardError;
     end
 
@@ -211,7 +216,7 @@ module AssetSync
       one_year = 31557600
       ext = File.extname(f)[1..-1]
       mime = MultiMime.lookup(ext)
-      gzip_file_handle = nil
+      compressed_file_handle = nil
       file_handle = File.open("#{path}/#{f}")
       file = {
         :key => f,
@@ -255,41 +260,44 @@ module AssetSync
       end
 
 
-      gzipped = "#{path}/#{f}.gz"
       ignore = false
-
-      if config.gzip? && File.extname(f) == ".gz"
-        # Don't bother uploading gzipped assets if we are in gzip_compression mode
-        # as we will overwrite file.css with file.css.gz if it exists.
-        log "Ignoring: #{f}"
-        ignore = true
-      elsif config.gzip? && File.exist?(gzipped)
-        original_size = File.size("#{path}/#{f}")
-        gzipped_size = File.size(gzipped)
-
-        if gzipped_size < original_size
-          percentage = ((gzipped_size.to_f/original_size.to_f)*100).round(2)
-          gzip_file_handle = File.open(gzipped)
-          file.merge!({
-                        :key => f,
-                        :body => gzip_file_handle,
-                        :content_encoding => 'gzip'
-                      })
-          log "Uploading: #{gzipped} in place of #{f} saving #{percentage}%"
-        else
-          percentage = ((original_size.to_f/gzipped_size.to_f)*100).round(2)
-          log "Uploading: #{f} instead of #{gzipped} (compression increases this file by #{percentage}%)"
+      if config.compression
+        compressed_name = "#{path}/#{f}.#{config.compression}"
+
+        if File.extname(f) == config.compression
+          # Don't bother uploading compressed assets if we are in compression mode
+          # as we will overwrite file.css with file.css.gz if it exists.
+          log "Ignoring: #{f}"
+          ignore = true
+        elsif File.exist?(compressed)
+          original_size = File.size("#{path}/#{f}")
+          compressed_size = File.size(compressed_name)
+
+          if compressed_size < original_size
+            percentage = ((compressed_size.to_f/original_size.to_f)*100).round(2)
+            compressed_file_handle = File.open(compressed_name)
+            file.merge!({
+                          :key => f,
+                          :body => compressed_file_handle,
+                          :content_encoding => CONTENT_ENCODING[config.compression]
+                        })
+            log "Uploading: #{compressed_name} in place of #{f} saving #{percentage}%"
+          else
+            percentage = ((original_size.to_f/compressed_size.to_f)*100).round(2)
+            log "Uploading: #{f} instead of #{compressed_name} (compression increases this file by #{percentage}%)"
+          end
         end
       else
-        if !config.gzip? && File.extname(f) == ".gz"
-          # set content encoding for gzipped files this allows cloudfront to properly handle requests with Accept-Encoding
+        compressed_encoding = CONTENT_ENCODING[File.extname(f).delete('.')]
+        if compressed_encoding
+          # set content encoding for compressed files this allows cloudfront to properly handle requests with Accept-Encoding
           # http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide/ServingCompressedFiles.html
           uncompressed_filename = f[0..-4]
           ext = File.extname(uncompressed_filename)[1..-1]
           mime = MultiMime.lookup(ext)
           file.merge!({
             :content_type     => mime,
-            :content_encoding => 'gzip'
+            :content_encoding => compressed_encoding
           })
         end
         log "Uploading: #{f}"
@@ -303,7 +311,7 @@ module AssetSync
 
       bucket.files.create( file ) unless ignore
       file_handle.close
-      gzip_file_handle.close if gzip_file_handle
+      compressed_file_handle.close if compressed_file_handle
     end
 
     def upload_files

data/lib/asset_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AssetSync
-  VERSION = "2.18.1"
+  VERSION = "2.19.0"
 end

data/spec/unit/asset_sync_spec.rb

@@ -59,8 +59,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -139,8 +139,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -230,8 +230,8 @@ describe AssetSync do
       AssetSync.config.gzip_compression = true
     end
 
-    it "config.gzip? should be true" do
-      expect(AssetSync.config.gzip?).to be_truthy
+    it "config.compression should be 'gz'" do
+      expect(AssetSync.config.compression).to eq("gz")
     end
   end
 

data/spec/unit/azure_rm_spec.rb

@@ -40,8 +40,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -71,8 +71,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -110,8 +110,8 @@ describe AssetSync do
       AssetSync.config.gzip_compression = true
     end
 
-    it "config.gzip? should be true" do
-      expect(AssetSync.config.gzip?).to be_truthy
+    it "config.compression should be 'gz'" do
+      expect(AssetSync.config.compression).to eq("gz")
     end
   end
 

data/spec/unit/backblaze_spec.rb

@@ -44,8 +44,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -79,8 +79,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -118,8 +118,8 @@ describe AssetSync do
       AssetSync.config.gzip_compression = true
     end
 
-    it "config.gzip? should be true" do
-      expect(AssetSync.config.gzip?).to be_truthy
+    it "config.compression should be 'gz'" do
+      expect(AssetSync.config.compression).to eq("gz")
     end
   end
 

data/spec/unit/google_spec.rb

@@ -30,8 +30,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do
@@ -174,8 +174,8 @@ describe AssetSync do
         expect(AssetSync.config.existing_remote_files).to eq("keep")
       end
 
-      it "should default gzip_compression to false" do
-        expect(AssetSync.config.gzip_compression).to be_falsey
+      it "should default compression to nil" do
+        expect(AssetSync.config.compression).to be_nil
       end
 
       it "should default manifest to false" do
@@ -229,8 +229,8 @@ describe AssetSync do
       AssetSync.config.gzip_compression = true
     end
 
-    it "config.gzip? should be true" do
-      expect(AssetSync.config.gzip?).to be_truthy
+    it "config.compression should be 'gz'" do
+      expect(AssetSync.config.compression).to eq("gz")
     end
   end
 

data/spec/unit/railsless_spec.rb

@@ -61,8 +61,8 @@ describe AssetSync do
       expect(AssetSync.config.existing_remote_files).to eq("keep")
     end
 
-    it "should default gzip_compression to false" do
-      expect(AssetSync.config.gzip_compression).to be_falsey
+    it "should default compression to nil" do
+      expect(AssetSync.config.compression).to be_nil
     end
 
     it "should default manifest to false" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 2.18.1
+  version: 2.19.0
 platform: ruby
 authors:
 - Simon Hamilton
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-02 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -288,7 +288,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront and