etag_for 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.rbc
+*.sassc
+.sass-cache
+capybara-*.html
+.rspec
+/.bundle
+/vendor/bundle
+/log/*
+/tmp/*
+/db/*.sqlite3
+/public/system/*
+/coverage/
+/spec/tmp/*
+**.orig
+rerun.txt
+pickle-email-*.html
+
+*~

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3-p286@etag_for --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in etag_for.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    etag_for (0.0.1)
+      activesupport (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (3.2.11)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    i18n (0.6.1)
+    metaclass (0.0.1)
+    minitest (4.4.0)
+    mocha (0.13.1)
+      metaclass (~> 0.0.1)
+    multi_json (1.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  etag_for!
+  minitest
+  mocha

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tom Fakes
+
+MIT License
+
+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.md

@@ -0,0 +1,118 @@
+# EtagFor
+
+Allow an ActionController action to include CSS, Javascript, View and Layout code as pieces for the calculation of an action's ETAG header.  This allows
+browsers to get new responses from the server if the view code that renders the response changes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'etag_for'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install etag_for
+
+## Usage
+
+Typical etag usage for an Rails controller action looks like this:
+
+```ruby
+class FooController < ApplicationController
+
+  def show
+    @post = Post.find(params[:id])
+    fresh_when :etag => @post, :last_modified => @post.updated_at, :public => true
+  end
+
+end
+```
+
+This works great, any time the @post object gets updated, the ETag header won't match, and a new response will be generated.
+
+This doesn't catch the case where the view code, **post.html.erb** is updated.  Clients with an existing response, including proxy caches, will never get an
+updated response, as the ETag calculation doesn't include this part of the response.
+
+With the provided **etag_for** method, the rendering templates used by your application can be used as part of the ETag calculation.
+
+```ruby
+class FooController < ApplicationController
+
+  def show
+    @post = Post.find(params[:id])
+    fresh_when :etag => etag_for(@post, :layout => 'application.html.erb', :view => 'post/show.html.erb'), :last_modified => @post.updated_at, :public => true
+  end
+
+end
+```
+
+## etag_for(item_or_items, options = {})
+
+Returns an array of strings that can be used as an input to **fresh_when** and **stale?** to calculate an ETag value for the current request.
+
+### item_or_items parameter
+
+The single item or items array that is the basic data retrieved to be rendered.  In the example below, the index method has an array of posts, and the show method
+provides a single post object
+
+```ruby
+class FooController < ApplicationController
+
+  def index
+    @posts = Post.all
+    fresh_when :etag => etag_for(@posts, :layout => 'application.html.erb', :view => 'post/index.html.erb'), :last_modified => @posts.first.updated_at, :public => true
+  end
+
+  def show
+    @post = Post.find(params[:id])
+    fresh_when :etag => etag_for(@post, :layout => 'application.html.erb', :view => 'post/show.html.erb'), :last_modified => @post.updated_at, :public => true
+  end
+
+end
+```
+
+### options
+
+#### :css
+
+Specifiy the CSS file used by the layout for this action.  The asset pipeline name will be substituted, to get the hash digest of the CSS file as part of the 
+ETag
+
+default value if none is specified is **application**.  Supply an empty string for no CSS file.
+
+#### :js
+
+Specifiy the JS file used by the layout for this action.  The asset pipeline name will be substituted, to get the hash digest of the JS file as part of the 
+ETag
+
+default value if none is specified is **application**.  Supply an empty string for no JS file.
+
+#### :layout
+
+The name of the layout file used by this action.  An MD5 digest of this file will be part of the ETag calculation
+
+e.g. 'application.html.erb'
+
+#### :view
+
+The path and name of the view file used by this action.  An MD5 digest of this file will be part of the ETag calculation
+
+e.g. 'posts/show.html.erb'
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits
+
+[<img src="http://d1za39ny3bo0r4.cloudfront.net/assets/craz8-logo-8e807e1c44376d564da419a6d82ec5be.png">](http://craz8.com)
+
+EtagFor is maintained by CRAZ8

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+end
+
+desc "Run tests"
+task :default => :test

data/etag_for.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'etag_for/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "etag_for"
+  gem.version       = EtagFor::VERSION
+  gem.authors       = ["Tom Fakes"]
+  gem.email         = ["tom@craz8.com"]
+  gem.description   = "Provide etag support for actions with views and layouts"
+  gem.summary       = "Allow an action to include CSS, Javascript, View and Layout code as pieces for the calculation of an action's ETAG header"
+  gem.homepage      = "https://github.com/craz8/etag_for"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "activesupport", ">= 3.0"
+
+  gem.add_development_dependency "minitest"
+  gem.add_development_dependency "mocha"
+end

data/lib/etag_for/etag_for.rb

@@ -0,0 +1,41 @@
+module EtagFor
+  extend ActiveSupport::Concern
+
+  def etag_for(item_or_items, options = {})
+    css_file = options[:css] || 'application'
+    js_file = options[:js] || 'application'
+
+    files = []
+    files << "layouts/#{options[:layout]}" if options[:layout]
+    files << options[:view] if options[:view]
+    files += options[:files] if options[:files]
+
+    [ extract_keys(item_or_items) ].flatten + [ css_path(css_file), js_path(js_file) ] + digests_of(files)
+  end
+
+protected
+  def digests_of(file_list)
+    file_list.map do |file| 
+      Digest::MD5.hexdigest(File.read("#{Rails.root}/app/views/#{file}"))
+    end
+  end
+
+  def css_path(css_file)
+    view_context.stylesheet_path(css_file) if css_file && css_file.length > 0
+  end
+
+  def js_path(js_file)
+    view_context.javascript_path(js_file) if js_file && js_file.length > 0
+  end
+
+  def extract_keys(item_or_items)
+    if item_or_items.respond_to?(:map)
+      item_or_items.map do |item|
+        item.respond_to?(:cache_key) ? item.cache_key : item.to_param
+      end
+    else
+      item_or_items.respond_to?(:cache_key) ? item_or_items.cache_key : item_or_items.to_param
+    end
+  end
+
+end

data/lib/etag_for/railtie.rb

@@ -0,0 +1,11 @@
+module EtagFor
+  class Railtie < ::Rails::Railtie
+
+    initializer 'etag_for.initialize' do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send :include, EtagFor
+      end
+    end
+
+  end
+end

data/lib/etag_for/version.rb

@@ -0,0 +1,3 @@
+module EtagFor
+  VERSION = "0.1.0"
+end

data/lib/etag_for.rb

@@ -0,0 +1,4 @@
+require 'active_support'
+require "etag_for/version"
+require "etag_for/etag_for"
+require "etag_for/railtie" if defined? Rails 

data/test/etag_for_test.rb

@@ -0,0 +1,99 @@
+require 'helper'
+
+class Rails
+  def self.root
+    ''
+  end
+end
+
+class TestController
+  include EtagFor
+
+  attr_accessor :view_context_mock
+  def view_context
+    @view_context_mock
+  end
+end
+
+describe EtagFor do
+
+  it "must convert file list to list of digests" do
+    file_list = [ "file_1", "file_2" ]
+    
+    File.stub :read, "12345678" do
+      digests = TestController.new.send(:digests_of, file_list)
+      digests.must_be_instance_of Array
+      digests.size.must_equal 2
+    end
+  end
+
+  it "must lookup stylesheet path if stylesheet given" do
+    view_context = MiniTest::Mock.new
+    view_context.expect :stylesheet_path, 'css-name', [ 'application' ]
+
+    controller = TestController.new
+    controller.view_context_mock = view_context
+
+    controller.send(:css_path, "application").must_equal "css-name"
+  end
+
+  it "must not lookup stylesheet path if no stylesheet given" do
+    TestController.new.send(:css_path, "").must_be_nil
+  end
+
+  it "must lookup javascript path if javascript given" do
+    view_context = MiniTest::Mock.new
+    view_context.expect :javascript_path, 'js-name', [ 'application' ]
+
+    controller = TestController.new
+    controller.view_context_mock = view_context
+
+    controller.send(:js_path, "application").must_equal "js-name"
+  end
+
+  it "must not lookup javascript path if no javascript given" do
+    TestController.new.send(:js_path, "").must_be_nil
+  end
+
+  it "must extract keys from item array with cache_key" do
+    item_1 = MiniTest::Mock.new
+    item_1.expect :cache_key, "foo"
+
+    item_2 = MiniTest::Mock.new
+    item_2.expect :cache_key, "bar"
+
+    TestController.new.send(:extract_keys, [ item_1, item_2 ]).must_equal [ "foo", "bar" ]
+  end
+
+  it "must extract key from a single item with cache_key" do
+    item_1 = MiniTest::Mock.new
+    item_1.expect :cache_key, "foo"
+
+    TestController.new.send(:extract_keys, item_1).must_equal "foo"
+  end
+
+  it "must extract keys from item array with out cache_key" do
+    item_1 = MiniTest::Mock.new
+    item_1.expect :to_param, "foo"
+
+    item_2 = MiniTest::Mock.new
+    item_2.expect :to_param, "bar"
+
+    TestController.new.send(:extract_keys, [ item_1, item_2 ]).must_equal [ "foo", "bar" ]
+  end
+
+  it "must extract key from a single item with out cache_key" do
+    item_1 = MiniTest::Mock.new
+    item_1.expect :to_param, "foo"
+
+    TestController.new.send(:extract_keys, item_1).must_equal "foo"
+  end
+
+  it "must return array from etag_for" do
+    item = MiniTest::Mock.new
+    item.expect :to_param, "foo"
+
+    TestController.new.etag_for(item, :css => "", :js => "").must_equal [ "foo", nil, nil ]
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'minitest/autorun'
+require 'etag_for'
+require 'mocha/setup'

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: etag_for
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Tom Fakes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provide etag support for actions with views and layouts
+email:
+- tom@craz8.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- etag_for.gemspec
+- lib/etag_for.rb
+- lib/etag_for/etag_for.rb
+- lib/etag_for/railtie.rb
+- lib/etag_for/version.rb
+- test/etag_for_test.rb
+- test/helper.rb
+homepage: https://github.com/craz8/etag_for
+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.8.24
+signing_key: 
+specification_version: 3
+summary: Allow an action to include CSS, Javascript, View and Layout code as pieces
+  for the calculation of an action's ETAG header
+test_files:
+- test/etag_for_test.rb
+- test/helper.rb