ashleym1972-cache-money 0.2.5.1

data/lib/cash/index.rb

@@ -0,0 +1,207 @@
+module Cash
+  class Index
+    attr_reader :attributes, :options
+    delegate :each, :hash, :to => :@attributes
+    delegate :get, :set, :expire, :find_every_without_cache, :calculate_without_cache, :calculate_with_cache, :incr, :decr, :primary_key, :to => :@active_record
+
+    DEFAULT_OPTIONS = { :ttl => 1.day }
+
+    def initialize(config, active_record, attributes, options = {})
+      @config, @active_record, @attributes, @options = config, active_record, Array(attributes).collect(&:to_s).sort, DEFAULT_OPTIONS.merge(options)
+    end
+
+    def ==(other)
+      case other
+      when Index
+        attributes == other.attributes
+      else
+        attributes == Array(other)
+      end
+    end
+    alias_method :eql?, :==
+
+    module Commands
+      def add(object)
+        clone = object.shallow_clone
+        _, new_attribute_value_pairs = old_and_new_attribute_value_pairs(object)
+        add_to_index_with_minimal_network_operations(new_attribute_value_pairs, clone)
+      end
+
+      def update(object)
+        clone = object.shallow_clone
+        old_attribute_value_pairs, new_attribute_value_pairs = old_and_new_attribute_value_pairs(object)
+        update_index_with_minimal_network_operations(old_attribute_value_pairs, new_attribute_value_pairs, clone)
+      end
+
+      def remove(object)
+        old_attribute_value_pairs, _ = old_and_new_attribute_value_pairs(object)
+        remove_from_index_with_minimal_network_operations(old_attribute_value_pairs, object)
+      end
+
+      def delete(object)
+        old_attribute_value_pairs, _ = old_and_new_attribute_value_pairs(object)
+        key = cache_key(old_attribute_value_pairs)
+        expire(key)
+      end
+    end
+    include Commands
+
+    module Attributes
+      def ttl
+        @ttl ||= options[:ttl] || config.ttl
+      end
+
+      def order
+        @order ||= options[:order] || :asc
+      end
+
+      def limit
+        options[:limit]
+      end
+
+      def buffer
+        options[:buffer]
+      end
+
+      def window
+        limit && limit + buffer
+      end
+    end
+    include Attributes
+
+    def serialize_object(object)
+      primary_key? ? object : object.id
+    end
+
+    def matches?(query)
+      query.calculation? ||
+      (query.order == ['id', order] &&
+      (!limit || (query.limit && query.limit + query.offset <= limit)))
+    end
+
+    private
+    def old_and_new_attribute_value_pairs(object)
+      old_attribute_value_pairs = []
+      new_attribute_value_pairs = []
+      @attributes.each do |name|
+        new_value = object.attributes[name]
+        original_value = object.send("#{name}_was")
+        old_attribute_value_pairs << [name, original_value]
+        new_attribute_value_pairs << [name, new_value]
+      end
+      [old_attribute_value_pairs, new_attribute_value_pairs]
+    end
+
+    def add_to_index_with_minimal_network_operations(attribute_value_pairs, object)
+      if primary_key?
+        add_object_to_primary_key_cache(attribute_value_pairs, object)
+      else
+        add_object_to_cache(attribute_value_pairs, object)
+      end
+    end
+
+    def primary_key?
+      @attributes.size == 1 && @attributes.first == primary_key
+    end
+
+    def add_object_to_primary_key_cache(attribute_value_pairs, object)
+      set(cache_key(attribute_value_pairs), [object], :ttl => ttl)
+    end
+
+    def cache_key(attribute_value_pairs)
+      attribute_value_pairs.flatten.join('/')
+    end
+
+    def add_object_to_cache(attribute_value_pairs, object, overwrite = true)
+      return if invalid_cache_key?(attribute_value_pairs)
+
+      key, cache_value, cache_hit = get_key_and_value_at_index(attribute_value_pairs)
+      if !cache_hit || overwrite
+        object_to_add = serialize_object(object)
+        objects = (cache_value + [object_to_add]).sort do |a, b|
+          (a <=> b) * (order == :asc ? 1 : -1)
+        end.uniq
+        objects = truncate_if_necessary(objects)
+        set(key, objects, :ttl => ttl)
+        incr("#{key}/count") { calculate_at_index(:count, attribute_value_pairs) }
+      end
+    end
+
+    def invalid_cache_key?(attribute_value_pairs)
+      attribute_value_pairs.collect { |_,value| value }.any? { |x| x.nil? }
+    end
+
+    def get_key_and_value_at_index(attribute_value_pairs)
+      key = cache_key(attribute_value_pairs)
+      cache_hit = true
+      cache_value = get(key) do
+        cache_hit = false
+        conditions = attribute_value_pairs.to_hash_without_nils
+        find_every_without_cache(:conditions => conditions, :limit => window).collect do |object|
+          serialize_object(object)
+        end
+      end
+      [key, cache_value, cache_hit]
+    end
+
+    def truncate_if_necessary(objects)
+      objects.slice(0, window || objects.size)
+    end
+
+    def calculate_at_index(operation, attribute_value_pairs)
+      conditions = attribute_value_pairs.to_hash_without_nils
+      calculate_without_cache(operation, :all, :conditions => conditions)
+    end
+
+    def update_index_with_minimal_network_operations(old_attribute_value_pairs, new_attribute_value_pairs, object)
+      if index_is_stale?(old_attribute_value_pairs, new_attribute_value_pairs)
+        remove_object_from_cache(old_attribute_value_pairs, object)
+        add_object_to_cache(new_attribute_value_pairs, object)
+      elsif primary_key?
+        add_object_to_primary_key_cache(new_attribute_value_pairs, object)
+      else
+        add_object_to_cache(new_attribute_value_pairs, object, false)
+      end
+    end
+
+    def index_is_stale?(old_attribute_value_pairs, new_attribute_value_pairs)
+      old_attribute_value_pairs != new_attribute_value_pairs
+    end
+
+    def remove_from_index_with_minimal_network_operations(attribute_value_pairs, object)
+      if primary_key?
+        remove_object_from_primary_key_cache(attribute_value_pairs, object)
+      else
+        remove_object_from_cache(attribute_value_pairs, object)
+      end
+    end
+
+    def remove_object_from_primary_key_cache(attribute_value_pairs, object)
+      set(cache_key(attribute_value_pairs), [], :ttl => ttl)
+    end
+
+    def remove_object_from_cache(attribute_value_pairs, object)
+      return if invalid_cache_key?(attribute_value_pairs)
+
+      key, cache_value, _ = get_key_and_value_at_index(attribute_value_pairs)
+      object_to_remove = serialize_object(object)
+      objects = cache_value - [object_to_remove]
+      objects = resize_if_necessary(attribute_value_pairs, objects)
+      set(key, objects, :ttl => ttl)
+    end
+
+    def resize_if_necessary(attribute_value_pairs, objects)
+      conditions = attribute_value_pairs.to_hash_without_nils
+      key = cache_key(attribute_value_pairs)
+      count = decr("#{key}/count") { calculate_at_index(:count, attribute_value_pairs) }
+
+      if limit && objects.size < limit && objects.size < count
+        find_every_without_cache(:select => :id, :conditions => conditions).collect do |object|
+          serialize_object(object)
+        end
+      else
+        objects
+      end
+    end
+  end
+end

data/lib/cash/local.rb

@@ -0,0 +1,59 @@
+module Cash
+  class Local
+    delegate :respond_to?, :to => :@remote_cache
+
+    def initialize(remote_cache)
+      @remote_cache = remote_cache
+    end
+
+    def cache_locally
+      @remote_cache = LocalBuffer.new(original_cache = @remote_cache)
+      yield
+    ensure
+      @remote_cache = original_cache
+    end
+
+    def method_missing(method, *args, &block)
+      @remote_cache.send(method, *args, &block)
+    end
+  end
+
+  class LocalBuffer
+    delegate :respond_to?, :to => :@remote_cache
+
+    def initialize(remote_cache)
+      @local_cache = {}
+      @remote_cache = remote_cache
+    end
+
+    def get(key, *options)
+      if @local_cache.has_key?(key)
+        @local_cache[key]
+      else
+        @local_cache[key] = @remote_cache.get(key, *options)
+      end
+    end
+
+    def set(key, value, *options)
+      @remote_cache.set(key, value, *options)
+      @local_cache[key] = value
+    end
+
+    def add(key, value, *options)
+      result = @remote_cache.add(key, value, *options)
+      if result == "STORED\r\n"
+        @local_cache[key] = value
+      end
+      result
+    end
+
+    def delete(key, *options)
+      @remote_cache.delete(key, *options)
+      @local_cache.delete(key)
+    end
+
+    def method_missing(method, *args, &block)
+      @remote_cache.send(method, *args, &block)
+    end
+  end
+end

data/lib/cash/lock.rb

@@ -0,0 +1,53 @@
+module Cash
+  class Lock
+    class Error < RuntimeError; end
+
+    DEFAULT_RETRY = 5
+    DEFAULT_EXPIRY = 30
+
+    def initialize(cache)
+      @cache = cache
+      @runtime = Benchmark::Tms.new
+    end
+
+    def synchronize(key, lock_expiry = DEFAULT_EXPIRY, retries = DEFAULT_RETRY)
+      if recursive_lock?(key)
+        yield
+      else
+        acquire_lock(key, lock_expiry, retries)
+        begin
+          yield
+        ensure
+          release_lock(key)
+        end
+      end
+    end
+
+    def acquire_lock(key, lock_expiry = DEFAULT_EXPIRY, retries = DEFAULT_RETRY)
+      retries.times do |count|
+        begin
+          response = @cache.add("lock/#{key}", Process.pid, lock_expiry)
+          return if response == "STORED\r\n"
+          raise Error if count == retries - 1
+        end
+        exponential_sleep(count) unless count == retries - 1
+      end
+      raise Error, "Couldn't acquire memcache lock for: #{key}"
+    end
+
+    def release_lock(key)
+      @cache.delete("lock/#{key}")
+    end
+
+    def exponential_sleep(count)
+      @runtime += Benchmark::measure { sleep((2**count) / 2.0) }
+    end
+
+    private
+
+    def recursive_lock?(key)
+      @cache.get("lock/#{key}") == Process.pid
+    end
+
+  end
+end

data/lib/cash/mock.rb

@@ -0,0 +1,154 @@
+module Cash
+  class Mock < HashWithIndifferentAccess
+    attr_accessor :servers
+
+    class CacheEntry
+      attr_reader :value
+      
+      def self.default_ttl
+        1_000_000
+      end
+
+      def self.now
+        Time.now
+      end
+      
+      def initialize(value, raw, ttl)
+        if raw
+          @value = value.to_s
+        else
+          @value = Marshal.dump(value)
+        end
+        
+        if ttl.zero?
+          @ttl = self.class.default_ttl
+        else
+          @ttl = ttl
+        end
+        
+        @expires_at = self.class.now + @ttl
+      end
+      
+      
+      def expired?
+        self.class.now > @expires_at
+      end
+      
+      def increment(amount = 1)
+        @value = (@value.to_i + amount).to_s
+      end
+      
+      def decrement(amount = 1)
+        @value = (@value.to_i - amount).to_s
+      end
+      
+      def unmarshal
+        Marshal.load(@value)
+      end
+      
+      def to_i
+        @value.to_i
+      end
+    end
+    
+    attr_accessor :logging
+    
+    def initialize
+      @logging = false
+    end
+    
+    def get_multi(keys)
+      slice(*keys).collect { |k,v| [k, v.unmarshal] }.to_hash_without_nils
+    end
+
+    def set(key, value, ttl = CacheEntry.default_ttl, raw = false)
+      log "< set #{key} #{ttl}"
+      self[key] = CacheEntry.new(value, raw, ttl)
+      log('> STORED')
+    end
+
+    def get(key, raw = false)
+      log "< get #{key}"
+      unless self.has_unexpired_key?(key)
+        log('> END')
+        return nil
+      end
+      
+      log("> sending key #{key}")
+      log('> END')
+      if raw
+        self[key].value
+      else
+        self[key].unmarshal
+      end
+    end
+    
+    def delete(key, options = {})
+      log "< delete #{key}"
+      if self.has_unexpired_key?(key)
+        log "> DELETED"
+        super(key)
+      else
+        log "> NOT FOUND"
+      end
+    end
+
+    def incr(key, amount = 1)
+      if self.has_unexpired_key?(key)
+        self[key].increment(amount)
+        self[key].to_i
+      end
+    end
+
+    def decr(key, amount = 1)
+      if self.has_unexpired_key?(key)
+        self[key].decrement(amount)
+        self[key].to_i
+      end
+    end
+
+    def add(key, value, ttl = CacheEntry.default_ttl, raw = false)
+      if self.has_unexpired_key?(key)
+        "NOT_STORED\r\n"
+      else
+        set(key, value, ttl, raw)
+        "STORED\r\n"
+      end
+    end
+
+    def append(key, value)
+      set(key, get(key, true).to_s + value.to_s, nil, true)
+    end
+
+    def namespace
+      nil
+    end
+
+    def flush_all
+      log('< flush_all')
+      clear
+    end
+
+    def stats
+      {}
+    end
+
+    def reset_runtime
+      [0, Hash.new(0)]
+    end
+
+    def has_unexpired_key?(key)
+      self.has_key?(key) && !self[key].expired?
+    end
+    
+    def log(message)
+      return unless logging
+      logger.debug(message)
+    end
+    
+    def logger
+      @logger ||= ActiveSupport::BufferedLogger.new(Rails.root.join('log/cash_mock.log'))
+    end
+    
+  end
+end

data/lib/cash/query/abstract.rb

@@ -0,0 +1,173 @@
+module Cash
+  module Query
+    class Abstract
+      delegate :with_exclusive_scope, :get, :table_name, :indices, :find_from_ids_without_cache, :cache_key, :columns_hash, :to => :@active_record
+
+      def self.perform(*args)
+        new(*args).perform
+      end
+
+      def initialize(active_record, options1, options2)
+        @active_record, @options1, @options2 = active_record, options1, options2 || {}
+
+        if active_record.base_class != active_record
+          @options2[:conditions] = active_record.merge_conditions(
+            @options2[:conditions], { active_record.inheritance_column => active_record.to_s }
+          )
+        end
+      end
+
+      def perform(find_options = {}, get_options = {})
+        if cache_config = cacheable?(@options1, @options2, find_options)
+          cache_keys, index = cache_keys(cache_config[0]), cache_config[1]
+
+          misses, missed_keys, objects = hit_or_miss(cache_keys, index, get_options)
+          format_results(cache_keys, choose_deserialized_objects_if_possible(missed_keys, cache_keys, misses, objects))
+        else
+          uncacheable
+        end
+      end
+
+      DESC = /DESC/i
+
+      def order
+        @order ||= begin
+          if order_sql = @options1[:order] || @options2[:order]
+            matched, table_name, column_name, direction = *(ORDER.match(order_sql))
+            [column_name, direction =~ DESC ? :desc : :asc]
+          else
+            ['id', :asc]
+          end
+        end
+      end
+
+      def limit
+        @limit ||= @options1[:limit] || @options2[:limit]
+      end
+
+      def offset
+        @offset ||= @options1[:offset] || @options2[:offset] || 0
+      end
+
+      def calculation?
+        false
+      end
+
+      private
+      def cacheable?(*optionss)
+        optionss.each { |options| return unless safe_options_for_cache?(options) }
+        partial_indices = optionss.collect { |options| attribute_value_pairs_for_conditions(options[:conditions]) }
+        return if partial_indices.include?(nil)
+        attribute_value_pairs = partial_indices.sum.sort { |x, y| x[0] <=> y[0] }
+
+        attribute_value_pairs.each do |attribute_value_pair|
+          return false if attribute_value_pair.last.is_a?(Array)
+        end
+
+        if index = indexed_on?(attribute_value_pairs.collect { |pair| pair[0] })
+          if index.matches?(self)
+            [attribute_value_pairs, index]
+          end
+        end
+      end
+
+      def hit_or_miss(cache_keys, index, options)
+        misses, missed_keys = nil, nil
+        objects = @active_record.get(cache_keys, options.merge(:ttl => index.ttl)) do |missed_keys|
+          misses = miss(missed_keys, @options1.merge(:limit => index.window))
+          serialize_objects(index, misses)
+        end
+        [misses, missed_keys, objects]
+      end
+
+      def cache_keys(attribute_value_pairs)
+        attribute_value_pairs.flatten.join('/')
+      end
+
+      def safe_options_for_cache?(options)
+        return false unless options.kind_of?(Hash)
+        options.except(:conditions, :readonly, :limit, :offset, :order).values.compact.empty? && !options[:readonly]
+      end
+
+      def attribute_value_pairs_for_conditions(conditions)
+        case conditions
+        when Hash
+          conditions.to_a.collect { |key, value| [key.to_s, value] }
+        when String
+          parse_indices_from_condition(conditions)
+        when Array
+          parse_indices_from_condition(*conditions)
+        when NilClass
+          []
+        end
+      end
+
+      AND = /\s+AND\s+/i
+      TABLE_AND_COLUMN = /(?:(?:`|")?(\w+)(?:`|")?\.)?(?:`|")?(\w+)(?:`|")?/              # Matches: `users`.id, `users`.`id`, users.id, id
+      VALUE = /'?(\d+|\?|(?:(?:[^']|'')*))'?/                     # Matches: 123, ?, '123', '12''3'
+      KEY_EQ_VALUE = /^\(?#{TABLE_AND_COLUMN}\s+=\s+#{VALUE}\)?$/ # Matches: KEY = VALUE, (KEY = VALUE)
+      ORDER = /^#{TABLE_AND_COLUMN}\s*(ASC|DESC)?$/i              # Matches: COLUMN ASC, COLUMN DESC, COLUMN
+
+      def parse_indices_from_condition(conditions = '', *values)
+        values = values.dup
+        conditions.split(AND).inject([]) do |indices, condition|
+          matched, table_name, column_name, sql_value = *(KEY_EQ_VALUE.match(condition))
+          if matched
+            value = sql_value == '?' ? values.shift : columns_hash[column_name].type_cast(sql_value)
+            indices << [column_name, value]
+          else
+            return nil
+          end
+        end
+      end
+
+      def indexed_on?(attributes)
+        indices.detect { |index| index == attributes }
+      end
+      alias_method :index_for, :indexed_on?
+
+      def format_results(cache_keys, objects)
+        return objects if objects.blank?
+
+        objects = convert_to_array(cache_keys, objects)
+        objects = apply_limits_and_offsets(objects, @options1)
+        deserialize_objects(objects)
+      end
+
+      def choose_deserialized_objects_if_possible(missed_keys, cache_keys, misses, objects)
+        missed_keys == cache_keys ? misses : objects
+      end
+
+      def serialize_objects(index, objects)
+        Array(objects).collect { |missed| index.serialize_object(missed) }
+      end
+
+      def convert_to_array(cache_keys, object)
+        if object.kind_of?(Hash)
+          cache_keys.collect { |key| object[cache_key(key)] }.flatten.compact
+        else
+          Array(object)
+        end
+      end
+
+      def apply_limits_and_offsets(results, options)
+        results.slice((options[:offset] || 0), (options[:limit] || results.length))
+      end
+
+      def deserialize_objects(objects)
+        if objects.first.kind_of?(ActiveRecord::Base)
+          objects
+        else
+          cache_keys = objects.collect { |id| "id/#{id}" }
+          objects = get(cache_keys, &method(:find_from_keys))
+          convert_to_array(cache_keys, objects)
+        end
+      end
+
+      def find_from_keys(*missing_keys)
+        missing_ids = Array(missing_keys).flatten.collect { |key| key.split('/')[2].to_i }
+        find_from_ids_without_cache(missing_ids, @options1)
+      end
+    end
+  end
+end

data/lib/cash/query/calculation.rb

@@ -0,0 +1,45 @@
+module Cash
+  module Query
+    class Calculation < Abstract
+      delegate :calculate_without_cache, :incr, :to => :@active_record
+
+      def initialize(active_record, operation, column, options1, options2)
+        super(active_record, options1, options2)
+        @operation, @column = operation, column
+      end
+
+      def perform
+        super({}, :raw => true)
+      end
+
+      def calculation?
+        true
+      end
+
+      protected
+      def miss(_, __)
+        calculate_without_cache(@operation, @column, @options1)
+      end
+
+      def uncacheable
+        calculate_without_cache(@operation, @column, @options1)
+      end
+
+      def format_results(_, objects)
+        objects.to_i
+      end
+
+      def serialize_objects(_, objects)
+        objects.to_s
+      end
+
+      def cacheable?(*optionss)
+        @column == :all && super(*optionss)
+      end
+
+      def cache_keys(attribute_value_pairs)
+        "#{super(attribute_value_pairs)}/#{@operation}"
+      end
+    end
+  end
+end