nkallen-cache-money 0.2.1

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,52 @@
+module Cash
+  class Lock
+    class Error < RuntimeError; end
+
+    DEFAULT_RETRY = 5
+    DEFAULT_EXPIRY = 30
+
+    def initialize(cache)
+      @cache = cache
+    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,86 @@
+module Cash
+  class Mock < 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)
+      if self.has_key?(key)
+        "NOT_STORED\r\n"
+      else
+        self[key] = marshal(value, 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
+      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/query/abstract.rb

@@ -0,0 +1,162 @@
+module Cash
+  module Query
+    class Abstract
+      delegate :with_exclusive_scope, :get, :table_name, :indices, :find_from_ids_without_cache, :cache_key, :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 || {}
+      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] }
+        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 : 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, {})
+      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

data/lib/cash/query/primary_key.rb

@@ -0,0 +1,51 @@
+module Cash
+  module Query
+    class PrimaryKey < Abstract
+      def initialize(active_record, ids, options1, options2)
+        super(active_record, options1, options2)
+        @expects_array = ids.first.kind_of?(Array)
+        @original_ids = ids
+        @ids = ids.flatten.compact.uniq.collect do |object|
+          object.respond_to?(:quoted_id) ? object.quoted_id : object.to_i
+        end
+      end
+
+      def perform
+        return [] if @expects_array && @ids.empty?
+        raise ActiveRecord::RecordNotFound if @ids.empty?
+
+        super(:conditions => { :id => @ids.first })
+      end
+
+      protected
+      def deserialize_objects(objects)
+        convert_to_active_record_collection(super(objects))
+      end
+
+      def cache_keys(attribute_value_pairs)
+        @ids.collect { |id| "id/#{id}" }
+      end
+
+
+      def miss(missing_keys, options)
+        find_from_keys(*missing_keys)
+      end
+
+      def uncacheable
+        find_from_ids_without_cache(@original_ids, @options1)
+      end
+
+      private
+      def convert_to_active_record_collection(objects)
+        case objects.size
+        when 0
+          raise ActiveRecord::RecordNotFound
+        when 1
+          @expects_array ? objects : objects.first
+        else
+          objects
+        end
+      end
+    end
+  end
+end