asset_sync 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ea1bceb8cfa4d10954bac53e96fe5bd2129b47c
-  data.tar.gz: d0396ac1587c86f5ab9a192bdd847e95f45e1cdf
+  metadata.gz: 5b188551b31d31cea82d0a2daa66ea13611526bf
+  data.tar.gz: 8dc71ab706a8da82c83030d1c0bcabe88d44e4d4
 SHA512:
-  metadata.gz: adb609d088e1e7a92105739ebcedd35cb2dd0dabd64bdca483e27ffe5a448fff99135d8cc6af5eae5a3ee0568147eb1927d317c9ef278eccf6dc7e23e33f1624
-  data.tar.gz: fa9dea180a9a7394e8a56f31dc646e138070b3d2af40ed17c858d1ef3e48c4ddecac381d17641397576477ee7d37cec26d2076e46963f2013837cb259ee0c6b0
+  metadata.gz: 4666031ff720620d925adbfee0e5213abd28c96e2df89f37af6e88dfd96d76e3b439e4a0e52c373243ea5452078218b07afaacc86f4b35f8fdeed8fa660c37f9
+  data.tar.gz: bef8d1ecde9c3bb946016db35ec7f558b9dea0f51a96bb19a727f03d2560688b48901720a3d2e102cf1aad2e5b3a617021e1cdc2e37bb502912dbbb36c9ef422

data/.editorconfig

@@ -0,0 +1,7 @@
+# EditorConfig is awesome: http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+[*.{md,markdown}]
+trim_trailing_whitespace = false

data/CHANGELOG.md

@@ -18,6 +18,23 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Nothing
 
 
+## [2.2.0] - 2016-07-12
+
+### Added
+
+- Add method `add_local_file_paths` to config for uploading additional files, like webpacker
+  (https://github.com/AssetSync/asset_sync/pull/347)
+
+### Changed
+
+- Nothing
+
+### Fixed
+
+- Fix too many files open when uploading local files
+  (https://github.com/AssetSync/asset_sync/pull/351)
+
+
 ## [2.1.0] - 2016-05-19
 
 ### Added
@@ -813,7 +830,8 @@ Changes:
     * Merge branch 'sinatra'
 
 
-[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.1.0...HEAD
+[Unreleased]: https://github.com/AssetSync/asset_sync/compare/v2.2.0...HEAD
+[2.2.0]: https://github.com/AssetSync/asset_sync/compare/v2.1.0...v2.2.0
 [2.1.0]: https://github.com/AssetSync/asset_sync/compare/v2.0.0...v2.1.0
 [2.0.0]: https://github.com/AssetSync/asset_sync/compare/v1.3.0...v2.0.0
 [1.3.0]: https://github.com/AssetSync/asset_sync/compare/v1.2.1...v1.3.0

data/README.md

@@ -253,7 +253,7 @@ production:
 
 ### Available Configuration Options
 
-All AssetSync configuration can be modified directly using environment variables with the **Built-in initializer**. e.g.
+Most AssetSync configuration can be modified directly using environment variables with the **Built-in initializer**. e.g.
 
 ```ruby
 AssetSync.config.fog_provider == ENV['FOG_PROVIDER']
@@ -274,6 +274,19 @@ AssetSync.config.gzip_compression == ENV['ASSET_SYNC_GZIP_COMPRESSION']
 * **ignored\_files**: an array of files to ignore e.g. `['ignore_me.js', %r(ignore_some/\d{32}\.css)]` Useful if there are some files that are created dynamically on the server and you don't want to upload on deploy **default**: `[]`
 * **cache\_asset\_regexps**: an array of files to add cache headers e.g. `['cache_me.js', %r(cache_some\.\d{8}\.css)]` Useful if there are some files that are added to sprockets assets list and need to be set as 'Cacheable' on uploaded server.  Only rails compiled regexp is matched internally **default**: `[]`
 
+##### Config Method `add_local_file_paths`
+Adding local files by providing a block:
+```ruby
+AssetSync.configure do |config|
+  # The block should return an array of file paths
+  config.add_local_file_paths do
+    # Any code that returns paths of local asset files to be uploaded
+    # Like Webpacker
+    Dir[File.join(Webpacker::Configuration.fetch(:public_output_path), '/**/**')]
+  end
+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)

data/lib/asset_sync/config.rb

@@ -67,6 +67,8 @@ module AssetSync
       self.cdn_distribution_id = nil
       self.invalidate = []
       self.cache_asset_regexps = []
+      @additional_local_file_paths_procs = []
+
       load_yml! if defined?(::Rails) && yml_exists?
     end
 
@@ -220,8 +222,30 @@ module AssetSync
       return options
     end
 
+    # @api
+    def add_local_file_paths(&block)
+      @additional_local_file_paths_procs =
+        additional_local_file_paths_procs + [block]
+    end
+
+    # @api private
+    #   This is to be called in Storage
+    #   Not to be called by user
+    def additional_local_file_paths
+      return [] if additional_local_file_paths_procs.empty?
+
+      # Using `Array()` to ensure it works when single value is returned
+      additional_local_file_paths_procs.each_with_object([]) do |proc, paths|
+        paths.concat(Array(proc.call))
+      end
+    end
+
   private
 
+    # This is a proc to get additional local files paths
+    # Since this is a proc it won't be able to be configured by a YAML file
+    attr_reader :additional_local_file_paths_procs
+
     def default_manifest_directory
       File.join(::Rails.public_path, assets_prefix)
     end

data/lib/asset_sync/storage.rb

@@ -42,7 +42,8 @@ module AssetSync
     end
 
     def local_files
-      @local_files ||= get_local_files.uniq
+      @local_files ||=
+        (get_local_files + config.additional_local_file_paths).uniq
     end
 
     def always_upload_files
@@ -120,9 +121,11 @@ module AssetSync
       one_year = 31557600
       ext = File.extname(f)[1..-1]
       mime = MultiMime.lookup(ext)
+      gzip_file_handle = nil
+      file_handle = File.open("#{path}/#{f}")
       file = {
         :key => f,
-        :body => File.open("#{path}/#{f}"),
+        :body => file_handle,
         :public => true,
         :content_type => mime
       }
@@ -167,9 +170,10 @@ module AssetSync
 
         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 => File.open(gzipped),
+                        :body => gzip_file_handle,
                         :content_encoding => 'gzip'
                       })
           log "Uploading: #{gzipped} in place of #{f} saving #{percentage}%"
@@ -198,7 +202,9 @@ module AssetSync
         })
       end
 
-      file = bucket.files.create( file ) unless ignore
+      bucket.files.create( file ) unless ignore
+      file_handle.close
+      gzip_file_handle.close if gzip_file_handle
     end
 
     def upload_files

data/lib/asset_sync/version.rb

@@ -1,3 +1,3 @@
 module AssetSync
-  VERSION = "2.1.0"
+  VERSION = "2.2.0".freeze
 end

data/spec/unit/storage_spec.rb

@@ -3,6 +3,10 @@ require File.dirname(__FILE__) + '/../spec_helper'
 describe AssetSync::Storage do
   include_context "mock Rails without_yml"
 
+  let(:file_like_object) do
+    double("file like object").as_null_object
+  end
+
   describe '#upload_files' do
     before(:each) do
       @local_files = ["local_image2.jpg", "local_image1.jpg", "local_stylesheet1.css", "local_stylesheet2.css"]
@@ -13,7 +17,7 @@ describe AssetSync::Storage do
     it 'should overwrite all remote files if set to ignore' do
       @config.existing_remote_files = 'ignore'
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(File).to receive(:file?).and_return(true) # Pretend they all exist
 
       @local_files.each do |file|
@@ -26,7 +30,7 @@ describe AssetSync::Storage do
       @config.always_upload = ['local_image.jpg', /local_image\d\.svg/]
 
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(storage).to receive(:get_remote_files).and_return(@remote_files)
       allow(File).to receive(:file?).and_return(true) # Pretend they all exist
 
@@ -40,7 +44,7 @@ describe AssetSync::Storage do
       @config.ignored_files = ['local_image1.jpg', /local_stylesheet\d\.css/]
 
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(storage).to receive(:get_remote_files).and_return(@remote_files)
       allow(File).to receive(:file?).and_return(true) # Pretend they all exist
 
@@ -68,7 +72,78 @@ describe AssetSync::Storage do
       ]
 
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
+      allow(storage).to receive(:get_remote_files).and_return(@remote_files)
+      allow(File).to receive(:file?).and_return(true) # Pretend they all exist
+
+      updated_nonfingerprinted_files = [
+        'public/image.png',
+        'public/application.js',
+      ]
+      (@local_files - @remote_files + updated_nonfingerprinted_files).each do |file|
+        expect(storage).to receive(:upload_file).with(file)
+      end
+      storage.upload_files
+    end
+
+    context "when config #add_local_file_paths is called" do
+      let(:additional_local_file_paths) do
+        ["webpack/example_asset.jpg"]
+      end
+
+      before(:each) do
+        @config.add_local_file_paths do
+          additional_local_file_paths
+        end
+      end
+
+      let(:storage) do
+        AssetSync::Storage.new(@config)
+      end
+
+      let(:file_paths_should_be_uploaded) do
+        @local_files -
+          @remote_files -
+          storage.ignored_files +
+          storage.always_upload_files +
+          additional_local_file_paths
+      end
+
+      before do
+        # Stubbing
+        allow(storage).to receive(:get_local_files).and_return(@local_files)
+        allow(storage).to receive(:get_remote_files).and_return(@remote_files)
+        # Pretend the files all exist
+        allow(File).to receive(:file?).and_return(true)
+      end
+
+      it "uploads additional files in additional to local files" do
+        file_paths_should_be_uploaded.each do |file|
+          expect(storage).to receive(:upload_file).with(file)
+        end
+        storage.upload_files
+      end
+    end
+
+    it 'should upload additonal  files' do
+      @local_files = [
+        'public/image.png',
+        'public/image-82389298328.png',
+        'public/image-a8389f9h324.png',
+        'public/application.js',
+        'public/application-b3389d983k1.js',
+        'public/application-ac387d53f31.js',
+        'public',
+      ]
+      @remote_files = [
+        'public/image.png',
+        'public/image-a8389f9h324.png',
+        'public/application.js',
+        'public/application-b3389d983k1.js',
+      ]
+
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(storage).to receive(:get_remote_files).and_return(@remote_files)
       allow(File).to receive(:file?).and_return(true) # Pretend they all exist
 
@@ -110,10 +185,10 @@ describe AssetSync::Storage do
       remote_files = []
       @config.cache_asset_regexps = [/\.[a-f0-9]{6}$/i, /\.[a-f0-9]{8}$/i]
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(local_files)
+      allow(storage).to receive(:get_local_files).and_return(local_files)
       allow(storage).to receive(:get_remote_files).and_return(remote_files)
       allow(File).to receive(:file?).and_return(true)
-      allow(File).to receive(:open).and_return(nil)
+      allow(File).to receive(:open).and_return(file_like_object)
 
       def check_file(file)
         case file[:key]
@@ -155,7 +230,7 @@ describe AssetSync::Storage do
       @config.fog_provider = 'AWS'
 
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(storage).to receive(:get_remote_files).and_return(@remote_files)
       allow(storage).to receive(:upload_file).and_return(true)
 
@@ -193,9 +268,10 @@ describe AssetSync::Storage do
         }
       }
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(storage).to receive(:get_remote_files).and_return(@remote_files)
-      allow(File).to receive(:open).and_return('file') # Pretend they all exist
+      # Pretend they all exist
+      allow(File).to receive(:open).and_return(file_like_object)
 
       bucket = double
       files = double
@@ -216,9 +292,10 @@ describe AssetSync::Storage do
         }
       }
       storage = AssetSync::Storage.new(@config)
-      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_local_files).and_return(@local_files)
       allow(storage).to receive(:get_remote_files).and_return(@remote_files)
-      allow(File).to receive(:open).and_return('file') # Pretend they all exist
+      # Pretend they all exist
+      allow(File).to receive(:open).and_return(file_like_object)
       bucket = double
       files = double
       allow(storage).to receive(:bucket).and_return(bucket)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Simon Hamilton
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-19 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog-core
@@ -164,6 +164,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".editorconfig"
 - ".gitignore"
 - ".travis.yml"
 - Appraisals