garner 0.4.5 → 0.5.0

data/lib/garner/strategies/binding/key/base.rb

@@ -3,15 +3,13 @@ module Garner
     module Binding
       module Key
         class Base
-
           # Compute a cache key from an object binding.
           #
           # @param binding [Object] The object from which to compute a key.
           # @return [String] A cache key string.
-          def self.apply(binding)
+          def self.apply(_binding)
             nil
           end
-
         end
       end
     end

data/lib/garner/strategies/binding/key/binding_index.rb

@@ -87,7 +87,6 @@ module Garner
             (binding.is_a?(Class) && binding.include?(Mongoid::Document))
           end
 
-          private
           def self.index_key_for(binding)
             if binding.respond_to?(:identity_string)
               binding_key = binding.identity_string
@@ -96,12 +95,12 @@ module Garner
             end
 
             {
-              :strategy => self,
-              :proxied_binding => binding_key
+              strategy: self,
+              proxied_binding: binding_key
             }
           end
 
-          def self.new_cache_key_for(binding)
+          def self.new_cache_key_for(_binding)
             SecureRandom.hex(RANDOM_KEY_LENGTH)
           end
         end

data/lib/garner/strategies/binding/key/cache_key.rb

@@ -3,7 +3,6 @@ module Garner
     module Binding
       module Key
         class CacheKey < Base
-
           # Compute a cache key from an object binding.
           #
           # @param binding [Object] The object from which to compute a key.
@@ -11,7 +10,6 @@ module Garner
           def self.apply(binding)
             binding.cache_key if binding.respond_to?(:cache_key)
           end
-
         end
       end
     end

data/lib/garner/strategies/binding/key/safe_cache_key.rb

@@ -3,7 +3,7 @@ module Garner
     module Binding
       module Key
         class SafeCacheKey < Base
-          VALID_FORMAT = /^(?<model>[^\/]+)\/(?<id>.+)-(?<timestamp>[0-9]{14})$/
+          VALID_FORMAT = %r{^(?<model>[^\/]+)\/(?<id>.+)-(?<timestamp>[0-9]{14,})$}
 
           # Compute a cache key from an object binding. Only return a key if
           # :cache_key and :updated_at are both defined and present on the
@@ -24,10 +24,9 @@ module Garner
             return unless binding.cache_key =~ VALID_FORMAT
 
             decimal_portion = binding.updated_at.utc.to_f % 1
-            decimal_string = sprintf("%.10f", decimal_portion).gsub(/^0/, "")
+            decimal_string = format('%.10f', decimal_portion).gsub(/^0/, '')
             "#{binding.cache_key}#{decimal_string}"
           end
-
         end
       end
     end

data/lib/garner/strategies/context/key/base.rb

@@ -3,17 +3,15 @@ module Garner
     module Context
       module Key
         class Base
-
           # Compute a hash of key-value pairs from a given ruby context,
           # and apply it to a cache identity.
           #
           # @param identity [Garner::Cache::Identity] The cache identity.
           # @param ruby_context [Object] An optional Ruby context.
           # @return [Garner::Cache::Identity] The modified identity.
-          def self.apply(identity, ruby_context = nil)
+          def self.apply(identity, _ruby_context = nil)
             identity
           end
-
         end
       end
     end

data/lib/garner/strategies/context/key/caller.rb

@@ -3,7 +3,6 @@ module Garner
     module Context
       module Key
         class Caller < Base
-
           def self.field
             :caller
           end
@@ -21,12 +20,12 @@ module Garner
               ::Rails.root.realpath.to_s
             else
               # Try to use the nearest ancestor directory containing a Gemfile.
-              requiring_caller = send(:caller).detect do |line|
-                !line.include?(File.join("lib", "garner"))
+              requiring_caller = send(:caller).find do |line|
+                !line.include?(File.join('lib', 'garner'))
               end
               return nil unless requiring_caller
 
-              requiring_file = requiring_caller.split(":")[0]
+              requiring_file = requiring_caller.split(':')[0]
               gemfile_root(File.dirname(requiring_file))
             end
           end
@@ -43,13 +42,13 @@ module Garner
               ruby_context.send(:caller).compact.each do |line|
                 parts = line.match(/(?<filename>[^:]+)\:(?<lineno>[^:]+)/)
                 file = (Pathname.new(parts[:filename]).realpath.to_s rescue nil)
-                next if file.nil? || file == ""
-                next if file.include?(File.join("lib", "garner"))
+                next if file.nil? || file == ''
+                next if file.include?(File.join('lib', 'garner'))
 
                 if (root = Garner.config.caller_root)
                   root += File::SEPARATOR unless root[-1] == File::SEPARATOR
                   next unless file =~ /^#{root}/
-                  value = "#{file.gsub(root || "", "")}:#{parts[:lineno]}"
+                  value = "#{file.gsub(root || '', '')}:#{parts[:lineno]}"
                 else
                   value = "#{file}:#{parts[:lineno]}"
                 end
@@ -58,24 +57,22 @@ module Garner
               end
             end
 
-            value ? identity.key(field => value) : identity
+            value ? identity.key(field => value) : super
           end
 
-          private
           def self.gemfile_root(path)
             path = Pathname.new(path).realpath.to_s
-            newpath = Pathname.new(File.join(path, "..")).realpath.to_s
+            newpath = Pathname.new(File.join(path, '..')).realpath.to_s
             if newpath == path
               # We've reached the filesystem root; return
               return nil
-            elsif File.exist?(File.join(newpath, "Gemfile"))
+            elsif File.exist?(File.join(newpath, 'Gemfile'))
               # We've struck Gemfile gold; return current path
               return newpath
             else
               return gemfile_root(newpath)
             end
           end
-
         end
       end
     end

data/lib/garner/strategies/context/key/jsonp.rb

@@ -3,7 +3,6 @@ module Garner
     module Context
       module Key
         class Jsonp < Base
-
           def self.field
             :request_params
           end
@@ -15,14 +14,12 @@ module Garner
           # @return [Garner::Cache::Identity] The modified identity.
           def self.apply(identity, ruby_context = nil)
             key_hash = identity.key_hash
-            return identity unless key_hash[field]
-
+            return super unless key_hash[field]
 
-            key_hash[field].delete("callback")
-            key_hash[field].delete("_")
+            key_hash[field].delete('callback')
+            key_hash[field].delete('_')
             identity
           end
-
         end
       end
     end

data/lib/garner/strategies/context/key/request_get.rb

@@ -3,7 +3,6 @@ module Garner
     module Context
       module Key
         class RequestGet < Base
-
           def self.field
             :request_params
           end
@@ -14,15 +13,14 @@ module Garner
           # @param ruby_context [Object] An optional Ruby context.
           # @return [Garner::Cache::Identity] The modified identity.
           def self.apply(identity, ruby_context = nil)
-            return identity unless (ruby_context.respond_to?(:request))
+            return super unless ruby_context.respond_to?(:request)
 
             request = ruby_context.request
-            if request && ["GET", "HEAD"].include?(request.request_method)
+            if request && %w(GET HEAD).include?(request.request_method)
               identity.key(field => request.GET.dup)
             end
             identity
           end
-
         end
       end
     end

data/lib/garner/strategies/context/key/request_path.rb

@@ -3,7 +3,6 @@ module Garner
     module Context
       module Key
         class RequestPath < Base
-
           def self.field
             :request_path
           end
@@ -14,13 +13,12 @@ module Garner
           # @param ruby_context [Object] An optional Ruby context.
           # @return [Garner::Cache::Identity] The modified identity.
           def self.apply(identity, ruby_context = nil)
-            return identity unless (ruby_context.respond_to?(:request))
+            return super unless ruby_context.respond_to?(:request)
 
             request = ruby_context.request
             identity.key(field => request.path) if request.respond_to?(:path)
             identity
           end
-
         end
       end
     end

data/lib/garner/strategies/context/key/request_post.rb

@@ -3,7 +3,6 @@ module Garner
     module Context
       module Key
         class RequestPost < Base
-
           def self.field
             :request_params
           end
@@ -14,15 +13,14 @@ module Garner
           # @param ruby_context [Object] An optional Ruby context.
           # @return [Garner::Cache::Identity] The modified identity.
           def self.apply(identity, ruby_context = nil)
-            return identity unless (ruby_context.respond_to?(:request))
+            return super unless ruby_context.respond_to?(:request)
 
             request = ruby_context.request
-            if request.request_method == "POST"
+            if request.request_method == 'POST'
               identity = identity.key(field => request.POST.dup)
             end
             identity
           end
-
         end
       end
     end

data/lib/garner/version.rb

@@ -1,3 +1,3 @@
 module Garner
-  VERSION = "0.4.5"
+  VERSION = '0.5.0'
 end

data/spec/garner/cache/context_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Garner::Cache::Context do
+
+  describe 'garner' do
+
+    before(:each) do
+      class TestContext
+        include Garner::Cache::Context
+      end
+      @test_context = TestContext.new
+    end
+
+    subject do
+      -> { @test_context.garner }
+    end
+
+    it 'returns a Garner::Cache::Identity' do
+      subject.call.should be_a(Garner::Cache::Identity)
+    end
+
+    it "sets the identity's ruby_binding to self" do
+      subject.call.ruby_context.should eq @test_context
+    end
+
+    it 'applies each of Garner.config.context_key_strategies' do
+      # Default :context_key_strategies
+      subject.call.key_hash[:caller].should_not be_nil
+
+      # Custom :context_key_strategies
+      Garner.configure do |config|
+        config.context_key_strategies = []
+      end
+      subject.call.key_hash[:caller].should be_nil
+    end
+
+  end
+end

data/spec/garner/cache/identity_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe Garner::Cache::Identity do
+
+  it 'includes Garner.config.global_cache_options' do
+    Garner.configure { |config| config.global_cache_options = { foo: 'bar' } }
+    subject.options_hash[:foo].should eq 'bar'
+  end
+
+  it 'includes Garner.config.expires_in' do
+    Garner.configure { |config| config.expires_in = 5.minutes }
+    subject.options_hash[:expires_in].should eq 5.minutes
+  end
+
+  describe 'nocache' do
+    it 'forces a cache bypass' do
+      Garner::Cache.should_not_receive :fetch
+      subject.nocache.fetch { 'foo' }
+    end
+  end
+
+  describe 'bind' do
+    it "adds to the object identity's bindings" do
+      subject.bind('foo')
+      subject.bind('bar')
+      subject.bindings.should eq %w(foo bar)
+    end
+
+    it 'raises an error for <> 1 arguments' do
+      expect { subject.bind }.to raise_error
+      expect { subject.bind('foo', 'bar') }.to raise_error
+    end
+  end
+
+  describe 'key' do
+    it "adds to the object identity's key_hash" do
+      subject.key(foo: 1)
+      subject.key(bar: 2)
+      subject.key_hash.should eq(foo: 1, bar: 2)
+    end
+
+    it 'raises an error for <> 1 arguments' do
+      expect { subject.key }.to raise_error
+      expect { subject.key({}, {}) }.to raise_error
+    end
+
+    it 'raises an error for non-hash arguments' do
+      expect { subject.key('foo') }.to raise_error
+    end
+  end
+
+  describe 'options' do
+    it "adds to the object identity's options_hash" do
+      subject.options(foo: 1)
+      subject.options(bar: 2)
+      subject.options_hash.should eq(expires_in: nil, foo: 1, bar: 2)
+    end
+
+    it 'raises an error for <> 1 arguments' do
+      expect { subject.options }.to raise_error
+      expect { subject.options({}, {}) }.to raise_error
+    end
+
+    it 'raises an error for non-hash arguments' do
+      expect { subject.options('foo') }.to raise_error
+    end
+  end
+end

data/spec/garner/cache_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Garner::Cache do
+  subject do
+    Garner::Cache
+  end
+
+  describe 'fetch' do
+    it 'requires bindings, a key hash, and an options hash' do
+      expect { subject.fetch { 'foo' } }.to raise_error
+      expect { subject.fetch([]) { 'foo' } }.to raise_error
+      expect { subject.fetch([], {}) { 'foo' } }.to raise_error
+    end
+
+    it 'requires a block' do
+      expect { subject.fetch([], {}, {}) }.to raise_error
+    end
+
+    it 'does not cache nil results' do
+      result1 = subject.fetch([], {}, {}) { nil }
+      result2 = subject.fetch([], {}, {}) { 'foo' }
+      result3 = subject.fetch([], {}, {}) { 'bar' }
+
+      result1.should.nil?
+      result2.should eq 'foo'
+      result3.should eq 'foo'
+    end
+
+    it 'does not cache results with un-bindable bindings' do
+      unbindable = double('object')
+      unbindable.stub(:garner_cache_key) { nil }
+      result1 = subject.fetch([unbindable], {}, {}) { 'foo' }
+      result2 = subject.fetch([unbindable], {}, {}) { 'bar' }
+      result1.should eq 'foo'
+      result2.should eq 'bar'
+    end
+
+    it 'raises an exception by default for nil bindings' do
+      expect do
+        subject.fetch([nil], {}, {}) { 'foo' }
+      end.to raise_error(Garner::Cache::NilBinding)
+    end
+
+    it 'raises no exception for nil bindings if config.whiny_nils is false' do
+      Garner.configure { |config| config.whiny_nils = false }
+      expect { subject.fetch([nil], {}, {}) { 'foo' } }.not_to raise_error
+    end
+  end
+end

data/spec/garner/config_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Garner::Config do
+  before :each do
+    @cache = Garner::Config.cache
+  end
+  after :each do
+    Garner::Config.cache = @cache
+  end
+  it 'configures a cache store' do
+    cache = Class.new
+    Garner.configure do |config|
+      config.cache = cache
+    end
+    Garner.config.cache.should eq cache
+  end
+end