garner 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a593ed7c69343123cf6aa7152da17d9403455cc
-  data.tar.gz: 2c93f44ef0551b09a947a54dd1dcdaac8145dac4
+  metadata.gz: be2617701ad4ec815fb797f21249d19df49c35d5
+  data.tar.gz: 3b5dca339f0b0aa5926bd4dd210c58c90ec7c658
 SHA512:
-  metadata.gz: f1448f9b7506742c5ceaae135f9e193080e76350366ed9e62cde64c7dd47f0dd7064a934dad934e6ae722823f64c5044da92899d6934c57924e29b9836ce3d21
-  data.tar.gz: 61ffea9d8c44c86e5fae7f5db352c0fa83880e6e8d317533e81953d5c36ded5beec5802d5846916fbcbc1f9f243898646e4c0f32aad163a002671a9f53eba837
+  metadata.gz: 4df4d8bed3cb46aad815fb29fafa791e2f786521ca76849eef16bad67d7da54e52076f85a13c36811a9ca6750813b41cff7e85c3e2b5ae64d5c03b4e953fe7ed
+  data.tar.gz: 20ef731da18baf1e571977e3144b4a7aa28d51dee40931260b7c0de8121601ee4d621300248d8bca7eea6c653cac06c9726b55e0b4aa1b1ba1289e1f23588556

data/.rubocop.yml

@@ -2,34 +2,5 @@ AllCops:
   Exclude:
     - vendor/**/*
 
-LineLength:
-  Enabled: false
+inherit_from: .rubocop_todo.yml
 
-MethodLength:
-  Enabled: false
-
-ClassLength:
-  Enabled: false
-
-CyclomaticComplexity:
-  Enabled: false
-
-Documentation:
-  # don't require classes to be documented
-  Enabled: false
-
-Encoding:
-  # no need to always specify encoding
-  Enabled: false
-
-DoubleNegation:
-  Enabled: false
-
-RaiseArgs:
-  Enabled: false
-
-RescueModifier:
-  Enabled: false
-
-ModuleFunction:
-  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,49 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-11-26 10:49:30 -0500 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 33
+
+# Offense count: 2
+Metrics/CyclomaticComplexity:
+  Max: 11
+
+# Offense count: 56
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 140
+
+# Offense count: 3
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 24
+
+# Offense count: 1
+Metrics/PerceivedComplexity:
+  Max: 12
+
+# Offense count: 38
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 3
+Style/DoubleNegation:
+  Enabled: false
+
+# Offense count: 1
+Style/ModuleFunction:
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: SupportedStyles.
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+# Offense count: 1
+Style/RescueModifier:
+  Enabled: false

data/.travis.yml

@@ -1,3 +1,5 @@
+sudo: false
+
 services:
   - mongodb
   - memcache

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.5.1 (11/26/2014)
+------------------
+
+* Fixed [#81](https://github.com/artsy/garner/issues/81): `Garner.cache` loses namespace options when calling delete when cache block yields `nil` - [@dblock](https://github.com/dblock).
+* Upgraded RSpec to 3.x and RuboCop to 0.27.1 - [@dblock](https://github.com/dblock).
+
 0.5.0 (7/17/2014)
 -----------------
 

data/Gemfile

@@ -1,3 +1,3 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 gemspec

data/README.md

@@ -8,7 +8,7 @@ If you're not familiar with HTTP caching, ETags and If-Modified-Since, watch us
 Upgrading
 ---------
 
-The current stable release line of Garner is 0.4.x, and contains many breaking changes from the previous 0.3.x series. For a summary of important changes, see [UPGRADING](UPGRADING.md).
+The current stable release line of Garner is 0.5.x, and contains many breaking changes from the previous 0.3.x series. For a summary of important changes, see [UPGRADING](UPGRADING.md).
 
 Usage
 -----
@@ -90,7 +90,7 @@ end
 In the above example, the `Order.identify` call will not result in a database query. Instead, it just communicates to Garner's cache sweeper that whenever the order with identity `params[:id]` is updated, this cache result should be invalidated. The `identify` method is provided by the Mongoid mixin. To use it, you should configure `Garner.config.mongoid_identity_fields`, e.g.:
 
 ```ruby
-Garner.configure.do |config|
+Garner.configure do |config|
   config.mongoid_identity_fields = [:_id, :_slugs]
 end
 ```

data/garner.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'activesupport'
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec', '~> 2.10'
+  s.add_development_dependency 'rspec', '~> 3.1'
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'grape', '~> 0.8.0'
   s.add_development_dependency 'sinatra'
@@ -40,5 +40,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'coveralls'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'dalli'
-  s.add_development_dependency 'rubocop', '0.24.1'
+  s.add_development_dependency 'rubocop', '0.27.1'
 end

data/lib/garner/cache.rb

@@ -13,7 +13,7 @@ module Garner
         result = Garner.config.cache.fetch(compound_key, options_hash) do
           yield
         end
-        Garner.config.cache.delete(compound_key) unless result
+        Garner.config.cache.delete(compound_key, options_hash) unless result
       else
         result = yield
       end

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

@@ -84,7 +84,7 @@ module Garner
           def self.canonical?(binding)
             # TODO: Implement real logic for determining canonicity.
             binding.is_a?(Mongoid::Document) ||
-            (binding.is_a?(Class) && binding.include?(Mongoid::Document))
+              (binding.is_a?(Class) && binding.include?(Mongoid::Document))
           end
 
           def self.index_key_for(binding)

data/lib/garner/version.rb

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

data/spec/garner/cache/context_spec.rb

@@ -16,22 +16,22 @@ describe Garner::Cache::Context do
     end
 
     it 'returns a Garner::Cache::Identity' do
-      subject.call.should be_a(Garner::Cache::Identity)
+      expect(subject.call).to be_a(Garner::Cache::Identity)
     end
 
     it "sets the identity's ruby_binding to self" do
-      subject.call.ruby_context.should eq @test_context
+      expect(subject.call.ruby_context).to 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
+      expect(subject.call.key_hash[:caller]).not_to be_nil
 
       # Custom :context_key_strategies
       Garner.configure do |config|
         config.context_key_strategies = []
       end
-      subject.call.key_hash[:caller].should be_nil
+      expect(subject.call.key_hash[:caller]).to be_nil
     end
 
   end

data/spec/garner/cache/identity_spec.rb

@@ -4,17 +4,17 @@ 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'
+    expect(subject.options_hash[:foo]).to 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
+    expect(subject.options_hash[:expires_in]).to eq 5.minutes
   end
 
   describe 'nocache' do
     it 'forces a cache bypass' do
-      Garner::Cache.should_not_receive :fetch
+      expect(Garner::Cache).not_to receive :fetch
       subject.nocache.fetch { 'foo' }
     end
   end
@@ -23,7 +23,7 @@ describe Garner::Cache::Identity do
     it "adds to the object identity's bindings" do
       subject.bind('foo')
       subject.bind('bar')
-      subject.bindings.should eq %w(foo bar)
+      expect(subject.bindings).to eq %w(foo bar)
     end
 
     it 'raises an error for <> 1 arguments' do
@@ -36,7 +36,7 @@ describe Garner::Cache::Identity 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)
+      expect(subject.key_hash).to eq(foo: 1, bar: 2)
     end
 
     it 'raises an error for <> 1 arguments' do
@@ -53,7 +53,7 @@ describe Garner::Cache::Identity 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)
+      expect(subject.options_hash).to eq(expires_in: nil, foo: 1, bar: 2)
     end
 
     it 'raises an error for <> 1 arguments' do

data/spec/garner/cache_spec.rb

@@ -21,18 +21,18 @@ describe Garner::Cache do
       result2 = subject.fetch([], {}, {}) { 'foo' }
       result3 = subject.fetch([], {}, {}) { 'bar' }
 
-      result1.should.nil?
-      result2.should eq 'foo'
-      result3.should eq 'foo'
+      expect(result1).to be nil
+      expect(result2).to eq 'foo'
+      expect(result3).to eq 'foo'
     end
 
     it 'does not cache results with un-bindable bindings' do
       unbindable = double('object')
-      unbindable.stub(:garner_cache_key) { nil }
+      allow(unbindable).to receive(:garner_cache_key) { nil }
       result1 = subject.fetch([unbindable], {}, {}) { 'foo' }
       result2 = subject.fetch([unbindable], {}, {}) { 'bar' }
-      result1.should eq 'foo'
-      result2.should eq 'bar'
+      expect(result1).to eq 'foo'
+      expect(result2).to eq 'bar'
     end
 
     it 'raises an exception by default for nil bindings' do
@@ -45,5 +45,13 @@ describe Garner::Cache do
       Garner.configure { |config| config.whiny_nils = false }
       expect { subject.fetch([nil], {}, {}) { 'foo' } }.not_to raise_error
     end
+
+    it 'deletes record when cached block yields nil' do
+      binding = double('object', garner_cache_key: 'key')
+      expect(Garner.config.cache).to receive(:delete).with({ binding_keys: ['key'], context_keys: { key: 'value' } }, { namespace: 'foo' })
+      subject.fetch [binding], { key: 'value' }, namespace: 'foo' do
+        nil
+      end
+    end
   end
 end

data/spec/garner/config_spec.rb

@@ -12,6 +12,6 @@ describe Garner::Config do
     Garner.configure do |config|
       config.cache = cache
     end
-    Garner.config.cache.should eq cache
+    expect(Garner.config.cache).to eq cache
   end
 end

data/spec/garner/mixins/mongoid/document_spec.rb

@@ -14,8 +14,8 @@ describe Garner::Mixins::Mongoid::Document do
 
     describe 'proxied_classes' do
       it 'returns all Mongoid superclasses' do
-        @monger.proxied_classes.should eq [Monger]
-        @cheese.proxied_classes.should eq [Cheese, Food]
+        expect(@monger.proxied_classes).to eq [Monger]
+        expect(@cheese.proxied_classes).to eq [Cheese, Food]
       end
     end
   end
@@ -26,44 +26,44 @@ describe Garner::Mixins::Mongoid::Document do
     describe '_latest_by_updated_at' do
       it 'returns a Mongoid::Document instance' do
         subject.create
-        subject.send(:_latest_by_updated_at).should be_a(subject)
+        expect(subject.send(:_latest_by_updated_at)).to be_a(subject)
       end
 
       it 'returns the _latest_by_updated_at document by :updated_at' do
         mongers = 3.times.map { |i| subject.create(name: "M#{i}") }
         mongers[1].touch
 
-        subject.send(:_latest_by_updated_at)._id.should eq mongers[1]._id
-        subject.send(:_latest_by_updated_at).updated_at.should eq mongers[1].reload.updated_at
+        expect(subject.send(:_latest_by_updated_at)._id).to eq mongers[1]._id
+        expect(subject.send(:_latest_by_updated_at).updated_at).to eq mongers[1].reload.updated_at
       end
 
       it 'returns nil if there are no documents' do
-        subject.send(:_latest_by_updated_at).should be_nil
+        expect(subject.send(:_latest_by_updated_at)).to be_nil
       end
 
       it 'returns nil if updated_at does not exist' do
         subject.create
-        subject.stub(:fields) { {} }
-        subject.send(:_latest_by_updated_at).should be_nil
+        allow(subject).to receive(:fields) { {} }
+        expect(subject.send(:_latest_by_updated_at)).to be_nil
       end
     end
 
     describe 'proxy_binding' do
       it 'returns the _latest_by_updated_at document' do
         subject.create
-        subject.proxy_binding.should be_a(Monger)
+        expect(subject.proxy_binding).to be_a(Monger)
       end
 
       it 'responds to :touch' do
         subject.create
-        subject.any_instance.should_receive(:touch)
+        expect_any_instance_of(subject).to receive(:touch)
         subject.proxy_binding.touch
       end
 
       describe 'cache_key' do
         it 'matches what would be returned from the full object' do
           monger = subject.create
-          subject.proxy_binding.cache_key.should eq monger.reload.cache_key
+          expect(subject.proxy_binding.cache_key).to eq monger.reload.cache_key
         end
 
         context 'with Mongoid subclasses' do
@@ -71,7 +71,7 @@ describe Garner::Mixins::Mongoid::Document do
 
           it 'matches what would be returned from the full object' do
             cheese = subject.create
-            subject.proxy_binding.cache_key.should eq cheese.reload.cache_key
+            expect(subject.proxy_binding.cache_key).to eq cheese.reload.cache_key
           end
         end
       end

data/spec/garner/mixins/mongoid/identity_spec.rb

@@ -4,9 +4,9 @@ require 'garner/mixins/mongoid'
 describe Garner::Mixins::Mongoid::Identity do
   before(:each) do
     @mock_strategy = double('strategy')
-    @mock_strategy.stub(:apply)
+    allow(@mock_strategy).to receive(:apply)
     @mock_mongoid_strategy = double('mongoid_strategy')
-    @mock_mongoid_strategy.stub(:apply)
+    allow(@mock_mongoid_strategy).to receive(:apply)
   end
 
   describe 'from_class_and_handle' do
@@ -36,9 +36,9 @@ describe Garner::Mixins::Mongoid::Identity do
 
     it 'sets klass, handle and a conditions hash' do
       identity = subject.from_class_and_handle(Monger, 'id')
-      identity.klass.should eq Monger
-      identity.handle.should eq 'id'
-      identity.conditions['$or'].should eq [
+      expect(identity.klass).to eq Monger
+      expect(identity.handle).to eq 'id'
+      expect(identity.conditions['$or']).to eq [
         { _id: 'id' },
         { _slugs: 'id' }
       ]
@@ -47,9 +47,9 @@ describe Garner::Mixins::Mongoid::Identity do
     context 'on a Mongoid subclass' do
       it 'sets klass to parent and includes the _type field' do
         identity = subject.from_class_and_handle(Cheese, 'id')
-        identity.klass.should eq Cheese
-        identity.conditions[:_type].should eq('$in' => ['Cheese'])
-        identity.conditions['$or'].should eq [
+        expect(identity.klass).to eq Cheese
+        expect(identity.conditions[:_type]).to eq('$in' => ['Cheese'])
+        expect(identity.conditions['$or']).to eq [
           { _id: 'id' },
           { _slugs: 'id' }
         ]
@@ -61,17 +61,17 @@ describe Garner::Mixins::Mongoid::Identity do
     subject { Monger.identify('m1').to_s }
 
     it 'stringizes the binding and includes klass and handle' do
-      subject.should be_a(String)
-      subject.should =~ /Monger/
-      subject.should =~ /m1/
+      expect(subject).to be_a(String)
+      expect(subject).to match(/Monger/)
+      expect(subject).to match(/m1/)
     end
 
     it 'should not change across identical instances' do
-      subject.should eq Monger.identify('m1').to_s
+      expect(subject).to eq Monger.identify('m1').to_s
     end
 
     it 'should be different across different instances' do
-      subject.should_not == Monger.identify('m2').to_s
+      expect(subject).not_to eq(Monger.identify('m2').to_s)
     end
   end
 
@@ -88,26 +88,26 @@ describe Garner::Mixins::Mongoid::Identity do
 
     describe 'proxy_binding' do
       it 'returns nil for nonexistent bindings' do
-        Monger.identify('m2').proxy_binding.should be_nil
+        expect(Monger.identify('m2').proxy_binding).to be_nil
       end
 
       it 'returns nil for nil bindings' do
         @monger.unset(:_slugs)
-        Monger.identify(nil).proxy_binding.should be_nil
+        expect(Monger.identify(nil).proxy_binding).to be_nil
       end
 
       it 'limits the query' do
-        Mongoid::Slug::Criteria.any_instance.should_receive(:limit).with(1).and_return([@monger])
+        expect_any_instance_of(Mongoid::Slug::Criteria).to receive(:limit).with(1).and_return([@monger])
         Monger.identify('m1').proxy_binding
       end
 
       describe 'cache_key' do
         it "generates a cache key equal to Mongoid::Document's" do
-          Monger.identify('m1').proxy_binding.cache_key.should eq @monger.cache_key
+          expect(Monger.identify('m1').proxy_binding.cache_key).to eq @monger.cache_key
 
           # Also test for Mongoid subclasses
-          Cheese.identify('havarti').proxy_binding.cache_key.should eq @cheese.cache_key
-          Food.identify(@cheese.id).proxy_binding.cache_key.should eq @cheese.cache_key
+          expect(Cheese.identify('havarti').proxy_binding.cache_key).to eq @cheese.cache_key
+          expect(Food.identify(@cheese.id).proxy_binding.cache_key).to eq @cheese.cache_key
         end
 
         context 'without Mongoid::Timestamps' do
@@ -117,22 +117,22 @@ describe Garner::Mixins::Mongoid::Identity do
           end
 
           it "generates a cache key equal to Mongoid::Document's" do
-            Monger.identify('m1').proxy_binding.cache_key.should eq @monger.cache_key
+            expect(Monger.identify('m1').proxy_binding.cache_key).to eq @monger.cache_key
 
             # Also test for Mongoid subclasses
-            Cheese.identify('havarti').proxy_binding.cache_key.should eq @cheese.cache_key
-            Food.identify(@cheese.id).proxy_binding.cache_key.should eq @cheese.cache_key
+            expect(Cheese.identify('havarti').proxy_binding.cache_key).to eq @cheese.cache_key
+            expect(Food.identify(@cheese.id).proxy_binding.cache_key).to eq @cheese.cache_key
           end
         end
       end
 
       describe 'updated_at' do
         it "returns :updated_at equal to Mongoid::Document's" do
-          Monger.identify('m1').proxy_binding.updated_at.should eq Monger.find('m1').updated_at
+          expect(Monger.identify('m1').proxy_binding.updated_at).to eq Monger.find('m1').updated_at
 
           # Also test for Mongoid subclasses
-          Cheese.identify('havarti').proxy_binding.updated_at.should eq @cheese.updated_at
-          Food.identify(@cheese.id).proxy_binding.updated_at.should eq @cheese.updated_at
+          expect(Cheese.identify('havarti').proxy_binding.updated_at).to eq @cheese.updated_at
+          expect(Food.identify(@cheese.id).proxy_binding.updated_at).to eq @cheese.updated_at
         end
       end
     end