garner 0.3.1 → 0.3.2

data/README.md

@@ -142,6 +142,7 @@ Available Key Strategies
 * `Garner::Strategies::Keys::Version` inserts the output of a `version` method, when available, primarily targeted at API implementations.
 * `Garner::Strategies::Keys::Key` inserts the value of `:key` within the requested context, useful to explicitly declare an element of a cache key.
 * `Garner::Strategies::Keys::RequestGet` inserts the value of HTTP request's GET parameters into the cache key when `:request` is present in the context.
+* `Garner::Strategies::Keys::RequestPost` inserts the value of HTTP request's POST parameters into the cache key when `:request` is present in the context.
 * `Garner::Strategies::Keys::RequestPath` inserts the value of the HTTP request's path into the cache key when `:request` is present in the context.
 
 Fetching Objects Directly from Cache
@@ -156,6 +157,22 @@ Garner::Cache::ObjectIdentity.cache({ bind: [ Model, { id: object_id }] }) do
 end
 ```
 
+When fetching directly from the cache, it may be useful to supply a generational cache key in addition to the bindings. (When the generational component changes, the cache result is invalidated independent of the bindings' state.) E.g.:
+
+```ruby
+Garner::Cache::ObjectIdentity.cache(bind: [Model, {id: object_id}], key: {v: '1'}) do
+  # ...
+end
+```
+
+Or, using the Grape mix-in:
+
+```ruby
+cache_or_304(bind: [User, current_user.id], key: {v: '1'}) do
+  # ...
+end
+```
+
 Various cache stores, including Memcached, support bulk read operations. The [Dalli gem](https://github.com/mperham/dalli) exposes this via the `read_multi` method. When invoked with a collection of bindings, Garner will call `read_multi` if available. This may significantly reduce the number of network roundtrips to the cache servers.
 
 ``` ruby

data/lib/garner/cache/object_identity.rb

@@ -38,7 +38,8 @@ module Garner
         Garner::Strategies::Keys::Caller,
         Garner::Strategies::Keys::Version,
         Garner::Strategies::Keys::RequestPath,
-        Garner::Strategies::Keys::RequestGet
+        Garner::Strategies::Keys::RequestGet,
+        Garner::Strategies::Keys::RequestPost
       ]
 
       CACHE_STRATEGIES = [
@@ -65,7 +66,7 @@ module Garner
           end
           # attempt to do a read_multi if the cache supports it
           read_multi = keys.size > 1 && Garner.config.cache.respond_to?(:read_multi)
-          local_cache = read_multi ? Garner.config.cache.read_multi(keys) : {}
+          local_cache = read_multi ? Garner.config.cache.read_multi(*keys) : {}
           # fetch all missing values
           bindings.each_with_index.map do |binding, index|
             key = keys[index]
@@ -164,7 +165,7 @@ module Garner
               find_or_create_key_prefix_for(el[:klass], el[:object])
             }.join(",") + ":" +
             Digest::MD5.hexdigest(
-              KEY_STRATEGIES.map { |strategy| context[strategy.field] }.compact.join("\n")
+              KEY_STRATEGIES.map { |strategy| context[strategy.field] }.uniq.compact.join("\n")
             )
           end
 

data/lib/garner/mixins/mongoid_document.rb

@@ -32,8 +32,10 @@ module Garner
           obj = self
           docs = []
           while obj.metadata && obj.embedded?
+            # FIXME: This is not a robust check for cycles
             break if docs.detect { |doc| doc.class == obj.class }
             parent = obj.send(obj.metadata.inverse)
+            break unless parent
             docs << parent
             obj = parent
           end

data/lib/garner/strategies/keys/caller_strategy.rb

@@ -16,15 +16,19 @@ module Garner
               return rc
             end
 
-            caller.each do |line|
-              split = line.split(":")
-              next unless split.length >= 2
-              path = (Pathname.new(split[0]).realpath.to_s rescue nil)
-              next if path.blank? || path.include?("lib/garner")
-              next unless path.include?("/app/") || path.include?("/spec/")
-              rc[field] = "#{path}:#{split[1]}"
-              break
+            if caller
+              caller.each do |line|
+                next unless line
+                split = line.split(":")
+                next unless split && split.length >= 2
+                path = (Pathname.new(split[0]).realpath.to_s rescue nil)
+                next if (! path) || path.empty? || path.include?("lib/garner")
+                next unless path.include?("/app/") || path.include?("/spec/")
+                rc[field] = "#{path}:#{split[1]}"
+                break
+              end
             end
+
             rc
           end
         end

data/lib/garner/strategies/keys/request_get_strategy.rb

@@ -11,7 +11,9 @@ module Garner
           
           def apply(key, context = {})
             key = key ? key.dup : {}
-            key[field] = context[:request].GET.dup if context && context[:request]
+            if context && (request = context[:request]) && [ "GET", "HEAD" ].include?(request.request_method)
+              key[field] = context[:request].GET.dup
+            end
             key
           end
           

data/lib/garner/strategies/keys/request_post_strategy.rb

@@ -0,0 +1,24 @@
+module Garner
+  module Strategies
+    module Keys
+      # Inject the request POST parameters into the key.
+      module RequestPost
+        class << self
+        
+          def field
+            :params
+          end
+          
+          def apply(key, context = {})
+            key = key ? key.dup : {}
+            if context && (request = context[:request]) && request.request_method == "POST"
+              key[field] = request.POST.dup
+            end
+            key
+          end
+          
+        end
+      end
+    end
+  end
+end

data/lib/garner/version.rb

@@ -1,3 +1,3 @@
 module Garner
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/garner.rb

@@ -11,6 +11,7 @@ require 'garner/strategies/keys/version_strategy'
 require 'garner/strategies/keys/caller_strategy'
 require 'garner/strategies/keys/request_path_strategy'
 require 'garner/strategies/keys/request_get_strategy'
+require 'garner/strategies/keys/request_post_strategy'
 require 'garner/strategies/keys/key_strategy'
 require 'garner/strategies/keys/jsonp_strategy'
 # etag strategies

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: garner
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-25 00:00:00.000000000 Z
+date: 2013-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -83,7 +83,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,13 +91,13 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
   type: :development
@@ -105,7 +105,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.2.0
 - !ruby/object:Gem::Dependency
@@ -113,81 +113,81 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: 2.10.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: dalli
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -260,6 +260,7 @@ files:
 - lib/garner/strategies/keys/key_strategy.rb
 - lib/garner/strategies/keys/request_get_strategy.rb
 - lib/garner/strategies/keys/request_path_strategy.rb
+- lib/garner/strategies/keys/request_post_strategy.rb
 - lib/garner/strategies/keys/version_strategy.rb
 - lib/garner/version.rb
 - LICENSE.md
@@ -279,7 +280,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2019166628533219668
+      hash: -971041197
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: