virtual_asset_path 0.1.0

data/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+
+group :dev do
+  gem 'actionpack', ENV['RAILS']
+  gem 'redgreen'
+  gem 'rspec', '~>2'
+  gem 'rake'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,55 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionpack (3.0.8)
+      activemodel (= 3.0.8)
+      activesupport (= 3.0.8)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.8)
+      activesupport (= 3.0.8)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.8)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rake (0.9.2)
+    redgreen (1.2.2)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    tzinfo (0.3.28)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack
+  jeweler
+  rake
+  redgreen
+  rspec (~> 2)

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/testtask'
+Rake::TestTask.new(:default) do |test|
+  test.libs << 'lib'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+task :all do
+  sh "RAILS=2.3.12 bundle && bundle exec rake"
+  sh "RAILS=3.0.8 bundle && bundle exec rake"
+#  sh "RAILS=3.1.0.rc4 bundle && bundle exec rake"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'virtual_asset_path'
+    gem.summary = "Instantly expired, cacheable assets, without query params"
+    gem.email = "michael@grosser.it"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,56 @@
+Virtual asset paths for great caching.
+
+ - cacheable without query params
+ - cached by MD5 of content (only change when the content changes / same on all servers)
+
+
+# Results
+
+    /foo/bar.jpg ... will be ...
+
+    # default + simple rewrite rules
+    /asset-v1afd23/foo/bar.jpg  # style: folder   method: MD5
+
+    # rails 3.1-ish, but complicated rewrite rules
+    /foo/bar-asset-v1afd23.jpg  # style: suffix   method: MD5
+
+    # no rewrite rule needed (great for development)
+    /foo/bar.jpg?1afd23         # style: query    method: MD5
+
+    # different methods ...
+    /asset-v1308942465/foo/bar.jpg  # style: folder   method: mtime
+    /asset-vxxx/foo/bar.jpg         # style: folder   method: ENV['RAILS_ASSET_ID'] = 'xxx'
+
+    # configure
+    VirtualAssetPath.style = :folder # default
+    VirtualAssetPath.style = :MD5    # default
+
+# Install
+(only tested on rails 2 atm)
+
+    ./script/plugin install git://github.com/grosser/virtual_asset_path.git
+Or
+    gem install virtual_asset_path
+
+# Nginx config
+
+    rewrite  ^/asset-v[a-z0-9]+(.*) $1; # style: folder
+    ??? # style: suffix
+
+# Apache config
+
+    ??? # style: folder
+    ??? # style: suffix
+
+# Tips
+ - [Speed] MD5 takes ~0.1 ms/file (results are cached per instance if cache_asset_timestamps is active)
+ - [Speed] mtime takes ~0.005 ms/file (...)
+
+# TODO
+ - Rails 3.1 support -- things got much more complicated ...
+
+Author
+======
+[Michael Grosser](http://grosser.it)<br/>
+michael@grosser.it<br/>
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require 'virtual_asset_path'

data/lib/virtual_asset_path.rb

@@ -0,0 +1,59 @@
+module VirtualAssetPath
+  VERSION = File.read( File.join(File.dirname(__FILE__),'..','VERSION') ).strip
+
+  class << self
+    attr_accessor :method, :style
+  end
+end
+
+module ActionView::Helpers::AssetTagHelper
+  def rewrite_asset_path_with_virtual_folder(*args)
+    asset_path = rewrite_asset_path_without_virtual_folder(*args)
+    id = virtual_asset_folder(asset_path)
+    if id.present?
+      case VirtualAssetPath.style
+      when :folder, nil then "/asset-v#{id}#{asset_path}"
+      when :query then "#{asset_path}?#{id}"
+      end
+    else
+      asset_path
+    end
+  end
+  alias_method_chain :rewrite_asset_path, :virtual_folder
+
+  def virtual_asset_folder(source)
+    if asset_id = ENV["RAILS_ASSET_ID"]
+      asset_id
+    else
+      if @@cache_asset_timestamps && (asset_id = @@asset_timestamps_cache[source])
+        asset_id
+      else
+        path = File.join(ASSETS_DIR, source)
+        asset_id = File.exist?(path) ? virtual_asset_folder_id(path) : ''
+
+        if @@cache_asset_timestamps
+          @@asset_timestamps_cache_guard.synchronize do
+            @@asset_timestamps_cache[source] = asset_id
+          end
+        end
+
+        asset_id
+      end
+    end
+  end
+
+  # overwrite to disable / use mtime ?
+  def virtual_asset_folder_id(path)
+    case VirtualAssetPath.method
+    when :md5,nil then Digest::MD5.file(path).hexdigest[0..6]
+    when :mtime then File.mtime(path).to_i.to_s
+    else
+      raise "unsupported hashing method"
+    end
+  end
+
+  # no longer needed <-> would conflict
+  def rails_asset_id(*args)
+    nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,76 @@
+require 'rubygems'
+require 'rspec'
+require 'active_support/all'
+require 'action_pack'
+require 'action_controller'
+require 'test/unit'
+require 'redgreen'
+$LOAD_PATH << 'lib'
+require 'init'
+
+class ActionView::Base
+  def debug(*args)
+    args.inspect
+  end
+
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::TagHelper
+end
+
+silence_warnings do
+  ActionView::Helpers::AssetTagHelper::ASSETS_DIR = 'test/public'
+end
+
+if ActionPack::VERSION::MAJOR > 2
+  require 'action_dispatch/testing/test_process'
+
+# fake checks
+  require 'ostruct'
+  module ActionController::UrlFor
+    def _routes
+      helpers = OpenStruct.new
+      helpers.url_helpers = Module.new
+      helpers
+    end
+  end
+
+  ROUTES = ActionDispatch::Routing::RouteSet.new
+  ROUTES.draw do
+    match ':controller(/:action(/:id(.:format)))'
+  end
+  ROUTES.finalize!
+
+# funky patch to get @routes working, in 'setup' did not work
+  module ActionController::TestCase::Behavior
+    def process_with_routes(*args)
+      @routes = ROUTES
+      process_without_routes(*args)
+    end
+    alias_method_chain :process, :routes
+  end
+
+  class ActionController::Base
+    self.view_paths = 'test/views'
+
+    def self._routes
+      ROUTES
+    end
+
+    def url_for(*args)
+      'xxx'
+    end
+  end
+else
+  require 'action_controller/test_process'
+
+  ActionController::Routing::Routes.reload rescue nil
+  ActionController::Base.cache_store = :memory_store
+
+  class ActionController::Base
+    before_filter :set_view_paths
+
+    def set_view_paths
+      @template.view_paths = 'test/views'
+    end
+  end
+end

data/test/views/virtual_asset_path_test/index.erb

@@ -0,0 +1 @@
+<%= image_tag params[:image], :alt => '' %>

data/test/virtual_asset_path_test.rb

@@ -0,0 +1,61 @@
+require 'test/test_helper'
+
+class VirtualAssetPathTestController < ActionController::Base
+  def index
+  end
+end
+
+#noinspection RubyArgCount
+class VirtualAssetPathTest < ActionController::TestCase
+  def setup
+    VirtualAssetPath.method = nil
+    VirtualAssetPath.style = nil
+    ENV["RAILS_ASSET_ID"] = nil
+    @controller = VirtualAssetPathTestController.new
+    ActionView::Base.send :class_variable_set, '@@asset_timestamps_cache', {}
+    ActionView::Base.send :class_variable_set, '@@cache_asset_timestamps', true
+  end
+
+  test "adds folder to found assets" do
+    get :index, :image => '/bar/foo.jpg'
+    @response.body.strip.should == "<img alt=\"\" src=\"/asset-vd41d8cd/bar/foo.jpg\" />"
+  end
+
+  test "does not add virtual path to unknown assets" do
+    get :index, :image => '/bar/not_found.jpg'
+    @response.body.strip.should == "<img alt=\"\" src=\"/bar/not_found.jpg\" />"
+  end
+
+  test "adds RAILS_ASSET_ID to found assets" do
+    ENV["RAILS_ASSET_ID"] = 'abc'
+    get :index, :image => '/bar/foo.jpg'
+    @response.body.strip.should == "<img alt=\"\" src=\"/asset-vabc/bar/foo.jpg\" />"
+  end
+
+  test "caches found asset ids" do
+    file = 'test/public/cached.jpg'
+    hash = '0cc175b'
+
+    begin
+      File.open(file,'w'){|f| f.write 'a' }
+      get :index, :image => '/cached.jpg'
+      @response.body.strip.should == "<img alt=\"\" src=\"/asset-v#{hash}/cached.jpg\" />"
+
+      File.open(file,'w'){|f| f.write 'b' }
+      get :index, :image => '/cached.jpg'
+      @response.body.strip.should == "<img alt=\"\" src=\"/asset-v#{hash}/cached.jpg\" />"
+    ensure
+      `rm #{file}`
+    end
+  end
+
+  test "caches with mtime" do
+    VirtualAssetPath.method = :mtime
+    get :index, :image => '/bar/foo.jpg'
+    @response.body.strip.should == "<img alt=\"\" src=\"/asset-v#{File.mtime('test/public/bar/foo.jpg').to_i}/bar/foo.jpg\" />"
+  end
+
+  test "has a version" do
+    VirtualAssetPath::VERSION.should =~ /^\d+\.\d+\.\d+$/
+  end
+end

data/virtual_asset_path.gemspec

@@ -0,0 +1,42 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{virtual_asset_path}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = %q{2011-06-25}
+  s.email = %q{michael@grosser.it}
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "init.rb",
+    "lib/virtual_asset_path.rb",
+    "test/public/bar/foo.jpg",
+    "test/test_helper.rb",
+    "test/views/virtual_asset_path_test/index.erb",
+    "test/virtual_asset_path_test.rb",
+    "virtual_asset_path.gemspec"
+  ]
+  s.homepage = %q{http://github.com/grosser/virtual_asset_path}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Instantly expired, cacheable assets, without query params}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: virtual_asset_path
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Michael Grosser
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-25 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: 
+email: michael@grosser.it
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+- VERSION
+- init.rb
+- lib/virtual_asset_path.rb
+- test/public/bar/foo.jpg
+- test/test_helper.rb
+- test/views/virtual_asset_path_test/index.erb
+- test/virtual_asset_path_test.rb
+- virtual_asset_path.gemspec
+has_rdoc: true
+homepage: http://github.com/grosser/virtual_asset_path
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Instantly expired, cacheable assets, without query params
+test_files: []
+