parolkar-cache-money 0.2.5

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, :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 || {}
+      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 : 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, {})
+      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

data/lib/cash/query/select.rb

@@ -0,0 +1,16 @@
+module Cash
+  module Query
+    class Select < Abstract
+      delegate :find_every_without_cache, :to => :@active_record
+
+      protected
+      def miss(_, miss_options)
+        find_every_without_cache(miss_options)
+      end
+
+      def uncacheable
+        find_every_without_cache(@options1)
+      end
+    end
+  end
+end

data/lib/cash/request.rb

@@ -0,0 +1,3 @@
+module Cash
+  Request = {}
+end

data/lib/cash/transactional.rb

@@ -0,0 +1,42 @@
+module Cash
+  class Transactional
+    attr_reader :memcache
+
+    def initialize(memcache, lock)
+      @memcache, @cache = [memcache, memcache]
+      @lock = lock
+    end
+
+    def transaction
+      exception_was_raised = false
+      begin_transaction
+      result = yield
+    rescue Object => e
+      exception_was_raised = true
+      raise
+    ensure
+      begin
+        @cache.flush unless exception_was_raised
+      ensure
+        end_transaction
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      @cache.send(method, *args, &block)
+    end
+
+    def respond_to?(method)
+      @cache.respond_to?(method)
+    end
+
+    private
+    def begin_transaction
+      @cache = Buffered.push(@cache, @lock)
+    end
+
+    def end_transaction
+      @cache = @cache.pop
+    end
+  end
+end

data/lib/cash/util/array.rb

@@ -0,0 +1,9 @@
+class Array
+  alias_method :count, :size
+
+  def to_hash
+    keys_and_values_without_nils = reject { |key, value| value.nil? }
+    shallow_flattened_keys_and_values_without_nils = keys_and_values_without_nils.inject([]) { |result, pair| result += pair }
+    Hash[*shallow_flattened_keys_and_values_without_nils]
+  end
+end

data/lib/cash/write_through.rb

@@ -0,0 +1,72 @@
+module Cash
+  module WriteThrough
+    DEFAULT_TTL = 12.hours
+
+    def self.included(active_record_class)
+      active_record_class.class_eval do
+        include InstanceMethods
+        extend ClassMethods
+      end
+    end
+
+    module InstanceMethods
+      def self.included(active_record_class)
+        active_record_class.class_eval do
+          after_create :add_to_caches
+          after_update :update_caches
+          after_destroy :remove_from_caches
+        end
+      end
+
+      def add_to_caches
+        InstanceMethods.unfold(self.class, :add_to_caches, self)
+      end
+
+      def update_caches
+        InstanceMethods.unfold(self.class, :update_caches, self)
+      end
+
+      def remove_from_caches
+        return if new_record?
+        InstanceMethods.unfold(self.class, :remove_from_caches, self)
+      end
+
+      def expire_caches
+        InstanceMethods.unfold(self.class, :expire_caches, self)
+      end
+
+      def shallow_clone
+        clone = self.class.new
+        clone.instance_variable_set("@attributes", instance_variable_get(:@attributes))
+        clone.instance_variable_set("@new_record", new_record?)
+        clone
+      end
+
+      private
+      def self.unfold(klass, operation, object)
+        while klass < ActiveRecord::Base && klass.ancestors.include?(WriteThrough)
+          klass.send(operation, object)
+          klass = klass.superclass
+        end
+      end
+    end
+
+    module ClassMethods
+      def add_to_caches(object)
+        indices.each { |index| index.add(object) }
+      end
+
+      def update_caches(object)
+        indices.each { |index| index.update(object) }
+      end
+
+      def remove_from_caches(object)
+        indices.each { |index| index.remove(object) }
+      end
+
+      def expire_caches(object)
+        indices.each { |index| index.delete(object) }
+      end
+    end
+  end
+end

data/spec/cash/accessor_spec.rb

@@ -0,0 +1,159 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+module Cash
+  describe Accessor do
+    describe '#fetch' do
+      describe '#fetch("...")' do
+        describe 'when there is a cache miss' do
+          it 'returns nil' do
+            Story.fetch("yabba").should be_nil
+          end
+        end
+
+        describe 'when there is a cache hit' do
+          it 'returns the value of the cache' do
+            Story.set("yabba", "dabba")
+            Story.fetch("yabba").should == "dabba"
+          end
+        end
+      end
+
+      describe '#fetch([...])', :shared => true do
+        describe 'when there is a total cache miss' do
+          it 'yields the keys to the block' do
+            Story.fetch(["yabba", "dabba"]) { |*missing_ids| ["doo", "doo"] }.should == {
+              "Story:1/yabba" => "doo",
+              "Story:1/dabba" => "doo"
+            }
+          end
+        end
+
+        describe 'when there is a partial cache miss' do
+          it 'yields just the missing ids to the block' do
+            Story.set("yabba", "dabba")
+            Story.fetch(["yabba", "dabba"]) { |*missing_ids| "doo" }.should == {
+              "Story:1/yabba" => "dabba",
+              "Story:1/dabba" => "doo"
+            }
+          end
+        end
+      end
+    end
+
+    describe '#get' do
+      describe '#get("...")' do
+        describe 'when there is a cache miss' do
+          it 'returns the value of the block' do
+            Story.get("yabba") { "dabba" }.should == "dabba"
+          end
+
+          it 'adds to the cache' do
+            Story.get("yabba") { "dabba" }
+            Story.get("yabba").should == "dabba"
+          end
+        end
+
+        describe 'when there is a cache hit' do
+          before do
+            Story.set("yabba", "dabba")
+          end
+
+          it 'returns the value of the cache' do
+            Story.get("yabba") { "doo" }.should == "dabba"
+          end
+
+          it 'does nothing to the cache' do
+            Story.get("yabba") { "doo" }
+            Story.get("yabba").should == "dabba"
+          end
+        end
+      end
+
+      describe '#get([...])' do
+        it_should_behave_like "#fetch([...])"
+      end
+    end
+
+    describe '#incr' do
+      describe 'when there is a cache hit' do
+        before do
+          Story.set("count", 0)
+        end
+
+        it 'increments the value of the cache' do
+          Story.incr("count", 2)
+          Story.get("count", :raw => true).should =~ /2/
+        end
+
+        it 'returns the new cache value' do
+          Story.incr("count", 2).should == 2
+        end
+      end
+
+      describe 'when there is a cache miss' do
+        it 'initializes the value of the cache to the value of the block' do
+          Story.incr("count", 1) { 5 }
+          Story.get("count", :raw => true).should =~ /5/
+        end
+
+        it 'returns the new cache value' do
+          Story.incr("count", 1) { 2 }.should == 2
+        end
+      end
+    end
+
+    describe '#add' do
+      describe 'when the value already exists' do
+        it 'yields to the block' do
+          Story.set("count", 1)
+          Story.add("count", 1) { "yield me" }.should == "yield me"
+        end
+      end
+
+      describe 'when the value does not already exist' do
+        it 'adds the key to the cache' do
+          Story.add("count", 1)
+          Story.get("count").should == 1
+        end
+      end
+    end
+
+    describe '#decr' do
+      describe 'when there is a cache hit' do
+        before do
+          Story.incr("count", 1) { 10 }
+        end
+
+        it 'decrements the value of the cache' do
+          Story.decr("count", 2)
+          Story.get("count", :raw => true).should =~ /8/
+        end
+
+        it 'returns the new cache value' do
+          Story.decr("count", 2).should == 8
+        end
+      end
+
+      describe 'when there is a cache miss' do
+        it 'initializes the value of the cache to the value of the block' do
+          Story.decr("count", 1) { 5 }
+          Story.get("count", :raw => true).should =~ /5/
+        end
+
+        it 'returns the new cache value' do
+          Story.decr("count", 1) { 2 }.should == 2
+        end
+      end
+    end
+
+    describe '#cache_key' do
+      it 'uses the version number' do
+        Story.version 1
+        Story.cache_key("foo").should == "Story:1/foo"
+
+        Story.version 2
+        Story.cache_key("foo").should == "Story:2/foo"
+      end
+    end
+  end
+end