viximo-cache-money 0.3.0

data/lib/cash/buffered.rb

@@ -0,0 +1,137 @@
+module Cash
+  class Buffered
+    def self.push(cache, lock)
+      if cache.is_a?(Buffered)
+        cache.push
+      else
+        Buffered.new(cache, lock)
+      end
+    end
+
+    def initialize(memcache, lock)
+      @buffer = {}
+      @commands = []
+      @cache = memcache
+      @lock = lock
+    end
+
+    def pop
+      @cache
+    end
+
+    def push
+      NestedBuffered.new(self, @lock)
+    end
+
+    def get(key, *options)
+      if @buffer.has_key?(key)
+        # Since buffered ActiveRecord objects can be modified before they get
+        # written to the repository, a shallow clone should always be returned
+        if @buffer[key].is_a?(Array) && @buffer[key][0].is_a?(ActiveRecord::Base)
+          @buffer[key].map(&:shallow_clone)
+        elsif @buffer[key].is_a?(ActiveRecord::Base)
+          @buffer[key].shallow_clone
+        else
+          @buffer[key]
+        end
+      else
+        @buffer[key] = @cache.get(key, *options)
+      end
+    end
+
+    def set(key, value, *options)
+      @buffer[key] = value
+      buffer_command Command.new(:set, key, value, *options)
+    end
+
+    def incr(key, amount = 1)
+      return unless value = get(key, true)
+
+      @buffer[key] = value.to_i + amount
+      buffer_command Command.new(:incr, key, amount)
+      @buffer[key]
+    end
+
+    def decr(key, amount = 1)
+      return unless value = get(key, true)
+
+      @buffer[key] = [value.to_i - amount, 0].max
+      buffer_command Command.new(:decr, key, amount)
+      @buffer[key]
+    end
+
+    def add(key, value, *options)
+      @buffer[key] = value
+      buffer_command Command.new(:add, key, value, *options)
+    end
+
+    def delete(key, *options)
+      @buffer[key] = nil
+      buffer_command Command.new(:delete, key, *options)
+    end
+
+    def get_multi(*keys)
+      values = keys.collect { |key| get(key) }
+      keys.zip(values).to_hash_without_nils
+    end
+
+    def flush
+      sorted_keys = @commands.select(&:requires_lock?).collect(&:key).uniq.sort
+      sorted_keys.each do |key|
+        @lock.acquire_lock(key)
+      end
+      perform_commands
+    ensure
+      @buffer = {}
+      sorted_keys.each do |key|
+        @lock.release_lock(key)
+      end
+    end
+
+    def respond_to?(method)
+      @cache.respond_to?(method)
+    end
+
+    protected
+
+    def perform_commands
+      @commands.each do |command|
+        command.call(@cache)
+      end
+    end
+
+    def buffer_command(command)
+      @commands << command
+    end
+    
+    private
+    
+    def method_missing(method, *args, &block)
+      @cache.send(method, *args, &block)
+    end
+  end
+
+  class NestedBuffered < Buffered
+    def flush
+      perform_commands
+    end
+  end
+
+  class Command
+    attr_accessor :key
+
+    def initialize(name, key, *args)
+      @name = name
+      @key = key
+      @args = args
+    end
+
+    def requires_lock?
+      @name == :set
+    end
+
+    def call(cache)
+      cache.send @name, @key, *@args
+    end
+  end
+end

data/lib/cash/config.rb

@@ -0,0 +1,78 @@
+module Cash
+  module Config
+    def self.create(active_record, options, indices = [])
+      active_record.cache_config = Cash::Config::Config.new(active_record, options)
+      indices.each { |i| active_record.index i.attributes, i.options }
+    end
+    
+    def self.included(a_module)
+      a_module.module_eval do
+        extend ClassMethods
+        delegate :repository, :to => "self.class"
+      end
+    end
+
+    module ClassMethods
+      def self.extended(a_class)
+        class << a_class
+          def cache_config
+            @cache_config
+          end
+          
+          delegate :repository, :indices, :to => :cache_config
+          alias_method_chain :inherited, :cache_config
+        end
+      end
+
+      def inherited_with_cache_config(subclass)
+        inherited_without_cache_config(subclass)
+        @cache_config.inherit(subclass) if @cache_config
+      end
+
+      def index(attributes, options = {})
+        options.assert_valid_keys(:ttl, :order, :limit, :buffer, :order_column)
+        (@cache_config.indices.unshift(Index.new(@cache_config, self, attributes, options))).uniq!
+      end
+
+      def version(number)
+        @cache_config.options[:version] = number
+      end
+
+      def cache_config=(config)
+        @cache_config = config
+      end
+      
+      def cacheable?(*args)
+        Cash.enabled && cache_config
+      end
+    end
+
+    class Config
+      attr_reader :active_record, :options
+
+      def initialize(active_record, options = {})
+        @active_record, @options = active_record, options
+      end
+
+      def repository
+        @options[:repository]
+      end
+
+      def ttl
+        @ttl ||= (repository.respond_to?(:default_ttl) && repository.default_ttl) || @options[:ttl]
+      end
+
+      def version
+        @options[:version] || 1
+      end
+
+      def indices
+        @indices ||= active_record == ActiveRecord::Base ? [] : [Index.new(self, active_record, active_record.primary_key)]
+      end
+
+      def inherit(active_record)
+        Cash::Config.create(active_record, @options, indices)
+      end
+    end
+  end
+end

data/lib/cash/fake.rb

@@ -0,0 +1,83 @@
+module Cash
+  class Fake < HashWithIndifferentAccess
+    attr_accessor :servers
+
+    def get_multi(*keys)
+      slice(*keys).collect { |k,v| [k, Marshal.load(v)] }.to_hash
+    end
+
+    def set(key, value, ttl = 0, raw = false)
+      self[key] = marshal(value, raw)
+    end
+
+    def get(key, raw = false)
+      if raw
+        self[key]
+      else
+        if self.has_key?(key)
+          Marshal.load(self[key])
+        else
+          nil
+        end
+      end
+    end
+
+    def incr(key, amount = 1)
+      if self.has_key?(key)
+        self[key] = (self[key].to_i + amount).to_s
+        self[key].to_i
+      end
+    end
+
+    def decr(key, amount = 1)
+      if self.has_key?(key)
+        self[key] = (self[key].to_i - amount).to_s
+        self[key].to_i
+      end
+    end
+
+    def add(key, value, ttl = 0, raw = false)
+      return false if self.has_key?(key)
+
+      self[key] = marshal(value, raw)
+      true
+    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
+      clear
+    end
+
+    def stats
+      {}
+    end
+
+    def reset_runtime
+      [0, Hash.new(0)]
+    end
+
+    private
+    def marshal(value, raw)
+      if raw
+        value.to_s
+      else
+        Marshal.dump(value)
+      end
+    end
+
+    def unmarshal(marshaled_obj)
+      Marshal.load(marshaled_obj)
+    end
+
+    def deep_clone(obj)
+      unmarshal(marshal(obj))
+    end
+  end
+end

data/lib/cash/finders.rb

@@ -0,0 +1,50 @@
+module Cash
+  module Finders
+    def self.included(active_record_class)
+      active_record_class.class_eval do
+        extend ClassMethods
+      end
+    end
+
+    module ClassMethods
+      def self.extended(active_record_class)
+        class << active_record_class
+          alias_method_chain :find_every, :cache
+          alias_method_chain :find_from_ids, :cache
+          alias_method_chain :calculate, :cache
+        end
+      end
+
+      def without_cache(&block)
+        with_scope(:find => {:readonly => true}, &block)
+      end
+
+      # User.find(:first, ...), User.find_by_foo(...), User.find(:all, ...), User.find_all_by_foo(...)
+      def find_every_with_cache(options)
+        if cacheable?
+          Query::Select.perform(self, options, scope(:find))
+        else
+          find_every_without_cache(options)
+        end
+      end
+
+      # User.find(1), User.find(1, 2, 3), User.find([1, 2, 3]), User.find([])
+      def find_from_ids_with_cache(ids, options)
+        if cacheable?
+          Query::PrimaryKey.perform(self, ids, options, scope(:find))
+        else
+          find_from_ids_without_cache(ids, options)
+        end
+      end
+
+      # User.count(:all), User.count, User.sum(...)
+      def calculate_with_cache(operation, column_name, options = {})
+        if cacheable?
+          Query::Calculation.perform(self, operation, column_name, options, scope(:find))
+        else
+          calculate_without_cache(operation, column_name, options)
+        end
+      end
+    end
+  end
+end

data/lib/cash/index.rb

@@ -0,0 +1,211 @@
+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, :logger, :to => :@active_record
+
+    def initialize(config, active_record, attributes, options = {})
+      @config, @active_record, @attributes, @options = config, active_record, Array(attributes).collect(&:to_s).sort, 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)
+        _, new_attribute_value_pairs = old_and_new_attribute_value_pairs(object)
+        add_to_index_with_minimal_network_operations(new_attribute_value_pairs, object)
+      end
+
+      def update(object)
+        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, object)
+      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
+      
+      def order_column
+        options[:order_column] || 'id'
+      end
+    end
+    include Attributes
+
+    def serialize_object(object)
+      primary_key? ? object.shallow_clone : object.id
+    end
+
+    def matches?(query)
+      query.calculation? ||
+      (query.order == [order_column, 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]
+        if object.changed.include? name
+          original_value = object.send("#{name}_was")
+        else
+          original_value = new_value
+        end
+        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), [serialize_object(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