asset_sync 0.2.10 → 0.2.11

data/README.md

@@ -9,55 +9,33 @@ This was initially built and is intended to work on [Heroku](http://heroku.com)
 
 ## Upgrading?
 
-If you are upgrading from a version of asset_sync **< 0.2.0** (i.e. 0.1.x). All of the references to config variables have changed to reference those used in **Fog**. Ensure to backup your `asset\_sync.rb` or `asset\_sync.yml` files and re-run the generator. You may also then need to update your ENV configuration variables (or you can change the ones that are referenced).
+If you are upgrading from a version of asset_sync **< 0.2.0** (i.e. 0.1.x). All of the references to config variables have changed to reference those used in **Fog**. Ensure to backup your `asset_sync.rb` or `asset_sync.yml` files and re-run the generator. You may also then need to update your ENV configuration variables (or you can change the ones that are referenced).
 
-## KNOWN ISSUES (IMPORTANT)
+## Heroku Labs (BETA)
 
-We are currently trying to talk with Heroku to iron these out.
+Previously there were [several issues](http://github.com/rumblelabs/asset_sync/blob/master/docs/heroku.md) with using asset_sync on Heroku as described in our [Heroku dev centre article](http://devcenter.heroku.com/articles/cdn-asset-host-rails31).
 
-1. Will not work on heroku on an application with a *RAILS_ENV* configured as anything other than production
-2. Will not work on heroku using ENV variables with the configuration as described below, you must hardcode all variables
+Now to get everything working smoothly with using **ENV** variables to configure `asset_sync` we just need to enable the [user\_env\_compile](http://devcenter.heroku.com/articles/labs-user-env-compile) functionality. In short:
 
-### 1. RAILS_ENV
+    heroku plugins:install https://github.com/heroku/heroku-labs.git
+    heroku labs:enable user_env_compile -a myapp
 
-When you see `rake assets:precompile` during deployment. Heroku is actually running something like
-
-    env RAILS_ENV=production DATABASE_URL=scheme://user:pass@127.0.0.1/dbname bundle exec rake assets:precompile 2>&1
-
-This means the *RAILS_ENV* you have set via *heroku:config* is not used.
-
-**Workaround:** you could have just one S3 bucket dedicated to assets and ensure to set keep the existing remote files
-
-    AssetSync.configure do |config|
-      ...
-      config.fog_directory = 'app-assets'
-      config.existing_remote_files = "keep"
-    end
-
-### 2. ENV varables not available
-
-Currently when heroku runs `rake assets:precompile` during deployment. It does not load your Rails application's environment config. This means using any **ENV** variables you could normally depend on are not available. For now you can just run `heroku run rake assets:precompile` after deploy.
-
-**Workaround:** you could just hardcode your AWS credentials in the initializer or yml
-
-    AssetSync.configure do |config|
-      config.aws_access_key_id = 'xxx'
-      config.aws_secret_access_key = 'xxx'
-      config.fog_directory = 'mybucket'
-    end
+Hopefully this will make it's way into the platform as standard.
 
 ## Installation
 
 Add the gem to your Gemfile
 
-    gem "asset_sync"
+``` ruby
+gem "asset_sync"
+```
 
 > The following steps are now optional as of version **0.1.7** there is a built-in initializer [lib/engine.rb](https://github.com/rumblelabs/asset_sync/blob/master/lib/asset_sync/engine.rb)
 
 Generate the rake task and config file
 
     rails g asset_sync:install
-    
+
 If you would like to use a YAML file for configuration instead of the default (Rails Initializer) then 
 
     rails g asset_sync:install --use-yml
@@ -72,10 +50,12 @@ The default *provider* is `AWS` but you can pick which one you need.
 Configure __config/environments/production.rb__ to use Amazon
 S3 as the asset host and ensure precompiling is enabled.
 
-    # config/environments/production.rb
-    config.action_controller.asset_host = Proc.new do |source, request|
-      request.ssl? ? "https://#{ENV['FOG_DIRECTORY']}.s3.amazonaws.com" : "http://#{ENV['FOG_DIRECTORY']}.s3.amazonaws.com"
-    end
+``` ruby
+# config/environments/production.rb
+config.action_controller.asset_host = Proc.new do |source, request|
+  request.ssl? ? "https://#{ENV['FOG_DIRECTORY']}.s3.amazonaws.com" : "http://#{ENV['FOG_DIRECTORY']}.s3.amazonaws.com"
+end
+```
 
 We support two methods of configuration.
 
@@ -92,57 +72,61 @@ The recommend way to configure **asset_sync** is by using environment variables
 
 The generator will create a Rails initializer at `config/initializers/asset_sync.rb`.
 
-    AssetSync.configure do |config|
-      config.fog_provider = 'AWS'
-      config.fog_directory = ENV['FOG_DIRECTORY']
-      config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
-      config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
-
-      # Don't delete files from the store
-      # config.existing_remote_files = "keep"
-      #
-      # Increase upload performance by configuring your region
-      # config.fog_region = 'eu-west-1'
-      #
-      # Automatically replace files with their equivalent gzip compressed version
-      # config.gzip_compression = true
-      #
-      # Use the Rails generated 'manifest.yml' file to produce the list of files to 
-      # upload instead of searching the assets directory.
-      # config.manifest = true
-      #
-      # Fail silently.  Useful for environments such as Heroku
-      # config.fail_silently = true
-    end
+``` ruby
+AssetSync.configure do |config|
+  config.fog_provider = 'AWS'
+  config.fog_directory = ENV['FOG_DIRECTORY']
+  config.aws_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  config.aws_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+
+  # Don't delete files from the store
+  # config.existing_remote_files = "keep"
+  #
+  # Increase upload performance by configuring your region
+  # config.fog_region = 'eu-west-1'
+  #
+  # Automatically replace files with their equivalent gzip compressed version
+  # config.gzip_compression = true
+  #
+  # Use the Rails generated 'manifest.yml' file to produce the list of files to 
+  # upload instead of searching the assets directory.
+  # config.manifest = true
+  #
+  # Fail silently.  Useful for environments such as Heroku
+  # config.fail_silently = true
+end
+```
 
 
 ### YAML (config/asset_sync.yml)
 
 If you used the `--use-yml` flag, the generator will create a YAML file at `config/asset_sync.yml`.
 
-    defaults: &defaults
-      fog_provider: "AWS"
-      fog_directory: "rails-app-assets"
-      aws_access_key_id: "<%= ENV['AWS_ACCESS_KEY_ID'] %>"
-      aws_secret_access_key: "<%= ENV['AWS_SECRET_ACCESS_KEY'] %>"
-      # You may need to specify what region your storage bucket is in
-      # fog_region: "eu-west-1"
-      existing_remote_files: keep # Existing pre-compiled assets on S3 will be kept
-      # 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
-
-    test:
-      <<: *defaults
-
-    production:
-      <<: *defaults
+``` yaml
+defaults: &defaults
+  fog_provider: "AWS"
+  fog_directory: "rails-app-assets"
+  aws_access_key_id: "<%= ENV['AWS_ACCESS_KEY_ID'] %>"
+  aws_secret_access_key: "<%= ENV['AWS_SECRET_ACCESS_KEY'] %>"
+  # You may need to specify what region your storage bucket is in
+  # fog_region: "eu-west-1"
+  existing_remote_files: keep # Existing pre-compiled assets on S3 will be kept
+  # 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
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults
+```
 
 ### Environment Variables
 
@@ -154,9 +138,11 @@ Add your Amazon S3 configuration details to **heroku**
 
 Or add to a traditional unix system
 
-    export AWS_ACCESS_KEY_ID=xxxx
-    export AWS_SECRET_ACCESS_KEY=xxxx
-    export FOG_DIRECTORY=xxxx
+``` bash
+export AWS_ACCESS_KEY_ID=xxxx
+export AWS_SECRET_ACCESS_KEY=xxxx
+export FOG_DIRECTORY=xxxx
+```
 
 ### Available Configuration Options
 
@@ -192,16 +178,20 @@ Or add to a traditional unix system
 
 If you are using anything other than the US buckets with S3 then you'll want to set the **region**. For example with an EU bucket you could set the following with YAML.
 
-    production:
-      # ...
-      aws_region: 'eu-west-1'
+``` yaml
+production:
+  # ...
+  aws_region: 'eu-west-1'
+```
 
 Or via the initializer
 
-    AssetSync.configure do |config|
-      # ...
-      config.fog_region = 'eu-west-1'
-    end
+``` ruby
+AssetSync.configure do |config|
+  # ...
+  config.fog_region = 'eu-west-1'
+end
+```
 
 ## Automatic gzip compression
 
@@ -219,10 +209,12 @@ To prevent this part of the deploy from failing (asset_sync raising a config err
 
 A rake task is included in asset\_sync to enhance the rails precompile task by automatically running after it:
 
-    # asset_sync/lib/tasks/asset_sync.rake
-    Rake::Task["assets:precompile"].enhance do
-      AssetSync.sync
-    end
+``` ruby
+# asset_sync/lib/tasks/asset_sync.rake
+Rake::Task["assets:precompile"].enhance do
+  AssetSync.sync
+end
+```
 
 ## Todo
 

data/asset_sync.gemspec

@@ -6,7 +6,7 @@ require "asset_sync/version"
 Gem::Specification.new do |s|
   s.name        = "asset_sync"
   s.version     = AssetSync::VERSION
-  s.date        = "2012-02-16"
+  s.date        = "2012-03-04"
   s.platform    = Gem::Platform::RUBY 
   s.authors     = ["Simon Hamilton", "David Rice", "Phil McClure"]
   s.email       = ["shamilton@rumblelabs.com", "me@davidjrice.co.uk", "pmcclure@rumblelabs.com"]

data/docs/heroku.md

@@ -0,0 +1,36 @@
+The following issues are currently present in Heroku if you are not following the steps outlined in the main [README](http://github.com/rumblelabs/asset_sync)
+
+## KNOWN ISSUES (IMPORTANT)
+
+We are currently trying to talk with Heroku to iron these out.
+
+1. Will not work on heroku on an application with a *RAILS_ENV* configured as anything other than production
+2. Will not work on heroku using ENV variables with the configuration as described below, you must hardcode all variables
+
+### 1. RAILS_ENV
+
+When you see `rake assets:precompile` during deployment. Heroku is actually running something like
+
+    env RAILS_ENV=production DATABASE_URL=scheme://user:pass@127.0.0.1/dbname bundle exec rake assets:precompile 2>&1
+
+This means the *RAILS_ENV* you have set via *heroku:config* is not used.
+
+**Workaround:** you could have just one S3 bucket dedicated to assets and ensure to set keep the existing remote files
+
+    AssetSync.configure do |config|
+      ...
+      config.fog_directory = 'app-assets'
+      config.existing_remote_files = "keep"
+    end
+
+### 2. ENV varables not available
+
+Currently when heroku runs `rake assets:precompile` during deployment. It does not load your Rails application's environment config. This means using any **ENV** variables you could normally depend on are not available. For now you can just run `heroku run rake assets:precompile` after deploy.
+
+**Workaround:** you could just hardcode your AWS credentials in the initializer or yml
+
+    AssetSync.configure do |config|
+      config.aws_access_key_id = 'xxx'
+      config.aws_secret_access_key = 'xxx'
+      config.fog_directory = 'mybucket'
+    end

data/lib/asset_sync/config.rb

@@ -71,7 +71,7 @@ module AssetSync
     end
 
     def yml
-      y ||= YAML.load(ERB.new(IO.read(yml_path)).result)[Rails.env] rescue nil || {}
+      @yml ||= YAML.load(ERB.new(IO.read(yml_path)).result)[Rails.env] rescue nil || {}
     end
 
     def yml_path

data/lib/asset_sync/version.rb

@@ -1,3 +1,3 @@
 module AssetSync
-  VERSION = "0.2.10"
+  VERSION = "0.2.11"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asset_sync
 version: !ruby/object:Gem::Version
-  version: 0.2.10
+  version: 0.2.11
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-16 00:00:00.000000000Z
+date: 2012-03-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
-  requirement: &70301574351660 !ruby/object:Gem::Requirement
+  requirement: &70259782223240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70301574351660
+  version_requirements: *70259782223240
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &70301574350960 !ruby/object:Gem::Requirement
+  requirement: &70259782222820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70301574350960
+  version_requirements: *70259782222820
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70301574349740 !ruby/object:Gem::Requirement
+  requirement: &70259782222400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70301574349740
+  version_requirements: *70259782222400
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70301574348040 !ruby/object:Gem::Requirement
+  requirement: &70259782221980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70301574348040
+  version_requirements: *70259782221980
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70301574346200 !ruby/object:Gem::Requirement
+  requirement: &70259782221560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,7 +67,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70301574346200
+  version_requirements: *70259782221560
 description: After you run assets:precompile your compiled assets will be synchronised
   with your S3 bucket.
 email:
@@ -83,6 +83,7 @@ files:
 - README.md
 - Rakefile
 - asset_sync.gemspec
+- docs/heroku.md
 - lib/asset_sync.rb
 - lib/asset_sync/asset_sync.rb
 - lib/asset_sync/config.rb