sq-asset_sync 2.0.0

data/lib/generators/asset_sync/templates/asset_sync.yml

@@ -0,0 +1,43 @@
+defaults: &defaults
+  <%- if aws? -%>
+  fog_provider: 'AWS'
+  aws_access_key_id: "<%= aws_access_key_id %>"
+  aws_secret_access_key: "<%= aws_secret_access_key %>"
+  # To use AWS reduced redundancy storage.
+  # aws_reduced_redundancy: true
+  <%- elsif google? -%>
+  fog_provider: 'Google'
+  google_storage_access_key_id: "<%= google_storage_access_key_id %>"
+  google_storage_secret_access_key: "<%= google_storage_secret_access_key %>"
+  <%- elsif rackspace? -%>
+  fog_provider: 'Rackspace'
+  rackspace_username: "<%= rackspace_username %>"
+  rackspace_api_key: "<%= rackspace_api_key %>"
+  # if you need to change rackspace_auth_url (e.g. if you need to use Rackspace London)
+  # rackspace_auth_url: "https://lon.identity.api.rackspacecloud.com/v2.0"
+  <%- end -%>
+  fog_directory: "<%= app_name %>-assets"
+  # You may need to specify what region your storage bucket is in
+  # fog_region: "eu-west-1"
+  existing_remote_files: keep
+  # To delete existing remote files.
+  # existing_remote_files: delete
+  # Automatically replace files with their equivalent gzip compressed version
+  # gzip_compression: true
+  # Fail silently.  Useful for environments such as Heroku
+  # fail_silently: true
+
+development:
+  <<: *defaults
+  enabled: false
+
+test:
+  <<: *defaults
+  enabled: false
+
+staging:
+  <<: *defaults
+  fog_directory: "<%= app_name %>-staging-assets"
+
+production:
+  <<: *defaults

data/lib/tasks/asset_sync.rake

@@ -0,0 +1,30 @@
+namespace :assets do
+
+  desc 'Synchronize assets to remote (assumes assets are already compiled)'
+  task :sync => :environment do
+    AssetSync.sync
+  end
+  namespace :sync do
+    desc 'Delete out-of-sync files on remote'
+    task :clean => :environment do
+      AssetSync.clean
+    end
+  end
+
+end
+
+if Rake::Task.task_defined?("assets:precompile:nondigest")
+  Rake::Task["assets:precompile:nondigest"].enhance do
+    # Conditional execution needs to be inside the enhance block because the enhance block
+    # will get executed before yaml or Rails initializers.
+    Rake::Task["assets:sync"].invoke if defined?(AssetSync) && AssetSync.config.run_on_precompile
+  end
+else
+  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
+    # assets environment in this case.
+    # 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
+end

data/script/ci

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+set -e
+
+export RAILS_ENV="test"
+
+ensure_app_dependencies_installed() {
+  install_bundler_if_needed
+  update_gems_if_needed
+}
+
+install_bundler_if_needed() {
+  echo "Checking for Bundler..."
+  gem install bundler --conservative
+}
+
+update_gems_if_needed() {
+  echo "Installing gems..."
+  bundle check || bundle install
+}
+
+run_specs() {
+  bundle exec rspec $(echo $RUN_LIST | tr , ' ')
+}
+
+run_full_build() {
+  ensure_app_dependencies_installed &&
+  run_specs
+}
+
+run_full_build

data/spec/dummy_app/Rakefile

@@ -0,0 +1,30 @@
+require 'rubygems'
+# require "rake"
+ENV['RAILS_ROOT'] = File.dirname(__FILE__)
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+# require 'rails/all'
+require "action_controller/railtie"
+require "sprockets/railtie"
+if defined?(Bundler)
+  Bundler.require(*Rails.groups(:assets => %w(development test)))
+end
+module AssetSyncTest
+  class Application < Rails::Application
+    config.encoding = "utf-8"
+    config.filter_parameters += [:password]
+    config.eager_load = false
+    config.assets.enabled = true
+    config.assets.version = '1.0'
+    config.secret_token = 'bf196b4383deefa4e0120a6ef1d9af1cc45f5c4ebd04405'
+    config.session_store :cookie_store, :key => '_asset_sync_test_session', :secret => 'xxxx'
+    config.active_support.deprecation = :log
+    config.assets.compress = true
+    config.assets.digest = true
+    config.assets.prefix = ENV['ASSET_SYNC_PREFIX']
+  end
+end
+AssetSyncTest::Application.initialize!
+AssetSyncTest::Application.load_tasks
+# Rake::Task['assets:precompile:all'].invoke

data/spec/dummy_app/app/assets/javascripts/application.js

@@ -0,0 +1 @@
+console.log("hello");

data/spec/fixtures/aws_with_yml/config/asset_sync.yml

@@ -0,0 +1,25 @@
+defaults: &defaults
+  fog_provider: "AWS"
+  aws_access_key_id: "xxxx"
+  aws_secret_access_key: "zzzz"
+  region: "eu-west-1"
+  run_on_precompile: false
+
+development:
+  <<: *defaults
+  fog_directory: "rails_app_development"
+  existing_remote_files: keep
+
+test:
+  <<: *defaults
+  fog_directory: "rails_app_test"
+  existing_remote_files: keep
+
+production:
+  <<: *defaults
+  fog_directory: "rails_app_production"
+  existing_remote_files: delete
+
+hybrid:
+  <<: *defaults
+  enabled: false

data/spec/fixtures/google_with_yml/config/asset_sync.yml

@@ -0,0 +1,19 @@
+defaults: &defaults
+  fog_provider: "Google"
+  google_storage_access_key_id: 'xxxx'
+  google_storage_secret_access_key: 'zzzz'
+
+development:
+  <<: *defaults
+  fog_directory: "rails_app_development"
+  existing_remote_files: keep
+
+test:
+  <<: *defaults
+  fog_directory: "rails_app_test"
+  existing_remote_files: keep
+
+production:
+  <<: *defaults
+  fog_directory: "rails_app_production"
+  existing_remote_files: delete

data/spec/fixtures/rackspace_with_yml/config/asset_sync.yml

@@ -0,0 +1,20 @@
+defaults: &defaults
+  fog_provider: "Rackspace"
+  rackspace_username: "xxxx"
+  rackspace_api_key: "zzzz"
+  region: "eu-west-1"
+
+development:
+  <<: *defaults
+  fog_directory: "rails_app_development"
+  existing_remote_files: keep
+
+test:
+  <<: *defaults
+  fog_directory: "rails_app_test"
+  existing_remote_files: keep
+
+production:
+  <<: *defaults
+  fog_directory: "rails_app_production"
+  existing_remote_files: delete

data/spec/fixtures/with_invalid_yml/config/asset_sync.yml

@@ -0,0 +1,24 @@
+defaults: &defaults
+  fog_provider= "AWS"
+  aws_access_key_id: "xxxx"
+  aws_secret_access_key: "zzzz"
+  region: "eu-west-1"
+
+development:
+  <<: *defaults
+  fog_directory: "rails_app_development"
+  existing_remote_files: keep
+
+test:
+  <<: *defaults
+  fog_directory: "rails_app_test"
+  existing_remote_files: keep
+
+production:
+  <<: *defaults
+  fog_directory: "rails_app_production"
+  existing_remote_files: delete
+
+hybrid:
+  <<: *defaults
+  enabled: false

data/spec/integration/aws_integration_spec.rb

@@ -0,0 +1,77 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+require "fog/aws"
+
+def bucket(name)
+  options = {
+    :provider => 'AWS',
+    :aws_access_key_id => ENV['AWS_ACCESS_KEY_ID'],
+    :aws_secret_access_key => ENV['AWS_SECRET_ACCESS_KEY']
+  }
+
+  connection = Fog::Storage.new(options)
+  connection.directories.get(ENV['FOG_DIRECTORY'], :prefix => name)
+end
+
+def execute(command)
+  app_path = File.expand_path("../../dummy_app", __FILE__)
+  Dir.chdir app_path
+  `#{command}`
+end
+
+describe "AssetSync" do
+
+  before(:each) do
+    @prefix = SecureRandom.hex(6)
+  end
+
+  let(:app_js_regex){
+    /#{@prefix}\/application-[a-zA-Z0-9]*.js$/
+  }
+
+  let(:app_js_gz_regex){
+    /#{@prefix}\/application-[a-zA-Z0-9]*.js.gz$/
+  }
+
+  let(:files){ bucket(@prefix).files }
+
+
+  after(:each) do
+    @directory = bucket(@prefix)
+    @directory.files.each do |f|
+      f.destroy
+    end
+  end
+
+  it "sync" do
+    execute "rake ASSET_SYNC_PREFIX=#{@prefix} assets:precompile"
+
+    files = bucket(@prefix).files
+
+    app_js_path = files.select{ |f| f.key =~ app_js_regex }.first
+    app_js_gz_path = files.select{ |f| f.key =~ app_js_gz_regex }.first
+
+    app_js = files.get( app_js_path.key )
+    expect(app_js.content_type).to eq("text/javascript")
+
+    app_js_gz = files.get( app_js_gz_path.key )
+    expect(app_js_gz.content_type).to eq("text/javascript")
+    expect(app_js_gz.content_encoding).to eq("gzip")
+  end
+
+  it "sync with enabled=false" do
+    execute "rake ASSET_SYNC_PREFIX=#{@prefix} ASSET_SYNC_ENABLED=false assets:precompile"
+    expect(bucket(@prefix).files.size).to eq(0)
+  end
+
+  it "sync with gzip_compression=true" do
+    execute "rake ASSET_SYNC_PREFIX=#{@prefix} ASSET_SYNC_GZIP_COMPRESSION=true assets:precompile"
+    # bucket(@prefix).files.size.should == 3
+
+    app_js_path = files.select{ |f| f.key =~ app_js_regex }.first
+    app_js = files.get( app_js_path.key )
+    expect(app_js.content_type).to eq("text/javascript")
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,64 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+rescue LoadError
+  # SimpleCov ain't available - continue
+end
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'asset_sync'
+
+require 'rspec'
+RSpec.configure do |config|
+  config.mock_framework = :rspec
+end
+
+shared_context "mock without Rails" do
+  before(:each) do
+    if defined? Rails
+      Object.send(:remove_const, :Rails)
+    end
+    allow(AssetSync).to receive(:log)
+  end
+end
+
+
+shared_context "mock Rails" do
+  before(:each) do
+    Object.send(:remove_const, :Rails) if defined? Rails
+    Rails = double 'Rails'
+    allow(Rails).to receive(:env).and_return('test')
+    allow(Rails).to receive_messages :application => double('application')
+    allow(Rails.application).to receive_messages :config => double('config')
+    allow(Rails.application.config).to receive_messages :assets => ActiveSupport::OrderedOptions.new
+    Rails.application.config.assets.prefix = '/assets'
+    allow(AssetSync).to receive(:log)
+  end
+end
+
+shared_context "mock Rails without_yml" do
+  include_context "mock Rails"
+
+  before(:each) do
+    set_rails_root('without_yml')
+    allow(Rails).to receive(:public_path).and_return(Rails.root.join('public').to_s)
+  end
+end
+
+def set_rails_root(path)
+  allow(Rails).to receive(:root).and_return(Pathname.new(File.join(File.dirname(__FILE__), 'fixtures', path)))
+end

data/spec/unit/asset_sync_spec.rb

@@ -0,0 +1,257 @@
+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 = '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"
+      end
+    end
+
+    it "should default to running on precompile" do
+      expect(AssetSync.config.run_on_precompile).to be_truthy
+    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
+
+    it "should default log_silently to true" do
+      expect(AssetSync.config.log_silently).to be_truthy
+    end
+    
+    it "log_silently? should reflect the configuration" do
+      AssetSync.config.log_silently = false
+      expect(AssetSync.config.log_silently?).to eq(false)
+    end
+
+    it "log_silently? should always be true if ENV['RAILS_GROUPS'] == 'assets'" do
+      AssetSync.config.log_silently = false
+      # make sure ENV is actually being checked ...
+      expect(ENV).to receive(:[]).with('RAILS_GROUPS').and_return('assets') 
+      expect(AssetSync.config.log_silently?).to eq(true)
+    end
+
+    it "should default cdn_distribution_id to nil" do
+      expect(AssetSync.config.cdn_distribution_id).to be_nil
+    end
+
+    it "should default invalidate to empty array" do
+      expect(AssetSync.config.invalidate).to eq([])
+    end
+  end
+
+  describe 'from yml' do
+    before(:each) do
+      set_rails_root('aws_with_yml')
+      AssetSync.config = AssetSync::Config.new
+    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 run_on_precompile" do
+      expect(AssetSync.config.run_on_precompile).to be_falsey
+    end
+
+    it "should configure aws_access_key_id" do
+      expect(AssetSync.config.aws_access_key_id).to eq("xxxx")
+    end
+
+    it "should configure aws_secret_access_key" do
+      expect(AssetSync.config.aws_secret_access_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
+
+    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, exporting to a mobile hybrid development directory' do
+    before(:each) do
+      Rails.env.replace('hybrid')
+      set_rails_root('aws_with_yml')
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "should be disabled" do
+      expect{ AssetSync.sync }.not_to raise_error()
+    end
+
+    after(:each) do
+      Rails.env.replace('test')
+    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 no other configuration than enabled = false" do
+    before(:each) do
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.enabled = false
+      end
+    end
+
+    it "should do nothing, without complaining" do
+      expect{ AssetSync.sync }.not_to raise_error()
+    end
+  end
+
+  describe 'with fail_silent configuration' do
+    before(:each) do
+      allow(AssetSync).to receive(:stderr).and_return(@stderr = 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
+
+    it "should output a warning to stderr" do
+      AssetSync.sync
+      expect(@stderr.string).to match(/can't be blank/)
+    end
+  end
+
+  describe 'with disabled config' do
+    before(:each) do
+      allow(AssetSync).to receive(:stderr).and_return(@stderr = StringIO.new)
+      AssetSync.config = AssetSync::Config.new
+      AssetSync.configure do |config|
+        config.enabled = false
+      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
+
+  describe 'with invalid yml' do
+
+    before(:each) do
+      set_rails_root('with_invalid_yml')
+      AssetSync.config = AssetSync::Config.new
+    end
+
+    it "config should be invalid" do
+      expect(AssetSync.config.valid?).to be_falsey
+    end
+
+    it "should raise a config invalid error" do
+      expect{ AssetSync.sync }.to raise_error()
+    end
+  end
+end