asset_sync 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ca689aa3521a19cb98a52f5c4319cc1e69ef0091b5ba8a2076745ec536f4cc9
-  data.tar.gz: 2fb823e7bd97003a447521bc1640dd1a0ee934e4692bfc6c0c4f8d8aa46545e2
+  metadata.gz: 8f0a301ff99d58cacb580c68586d0dd58ccea76c4368e605cfec7c97f1ec8207
+  data.tar.gz: 62b5f062c8eec2f700961aa3c1f3b375a5c700c20fd5b795d034a76dda0bc3bf
 SHA512:
-  metadata.gz: a15f3c71c845ae310f8ea1ed20a38dcd652832d7952ace0db544c6269810701bb0217242696018a7eb0c5a4dd839e5cb018714c2a623106cd3662a1e4b95e02f
-  data.tar.gz: 7b9b929264f61d277248956a29132c969f1c8402bc4f0e606f3e273a7a6b835ea166b45b8f75c9264fce1f224dcd7e8ab7ae99a6f3396be56c7444fd7e266bef
+  metadata.gz: ac1d44af84bbfca4a10dcc6d03346337f90a4944d364b5b4721b20c5e2acd8c21187de149510452f97897b0b36c0351f8647ccfc3fc8da533c275db7d82e6502
+  data.tar.gz: c99b77189e305fab78cb03a0493b85056f707858f5703c27a5a4045a8a174e388c749d50ce9127d23abeddd855b7eff1501b2313c8adf84dbfb815ce52f7ab33

data/Appraisals

@@ -1,8 +1,4 @@
 
-appraise "rails_4_1" do
-  gem "rails", "~> 4.1.0"
-end
-
 appraise "rails_4_2" do
   gem "rails", "~> 4.2.0"
 end
@@ -14,3 +10,7 @@ end
 appraise "rails_5_1" do
   gem "rails", "~> 5.1.0"
 end
+
+appraise "rails_5_2" do
+  gem "rails", "~> 5.2.0"
+end

data/CHANGELOG.md

@@ -18,6 +18,25 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [2.5.0] - 2018-10-25
+
+### Added
+
+- Add ruby only option `file_ext_to_mime_type_overrides`
+  (https://github.com/AssetSync/asset_sync/pull/374)
+
+### Changed
+
+- Start testing against rails 5.2, stop testing against rails 4.2
+
+### Fixed
+
+- Only enhance rake task assets:precompile if it's defined
+  (https://github.com/AssetSync/asset_sync/commit/e1eb1a16b06fd39def1759428a2d94733915bbff)
+- Avoid ruby warning due to "method redefined"
+  (https://github.com/AssetSync/asset_sync/pull/371)
+
+
 ## [2.4.0] - 2017-12-20
 
 ### Added
@@ -861,7 +880,8 @@ Changes:
     * Merge branch 'sinatra'
 
 
-[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.4.0...HEAD
+[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.5.0...HEAD
+[2.5.0]: https://github.com/AssetSync/asset_sync/compare/v2.4.0...v2.5.0
 [2.4.0]: https://github.com/AssetSync/asset_sync/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/AssetSync/asset_sync/compare/v2.2.0...v2.3.0
 [2.2.0]: https://github.com/AssetSync/asset_sync/compare/v2.1.0...v2.2.0

data/README.md

@@ -344,6 +344,24 @@ end
 ```
 The blocks are run when local files are being scanned and uploaded
 
+##### Config Method `file_ext_to_mime_type_overrides`
+It's reported that `mime-types` 3.x returns `application/ecmascript` instead of `application/javascript`  
+Such change of mime type might cause some CDN to disable asset compression  
+So this gem has defined a default override for file ext `js` to be mapped to `application/javascript` by default
+
+To customize the overrides:
+```ruby
+AssetSync.configure do |config|
+  # Clear the default overrides
+  config.file_ext_to_mime_type_overrides.clear
+  
+  # Add/Edit overrides
+  # Will call `#to_s` for inputs
+  config.file_ext_to_mime_type_overrides.add(:js, :"application/x-javascript")
+end
+```
+The blocks are run when local files are being scanned and uploaded
+
 #### Fog (Required)
 * **fog\_provider**: your storage provider *AWS* (S3) or *Rackspace* (Cloud Files) or *Google* (Google Storage) or *AzureRM* (Azure Blob)
 * **fog\_directory**: your bucket name
@@ -523,6 +541,37 @@ namespace :assets do
 end
 ```
 
+## Webpacker (> 2.0) support
+
+1. Add webpacker files and disable `run_on_precompile`:
+```ruby
+AssetSync.configure do |config|
+  # Disable automatic run on precompile in order to attach to webpacker rake task
+  config.run_on_precompile = false
+  # The block should return an array of file paths
+  config.add_local_file_paths do
+    # Support webpacker assets
+    public_root = Rails.root.join("public")
+    Dir.chdir(public_root) do
+      packs_dir = Webpacker.config.public_output_path.relative_path_from(public_root)
+      Dir[File.join(packs_dir, '/**/**')]
+    end
+  end
+end
+```
+
+2. Add a `asset_sync.rake` in your `lib/tasks` directory that enhances the correct task, otherwise asset_sync runs before `webpacker:compile` does:
+```
+if defined?(AssetSync)
+  Rake::Task['webpacker:compile'].enhance do
+    Rake::Task["assets:sync"].invoke
+  end
+end
+```
+
+### Caveat
+By adding local files outside the normal Rails `assets` directory, the uploading part works, however checking that the asset was previously uploaded is not working because asset_sync is only fetching the files in the `assets` directory on the remote bucket. This will mean additional time used to upload the same assets again on every precompilation.
+
 ## Running the specs
 
 Make sure you have a .env file with these details:-

data/asset_sync.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "rspec"
   s.add_development_dependency "bundler"
-  s.add_development_dependency "jeweler"
+
+  s.add_development_dependency('mime-types', ">= 3.0")
 
   s.add_development_dependency "fog-aws"
   s.add_development_dependency "fog-azure-rm"

data/gemfiles/{rails_4_1.gemfile → rails_5_2.gemfile}

@@ -5,6 +5,6 @@ source "https://rubygems.org"
 gem "rcov", platforms: :mri_18, group: [:development, :test]
 gem "simplecov", platforms: [:jruby, :mri_19, :ruby_19, :mri_20, :rbx], group: [:development, :test], require: false
 gem "jruby-openssl", platform: :jruby
-gem "rails", "~> 4.1.0"
+gem "rails", "~> 5.2.0"
 
 gemspec path: "../"

data/lib/asset_sync/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_model"
 require "erb"
 require "yaml"
@@ -17,7 +19,6 @@ module AssetSync
     attr_accessor :always_upload
     attr_accessor :ignored_files
     attr_accessor :prefix
-    attr_accessor :public_path
     attr_accessor :enabled
     attr_accessor :custom_headers
     attr_accessor :run_on_precompile
@@ -25,6 +26,7 @@ module AssetSync
     attr_accessor :cdn_distribution_id
     attr_accessor :cache_asset_regexps
     attr_accessor :include_manifest
+    attr_writer :public_path
 
     # FOG configuration
     attr_accessor :fog_provider          # Currently Supported ['AWS', 'Rackspace']
@@ -268,6 +270,11 @@ module AssetSync
       end
     end
 
+    #@api
+    def file_ext_to_mime_type_overrides
+      @file_ext_to_mime_type_overrides ||= FileExtToMimeTypeOverrides.new
+    end
+
   private
 
     # This is a proc to get additional local files paths
@@ -277,5 +284,43 @@ module AssetSync
     def default_manifest_directory
       File.join(::Rails.public_path, assets_prefix)
     end
+
+
+    # @api private
+    class FileExtToMimeTypeOverrides
+      def initialize
+        # The default is to prevent new mime type `application/ecmascript` to be returned
+        # which disables compression on some CDNs
+        @overrides = {
+          "js" => "application/javascript",
+        }
+      end
+
+      # @api
+      def add(ext, mime_type)
+        # Symbol / Mime type object might be passed in
+        # But we want strings only
+        @overrides.store(
+          ext.to_s, mime_type.to_s,
+        )
+      end
+
+      # @api
+      def clear
+        @overrides = {}
+      end
+
+
+      # @api private
+      def key?(key)
+        @overrides.key?(key)
+      end
+
+      # @api private
+      def fetch(key)
+        @overrides.fetch(key)
+      end
+
+    end
   end
 end

data/lib/asset_sync/multi_mime.rb

@@ -4,6 +4,11 @@ module AssetSync
   class MultiMime
 
     def self.lookup(ext)
+      overrides =
+        ::AssetSync.config.file_ext_to_mime_type_overrides
+      if overrides.key?(ext)
+        return overrides.fetch(ext)
+      end
 
       if defined?(::MIME::Types)
         ::MIME::Types.type_for(ext).first

data/lib/asset_sync/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module AssetSync
-  VERSION = "2.4.0".freeze
+  VERSION = "2.5.0".freeze
 end

data/lib/tasks/asset_sync.rake

@@ -19,7 +19,7 @@ if Rake::Task.task_defined?("assets:precompile:nondigest")
     # will get executed before yaml or Rails initializers.
     Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
   end
-else
+elsif Rake::Task.task_defined?("assets:precompile")
   Rake::Task["assets:precompile"].enhance do
     # rails 3.1.1 will clear out Rails.application.config if the env vars
     # RAILS_GROUP and RAILS_ENV are not defined. We need to reload the
@@ -27,4 +27,6 @@ else
     # Rake::Task["assets:environment"].invoke if Rake::Task.task_defined?("assets:environment")
     Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
   end
+else
+  # Nothing to be enhanced
 end

data/spec/unit/multi_mime_spec.rb

@@ -36,6 +36,8 @@ describe AssetSync::MultiMime do
     $".grep(/mime\//).each do |file_path|
       $".delete(file_path)
     end
+
+    AssetSync.config = AssetSync::Config.new
   end
 
   after(:all) do
@@ -69,4 +71,49 @@ describe AssetSync::MultiMime do
 
   end
 
+  describe "use of option file_ext_to_mime_type_overrides" do
+    before(:each) do
+      require 'mime/types'
+    end
+
+    context "with default value" do
+      it "should return default value set by gem" do
+        expect(
+          AssetSync::MultiMime.lookup("js").to_s,
+        ).to eq("application/javascript")
+      end
+    end
+    context "with empty value" do
+      before(:each) do
+        AssetSync.config = AssetSync::Config.new
+        AssetSync.configure do |config|
+          config.file_ext_to_mime_type_overrides.clear
+        end
+      end
+
+      it "should return value from mime-types gem" do
+        expect(
+          AssetSync::MultiMime.lookup("js").to_s,
+        ).to eq(::MIME::Types.type_for("js").first.to_s)
+      end
+    end
+    context "with custom value" do
+      before(:each) do
+        AssetSync.config = AssetSync::Config.new
+        AssetSync.configure do |config|
+          config.file_ext_to_mime_type_overrides.add(
+            :js,
+            :"application/x-javascript",
+          )
+        end
+      end
+
+      it "should return custom value" do
+        expect(
+          AssetSync::MultiMime.lookup("js").to_s,
+        ).to eq("application/x-javascript")
+      end
+    end
+  end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Simon Hamilton
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2018-10-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -98,19 +98,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: jeweler
+  name: mime-types
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: fog-aws
   requirement: !ruby/object:Gem::Requirement
@@ -189,10 +189,10 @@ files:
 - UPGRADING.md
 - asset_sync.gemspec
 - docs/heroku.md
-- gemfiles/rails_4_1.gemfile
 - gemfiles/rails_4_2.gemfile
 - gemfiles/rails_5_0.gemfile
 - gemfiles/rails_5_1.gemfile
+- gemfiles/rails_5_2.gemfile
 - lib/asset_sync.rb
 - lib/asset_sync/asset_sync.rb
 - lib/asset_sync/config.rb
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: asset_sync
-rubygems_version: 2.7.3
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Synchronises Assets in a Rails 3 application and Amazon S3/Cloudfront and