garner 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be2617701ad4ec815fb797f21249d19df49c35d5
-  data.tar.gz: 3b5dca339f0b0aa5926bd4dd210c58c90ec7c658
+  metadata.gz: 84c7b960a4a1d14289fcfe1966869f130a100821
+  data.tar.gz: 54b2913e7ec83f309c7413253ad603b31812ecad
 SHA512:
-  metadata.gz: 4df4d8bed3cb46aad815fb29fafa791e2f786521ca76849eef16bad67d7da54e52076f85a13c36811a9ca6750813b41cff7e85c3e2b5ae64d5c03b4e953fe7ed
-  data.tar.gz: 20ef731da18baf1e571977e3144b4a7aa28d51dee40931260b7c0de8121601ee4d621300248d8bca7eea6c653cac06c9726b55e0b4aa1b1ba1289e1f23588556
+  metadata.gz: 8efca6c55b739abb1adb3f90b4e8374b86b522f66a2d78112fd2c523dd010b1de2580fd6108007627944cd5bf03839e83d5bd2a6bb20b2facee71c0c23b05727
+  data.tar.gz: d0c2f0e0bc7799caf47485fbab287d0d1a818e9e0370b179e399b502cf3ab6301543a87a1d836c11e4a725f453b910a2c78dfcee26e0e32c8a8c32cced866ed2

data/.rubocop_todo.yml

@@ -1,5 +1,6 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2014-11-26 10:49:30 -0500 using RuboCop version 0.27.1.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-10-19 17:38:30 -0400 using RuboCop version 0.34.2.
 # 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
@@ -13,7 +14,7 @@ Metrics/AbcSize:
 Metrics/CyclomaticComplexity:
   Max: 11
 
-# Offense count: 56
+# Offense count: 73
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 140
@@ -27,23 +28,46 @@ Metrics/MethodLength:
 Metrics/PerceivedComplexity:
   Max: 12
 
-# Offense count: 38
+# Offense count: 24
+# Configuration parameters: Exclude.
 Style/Documentation:
   Enabled: false
 
 # Offense count: 3
 Style/DoubleNegation:
-  Enabled: false
+  Exclude:
+    - 'lib/garner/strategies/binding/invalidation/touch.rb'
+    - 'spec/garner/version_spec.rb'
+    - 'spec/support/cache.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/EmptyElse:
+  Exclude:
+    - 'lib/garner/cache.rb'
+    - 'lib/garner/strategies/binding/key/binding_index.rb'
 
 # Offense count: 1
 Style/ModuleFunction:
-  Enabled: false
+  Exclude:
+    - 'lib/garner/config.rb'
 
 # Offense count: 1
 # Configuration parameters: SupportedStyles.
 Style/RaiseArgs:
   EnforcedStyle: compact
 
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
+Style/RegexpLiteral:
+  Exclude:
+    - 'garner.gemspec'
+    - 'spec/garner/strategies/binding/key/safe_cache_key_spec.rb'
+
 # Offense count: 1
+# Cop supports --auto-correct.
 Style/RescueModifier:
-  Enabled: false
+  Exclude:
+    - 'lib/garner/strategies/context/key/caller.rb'

data/.travis.yml

@@ -6,10 +6,12 @@ services:
 
 rvm:
   - 1.9.3
-  - 2.1.2
+  - 2.1
+  - 2.2
   - rbx-2
   - jruby-19mode
 
 env:
   - MONGOID_VERSION=3
   - MONGOID_VERSION=4
+  - MONGOID_VERSION=5

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+0.5.2 (10/19/2015)
+------------------
+
+* [#89](https://github.com/artsy/garner/pull/89): Added support for Mongoid 5 - [@dblock](https://github.com/dblock).
+
 0.5.1 (11/26/2014)
 ------------------
 

data/README.md

@@ -1,6 +1,12 @@
-Garner [![Build Status](https://secure.travis-ci.org/artsy/garner.png)](http://travis-ci.org/artsy/garner) [![Dependency Status](https://gemnasium.com/artsy/garner.png)](https://gemnasium.com/artsy/garner) [![Coverage Status](https://coveralls.io/repos/artsy/garner/badge.png)](https://coveralls.io/r/artsy/garner) [![Code Climate](https://codeclimate.com/github/artsy/garner.png)](https://codeclimate.com/github/artsy/garner)
+Garner
 ======
 
+[![Gem Version](https://badge.fury.io/rb/garner.svg)](https://badge.fury.io/rb/garner)
+[![Build Status](https://travis-ci.org/artsy/garner.svg?branch=master)](https://travis-ci.org/artsy/garner)
+[![Dependency Status](https://gemnasium.com/artsy/garner.svg)](https://gemnasium.com/artsy/garner)
+[![Code Climate](https://codeclimate.com/github/artsy/garner.svg)](https://codeclimate.com/github/artsy/garner)
+[![Coverage Status](https://coveralls.io/repos/artsy/garner/badge.svg?branch=master&service=github)](https://coveralls.io/github/artsy/garner?branch=master)
+
 Garner is a cache layer for Ruby and Rack applications, supporting model and instance binding and hierarchical invalidation. To "garner" means to gather data from various sources and to make it readily available in one place, kind of like a cache!
 
 If you're not familiar with HTTP caching, ETags and If-Modified-Since, watch us introduce Garner in [From Zero to API Cache in 10 Minutes](http://www.confreaks.com/videos/986-goruco2012-from-zero-to-api-cache-w-grape-mongodb-in-10-minutes) at GoRuCo 2012.
@@ -51,7 +57,7 @@ ORM Integrations
 
 ### Mongoid
 
-To use Mongoid documents and classes for Garner bindings, use `Garner::Mixins::Mongoid::Document`. You can set it up in an initializer:
+To use Mongoid 3, 4 or 5 documents and classes for Garner bindings, use `Garner::Mixins::Mongoid::Document`. You can set it up in an initializer:
 
 ``` ruby
 require "garner/mixins/mongoid"

data/Rakefile

@@ -27,10 +27,10 @@ YARD::Rake::YardocTask.new(:doc)
 task :benchmark do
   require 'performance/strategy_benchmark'
   StrategyBenchmark.new(
-                          n: ENV['N'].try(&:to_i),
-                          d: ENV['D'].try(&:to_i),
-                          r: ENV['R'].try(&:to_i)
-                        ).run!
+    n: ENV['N'].try(&:to_i),
+    d: ENV['D'].try(&:to_i),
+    r: ENV['R'].try(&:to_i)
+  ).run!
 end
 
 require 'rubocop/rake_task'

data/garner.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'sinatra'
   s.add_development_dependency 'rack-test'
   s.add_development_dependency 'mongoid', '>= 3.0.0'
-  s.add_development_dependency 'mongoid_slug'
+  s.add_development_dependency 'mongoid-slug'
   s.add_development_dependency 'activerecord'
   if RUBY_PLATFORM =~ /java/
     s.add_development_dependency 'jdbc-sqlite3'
@@ -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.27.1'
+  s.add_development_dependency 'rubocop', '0.34.2'
 end

data/lib/garner/cache/context.rb

@@ -1,7 +1,7 @@
 # Set up Garner configuration parameters
 Garner.config.option(:context_key_strategies,
                      default: [Garner::Strategies::Context::Key::Caller]
-)
+                    )
 Garner.config.option(:rack_context_key_strategies,
                      default: [
                        Garner::Strategies::Context::Key::Caller,
@@ -9,7 +9,7 @@ Garner.config.option(:rack_context_key_strategies,
                        Garner::Strategies::Context::Key::RequestPost,
                        Garner::Strategies::Context::Key::RequestPath
                      ]
-)
+                    )
 
 module Garner
   module Cache

data/lib/garner/mixins/mongoid/document.rb

@@ -79,7 +79,6 @@ module Garner
             invalidation_strategy.apply(self)
             invalidation_strategy.apply(_root) if _root != self && Garner.config.invalidate_mongoid_root
           end
-
         end
       end
     end

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

@@ -3,7 +3,7 @@ module Garner
     module Binding
       module Key
         class BindingIndex < Base
-          RANDOM_KEY_LENGTH = 12  # In bytes.
+          RANDOM_KEY_LENGTH = 12 # In bytes.
 
           # Compute a cache key as follows:
           # 1. Determine whether the binding is canonical.

data/lib/garner/version.rb

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

data/spec/garner/cache/context_spec.rb

@@ -1,9 +1,7 @@
 require 'spec_helper'
 
 describe Garner::Cache::Context do
-
   describe 'garner' do
-
     before(:each) do
       class TestContext
         include Garner::Cache::Context
@@ -33,6 +31,5 @@ describe Garner::Cache::Context do
       end
       expect(subject.call.key_hash[:caller]).to be_nil
     end
-
   end
 end

data/spec/garner/cache/identity_spec.rb

@@ -1,7 +1,6 @@
 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' } }
     expect(subject.options_hash[:foo]).to eq 'bar'

data/spec/garner/cache_spec.rb

@@ -48,7 +48,7 @@ describe Garner::Cache do
 
     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' })
+      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

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

@@ -82,6 +82,7 @@ describe Garner::Mixins::Mongoid::Identity do
       end
 
       @monger = Monger.create(name: 'M1')
+      @monger.reload
       @cheese = Cheese.create(name: 'Havarti')
       @cheese.reload
     end

data/spec/garner/mixins/rack_spec.rb

@@ -2,9 +2,7 @@ require 'spec_helper'
 require 'garner/mixins/rack'
 
 describe Garner::Mixins::Rack do
-
   describe 'garner' do
-
     before(:each) do
       class MockApp
         include Garner::Mixins::Rack
@@ -43,6 +41,5 @@ describe Garner::Mixins::Rack do
       expect(subject.call.key_hash[:caller]).to be_nil
       expect(subject.call.key_hash[:request_params]).to eq('foo' => 'bar')
     end
-
   end
 end

data/spec/garner/strategies/binding/invalidation/binding_index_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Garner::Strategies::Binding::Invalidation::BindingIndex do
-
   before(:each) do
     @mock = double('model')
     allow(@mock).to receive(:touch)
@@ -10,5 +9,4 @@ describe Garner::Strategies::Binding::Invalidation::BindingIndex do
   subject { Garner::Strategies::Binding::Invalidation::BindingIndex }
 
   it_behaves_like 'Garner::Strategies::Binding::Invalidation strategy'
-
 end

data/spec/garner/strategies/binding/invalidation/touch_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Garner::Strategies::Binding::Invalidation::Touch do
-
   before(:each) do
     @mock = double('model')
     allow(@mock).to receive(:touch)

data/spec/garner/strategies/binding/key/binding_index_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Garner::Strategies::Binding::Key::BindingIndex do
-
   before(:each) do
     @new_mock = double('new_mock')
 
@@ -68,9 +67,9 @@ describe Garner::Strategies::Binding::Key::BindingIndex do
       it 'stores the cache key to cache' do
         subject.fetch_cache_key_for(@persisted_mock)
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: 'Mocker/id=4'
-                                 )).to eq @mock_key
+                 strategy: subject,
+                 proxied_binding: 'Mocker/id=4'
+        )).to eq @mock_key
       end
     end
 
@@ -82,17 +81,17 @@ describe Garner::Strategies::Binding::Key::BindingIndex do
       it 'stores the canonical binding to cache' do
         subject.fetch_cache_key_for(@persisted_mock_alias)
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: 'MockerAlias/id=alias-4'
-                                 )).to eq @persisted_mock
+                 strategy: subject,
+                 proxied_binding: 'MockerAlias/id=alias-4'
+        )).to eq @persisted_mock
       end
 
       it 'stores the cache key to cache' do
         subject.fetch_cache_key_for(@persisted_mock_alias)
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: 'Mocker/id=4'
-                                 )).to eq @mock_key
+                 strategy: subject,
+                 proxied_binding: 'Mocker/id=4'
+        )).to eq @mock_key
       end
 
       context 'whose canonical binding is nil' do
@@ -107,9 +106,9 @@ describe Garner::Strategies::Binding::Key::BindingIndex do
         it 'does not store the cache key to cache' do
           subject.fetch_cache_key_for(@persisted_mock_alias)
           expect(Garner.config.cache.read(
-                                     strategy: subject,
-                                     proxied_binding: ''
-                                   )).to be_nil
+                   strategy: subject,
+                   proxied_binding: ''
+          )).to be_nil
         end
       end
     end
@@ -154,9 +153,9 @@ describe Garner::Strategies::Binding::Key::BindingIndex do
       it 'stores the canonical binding to cache' do
         subject.fetch_canonical_binding_for(@persisted_mock_alias)
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: 'MockerAlias/id=alias-4'
-                                 )).to eq @persisted_mock
+                 strategy: subject,
+                 proxied_binding: 'MockerAlias/id=alias-4'
+        )).to eq @persisted_mock
       end
     end
 
@@ -221,24 +220,24 @@ describe Garner::Strategies::Binding::Key::BindingIndex do
         expect(key1).to eq key2
 
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: "Garner::Mixins::Mongoid::Identity/klass=Food,handle=#{@cheese.id}"
-                                 )).to eq @cheese
+                 strategy: subject,
+                 proxied_binding: "Garner::Mixins::Mongoid::Identity/klass=Food,handle=#{@cheese.id}"
+        )).to eq @cheese
 
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: 'Garner::Mixins::Mongoid::Identity/klass=Cheese,handle=m1'
-                                 )).to eq @cheese
+                 strategy: subject,
+                 proxied_binding: 'Garner::Mixins::Mongoid::Identity/klass=Cheese,handle=m1'
+        )).to eq @cheese
 
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: "Cheese/id=#{@cheese.id}"
-                                 )).to eq key1
+                 strategy: subject,
+                 proxied_binding: "Cheese/id=#{@cheese.id}"
+        )).to eq key1
 
         expect(Garner.config.cache.read(
-                                   strategy: subject,
-                                   proxied_binding: "Food/id=#{@cheese.id}"
-                                 )).to be_nil
+                 strategy: subject,
+                 proxied_binding: "Food/id=#{@cheese.id}"
+        )).to be_nil
       end
     end
   end

data/spec/garner/strategies/binding/key/cache_key_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Garner::Strategies::Binding::Key::CacheKey do
-
   before(:each) do
     @mock = double('model')
     allow(@mock).to receive(:cache_key) { 'mocks/4' }

data/spec/garner/strategies/binding/key/safe_cache_key_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe Garner::Strategies::Binding::Key::SafeCacheKey do
-
   before(:each) do
     @new_mock = double('model')
     allow(@new_mock).to receive(:cache_key) { 'mocks/4' }

data/spec/garner/strategies/context/key/request_get_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe Garner::Strategies::Context::Key::RequestGet do
   %w(GET HEAD).each do |method|
     context method do
-
       before(:each) do
         @cache_identity = Garner::Cache::Identity.new
         @request = Rack::Request.new('REQUEST_METHOD' => method, 'QUERY_STRING' => 'foo=bar')

data/spec/integration/active_record_spec.rb

@@ -2,7 +2,6 @@ require 'spec_helper'
 
 describe 'ActiveRecord integration', type: :request do
   context 'using the Garner::Strategies::Binding::Key::CacheKey strategy' do
-
     describe 'cache key generation' do
       subject { Garner::Strategies::Binding::Key::CacheKey }
 

data/spec/integration/mongoid_spec.rb

@@ -125,7 +125,6 @@ describe 'Mongoid integration', type: :request do
                 expect(Monger).to receive(:find).once
                 2.times { Monger.garnered_find(%w(m1 m2)) }
               end
-
             end
           end
 

data/spec/integration/sinatra_spec.rb

@@ -1,9 +1,10 @@
+# encoding: utf-8
+
 require 'spec_helper'
 require 'garner/mixins/rack'
 require 'sinatra'
 
 describe 'Sinatra integration', type: :request do
-
   let(:app) do
     class TestSinatraApp < Sinatra::Base
       helpers Garner::Mixins::Rack
@@ -25,5 +26,4 @@ describe 'Sinatra integration', type: :request do
   end
 
   it_behaves_like 'Rack::ConditionalGet server'
-
 end

data/spec/performance/support/benchmark_context_wrapper.rb

@@ -53,7 +53,8 @@ class BenchmarkContextWrapper
   private
 
   def warm_caches
-    klass, handle = binding.class, binding.slug
+    klass = binding.class
+    handle = binding.slug
     json = binding.reload.to_json
     garner.bind(klass.identify(handle)).key(caller: nil) { json }
     garner.bind(klass).key(caller: nil) { json }

data/spec/shared/conditional_get.rb

@@ -14,28 +14,28 @@ shared_examples_for 'Rack::ConditionalGet server' do
 
   it "writes the cached object's ETag from binding" do
     get '/'
-    expect(last_response.headers['ETag'].length).to eq 32 + 2
+    expect(last_response.headers['ETag'].length).to eq 32 + 2 + 2
   end
 
   it 'sends a 304 response if content has not changed (If-None-Match)' do
     get '/'
     expect(last_response.status).to eq 200
-    expect(last_response.headers['ETag']).to eq %("#{etag_for(last_response.body)}")
-    get '/', {},  'HTTP_IF_NONE_MATCH' => last_response.headers['ETag']
+    expect(last_response.headers['ETag']).to eq "W/\"#{etag_for(last_response.body)}\""
+    get '/', {}, 'HTTP_IF_NONE_MATCH' => last_response.headers['ETag']
     expect(last_response.status).to eq 304
   end
 
   it 'sends a 200 response if content has changed (If-None-Match)' do
     get '/'
     expect(last_response.status).to eq 200
-    get '/', {},  'HTTP_IF_NONE_MATCH' => %("#{etag_for('foobar')}")
+    get '/', {}, 'HTTP_IF_NONE_MATCH' => %("#{etag_for('foobar')}")
     expect(last_response.status).to eq 200
   end
 
   it 'sends a 200 response if content has changed (valid If-Modified-Since but invalid If-None-Match)' do
     get '/'
     expect(last_response.status).to eq 200
-    get '/', {},  'HTTP_IF_MODIFIED_SINCE' => (Time.now + 1).httpdate, 'HTTP_IF_NONE_MATCH' => %("#{etag_for(last_response.body)}")
+    get '/', {}, 'HTTP_IF_MODIFIED_SINCE' => (Time.now + 1).httpdate, 'HTTP_IF_NONE_MATCH' => etag_for(last_response.body)
     expect(last_response.status).to eq 200
   end
 

data/spec/support/mongoid.rb

@@ -1,24 +1,14 @@
 require 'garner/mixins/mongoid'
 require 'mongoid_slug'
 
-# Use garner_test database for integration tests
-Mongoid.load_configuration(
-  sessions: {
-    default: {
-      uri: ENV['GARNER_MONGO_URL'] || 'mongodb://localhost/garner_test',
-      safe: true
-    }
-  },
-  options: {
-    raise_not_found_error: false
-  }
-)
-
-if ENV['GARNER_MONGOID_LOG']
-  Mongoid.logger = Logger.new(ENV['GARNER_MONGOID_LOG'])
-  Moped.logger = Mongoid.logger
+Mongoid.configure do |config|
+  config.connect_to 'garner_test'
+  config.raise_not_found_error = false
 end
 
+Mongoid.logger.level = Logger::INFO
+Mongo::Logger.logger.level = Logger::INFO if Mongoid::Compatibility::Version.mongoid5?
+
 # Include mixin
 module Mongoid
   module Document

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garner
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Daniel Doubrovkine
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-26 00:00:00.000000000 Z
+date: 2015-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -166,7 +166,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
-  name: mongoid_slug
+  name: mongoid-slug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -255,14 +255,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.34.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.27.1
+        version: 0.34.2
 description: 
 email:
 - dblock@dblock.org
@@ -371,7 +371,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Garner is a cache layer for Ruby and Rack applications, supporting model