artsy/garner

View on GitHub
lib/garner/cache/identity.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Garner
  module Cache
    class Identity
      attr_accessor :ruby_context
      attr_accessor :bindings, :key_hash, :options_hash

      def initialize(ruby_context = nil)
        @ruby_context = ruby_context

        @bindings = []
        @key_hash = {}

        # Set up options hash with defaults
        @options_hash = Garner.config.global_cache_options.dup || {}
        @options_hash[:expires_in] ||= Garner.config.expires_in
      end

      def fetch(&block)
        if @nocache
          yield
        else
          Garner::Cache.fetch(@bindings, @key_hash, @options_hash, &block)
        end
      end

      # Disable caching for this identity.
      def nocache
        @nocache = true
        block_given? ? fetch(&block) : self
      end

      # Bind this cache identity to a (bindable) object.
      #
      # @param object [Object] An object; should support configured binding strategy.
      def bind(object, &block)
        @bindings << object
        block_given? ? fetch(&block) : self
      end

      # Merge the given hash into the cache identity's key hash.
      #
      # @param hash [Hash] A hash to merge on top of the current key hash.
      def key(hash, &block)
        @key_hash.merge!(hash)
        block_given? ? fetch(&block) : self
      end

      # Merge the given hash into the cache identity's cache options.
      # Any cache_options supported by Garner.config.cache may be passed.
      #
      # @param hash [Hash] Options to pass to Garner.config.cache.
      def options(hash, &block)
        @options_hash.merge!(hash)
        block_given? ? fetch(&block) : self
      end
    end
  end
end