sq-asset_sync 2.0.0

data/spec/unit/google_spec.rb

@@ -0,0 +1,142 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AssetSync do
+  include_context "mock Rails without_yml"
+
+  describe 'with initializer' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fog_provider = 'Google'
+        config.google_storage_access_key_id = 'aaaa'
+        config.google_storage_secret_access_key = 'bbbb'
+        config.fog_directory = 'mybucket'
+        config.existing_remote_files = "keep"
+      end
+    end
+
+    it "should configure provider as Google" do
+      expect(AssetSync.config.fog_provider).to eq('Google')
+      expect(AssetSync.config).to be_google
+    end
+
+    it "should should keep existing remote files" do
+      expect(AssetSync.config.existing_remote_files?).to eq(true)
+    end
+
+    it "should configure google_storage_access_key_id" do
+      expect(AssetSync.config.google_storage_access_key_id).to eq("aaaa")
+    end
+
+    it "should configure google_storage_secret_access_key" do
+      expect(AssetSync.config.google_storage_secret_access_key).to eq("bbbb")
+    end
+
+    it "should configure fog_directory" do
+      expect(AssetSync.config.fog_directory).to eq("mybucket")
+    end
+
+    it "should configure existing_remote_files" 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
+    end
+
+    it "should default manifest to false" do
+      expect(AssetSync.config.manifest).to be_falsey
+    end
+  end
+
+  describe 'from yml' do
+    before(:each) do
+      set_rails_root('google_with_yml')
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should configure google_storage_access_key_id" do
+      expect(AssetSync.config.google_storage_access_key_id).to eq("xxxx")
+    end
+
+    it "should configure google_storage_secret_access_key" do
+      expect(AssetSync.config.google_storage_secret_access_key).to eq("zzzz")
+    end
+
+    it "should configure google_storage_access_key" do
+      expect(AssetSync.config.fog_directory).to eq("rails_app_test")
+    end
+
+    it "should configure google_storage_access_key" 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
+    end
+
+    it "should default manifest to false" do
+      expect(AssetSync.config.manifest).to be_falsey
+    end
+  end
+
+  describe 'with no configuration' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should be invalid" do
+      expect{ AssetSync.sync }.to raise_error()
+    end
+  end
+
+  describe 'with fail_silent configuration' do
+    before(:each) do
+      allow(AssetSync).to receive(:stderr).and_return(StringIO.new)
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fail_silently = true
+      end
+    end
+
+    it "should not raise an invalid exception" do
+      expect{ AssetSync.sync }.not_to raise_error()
+    end
+  end
+
+  describe 'with gzip_compression enabled' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.config.gzip_compression = true
+    end
+
+    it "config.gzip? should be true" do
+      expect(AssetSync.config.gzip?).to be_truthy
+    end
+  end
+
+  describe 'with manifest enabled' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.config.manifest = true
+    end
+
+    it "config.manifest should be true" do
+      expect(AssetSync.config.manifest).to be_truthy
+    end
+
+    it "config.manifest_path should default to public/assets.." do
+      expect(AssetSync.config.manifest_path).to match(/public\/assets\/manifest.yml/)
+    end
+
+    it "config.manifest_path should default to public/assets.." do
+      Rails.application.config.assets.manifest = "/var/assets"
+      expect(AssetSync.config.manifest_path).to eq("/var/assets/manifest.yml")
+    end
+
+    it "config.manifest_path should default to public/custom_assets.." do
+      Rails.application.config.assets.prefix = 'custom_assets'
+      expect(AssetSync.config.manifest_path).to match(/public\/custom_assets\/manifest.yml/)
+    end
+  end
+end

data/spec/unit/multi_mime_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AssetSync::MultiMime do
+
+  before(:each) do
+    Object.send(:remove_const, :Rails) if defined?(Rails)
+    Object.send(:remove_const, :Mime) if defined?(Mime)
+    Object.send(:remove_const, :Rack) if defined?(Rack)
+  end
+
+  after(:each) do
+    Object.send(:remove_const, :Rails) if defined?(Rails)
+    Object.send(:remove_const, :Mime) if defined?(Mime)
+    Object.send(:remove_const, :Rack) if defined?(Rack)
+  end
+
+  after(:all) do
+    require 'mime/types'
+  end
+
+  describe 'Mime::Type' do
+
+    it 'should detect mime type' do
+      require 'rails'
+      expect(AssetSync::MultiMime.lookup('css')).to eq("text/css")
+    end
+
+  end
+
+  describe 'Rack::Mime' do
+
+    it 'should detect mime type' do
+      require 'rack/mime'
+      expect(AssetSync::MultiMime.lookup('css')).to eq("text/css")
+    end
+
+  end
+
+  describe 'MIME::Types' do
+
+    it 'should detect mime type' do
+      require 'mime/types'
+      expect(AssetSync::MultiMime.lookup('css')).to eq("text/css")
+    end
+
+  end
+
+end

data/spec/unit/rackspace_spec.rb

@@ -0,0 +1,90 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AssetSync do
+  include_context "mock Rails"
+
+  describe 'using Rackspace with initializer' do
+    before(:each) do
+      set_rails_root('without_yml')
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fog_provider          = 'Rackspace'
+        config.fog_directory         = 'mybucket'
+        config.fog_region            = 'dunno'
+        config.rackspace_username    = 'aaaa'
+        config.rackspace_api_key     = 'bbbb'
+        config.existing_remote_files = 'keep'
+      end
+    end
+
+    it "should configure provider as Rackspace" do
+      expect(AssetSync.config.fog_provider).to eq('Rackspace')
+      expect(AssetSync.config).to be_rackspace
+    end
+
+    it "should keep existing remote files" do
+      expect(AssetSync.config.existing_remote_files?).to eq(true)
+    end
+
+    it "should configure rackspace_username" do
+      expect(AssetSync.config.rackspace_username).to eq("aaaa")
+    end
+
+    it "should configure rackspace_api_key" do
+      expect(AssetSync.config.rackspace_api_key).to eq("bbbb")
+    end
+
+    it "should configure fog_directory" do
+      expect(AssetSync.config.fog_directory).to eq("mybucket")
+    end
+
+    it "should configure fog_region" do
+      expect(AssetSync.config.fog_region).to eq("dunno")
+    end
+
+    it "should configure existing_remote_files" do
+      expect(AssetSync.config.existing_remote_files).to eq("keep")
+    end
+
+    it "should configure existing_remote_files" do
+      expect(AssetSync.config.existing_remote_files).to eq("keep")
+    end
+
+    it "should default rackspace_auth_url to false" do
+      expect(AssetSync.config.rackspace_auth_url).to be_falsey
+    end
+
+  end
+
+  describe 'using Rackspace from yml' do
+
+    before(:each) do
+      set_rails_root('rackspace_with_yml')
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should keep existing remote files" do
+      expect(AssetSync.config.existing_remote_files?).to eq(true)
+    end
+
+    it "should configure rackspace_username" do
+      expect(AssetSync.config.rackspace_username).to eq("xxxx")
+    end
+
+    it "should configure rackspace_api_key" do
+      expect(AssetSync.config.rackspace_api_key).to eq("zzzz")
+    end
+
+    it "should configure fog_directory" do
+      expect(AssetSync.config.fog_directory).to eq("rails_app_test")
+    end
+
+    it "should configure fog_region" do
+      expect(AssetSync.config.fog_region).to eq("eu-west-1")
+    end
+
+    it "should configure existing_remote_files" do
+      expect(AssetSync.config.existing_remote_files).to eq("keep")
+    end
+  end
+end

data/spec/unit/railsless_spec.rb

@@ -0,0 +1,72 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AssetSync do
+  include_context "mock without Rails"
+
+  describe 'with initializer' do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.fog_provider = 'AWS'
+        config.aws_access_key_id = 'aaaa'
+        config.aws_secret_access_key = 'bbbb'
+        config.fog_directory = 'mybucket'
+        config.fog_region = 'eu-west-1'
+        config.existing_remote_files = "keep"
+        config.prefix = "assets"
+        config.public_path = Pathname("./public")
+      end
+    end
+
+    it "should have prefix of assets" do
+      expect(AssetSync.config.prefix).to eq("assets")
+    end
+
+    it "should have prefix of assets" do
+      expect(AssetSync.config.public_path.to_s).to eq("./public")
+    end
+
+    it "should default AssetSync to enabled" do
+      expect(AssetSync.config.enabled?).to be_truthy
+      expect(AssetSync.enabled?).to be_truthy
+    end
+
+    it "should configure provider as AWS" do
+      expect(AssetSync.config.fog_provider).to eq('AWS')
+      expect(AssetSync.config).to be_aws
+    end
+
+    it "should should keep existing remote files" do
+      expect(AssetSync.config.existing_remote_files?).to eq(true)
+    end
+
+    it "should configure aws_access_key" do
+      expect(AssetSync.config.aws_access_key_id).to eq("aaaa")
+    end
+
+    it "should configure aws_secret_access_key" do
+      expect(AssetSync.config.aws_secret_access_key).to eq("bbbb")
+    end
+
+    it "should configure aws_access_key" do
+      expect(AssetSync.config.fog_directory).to eq("mybucket")
+    end
+
+    it "should configure fog_region" do
+      expect(AssetSync.config.fog_region).to eq("eu-west-1")
+    end
+
+    it "should configure existing_remote_files" 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
+    end
+
+    it "should default manifest to false" do
+      expect(AssetSync.config.manifest).to be_falsey
+    end
+
+  end
+end

data/spec/unit/storage_spec.rb

@@ -0,0 +1,244 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe AssetSync::Storage do
+  include_context "mock Rails without_yml"
+
+  describe '#upload_files' do
+    before(:each) do
+      @local_files = ["local_image2.jpg", "assets/manifest-abc.json", "local_image1.jpg", "local_stylesheet1.css", "local_stylesheet2.css"]
+      @remote_files = ["local_image.jpg", "local_stylesheet1.css"]
+      @config = AssetSync::Config.new
+    end
+
+    it 'always uploads the manifest last', test: true do
+      expect(@config).to receive(:manifest_digest_path).and_return('assets/manifest-abc.json')
+
+      allow(File).to receive(:file?).and_return(true) # Pretend they all exist
+
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(:local_files).and_return(@local_files)
+      allow(storage).to receive(:get_remote_files).and_return(@remote_files)
+      expect(storage).to receive(:upload_file).ordered.with('local_image2.jpg')
+      expect(storage).to receive(:upload_file).ordered.with('local_image1.jpg')
+      expect(storage).to receive(:upload_file).ordered.with('local_stylesheet2.css')
+      expect(storage).to receive(:upload_file).ordered.with('assets/manifest.json')
+      expect(storage).to receive(:upload_file).ordered.with('assets/manifest-abc.json')
+
+      storage.upload_files
+    end
+
+    context 'with the manifest on the remote', test: true do
+      before do
+        @remote_files << 'manifest-abc.json'
+      end
+
+      it 'does not upload' do
+        expect(@config).to receive(:manifest_digest_path).and_return('assets/manifest-abc.json')
+
+        allow(File).to receive(:file?).and_return(true) # Pretend they all exist
+
+        storage = AssetSync::Storage.new(@config)
+
+        conn_mock = double
+        allow(storage).to receive(:connection).and_return(conn_mock)
+        expect(conn_mock).to receive(:head_object).with(@config.fog_directory, 'assets/manifest-abc.json').and_return(
+          double(headers: { 'Last-Modified' => CGI.rfc1123_date(Time.now.utc) })
+        )
+        allow(storage).to receive(:local_files).and_return(@local_files)
+        allow(storage).to receive(:get_remote_files).and_return(@remote_files)
+        expect(storage).to_not receive(:upload_file)
+
+        storage.upload_files
+      end
+    end
+
+    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(File).to receive(:file?).and_return(true) # Pretend they all exist
+
+      @local_files.each do |file|
+        expect(storage).to receive(:upload_file).with(file)
+      end
+
+      expect(storage).to receive(:upload_file).ordered.with('assets/manifest.json')
+      storage.upload_files
+    end
+
+    it 'should allow force overwriting of specific files' do
+      @config.always_upload = ['local_image.jpg']
+
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(: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
+
+      (@local_files - @remote_files + storage.always_upload_files).each do |file|
+        expect(storage).to receive(:upload_file).with(file)
+      end
+
+      expect(storage).to receive(:upload_file).ordered.with('assets/manifest.json')
+      storage.upload_files
+    end
+
+    it 'should allow to ignore files' 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_remote_files).and_return(@remote_files)
+      allow(File).to receive(:file?).and_return(true) # Pretend they all exist
+
+      (@local_files - @remote_files - storage.ignored_files + storage.always_upload_files).each do |file|
+        expect(storage).to receive(:upload_file).with(file)
+      end
+
+      expect(storage).to receive(:upload_file).ordered.with('assets/manifest.json')
+      storage.upload_files
+    end
+
+    it 'should upload updated non-fingerprinted 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(: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
+
+    it 'should correctly set expire date' do
+      local_files = ['file1.jpg', 'file1-1234567890abcdef1234567890abcdef.jpg',
+        'file1-1234567890abcdef1234567890abcdef.jpg.gz']
+      local_files += ['dir1/dir2/file2.jpg', 'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg',
+        'dir1/dir2/file2-1234567890abcdef1234567890abcdef.jpg.gz']
+      remote_files = []
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(: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)
+
+      def check_file(file)
+        case file[:key]
+        when 'file1.jpg'
+        when 'dir1/dir2/file2.jpg'
+          !expect(file).not_to include(:cache_control, :expires)
+        when %r|file1-1234567890abcdef1234567890abcdef\.jpg|
+        when %r|dir1/dir2/file2-1234567890abcdef1234567890abcdef\.jpg|
+          expect(file).to include(:cache_control, :expires)
+          file.should include(:cache_control, :expires)
+        else
+          fail
+        end
+      end
+
+      files = double()
+      local_files.count.times do
+        expect(files).to receive(:create) { |file| check_file(file) }
+      end
+      allow(storage).to receive_message_chain(:bucket, :files).and_return(files)
+      storage.upload_files
+    end
+
+    it "shoud invalidate files" do
+      @config.cdn_distribution_id = "1234"
+      @config.invalidate = ['local_image1.jpg']
+      @config.fog_provider = 'AWS'
+
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(: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)
+
+      mock_cdn = double
+      expect(Fog::CDN).to receive(:new).and_return(mock_cdn)
+      expect(mock_cdn).to receive(:post_invalidation).with("1234", ["/assets/local_image1.jpg"]).and_return(double({:body => {:id => '1234'}}))
+
+      storage.upload_files
+    end
+  end
+
+  describe '#upload_file' do
+    before(:each) do
+      # Object#remove_const does not remove the loaded
+      # file from the $" variable
+      #Object.send(:remove_const, :MIME) if defined?(MIME)
+      mime_types = $".grep(/mime\/types/).first
+      $".delete(mime_types)
+      require 'mime/types'
+      @config = AssetSync::Config.new
+    end
+
+    it 'accepts custom headers per file' do
+      @config.custom_headers = {
+        "local_image2.jpg" => {
+          :cache_control => 'max-age=0'
+        }
+      }
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(: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
+
+      bucket = double
+      files = double
+
+      allow(storage).to receive(:bucket).and_return(bucket)
+      allow(bucket).to receive(:files).and_return(files)
+
+      expect(files).to receive(:create) do |argument|
+        expect(argument[:cache_control]).to eq('max-age=0')
+      end
+      storage.upload_file('assets/local_image2.jpg')
+    end
+
+    it 'accepts custom headers with a regular expression' do
+      @config.custom_headers = {
+        ".*\.jpg" => {
+          :cache_control => 'max-age=0'
+        }
+      }
+      storage = AssetSync::Storage.new(@config)
+      allow(storage).to receive(: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
+      bucket = double
+      files = double
+      allow(storage).to receive(:bucket).and_return(bucket)
+      allow(bucket).to receive(:files).and_return(files)
+
+      expect(files).to receive(:create) do |argument|
+        expect(argument[:cache_control]).to eq('max-age=0')
+      end
+      storage.upload_file('assets/some_longer_path/local_image2.jpg')
+    end
+
+    after(:each) do
+      #Object.send(:remove_const, :MIME) if defined?(MIME)
+    end
+  end
+end