ettu 0.0.1 → 0.0.2

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--profile

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/README.md

@@ -1,6 +1,19 @@
 # Ettu
 
-TODO: Write a gem description
+Using Rails 4's `stale?` or `fresh_when`? Are your users seeing old view
+code even after new deploys? The Rails way `fresh_when(@product)`
+doesn't account for changes in your view code, you have to do it
+yourself.
+
+Ettu (loosely translated "And calculate you, too?") transparently
+accounts for the current action's view code (JavaScript, CSS, templates)
+using the same [asset fingerprints]
+(http://guides.rubyonrails.org/asset_pipeline.html#what-is-fingerprinting-and-why-should-i-care-questionmark)
+and Russian Doll [cache digests]
+(https://github.com/rails/cache_digests#readme) used by Rails. It does
+all of this while allowing you to use the same syntax you're already
+accustomed to. So keep doing what you're doing, and let Ettu worry about
+changes to your view code.
 
 ## Installation
 
@@ -12,18 +25,68 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Usage
 
-    $ gem install ettu
+Rails 4 ETags can be used in the following way:
 
-## Usage
+```ruby
+class ProductsController < ApplicationController
+    def show
+        @product = Product.find(params[:id])
+
+        # Sugar syntax
+        fresh_when @product
+
+        # Hash syntax
+        fresh_when etag: @product, last_modified: @product.updated_at, public: true
+    end
+end
+```
+
+Ettu wants you to keep using either syntax, and let it worry about the
+view code. By default, it will add in the asset fingerprints of
+`application.js` and `application.css` along with the cache digest of
+the current action into the calculation for the final ETag sent to the
+browser.
+
+### Configuring
+
+Of course, you can override Ettu's behavior. Using a custom js file?
+Just pass in like so:
+
+    fresh_when @product, js: 'custom.js'
+
+The same things goes for custom css files:
+
+    fresh_when @product, css: 'custom.css'
+
+Have several other assets you want to account for? Pass them in as an
+array with the `assets` key:
+
+    fresh_when @product, assets: ['first.css', 'second.js']
+
+You can specify a template with the `view` key:
+
+    fresh_when @product, "products/index"
+
+You can even stop Ettu from accounting for any of them by setting the
+value to `false`:
+
+    fresh_when @product, js: false, css: false, view: false
+
+
+### What about Rails' default `fresh_when`?
 
-TODO: Write usage instructions here
+Ettu tries its darndest to not interfere with Rails' default
+implementation. Ettu makes sure to pass all the options you specify to
+Rails (like the `public` option). It's even coded as a drop-in gem that
+won't cause problems if it's not installed.
 
 ## 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
+3. Code your feature, and add specs for it
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1 +1,6 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/ettu.gemspec

@@ -4,23 +4,22 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ettu/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "ettu"
+  spec.name          = 'ettu'
   spec.version       = Ettu::VERSION
-  spec.authors       = ["Justin Ridgewell"]
-  spec.email         = ["jridgewell@cloudspace.com"]
+  spec.authors       = ['Justin Ridgewell']
+  spec.email         = ['jridgewell@cloudspace.com']
   spec.description   = %q{Account for js, css, and views when using ETags.}
   spec.summary       = %q{Account for view code when using ETags.}
-  spec.homepage      = "http://github.com/cloudspace/ettu"
-  spec.license       = "MIT"
+  spec.homepage      = 'http://github.com/cloudspace/ettu'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'actionpack', '>= 4.0'
-  spec.add_dependency 'activesupport', '>= 4.0'
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_dependency 'rails', '>= 4.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
 end

data/lib/ettu/ettu.rb

@@ -0,0 +1,68 @@
+module Ettu
+  class Ettu
+    attr_reader :options
+
+    def initialize(record_or_options = nil, additional_options = {})
+      if record_or_options.is_a? Hash
+        @record = nil
+        @options = record_or_options
+      else
+        @record = record_or_options
+        @options = additional_options
+      end
+      @asset_etags = []
+    end
+
+    def response_etag
+      @options.fetch(:etag, @record)
+    end
+
+    def last_modified
+      @options.fetch(:last_modified, @record.try(:updated_at))
+    end
+
+    def view_etag(view)
+      @view_etag ||= view_digest(view)
+    end
+
+    def asset_etag(asset)
+      @asset_etags[asset] ||= asset_digest(asset)
+    end
+
+    def js_etag
+      js = @options.fetch(:js, 'application.js')
+      asset_etag js
+    end
+
+    def css_etag
+      css = @options.fetch(:css, 'application.css')
+      asset_etag css
+    end
+
+    private
+
+    # Jeremy Kemper
+    # https://gist.github.com/jeremy/4211803
+    def view_digest(view)
+      CacheDigests::TemplateDigestor.digest(
+        view,
+        request.format.try(:to_sym),
+        lookup_context
+      )
+    rescue ActionView::MissingTemplate
+      '' # Ignore missing templates
+    end
+
+    # Jeremy Kemper
+    # https://gist.github.com/jeremy/4211803
+    # Check precompiled asset manifest (production) or compute the digest (dev).
+    def asset_digest(asset)
+      return nil unless asset.present?
+      if manifest = Rails.application.config.assets.digests
+        manifest[asset]
+      else
+        Rails.application.assets[asset].digest
+      end
+    end
+  end
+end

data/lib/ettu/fresh_when.rb

@@ -0,0 +1,29 @@
+module Ettu
+  module FreshWhen
+    extend ActiveSupport::Concern
+
+    included do
+      alias_method :old_fresh_when, :fresh_when
+
+      def fresh_when(record_or_options, additional_options = {})
+        ettu = Ettu.new(record_or_options, additional_options)
+
+        etags = [*ettu.response_etag]
+        if view = ettu.options.fetch(:view, "#{controller_name}/#{action_name}")
+          etags << ettu.view_etag(view)
+        end
+        if request.format.try(:html?)
+          etags << ettu.js_etag
+          etags << ettu.css_etag
+        end
+        assets = ettu.options.fetch(:assets, []).map { |asset| ettu.asset_etag(asset) }
+        etags.concat assets
+
+        ettu_params = {etag: etags, last_modified: ettu.last_modified}
+
+        old_fresh_when nil, ettu.options.merge(ettu_params)
+      end
+
+    end
+  end
+end

data/lib/ettu/railtie.rb

@@ -0,0 +1,11 @@
+module Ettu
+  class Railtie < ::Rails::Railtie
+    initializer 'install' do
+      require 'ettu'
+
+      ActiveSupport.on_load :action_controller do
+        ActionController::Base.send :include, Ettu::FreshWhen
+      end
+    end
+  end
+end

data/lib/ettu/version.rb

@@ -1,3 +1,3 @@
 module Ettu
-  VERSION = "0.0.1"
+  VERSION = '0.0.2'
 end

data/lib/ettu.rb

@@ -1,5 +1,8 @@
-require "ettu/version"
+require 'active_support/concern'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/object/try'
 
-module Ettu
-  # Your code goes here...
-end
+require 'ettu/version'
+require 'ettu/ettu'
+require 'ettu/fresh_when'
+require 'ettu/railtie' if defined? Rails

data/spec/ettu_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+Record = Struct.new(:updated_at)
+Nested = Struct.new(:nil) do
+  def [](name)
+    nil
+  end
+  def method_missing(name, *args, &block)
+    return self
+  end
+end
+module Rails
+  module Railtie; end
+
+  def self.application
+    Nested.new(nil)
+  end
+end
+
+describe Ettu::Ettu do
+  let(:record) { Record.new(DateTime.now) }
+  let(:hash) { { etag: record, last_modified: DateTime.now, public: false, random: true } }
+
+  context 'when supplied with :js option' do
+    xit "returns hash[:js]'s fingerprint as #js_etag"
+  end
+
+  context 'when supplied with :css option' do
+    xit "returns hash[:css]'s fingerprint as #css_etag"
+  end
+
+  xit '#view_etag'
+
+  context 'when given only a record' do
+    subject(:ettu) { Ettu::Ettu.new(record) }
+
+    it 'makes #options an empty hash' do
+      expect(ettu.options).to be_a(Hash)
+    end
+
+    it 'uses record as #response_etag' do
+      expect(ettu.response_etag).to eq(record)
+    end
+
+    it "uses record's #updated_at for #last_modified" do
+      expect(ettu.last_modified).to eq(record.updated_at)
+    end
+  end
+
+  context 'when given only a hash' do
+    subject(:ettu) { Ettu::Ettu.new(hash) }
+
+    it 'sets #options to that hash' do
+      expect(ettu.options).to eq(hash)
+    end
+
+    it 'uses hash[:etag] as #response_etag' do
+      expect(ettu.response_etag).to eq(hash[:etag])
+    end
+
+    it 'uses hash[:last_modified] as #last_modified' do
+      expect(ettu.last_modified).to eq(hash[:last_modified])
+    end
+  end
+
+  context 'when given a record and hash' do
+    let(:hash) { { public: true } }
+    subject(:ettu) { Ettu::Ettu.new(record, hash) }
+
+    describe '#response_etag' do
+      it 'uses record as #response_etag' do 
+        expect(ettu.response_etag).to eq(record)
+      end
+
+      context 'when supplied with hash with :etag' do
+        let(:hash) { { etag: 'hash' } }
+
+        it 'overrides #response_etag with hash[:etag]' do
+          expect(ettu.response_etag).to eq(hash[:etag])
+        end
+      end
+    end
+
+    describe '#last_modified' do
+      it "uses record's #updated_at as #last_modified" do 
+        expect(ettu.last_modified).to eq(record.updated_at)
+      end
+
+      context 'when supplied with hash with :last_modified' do
+        let(:hash) { { last_modified: 'now' } }
+
+        it 'overrides #last_modified with hash[:last_modified]' do
+          expect(ettu.last_modified).to eq(hash[:last_modified])
+        end
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'ettu'
+require 'date'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.order = 'random'
+end

metadata

@@ -1,46 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: ettu
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
+  prerelease: 
 platform: ruby
 authors:
 - Justin Ridgewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-28 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: actionpack
+  name: rails
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '4.0'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '4.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -48,6 +38,7 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -55,29 +46,33 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   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: Account for js, css, and views when using ETags.
@@ -88,35 +83,45 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - ettu.gemspec
 - lib/ettu.rb
+- lib/ettu/ettu.rb
+- lib/ettu/fresh_when.rb
+- lib/ettu/railtie.rb
 - lib/ettu/version.rb
+- spec/ettu_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/cloudspace/ettu
 licenses:
 - MIT
-metadata: {}
 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: 2.0.0
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Account for view code when using ETags.
-test_files: []
+test_files:
+- spec/ettu_spec.rb
+- spec/spec_helper.rb

checksums.yaml

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: 24ca5006437908efcc5679dd16d5ff35e4190f26
-  data.tar.gz: 331355145e661214c76452e0989dc43fd983c9e4
-SHA512:
-  metadata.gz: afce7dcd1072974e6c70317a43715d82cd9c4c1cfa1c7dc4d2ff4579109b2b89f9983e7e7274935178f6f7f15f718cfbd09f9acf8caa4b453f891c9af3cbc2ac
-  data.tar.gz: bdbbdf8a4f77456dcb144c59d232258e08a44b3687035b63767e5b23b7f3213f0459e44edc6521896b2f92f535fc89c72daf7573e6248eb795b2e1110035665d