asset_hash 0.1

data/Gemfile

@@ -0,0 +1,9 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.5"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright 2011 Donald Piret
+
+This code was inspired by the https://github.com/moocode/asset_id project by Richard Taylor
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -0,0 +1,44 @@
+h1. AssetHash
+
+h2. About
+
+AssetHash is a gem that allows you to easily generate unique paths for your static assets in order to avoid caching issues.
+Its main purpose is to allow you to use Amazon Cloudfront with a custom origin policy to serve your static assets easily.
+
+It uses an MD5 hash of your static asset to modify the filename, so only changed files will result in a different filename.
+
+It also comes with a rake task to automatically create hashed versions of your asset filenames, useful for deployments.
+
+h2. Usage
+
+Add the gem to your Gemfile
+
+<code>gem "asset_hash"</code>
+
+Set up a CloudFront distribution with a custom origin that points to your website's URL.
+
+Check the following website as well as the Amazon CloudFront documentation for help on setting up a custom origin CloudFront distribution:
+http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/index.html?DistributionConfigDatatype.html#CustomOriginChildElements
+
+Configure your environment file to use this CloudFront distribution as your asset host and the hashed filenames in the helpers.
+
+<pre><code>config.action_controller.asset_host = Proc.new do |source, request|
+  request.ssl? ? "https://distributionID.cloudfront.net" : "http://distributionID.cloudfront.net"
+end
+config.action_controller.asset_path = Proc.new do |source|
+  AssetHash.fingerprint(source)
+end
+</code></pre>
+
+Set up your deployment file (Capistrano, Chef callback or other) to run the included rake task on deploy
+
+<code>rake asset:hash:generate</code>
+
+This will copy all your assets from a path like <code>stylesheets/application.css</code> to something like <code>stylesheets/applications-234fe3b632356brdedf3115ee743250.css</code> and create a gzipped version as well at <code>stylesheets/applications-234fe3b632356brdedf3115ee743250.css.gz</code>
+This ensures that when CloudFront caches your static assets, it will always serve the up-to-date version.
+
+The code by default plays nice with Jammit by including the assets directory to the default images, javascripts and stylesheets directories, and you can customize which directories are scanned for assets using <code>AssetHash::Base.asset_paths = ['custom', 'directories']</code>
+
+h2. License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AssetHash'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/asset_hash.rb

@@ -0,0 +1,87 @@
+require 'digest/md5'
+require 'time'
+require 'mime/types'
+require 'asset_hash/railtie' if defined?(Rails)
+
+module AssetHash
+  def self.process!
+    AssetHash::Base.process!
+  end
+
+  def self.fingerprint(path)
+    AssetHash::Base.fingerprint(path)
+  end
+
+  class Base
+    DEFAULT_ASSET_PATHS = ['favicon.ico', 'images', 'javascripts', 'stylesheets', 'assets']
+    @@asset_paths = DEFAULT_ASSET_PATHS
+
+    DEFAULT_GZIP_TYPES = ['text/css', 'application/javascript']
+    @@gzip_types = DEFAULT_GZIP_TYPES
+
+    def self.gzip_types=(types)
+      @@gzip_types = types
+    end
+
+    def self.gzip_types
+      @@gzip_types
+    end
+
+    def self.path_prefix
+      File.join Rails.root, 'public'
+    end
+
+    def self.asset_paths=(paths)
+      @@asset_paths = paths
+    end
+
+    def self.asset_paths
+      @@asset_paths
+    end
+
+    def self.absolute_path(path)
+      File.join path_prefix, path
+    end
+
+    def self.assets
+      asset_paths.inject([]) {|assets, path|
+        path = absolute_path(path)
+        assets << path if File.exists? path and !File.directory? path
+        assets += Dir.glob(path+'/**/*').inject([]) {|m, file|
+          m << file unless File.directory? file; m
+        }
+      }
+    end
+
+    def self.fingerprint(path)
+      path = File.join path_prefix, path unless path =~ /#{path_prefix}/
+      d = Digest::MD5.file(path).hexdigest
+      path = path.gsub(path_prefix, '')
+      extension = (path =~ /\.gz$/ ? File.extname(File.basename(path, ".gz")) + ".gz" : File.extname(path))
+      File.join File.dirname(path), "#{File.basename(path, extension)}-#{d}#{extension}"
+    end
+
+    def self.original_path(path)
+      path = File.join path_prefix, path unless path =~ /#{path_prefix}/
+      path = path.gsub(path_prefix, '')
+      extension = (path =~ /\.gz$/ ? File.extname(File.basename(path, ".gz")) + ".gz" : File.extname(path))
+      File.join File.dirname(path), "#{File.basename(path, extension)}#{extension}"
+    end
+
+    def self.process!
+      assets.each do |asset|
+        mime_type = MIME::Types.of(asset).first.to_s
+        if gzip_types.include?(mime_type) && !File.exists?(asset + ".gz")
+          # You can GZIP the type of this file and no gzipped version was found already
+          # Gzip the original asset then move it to the right filename
+          gz_path = asset + ".gz"
+          `gzip -c "#{asset}" > "#{gz_path}"`
+          FileUtils.mv(gz_path, File.join(path_prefix, fingerprint(asset) + ".gz"))
+        end
+        FileUtils.cp(asset, File.join(path_prefix, fingerprint(asset)))
+      end
+    end
+
+  end
+
+end

data/lib/asset_hash/railtie.rb

@@ -0,0 +1,9 @@
+require 'asset_hash'
+require 'rails'
+module AssetHash
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/asset_hash.rake"
+    end
+  end
+end

data/lib/tasks/asset_hash.rake

@@ -0,0 +1,10 @@
+require 'asset_hash'
+
+namespace :asset do
+  namespace :hash do
+    desc 'Generate the assets with the hashed filenames'
+    task :generate do
+      AssetHash.process!
+    end
+  end
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: asset_hash
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: "0.1"
+platform: ruby
+authors: []
+
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.16"
+  type: :runtime
+  version_requirements: *id001
+description: This gem allows you to copy your static assets to a versions including a unique hash in the filename. By using this and modifying your Rails asset path you can easily serve static content on Cloudfront using the custom origin policy.
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/asset_hash/railtie.rb
+- lib/asset_hash.rb
+- lib/tasks/asset_hash.rake
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.textile
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 2
+summary: Asset hasher for Cloudfront custom origin domain asset hosting.
+test_files: []
+