ettu 0.0.5 → 0.0.6

data/.rspec

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

data/ettu.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
 end

data/lib/ettu/configuration.rb

@@ -0,0 +1,30 @@
+class Ettu
+  class Configuration < ActiveSupport::OrderedOptions
+    def initialize
+      super
+      set_defaults
+    end
+
+    def reset
+      set_defaults
+    end
+
+    private
+
+    def set_defaults
+      self.js = 'application.js'
+      self.css = 'application.css'
+      self.assets = []
+
+      # Don't actually set view by default.
+      # This'll allow #fetch to return the real default
+      # at runtime.
+      # self.view = "#{controller_name}/#{action_name}"
+      delete :view if key? :view
+
+      if defined? ActionView::Digestor
+        self.template_digestor = ActionView::Digestor
+      end
+    end
+  end
+end

data/lib/ettu/fresh_when.rb

@@ -5,22 +5,19 @@ class Ettu
     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, self)
+      def fresh_when(record_or_options, additional_options)
+        ettu = ettu_instance(record_or_options, additional_options, self)
 
-        etags = [*ettu.response_etag]
-        etags << ettu.view_etag
-        if request.format.try(:html?)
-          etags << ettu.js_etag
-          etags << ettu.css_etag
-        end
-        etags.concat ettu.asset_etags
-
-        ettu_params = {etag: etags, last_modified: ettu.last_modified}
+        ettu_params = {etag: ettu.etags, last_modified: ettu.last_modified}
 
         old_fresh_when nil, ettu.options.merge(ettu_params)
       end
+    end
+
+    private
 
+    def ettu_instance(record_or_options, additional_options, controller)
+      Ettu.new record_or_options, additional_options, controller
     end
   end
 end

data/lib/ettu/version.rb

@@ -1,3 +1,3 @@
 class Ettu
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/ettu.rb

@@ -4,22 +4,15 @@ require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/object/try'
 
 require 'ettu/version'
+require 'ettu/configuration'
 require 'ettu/fresh_when'
-require 'ettu/railtie' if defined? Rails
+require 'ettu/railtie' if defined? Rails::Railtie
 
 class Ettu
   attr_reader :options
 
   class << self
-    @@config = ActiveSupport::OrderedOptions.new
-    @@config.js = 'application.js'
-    @@config.css = 'application.css'
-    @@config.assets = []
-    @@config.template_digestor = if defined? ActionView::Digestor
-                                   ActionView::Digestor
-                                 else
-                                   nil
-                                 end
+    @@config = Configuration.new
 
     def configure
       yield @@config
@@ -27,27 +20,36 @@ class Ettu
   end
 
   def initialize(record_or_options = nil, additional_options = {}, controller = nil)
-    @controller = controller
-    @asset_etags = {}
+    @controller, @asset_etags = controller, {}
     if record_or_options.is_a? Hash
-      @record = nil
-      @options = record_or_options
+      @record, @options = nil, record_or_options
     else
-      @record = record_or_options
-      @options = additional_options
+      @record, @options = record_or_options, additional_options
     end
   end
 
-  def response_etag
-    @options.fetch(:etag, @record)
+  def etags
+    etags = [*response_etag]
+    etags << view_etag
+    if @controller.request.format.try(:html?)
+      etags << js_etag
+      etags << css_etag
+    end
+    etags.concat asset_etags
   end
 
   def last_modified
     @options.fetch(:last_modified, @record.try(:updated_at))
   end
 
+  def response_etag
+    @options.fetch(:etag, @record)
+  end
+
   def view_etag
-    @view_etag ||= view_digest
+    default_view = @@config.fetch(:view, "#{@controller.controller_name}/#{@controller.action_name}")
+    view = @options.fetch(:view, default_view)
+    @view_etag ||= view_digest(view)
   end
 
   def js_etag
@@ -73,9 +75,10 @@ class Ettu
 
   # Jeremy Kemper
   # https://gist.github.com/jeremy/4211803
-  def view_digest
+  def view_digest(view)
+    return nil unless view.present?
     @@config.template_digestor.digest(
-      "#{@controller.controller_name}/#{@controller.action_name}",
+      view,
       @controller.request.format.try(:to_sym),
       @controller.lookup_context
     )
@@ -86,6 +89,8 @@ class Ettu
   # Check precompiled asset manifest (production) or compute the digest (dev).
   def asset_digest(asset)
     return nil unless asset.present?
+    # Is Rails.application.config.assets.digests needed?
+    # Seems to always be nil...
     if manifest = Rails.application.config.assets.digests
       manifest[asset]
     else

data/spec/ettu_spec.rb

@@ -1,41 +1,98 @@
 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
+describe Ettu do
+  let(:controller) { Controller.new }
+  let(:record) { Record.new(DateTime.now) }
+  let(:hash) { { etag: record, last_modified: DateTime.now } }
+  before(:all) do
+    Ettu.configure { |config| config.template_digestor = Digestor }
   end
-end
-module Rails
-  module Railtie; end
 
-  def self.application
-    Nested.new(nil)
-  end
-end
+  context 'when supplied with options' do
+    let(:hash) { { js: 'custom.js', css: 'custom.css', assets: 'first.ext', view: 'custom/action' } }
+    subject(:ettu) { Ettu.new(hash, {}, controller) }
 
-describe Ettu do
-  let(:record) { Record.new(DateTime.now) }
-  let(:hash) { { etag: record, last_modified: DateTime.now, public: false, random: true } }
+    it 'will use :js option over default' do
+      expect(ettu.js_etag).to eq('custom.js.digest')
+    end
 
-  context 'when supplied with :js option' do
-    xit "returns hash[:js]'s fingerprint as #js_etag"
-  end
+    it 'will use :css option over default' do
+      expect(ettu.css_etag).to eq('custom.css.digest')
+    end
 
-  context 'when supplied with :css option' do
-    xit "returns hash[:css]'s fingerprint as #css_etag"
+    it 'will use :asset option over default' do
+      expect(ettu.asset_etags).to eq(['first.ext.digest'])
+    end
+
+    it 'will use :view option over default' do
+      expect(ettu.view_etag).to eq('custom/action.digest')
+    end
   end
 
-  xit '#view_etag'
+  describe '.configure' do
+    subject(:ettu) { Ettu.new(nil, {}, controller) }
 
+    context 'when no options are specified' do
+      before(:all) do
+        Ettu.configure do |config|
+          config.js = 'custom.js'
+          config.css = 'custom.css'
+          config.assets = ['first.ext', 'second.ext']
+          config.view = 'custom/view'
+        end
+      end
+      after(:all) { Ettu.configure { |config| config.reset } }
 
-  context '.configure' do
+      it 'will use the default js file' do
+        expect(ettu.js_etag).to eq('custom.js.digest')
+      end
 
+      it 'will use the default css file' do
+        expect(ettu.css_etag).to eq('custom.css.digest')
+      end
+
+      it 'will use the default asset files' do
+        expect(ettu.asset_etags).to eq(['first.ext.digest', 'second.ext.digest'])
+      end
+
+      it 'will use the default view file' do
+        expect(ettu.view_etag).to eq('custom/view.digest')
+      end
+    end
+
+    context 'when setting default to false' do
+      before(:all) do
+        Ettu.configure do |config|
+          config.js = false
+          config.css = false
+          config.view = false
+        end
+      end
+      after(:all) { Ettu.configure { |config| config.reset } }
+
+      it 'will disable js etag' do
+        expect(ettu.js_etag).to eq(nil)
+      end
+
+      it 'will disable css etag' do
+        expect(ettu.css_etag).to eq(nil)
+      end
+
+      it 'will disable view etags' do
+        expect(ettu.view_etag).to eq(nil)
+      end
+    end
   end
 
+  describe '#etags' do
+    let(:ettu) { Ettu.new(record, {}, controller) }
+    it 'will collect all etags' do
+      expected = [record, 'controller_name/action_name.digest', 'application.js.digest', 'application.css.digest']
+      result = ettu.etags
+      expect(ettu.etags).to include(*expected)
+      expect(expected).to include(*result)
+    end
+  end
 
   context 'when given only a record' do
     subject(:ettu) { Ettu.new(record) }

data/spec/fixtures.rb

@@ -0,0 +1,49 @@
+class Nester < ActiveSupport::OrderedOptions
+  def initialize
+    super { |h, k| h[k] = Nester.new }
+  end
+end
+
+class Controller < Nester
+  def initialize
+    super
+
+    self.request.format['html?'] = true
+    self.controller_name = 'controller_name'
+    self.action_name = 'action_name'
+  end
+
+  def fresh_when(*args)
+    :old_fresh_when
+  end
+
+  include ::Ettu::FreshWhen
+end
+
+class Digestor
+  def self.method_missing(name, *args, &block)
+    args.first.to_s + '.digest'
+  end
+end
+
+class Record
+  attr_accessor :updated_at
+
+  def initialize(updated_at)
+    @updated_at = updated_at
+  end
+end
+
+module Rails
+  def self.application
+    @nested ||= Nester.new
+  end
+end
+Rails.application.assets['application.js'].digest = 'application.js.digest'
+Rails.application.assets['application.css'].digest = 'application.css.digest'
+Rails.application.assets['custom.js'].digest = 'custom.js.digest'
+Rails.application.assets['custom.css'].digest = 'custom.css.digest'
+Rails.application.assets['first.ext'].digest = 'first.ext.digest'
+Rails.application.assets['second.ext'].digest = 'second.ext.digest'
+Rails.application.config.assets.digests = nil
+

data/spec/fresh_when_spec.rb

@@ -1,8 +1,46 @@
+require 'spec_helper'
+
+
 describe Ettu::FreshWhen do
-  context 'when given extra options' do
-    subject(:ettu) { Ettu.new(record) }
+  before(:all) do
+    Ettu.configure { |config| config.template_digestor = Digestor }
+  end
+
+  let(:ettu) { double }
+  let(:record) { Record.new(DateTime.now) }
+  let(:hash) { { random: true, options: true } }
+  subject(:controller) { Controller.new }
+
+  before(:each) do
+    controller.stub(ettu_instance: ettu)
+    ettu.stub(:etags)
+    ettu.stub(:last_modified)
+    ettu.stub(options: {})
+  end
+
+  it 'calls Ettu#etags' do
+    ettu.should_receive(:etags)
+    controller.fresh_when record, hash
+  end
+
+  it 'calls Ettu#last_modified' do
+    ettu.should_receive(:last_modified)
+    controller.fresh_when record, hash
+  end
+
+  it 'passes nil as the first argument to original fresh_when' do
+    controller.should_receive(:old_fresh_when) do |r, h|
+      r.nil?
+    end
+    controller.fresh_when record, hash
+  end
 
-    it "passes those options to Rails' fresh_when"
-    it "calls #old_fresh_when"
+  it 'passes extra options to original fresh_when' do
+    controller.should_receive(:old_fresh_when) do |r, h|
+      hash.each_pair.all? do |k, v|
+        h[k] == v
+      end
+    end
+    controller.fresh_when record, hash
   end
 end

data/spec/spec_helper.rb

@@ -5,8 +5,14 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-require 'ettu'
 require 'date'
+require 'active_support/ordered_options'
+
+require 'simplecov'
+SimpleCov.start { add_filter '/spec/' }
+
+require 'ettu'
+require 'fixtures'
 
 RSpec.configure do |config|
   config.run_all_when_everything_filtered = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ettu
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -75,6 +75,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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.
 email:
 - jridgewell@cloudspace.com
@@ -91,10 +107,12 @@ files:
 - Rakefile
 - ettu.gemspec
 - lib/ettu.rb
+- lib/ettu/configuration.rb
 - lib/ettu/fresh_when.rb
 - lib/ettu/railtie.rb
 - lib/ettu/version.rb
 - spec/ettu_spec.rb
+- spec/fixtures.rb
 - spec/fresh_when_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/cloudspace/ettu
@@ -124,5 +142,6 @@ specification_version: 3
 summary: Account for view code when using ETags.
 test_files:
 - spec/ettu_spec.rb
+- spec/fixtures.rb
 - spec/fresh_when_spec.rb
 - spec/spec_helper.rb