asset_timestamps_cache 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+public/*

data/README.md

@@ -0,0 +1,53 @@
+AssetTimestampsCache
+====================
+
+A simple asset timestamping solution. Adapted from asset timestamping functionality in ActionPack.
+
+Allows you to set far-future expires headers on images, stylesheets, javascripts, flash etc. and
+bust the browser's cache only when the file has changed.
+
+For more on far-future expires headers, see [http://developer.yahoo.com/performance/rules.html#expires](http://developer.yahoo.com/performance/rules.html#expires)
+
+
+View Helper
+===========
+
+AssetTimestampsCache::ViewHelper contains an timestamped_asset_path method,
+which appends a timestamp of the file's last modified time to the asset path.
+
+So,
+
+    <%= timestamped_asset_path "images/logo.png" %>
+
+will output:
+
+    "images/logo.png?1267564623"
+
+This timestamp value is cached, so that subsequent calls don't need to hit the filesystem.
+
+Sinatra setup example:
+
+    class MyApp < Sinatra::Base
+      helper AssetTimestampsCache::ViewHelper
+
+      # etc...
+    end
+
+
+Direct Cache Access
+===================
+
+    # Will look for "public/images/log.png" and get last modified time.
+    # Subsequent lookups will read from internal hash cache instead of filesystem
+    AssetTimestampsCache["images/logo.png"] # => "1267564623"
+
+    # Change asset directory from default of "public"
+    AssetTimestampsCache.asset_dir = 'assets'
+
+    # Clear cache
+    AssetTimestampsCache.clear
+
+
+Caveat: NOT THREADSAFE. This shouldn't be a problem if you're deploying to Passenger.
+One could always add a Mutex around cache writes (as ActionPack does) if thread safety
+is an issue.

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end
+task :default => :test
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "asset_timestamps_cache"
+    gemspec.summary = "A simple asset timestamping solution."
+    gemspec.description = "Adapted from asset timestamping functionality in ActionPack."
+    gemspec.email = "gbuesing@gmail.com"
+    gemspec.homepage = "http://github.com/gbuesing/asset_timestamps_cache"
+    gemspec.authors = ["Geoff Buesing"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION

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

data/lib/asset_timestamps_cache.rb

@@ -0,0 +1,35 @@
+module AssetTimestampsCache
+
+  @@asset_timestamps_cache = {}
+  @@asset_dir = 'public'
+
+  def self.asset_dir
+    @@asset_dir
+  end
+
+  def self.asset_dir=(val)
+    @@asset_dir = val
+  end
+
+  def self.[](asset_path)
+    if timestamp = @@asset_timestamps_cache[asset_path]
+      timestamp
+    else
+      file_path = File.join(*[@@asset_dir, asset_path].compact)
+      timestamp = File.exist?(file_path) ? File.mtime(file_path).to_i.to_s : ''
+      @@asset_timestamps_cache[asset_path] = timestamp
+    end
+  end
+
+  def self.clear
+    @@asset_timestamps_cache.clear
+  end
+
+  module ViewHelper
+    def timestamped_asset_path(asset_path)
+      timestamp = AssetTimestampsCache[asset_path]
+      "#{asset_path}?#{timestamp}"
+    end
+  end
+
+end

data/test/test_asset_timestamps_cache.rb

@@ -0,0 +1,49 @@
+require 'asset_timestamps_cache'
+require 'test/unit'
+require 'fileutils'
+require 'rubygems'
+require 'mocha'
+
+class TestAssetTimestampsCache < Test::Unit::TestCase
+  def setup
+    AssetTimestampsCache.clear
+    FileUtils.mkdir_p 'public'
+  end
+
+  def test_returns_mtime_for_file
+    FileUtils.touch 'public/fixture.txt'
+    mtime = File.mtime('public/fixture.txt').to_i.to_s
+    assert_equal mtime, AssetTimestampsCache['fixture.txt']
+  end
+
+  def test_returns_blank_string_for_nonexistent_file
+    assert_equal '', AssetTimestampsCache['nonexistent.txt']
+  end
+
+  def test_only_calls_file_mtime_once_on_repeated_access
+    File.expects(:mtime).once.returns '12345'
+    5.times do
+      assert_equal '12345', AssetTimestampsCache['fixture.txt']
+    end
+  end
+end
+
+class TestAssetTimestampsCacheViewHelper < Test::Unit::TestCase
+  class Foo; include(AssetTimestampsCache::ViewHelper); end
+
+  def setup
+    AssetTimestampsCache.clear
+    FileUtils.mkdir_p 'public'
+    @scope = Foo.new
+  end
+
+  def test_timestamped_asset_path
+    FileUtils.touch 'public/fixture.txt'
+    mtime = File.mtime('public/fixture.txt').to_i.to_s
+    assert_equal "fixture.txt?#{mtime}", @scope.timestamped_asset_path('fixture.txt')
+  end
+
+  def test_timestamped_asset_path_for_nonexistent_asset
+    assert_equal "nonexistent.txt?", @scope.timestamped_asset_path('nonexistent.txt')
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: asset_timestamps_cache
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Geoff Buesing
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-02 00:00:00 -06:00
+default_executable: 
+dependencies: []
+
+description: Adapted from asset timestamping functionality in ActionPack.
+email: gbuesing@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- .gitignore
+- README.md
+- Rakefile
+- VERSION
+- lib/asset_timestamps_cache.rb
+- test/test_asset_timestamps_cache.rb
+has_rdoc: true
+homepage: http://github.com/gbuesing/asset_timestamps_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple asset timestamping solution.
+test_files: 
+- test/test_asset_timestamps_cache.rb