garner 0.4.5 → 0.5.0

data/garner.gemspec

@@ -0,0 +1,44 @@
+$LOAD_PATH.push File.expand_path('../lib', __FILE__)
+require 'garner/version'
+
+Gem::Specification.new do |s|
+  s.name = 'garner'
+  s.version = Garner::VERSION
+  s.authors = ['Daniel Doubrovkine', 'Frank Macreery']
+  s.summary = 'Garner is a cache layer for Ruby and Rack applications, supporting model and instance binding and hierarchical invalidation.'
+  s.email = ['dblock@dblock.org', 'frank.macreery@gmail.com']
+  s.homepage = 'https://github.com/artsy/garner'
+  s.license = 'MIT'
+
+  s.files = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  s.test_files = s.files.grep(/^(spec)\//)
+  s.extra_rdoc_files = Dir['*.md']
+  s.require_paths = ['lib']
+
+  s.post_install_message = File.read('UPGRADING') if File.exist?('UPGRADING')
+
+  s.add_runtime_dependency 'rack'
+  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency 'multi_json', '>= 1.3.0'
+  s.add_runtime_dependency 'activesupport'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec', '~> 2.10'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'grape', '~> 0.8.0'
+  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 'activerecord'
+  if RUBY_PLATFORM =~ /java/
+    s.add_development_dependency 'jdbc-sqlite3'
+    s.add_development_dependency 'activerecord-jdbcsqlite3-adapter'
+  else
+    s.add_development_dependency 'sqlite3'
+  end
+  s.add_development_dependency 'coveralls'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'dalli'
+  s.add_development_dependency 'rubocop', '0.24.1'
+end

data/lib/garner.rb

@@ -1,31 +1,31 @@
-require "multi_json"
-require "active_support"
+require 'multi_json'
+require 'active_support'
 
 # Garner core
-require "garner/version"
-require "garner/config"
+require 'garner/version'
+require 'garner/config'
 
 # Key strategies
-require "garner/strategies/context/key/base"
-require "garner/strategies/context/key/caller"
-require "garner/strategies/context/key/request_path"
-require "garner/strategies/context/key/request_get"
-require "garner/strategies/context/key/request_post"
-require "garner/strategies/context/key/jsonp"
+require 'garner/strategies/context/key/base'
+require 'garner/strategies/context/key/caller'
+require 'garner/strategies/context/key/request_path'
+require 'garner/strategies/context/key/request_get'
+require 'garner/strategies/context/key/request_post'
+require 'garner/strategies/context/key/jsonp'
 
 # Binding strategies
-require "garner/strategies/binding/key/base"
-require "garner/strategies/binding/key/cache_key"
-require "garner/strategies/binding/key/safe_cache_key"
-require "garner/strategies/binding/key/binding_index"
+require 'garner/strategies/binding/key/base'
+require 'garner/strategies/binding/key/cache_key'
+require 'garner/strategies/binding/key/safe_cache_key'
+require 'garner/strategies/binding/key/binding_index'
 
 # Invalidation strategies
-require "garner/strategies/binding/invalidation/base"
-require "garner/strategies/binding/invalidation/touch"
-require "garner/strategies/binding/invalidation/binding_index"
+require 'garner/strategies/binding/invalidation/base'
+require 'garner/strategies/binding/invalidation/touch'
+require 'garner/strategies/binding/invalidation/binding_index'
 
 # Cache
-require "garner/cache"
-require "garner/cache/identity"
-require "garner/cache/context"
-require "garner/cache/binding"
+require 'garner/cache'
+require 'garner/cache/identity'
+require 'garner/cache/context'
+require 'garner/cache/binding'

data/lib/garner/cache.rb

@@ -1,5 +1,6 @@
 module Garner
   module Cache
+    class NilBinding < StandardError; end
 
     # Fetch a result from cache.
     #
@@ -7,7 +8,7 @@ module Garner
     #        bound. These objects' keys are injected into the compound cache key.
     # @param key_hash [Hash] Hash to comprise the compound cache key.
     # @param options_hash [Hash] Options to be passed to Garner.config.cache.
-    def self.fetch(bindings, key_hash, options_hash, &block)
+    def self.fetch(bindings, key_hash, options_hash, &_block)
       if (compound_key = compound_key(bindings, key_hash))
         result = Garner.config.cache.fetch(compound_key, options_hash) do
           yield
@@ -19,15 +20,13 @@ module Garner
       result
     end
 
-    private
     def self.compound_key(bindings, key_hash)
-      binding_keys = bindings.map(&:garner_cache_key).compact
-
+      binding_keys = bindings.map { |binding| key_for(binding) }.compact
       if binding_keys.size == bindings.size
         # All bindings have non-nil cache keys, proceed.
         {
-          :binding_keys => binding_keys,
-          :context_keys => key_hash
+          binding_keys: binding_keys,
+          context_keys: key_hash
         }
       else
         # A nil cache key was generated. Skip caching.
@@ -37,5 +36,13 @@ module Garner
       end
     end
 
+    def self.key_for(binding)
+      if binding.nil?
+        return nil unless Garner.config.whiny_nils?
+        fail NilBinding
+      else
+        binding.garner_cache_key
+      end
+    end
   end
 end

data/lib/garner/cache/binding.rb

@@ -1,21 +1,13 @@
 # Set up Garner configuration parameters
-Garner.config.option(:binding_key_strategy, {
-  :default => Garner::Strategies::Binding::Key::SafeCacheKey
-})
-Garner.config.option(:binding_invalidation_strategy, {
-  :default => Garner::Strategies::Binding::Invalidation::Touch
-})
-Garner.config.option(:mongoid_identity_fields, {
-  :default => [:_id]
-})
-Garner.config.option(:invalidate_mongoid_root, {
-  :default => true
-})
+
+Garner.config.option(:binding_key_strategy, default: Garner::Strategies::Binding::Key::SafeCacheKey)
+Garner.config.option(:binding_invalidation_strategy, default: Garner::Strategies::Binding::Invalidation::Touch)
+Garner.config.option(:mongoid_identity_fields, default: [:_id])
+Garner.config.option(:invalidate_mongoid_root, default: true)
 
 module Garner
   module Cache
     module Binding
-
       # Override this method to use a custom key strategy.
       #
       # @return [Object] The strategy to be used for instances of this class.
@@ -46,6 +38,7 @@ module Garner
       end
 
       protected
+
       def _invalidate
         invalidation_strategy.apply(self)
       end
@@ -61,7 +54,6 @@ module Garner
       def _garner_after_destroy
         _invalidate if invalidation_strategy.apply_on_callback?(:destroy)
       end
-
     end
   end
 end

data/lib/garner/cache/context.rb

@@ -1,20 +1,19 @@
 # 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,
-    Garner::Strategies::Context::Key::RequestGet,
-    Garner::Strategies::Context::Key::RequestPost,
-    Garner::Strategies::Context::Key::RequestPath
-  ]
-})
+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,
+                       Garner::Strategies::Context::Key::RequestGet,
+                       Garner::Strategies::Context::Key::RequestPost,
+                       Garner::Strategies::Context::Key::RequestPath
+                     ]
+)
 
 module Garner
   module Cache
     module Context
-
       # Instantiate a context-appropriate cache identity.
       #
       # @example

data/lib/garner/cache/identity.rb

@@ -12,7 +12,7 @@ module Garner
 
         # Set up options hash with defaults
         @options_hash = Garner.config.global_cache_options || {}
-        @options_hash.merge!({ :expires_in => Garner.config.expires_in })
+        @options_hash.merge!(expires_in: Garner.config.expires_in)
       end
 
       def fetch(&block)

data/lib/garner/config.rb

@@ -1,5 +1,4 @@
 module Garner
-
   class << self
     # Set the configuration options. Best used by passing a block.
     #
@@ -12,7 +11,7 @@ module Garner
     def configure
       block_given? ? yield(Garner::Config) : Garner::Config
     end
-    alias :config :configure
+    alias_method :config, :configure
   end
 
   module Config
@@ -77,7 +76,7 @@ module Garner
     #
     # @return [Cache] The configured cache or a default cache instance.
     def cache
-      settings[:cache] = default_cache unless settings.has_key?(:cache)
+      settings[:cache] = default_cache unless settings.key?(:cache)
       settings[:cache]
     end
 
@@ -103,7 +102,7 @@ module Garner
     #
     # @return [String] The configured caller_root or a default.
     def caller_root
-      settings[:caller_root] = default_caller_root unless settings.has_key?(:caller_root)
+      settings[:caller_root] = default_caller_root unless settings.key?(:caller_root)
       settings[:caller_root]
     end
 
@@ -123,10 +122,16 @@ module Garner
     end
 
     # Default cache options
-    option(:global_cache_options, :default => {})
+    option(:global_cache_options, default: {})
 
     # Default cache expiration time.
-    option(:expires_in, :default => nil)
+    option(:expires_in, default: nil)
+
+    # Default behavior on nil bindings
+    option(:whiny_nils, default: true)
+
+    def whiny_nils?
+      whiny_nils
+    end
   end
 end
-

data/lib/garner/mixins/active_record.rb

@@ -1,4 +1,4 @@
-require "garner"
-require "active_record"
+require 'garner'
+require 'active_record'
 
-require "garner/mixins/active_record/base"
+require 'garner/mixins/active_record/base'

data/lib/garner/mixins/active_record/base.rb

@@ -1,5 +1,5 @@
-require "garner"
-require "active_record"
+require 'garner'
+require 'active_record'
 
 module Garner
   module Mixins

data/lib/garner/mixins/mongoid.rb

@@ -1,5 +1,5 @@
-require "garner"
-require "mongoid"
+require 'garner'
+require 'mongoid'
 
-require "garner/mixins/mongoid/document"
-require "garner/mixins/mongoid/identity"
+require 'garner/mixins/mongoid/document'
+require 'garner/mixins/mongoid/identity'

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

@@ -58,30 +58,26 @@ module Garner
               binding = identify(arg)
               identity = identity.bind(binding)
             end
-            identity.key({ :garnered_find_args => args }) do
+            identity.key(garnered_find_args: args) do
               find(*args)
             end
           end
 
-          after_create    :_garner_after_create
-          after_update    :_garner_after_update
-          after_destroy   :_garner_after_destroy
+          after_create :_garner_after_create
+          after_update :_garner_after_update
+          after_destroy :_garner_after_destroy
 
           protected
+
           def self._latest_by_updated_at
             # Only find the latest if we can order by :updated_at
-            return nil unless fields["updated_at"]
-            only(:_id, :_type, :updated_at).order_by({
-              :updated_at => :desc
-            }).first
+            return nil unless fields['updated_at']
+            only(:_id, :_type, :updated_at).order_by(updated_at: :desc).first
           end
 
           def _invalidate
             invalidation_strategy.apply(self)
-
-            if _root != self && Garner.config.invalidate_mongoid_root
-              invalidation_strategy.apply(_root)
-            end
+            invalidation_strategy.apply(_root) if _root != self && Garner.config.invalidate_mongoid_root
           end
 
         end

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

@@ -15,7 +15,7 @@ module Garner
         def self.from_class_and_handle(klass, handle)
           validate_class!(klass)
 
-          self.new.tap do |identity|
+          new.tap do |identity|
             identity.klass = klass
             identity.handle = handle
             identity.conditions = conditions_for(klass, handle)
@@ -41,21 +41,20 @@ module Garner
           "#{self.class.name}/klass=#{klass},handle=#{handle}"
         end
 
-        private
         def self.validate_class!(klass)
           if !klass.include?(::Mongoid::Document)
-            raise "Must instantiate from a Mongoid class"
+            fail 'Must instantiate from a Mongoid class'
           elsif klass.embedded?
-            raise "Cannot instantiate from an embedded document class"
+            fail 'Cannot instantiate from an embedded document class'
           end
         end
 
         def self.conditions_for(klass, handle)
           # Multiple-ID conditions
           conditions = {
-            "$or" => Garner.config.mongoid_identity_fields.map { |field|
+            '$or' => Garner.config.mongoid_identity_fields.map do |field|
               { field => handle }
-            }
+            end
           }
 
           # _type conditions

data/lib/garner/mixins/rack.rb

@@ -1,9 +1,8 @@
-require "garner"
+require 'garner'
 
 module Garner
   module Mixins
     module Rack
-
       # Override this method to conditionally disable the cache.
       #
       # @return [Boolean]

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

@@ -3,11 +3,10 @@ module Garner
     module Binding
       module Invalidation
         class Base
-
           # Specifies whether invalidation should happen on callbacks.
           #
           # @param kind [Symbol] One of :create, :update, :destroy
-          def self.apply_on_callback?(kind = nil)
+          def self.apply_on_callback?(_kind = nil)
             true
           end
 
@@ -16,10 +15,9 @@ module Garner
           #
           # @param binding [Object] The binding whose caches are to be
           #   invalidated.
-          def self.apply(binding)
+          def self.apply(_binding)
           end
         end
-
       end
     end
   end

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

@@ -3,11 +3,10 @@ module Garner
     module Binding
       module Invalidation
         class BindingIndex < Base
-
           # Specifies whether invalidation should happen on callbacks.
           #
           # @param kind [Symbol] One of :create, :update, :destroy
-          def self.apply_on_callback?(kind = nil)
+          def self.apply_on_callback?(_kind = nil)
             true
           end
 
@@ -29,7 +28,6 @@ module Garner
           end
         end
       end
-
     end
   end
 end

data/lib/garner/strategies/binding/invalidation/touch.rb

@@ -3,7 +3,6 @@ module Garner
     module Binding
       module Invalidation
         class Touch < Base
-
           # Specifies whether invalidation should happen on callbacks.
           #
           # @param kind [Symbol] One of :create, :update, :destroy
@@ -35,7 +34,6 @@ module Garner
           end
         end
       end
-
     end
   end
 end