ettu 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 28eeeb019730fdbde0370f53b31ee30dade06adb
-  data.tar.gz: 7b925784197f8e7d9c8009b57563e0d85ce1f49a
+  metadata.gz: 2d25ab552acd13252c6c5b916e118e4fb84fe99f
+  data.tar.gz: 2235cc55e58233893a321d28b308d51e94a41655
 SHA512:
-  metadata.gz: 0c41c23a43c47b53764dbfb531248c6cce4c026461e4277de4c4905ad0928be4de9ac291db68999054c0aa9c3260140a6f86909fc01959f7251db36f092cb29d
-  data.tar.gz: 40f849ff897c470f6af3f8ccef53795cb0263a5c9f7710e2c1f9a03ad28bfaafee3ede974bde2cb5d3db2e7af4339f38d6e7a9a982305d8cd35c6e68f4e60cf0
+  metadata.gz: 65087d66aa1735063f863232f47e18fb97816b9ce894edcd1f04b732f548d470c3e4a7087a26b93d4eedead50927f5223c60c515be033675a8be9e0df592ed2e
+  data.tar.gz: 01e1259d72f51e4a37c3ae90996a872c72ac7ef2875cddee04ba38cea974b2831aaba5728e61b27203d73880469d9eb3d2ed46fc3d5b73b25a3610311777738f

data/README.md

@@ -1,6 +1,8 @@
 Ettu
 ====
 
+[![Build Status](https://travis-ci.org/cloudspace/ettu.png?branch=v3)](https://travis-ci.org/cloudspace/ettu)
+
 Using Rails 3'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
@@ -46,10 +48,9 @@ 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.
+view code. By default, it will add in the fingerprints of your
+precompiled assets along with the cache digest of the current action
+into the calculation for the final ETag sent to the browser.
 
 ### Configuring
 
@@ -68,34 +69,24 @@ Of course, you can override Ettu's default behavior:
 ```ruby
 # config/initializers/ettu.rb
 Ettu.configure do |config|
-  # Set the default js file
-  config.js = 'app.js'
-  # Or don't account for javascript
-  # config.js = false
-
-  # Set the default css file
-  config.css = 'style.css'
-  # Or don't account for css
-  # config.css = false
-
   # Add in extra assets to account for
-  config.assets = ['first.js', 'second.css']
+  config.assets += ['first.js', 'second.css']
 end
 ```
 
 Or each can be passed on an individual basis:
 
-    fresh_when @product, js: 'app.js', css: 'style.css', assets: 'super.css'
+    fresh_when @product, assets: 'super.css'
 
 Additionally, you can specify a different template to calculate with the
 `view` option:
 
-    fresh_when @product, view: "products/index"
+    fresh_when @product, view: '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
+    fresh_when @product, assets: false, view: false
 
 ### What about Rails' default `fresh_when`?
 

data/ROADMAP.md

@@ -1,9 +1,9 @@
 Ettu Roadmap
 ============
 
-1. [x] Decouple Ettu and Configuration
-2. [ ] Remove Rails Version checking
+- [x] Decouple Ettu and Configuration
+- [x] Remove Rails Version checking
     - Separate gem into branches
     - v3 branch will track Rails 3
     - v4 branch will track Rails 4
-3. [ ] Default assets to those set in Rails.application.config.assets.precompile
+- [x] Default assets to those set in Rails.application.config.assets

data/lib/ettu/configuration.rb

@@ -13,9 +13,7 @@ class Ettu
     private
 
     def set_defaults
-      self.js = 'application.js'
-      self.css = 'application.css'
-      self.assets = []
+      self.assets = LateLoadAssets.new(self, :assets)
 
       # Don't actually set view by default.
       # This'll allow #fetch to return the real default
@@ -23,32 +21,40 @@ class Ettu
       # self.view = "#{controller_name}/#{action_name}"
       delete :view if key? :view
 
-      # Don't attempt to reset the template_digestor
-      # if one has already been found
-      unless self.template_digestor
-        self.template_digestor = LateLoadTemplateDigestor.new(self)
-      end
+      self.template_digestor = LateLoadTemplateDigestor.new(self, :template_digestor)
     end
 
-    class LateLoadTemplateDigestor
-      def initialize(config)
+    class LateLoad
+      def initialize(config, name)
         @config = config
+        @name = name
+      end
+
+      def method_missing(method, *args, &block)
+        late_load = defaults
+        @config[@name] = late_load
+        late_load.send method, *args, &block
       end
+    end
 
-      def digest(*args)
-        digestor = attempt_late_template_digestor_set
-        digestor.digest(*args)
+    class LateLoadAssets < LateLoad
+      def to_a
+        super
       end
 
-      private
+      def defaults
+        ::Rails.application.config.assets.digests.keys
+      end
+    end
 
-      def attempt_late_template_digestor_set
+    class LateLoadTemplateDigestor < LateLoad
+      def defaults
         unless defined? CacheDigests::TemplateDigestor
           # Attempt to load cache_digets
           require 'cache_digests'
         end
         # Attempt to use CacheDigests::TemplateDigestor on Rails 3
-        @config.template_digestor = CacheDigests::TemplateDigestor
+        ::CacheDigests::TemplateDigestor
       rescue LoadError
         raise "Ettu requires the cache_digests gem in Rails v#{Rails::VERSION::STRING}"
       end

data/lib/ettu/fresh_when.rb

@@ -2,22 +2,12 @@ class 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, self
 
-      def fresh_when(record_or_options, additional_options = {})
-        ettu = ettu_instance(record_or_options, additional_options, self)
+      ettu_params = {etag: ettu.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
+      super nil, ettu.options.merge(ettu_params)
     end
   end
 end

data/lib/ettu/version.rb

@@ -1,3 +1,3 @@
 class Ettu
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/lib/ettu.rb

@@ -32,11 +32,8 @@ class Ettu
   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
+    etags.compact
   end
 
   def last_modified
@@ -53,16 +50,6 @@ class Ettu
     @view_etag ||= view_digest(view)
   end
 
-  def js_etag
-    js = @options.fetch(:js, @@config.js)
-    asset_etag js
-  end
-
-  def css_etag
-    css = @options.fetch(:css, @@config.css)
-    asset_etag css
-  end
-
   def asset_etags
     assets = @options.fetch(:assets, @@config.assets)
     [*assets].map { |asset| asset_etag(asset) }

data/spec/ettu_spec.rb

@@ -4,24 +4,16 @@ 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
 
   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) }
-
-    it 'will use :js option over default' do
-      expect(ettu.js_etag).to eq('custom.js.digest')
-    end
-
-    it 'will use :css option over default' do
-      expect(ettu.css_etag).to eq('custom.css.digest')
+    before(:all) do
+      Ettu.configure { |config| config.template_digestor = Digestor }
     end
+    let(:hash) { { assets: 'first.ext', view: 'custom/action' } }
+    subject(:ettu) { Ettu.new(hash, {}, controller) }
 
     it 'will use :asset option over default' do
-      expect(ettu.asset_etags).to eq(['first.ext.digest'])
+      expect(ettu.asset_etags).to eq(['first.ext.manifest'])
     end
 
     it 'will use :view option over default' do
@@ -31,50 +23,53 @@ describe Ettu do
 
   describe '.configure' do
     subject(:ettu) { Ettu.new(nil, {}, controller) }
+    before(:all) do
+      Ettu.configure { |config| config.template_digestor = Digestor }
+    end
     after(:all) { Ettu.configure { |config| config.reset } }
 
     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
 
-      it 'will use the default js file' do
-        expect(ettu.js_etag).to eq('custom.js.digest')
+      it 'will use the default asset files' do
+        expect(ettu.asset_etags).to eq(['first.ext.manifest', 'second.ext.manifest'])
       end
 
-      it 'will use the default css file' do
-        expect(ettu.css_etag).to eq('custom.css.digest')
+      it 'will use the default view file' do
+        expect(ettu.view_etag).to eq('custom/view.digest')
       end
+    end
 
-      it 'will use the default asset files' do
-        expect(ettu.asset_etags).to eq(['first.ext.digest', 'second.ext.digest'])
+    context 'can append additional assets' do
+      let(:configuration) { Ettu::Configuration.new }
+      let(:random_string) { SecureRandom.hex }
+
+      it 'with +=' do
+        configuration.assets += [random_string]
+        expect(configuration.assets).to include(random_string)
       end
 
-      it 'will use the default view file' do
-        expect(ettu.view_etag).to eq('custom/view.digest')
+      it 'with <<' do
+        configuration.assets << random_string
+        expect(configuration.assets).to include(random_string)
       end
     end
 
     context 'when setting default to false' do
       before(:all) do
         Ettu.configure do |config|
-          config.js = false
-          config.css = false
+          config.assets = false
           config.view = false
         end
       end
 
-      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)
+      it 'will disable asset etags' do
+        expect(ettu.asset_etags).to eq([nil])
       end
 
       it 'will disable view etags' do
@@ -84,13 +79,27 @@ describe Ettu do
   end
 
   describe '#etags' do
+    before(:all) do
+      Ettu.configure { |config| config.template_digestor = Digestor }
+    end
     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']
+      expected = [
+        record, 'controller_name/action_name.digest',
+       'application.js.manifest', 'application.css.manifest',
+       'custom.js.manifest', 'custom.css.manifest',
+       'first.ext.manifest', 'second.ext.manifest'
+      ]
       result = ettu.etags
-      expect(ettu.etags).to include(*expected)
+      expect(result).to include(*expected)
       expect(expected).to include(*result)
     end
+
+    it 'will not allow nils' do
+      ettu = Ettu.new(nil, {assets: [nil, nil, nil]}, controller )
+      expect(ettu.etags).not_to include(nil)
+    end
   end
 
   context 'when given only a record' do

data/spec/fixtures.rb

@@ -13,9 +13,12 @@ class Controller < Nester
     self.action_name = 'action_name'
   end
 
-  def fresh_when(*args)
-    :old_fresh_when
+  module Freshness
+    def fresh_when(*args)
+      [*args]
+    end
   end
+  include Freshness
 
   include ::Ettu::FreshWhen
 end
@@ -48,5 +51,7 @@ 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
-
+Rails.application.config.assets.digests = Rails.application.assets.keys.reduce({}) do |hash, asset|
+  hash[asset.to_s] = asset.to_s + '.manifest'
+  hash
+end

data/spec/fresh_when_spec.rb

@@ -6,41 +6,19 @@ describe Ettu::FreshWhen 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
+    ret = controller.fresh_when record, hash
+
+    expect(ret[0]).to equal(nil)
   end
 
   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
+    ret = controller.fresh_when record, hash
+
+    expect(ret[1]).to include_hash(hash)
   end
 end

data/spec/spec_helper.rb

@@ -7,6 +7,14 @@
 
 require 'date'
 require 'active_support/ordered_options'
+require 'securerandom'
+RSpec::Matchers.define :include_hash do |expected|
+  match do |actual|
+    !actual.nil? && 
+      !actual.empty? && 
+      (actual.to_a & expected.to_a) == expected.to_a
+  end
+end
 
 require 'simplecov'
 SimpleCov.start { add_filter '/spec/' }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ettu
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Justin Ridgewell
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-01 00:00:00.000000000 Z
+date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails