garner 0.4.4 → 0.4.5

data/README.md

@@ -1,4 +1,4 @@
-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)
+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 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!
@@ -8,7 +8,7 @@ If you're not familiar with HTTP caching, ETags and If-Modified-Since, watch us
 Upgrading
 ---------
 
-The current stable release of Garner is 0.4.1, and contains many breaking changes from the previous stable release, 0.3.3. For a summary of important changes, see [UPGRADING](UPGRADING.md).
+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).
 
 Usage
 -----
@@ -18,7 +18,7 @@ Usage
 Add Garner to your Gemfile with `gem "garner"` and run `bundle install`. Next, include the appropriate mixin in your app:
 
 * For plain-old Ruby apps, `include Garner::Cache::Context`.
-* For Rack apps, `include Garner::Mixins::Rack`. (This provides saner defaults for injecting request parameters into the cache context key. More on cache context keys later.)
+* For Rack apps, first `require "garner/mixins/rack"`, then `include Garner::Mixins::Rack`. (This provides saner defaults for injecting request parameters into the cache context key. More on cache context keys later.)
 
 Now, to use Garner's cache, invoke `garner` with a logic block from within your application. The result of the block will be computed once, and then stored in the cache.
 
@@ -54,6 +54,8 @@ ORM Integrations
 To use Mongoid documents and classes for Garner bindings, use `Garner::Mixins::Mongoid::Document`. You can set it up in an initializer:
 
 ``` ruby
+require "garner/mixins/mongoid"
+
 module Mongoid
   module Document
     include Garner::Mixins::Mongoid::Document
@@ -122,6 +124,19 @@ module ActiveRecord
 end
 ```
 
+Cache Options
+-------------
+
+You can pass additional options directly to the cache implementation:
+
+``` ruby
+get "/latest_order" do
+  # Expire the latest order every 15 minutes
+  garner.options(expires_in: 15.minutes) do
+    Order.latest
+  end
+end
+```
 
 Under The Hood: Bindings
 ------------------------

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

@@ -38,15 +38,28 @@ module Garner
             Mongoid::Identity.from_class_and_handle(self, handle)
           end
 
-          # Find an object by _id, or other findable field, first trying to
-          # fetch from Garner's cache.
+          # Find an object by _id, or other findable field, or by multiple findable
+          # fields, first trying to fetch from Garner's cache.
           #
-          # @return [Mongoid::Document]
-          def self.garnered_find(handle)
-            return nil unless (binding = identify(handle))
+          #
+          # @example Find by an id.
+          #   Garner::Mixins::Mongoid::Document.garnered_find(BSON::ObjectId.new)
+          #
+          # @example Find by multiple id's.
+          #   Garner::Mixins::Mongoid::Document.garnered_find(BSON::ObjectId.new, BSON::ObjectId.new)
+          #
+          # @example Find by multiple id's in an array.
+          #   Garner::Mixins::Mongoid::Document.garnered_find([ BSON::ObjectId.new, BSON::ObjectId.new ])
+          #
+          # @return [ Array<Mongoid::Document>, Mongoid::Document ]
+          def self.garnered_find(*args)
             identity = Garner::Cache::Identity.new
-            identity.bind(binding).key({ :source => :garnered_find }) do
-              find(handle)
+            args.flatten.each do |arg|
+              binding = identify(arg)
+              identity = identity.bind(binding)
+            end
+            identity.key({ :garnered_find_args => args }) do
+              find(*args)
             end
           end
 

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

@@ -30,6 +30,7 @@ module Garner
         #
         # @return [Mongoid::Document]
         def proxy_binding
+          return nil unless handle
           @proxy_binding ||= klass.where(conditions).only(:_id, :_type, :updated_at).limit(1).entries.first
         end
 
@@ -50,7 +51,7 @@ module Garner
         end
 
         def self.conditions_for(klass, handle)
-          # multiple-ID conditions
+          # Multiple-ID conditions
           conditions = {
             "$or" => Garner.config.mongoid_identity_fields.map { |field|
               { field => handle }

data/lib/garner/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garner
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -400,7 +400,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4248293876720409745
+      hash: 1633170604903825081
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: