horcrux 0.0.4 → 0.1.0

data/horcrux.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'horcrux'
-  s.version           = '0.0.4'
-  s.date              = '2012-01-03'
+  s.version           = '0.1.0'
+  s.date              = '2012-01-09'
   s.rubyforge_project = 'horcrux'
 
   ## Make sure your summary is short. The description may be as long
@@ -47,11 +47,13 @@ Gem::Specification.new do |s|
     horcrux.gemspec
     lib/horcrux.rb
     lib/horcrux/entity.rb
+    lib/horcrux/multiple.rb
     lib/horcrux/serializers/gzip_serializer.rb
     lib/horcrux/serializers/message_pack_serializer.rb
     test/entity_test.rb
     test/helper.rb
     test/memory_test.rb
+    test/multiple_test.rb
     test/serializer_test.rb
   ]
   # = MANIFEST =

data/lib/horcrux/multiple.rb

@@ -0,0 +1,206 @@
+module Horcrux
+  class Multiple
+    include Methods
+
+    attr_reader :rescuable_exceptions
+    attr_reader :error_handlers, :missing_handlers
+
+    # Sets up an Adapter using a collection of other adapters.  The first is
+    # assumed to be the main, while the others are write-through caches.  This
+    # is good for caching.
+    #
+    #     mysql = Horcrux::MysqlAdapter.new ... # fake
+    #     memcache = Horcrux::MemcacheAdapter.new ... # fake
+    #     adapter = Horcrux::Multiple.new mysql, memcache
+    #
+    # Reads will hit the secondary adapters before the main.  Writes will hit
+    # the main adapter first, before being sent to the secondary adapters.
+    #
+    # *adapters - One or more Horcrux-compliant adapters.
+    def initialize(*adapters)
+      if adapters.empty?
+        raise ArgumentError, "Need at least 1 adapter."
+      end
+
+      @main = adapters.shift
+      @adapters = adapters
+      @error_handlers = []
+      @missing_handlers = []
+      @rescuable_exceptions = [StandardError]
+    end
+
+    # Public: Adds the given block to the chain of handlers to call for a
+    # raised exception while accessing one of the adapters.
+    #
+    #     @adapter.on_error do |err, obj|
+    #       obj[:adapter]
+    #       obj[:method]
+    #       obj[:args]
+    #     end
+    #
+    # Returns nothing.
+    def on_error(&block)
+      @error_handlers << block
+      nil
+    end
+
+    # Public: Adds the given block to the chain of handlers to call when a 
+    # secondary adapter is missing one or more keys.
+    #
+    #     @adapter.on_missing do |adapter, values|
+    #       adapter.set_all(values)
+    #     end
+    #
+    # Returns nothing.
+    def on_missing(&block)
+      @missing_handlers << block
+      nil
+    end
+
+    ## HORCRUX METHODS
+   
+    def get_all(*keys)
+      original = keys.dup
+      adapter_missing = {}
+      values = {}
+
+      @adapters.each do |adapter|
+        found, missing = get_from_adapter(adapter, keys)
+        values.update(found)
+
+        if !missing.empty?
+          adapter_missing[adapter] = missing
+        end
+
+        keys = missing
+      end
+
+      found, missing = get_from_adapter(@main, keys)
+      values.update(found)
+
+      call_missing_handlers(values, adapter_missing)
+
+      original.map { |key| values[key] }
+    end
+
+    def key?(key)
+      read_cache :key?, key
+    end
+
+    def get(key)
+      read_cache :get, key
+    end
+
+    def set(key, value)
+      write_through :set, key, value
+    end
+
+    def set_all(values)
+      write_through :set_all, values
+    end
+
+    def delete(key)
+      write_through :delete, key
+    end
+
+    def delete_all(*keys)
+      write_through :delete_all, *keys
+    end
+
+    ## INTERNAL
+
+    # Writes the data to the main adapter first, and then to the other
+    # adapters.
+    #
+    # method - A Symbol identifying the method to call.
+    # *args  - One or more arguments to send to the methods.
+    #
+    # Returns the result of the method call on the main adapter.
+    def write_through(method, *args)
+      result = @main.send(method, *args)
+      @adapters.each do |adapter|
+        call_adapter adapter, method, *args
+      end
+      result
+    end
+
+    # Reads the data from the other adapters before the main adapter.
+    #
+    # method - A Symbol identifying the method to call.
+    # *args  - One or more arguments to send to the methods.
+    #
+    # Returns the result of the first adapter to respond with a value.
+    def read_cache(method, *args)
+      value = nil
+      @adapters.detect do |adapter| 
+        value = call_adapter adapter, method, *args
+      end
+      value || @main.send(method, *args)
+    end
+
+    # Calls the given adapter, swallowing up any error.
+    #
+    # adapter - A Horcrux adapter.
+    # method - A Symbol identifying the method to call.
+    # *args  - One or more arguments to send to the methods.
+    #
+    # Returns the value of the method call.
+    def call_adapter(adapter, method, *args)
+      adapter.send(method, *args)
+    rescue Object => err
+      raise unless @rescuable_exceptions.any? { |klass| err.is_a?(klass) }
+
+      if @error_handlers.each do |handler|
+        handler.call err, :adapter => adapter, :method => method, :args => args
+      end.empty?
+        $stderr.puts "#{err.class} Exception for #{adapter.inspect}##{method}: #{err}"
+      end
+    end
+
+    # Gets all keys from the adapter.
+    #
+    # adapter - A Horcrux adapter.
+    # keys    - Array of String keys to fetch.
+    #
+    # Returns an Array tuple with a Hash of found keys/values, and an Array of
+    # missing keys.
+    def get_from_adapter(adapter, keys)
+      missing = []
+      found = {}
+
+      adapter.get_all(*keys).each_with_index do |value, index|
+        key = keys[index]
+
+        if value
+          found[key] = value
+        else
+          missing << key
+        end
+      end unless keys.empty?
+
+      [found, missing]
+    end
+
+    # Call the on_missing callbacks for the handlers that were missing keys.
+    # This gives you a chance to set those values in the secondary adapters.
+    #
+    # values  - A Hash of all of the found keys => values.
+    # missing - A Hash of Adapter => Array of missing keys.
+    #
+    # Returns nothing.
+    def call_missing_handlers(values, missing)
+      return if @missing_handlers.empty?
+      missing.each do |adapter, keys|
+        missing_values = {}
+        keys.each do |key|
+          missing_values[key] = values[key]
+        end
+
+        @missing_handlers.each do |handler|
+          handler.call adapter, missing_values
+        end
+      end
+    end
+  end
+end
+

data/lib/horcrux.rb

@@ -1,6 +1,6 @@
 # See the README.md
 module Horcrux
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 
   # Implements the optional methods of a Horcrux adapter.
   module Methods

data/test/helper.rb

@@ -2,4 +2,5 @@ require 'test/unit'
 require File.expand_path('../../lib/horcrux', __FILE__)
 require File.expand_path('../../lib/horcrux/serializers/gzip_serializer', __FILE__)
 require File.expand_path('../../lib/horcrux/entity', __FILE__)
+require File.expand_path('../../lib/horcrux/multiple', __FILE__)
 

data/test/multiple_test.rb

@@ -0,0 +1,120 @@
+require File.expand_path('../memory_test', __FILE__)
+
+module Horcrux
+  class MultipleTest < MemoryTest
+    def setup
+      @main = Memory.new(@main_hash = {})
+      @cache1 = Memory.new(@cache1_hash = {})
+      @cache2 = Memory.new(@cache2_hash = {})
+      @adapter = Multiple.new @main, @cache1, @cache2
+    end
+
+    def test_reads_cache_before_main
+      @main.set 'a', '3'
+      @cache1.set 'a', '1'
+      @cache2.set 'a', '2'
+
+      assert_equal '1', @adapter.get('a')
+
+      @cache1.delete 'a'
+
+      assert_equal '2', @adapter.get('a')
+
+      @cache2.delete 'a'
+
+      assert_equal '3', @adapter.get('a')
+    end
+
+    def test_sets_to_all_caches
+      @adapter.set 'a', '5'
+
+      assert_equal '5', @main.get('a')
+      assert_equal '5', @cache1.get('a')
+      assert_equal '5', @cache2.get('a')
+    end
+
+    def test_sets_values_to_all_caches
+      @adapter.set_all 'a' => '5'
+
+      assert_equal '5', @main.get('a')
+      assert_equal '5', @cache1.get('a')
+      assert_equal '5', @cache2.get('a')
+    end
+
+    def test_deletes_from_all_caches
+      @main.set 'a', '1'
+      @cache1.set 'a', '1'
+      @cache2.set 'a', '1'
+
+      @adapter.delete 'a'
+
+      assert !@main.key?('a')
+      assert !@cache1.key?('a')
+      assert !@cache1.key?('a')
+      assert !@adapter.key?('a')
+    end
+
+    def test_deletes_keys_from_all_caches
+      @main.set 'a', '1'
+      @cache1.set 'a', '1'
+      @cache2.set 'a', '1'
+
+      @adapter.delete_all 'a'
+
+      assert !@main.key?('a')
+      assert !@cache1.key?('a')
+      assert !@cache1.key?('a')
+      assert !@adapter.key?('a')
+    end
+
+    def test_calls_on_missing_callback
+      called = 0
+
+      @adapter.on_missing do |adapter, values|
+        called += 1
+        
+        case adapter
+        when @cache1
+          assert_equal 2, values.size
+          assert_equal '1', values['a']
+          assert_equal '3', values['c']
+        when @cache2
+          assert_equal 1, values.size
+          assert_equal '3', values['c']
+        else
+          fail "Bad adapter: #{adapter.inspect}"
+        end
+
+      end
+
+      @cache2.set 'a', '1'
+      @cache1.set 'b', '2'
+      @main.set 'c', '3'
+
+      assert_equal %w(1 2 3), @adapter.get_all('a', 'b', 'c')
+      assert_equal 2, called
+    end
+
+    def test_ignores_errors
+      called = false
+
+      @adapter.on_error do |err, obj|
+        called = true
+        assert_kind_of RuntimeError, err
+        assert_equal @cache1, obj[:adapter]
+        assert_equal :get, obj[:method]
+        assert_equal %w(a), obj[:args]
+      end
+
+      hash = @cache1_hash
+      def hash.[](*args) raise end
+
+      @cache1.set 'a', '1'
+      @cache2.set 'a', '2'
+
+      assert_equal '2', @adapter.get('a')
+      assert called
+    end
+  end
+end
+

metadata

@@ -1,44 +1,59 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: horcrux
-version: !ruby/object:Gem::Version
-  version: 0.0.4
+version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
-authors:
+authors: 
 - Rick Olson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-03 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-01-09 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70162015702560 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70162015702560
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: test-unit
-  requirement: &70162015699840 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *70162015699840
+  version_requirements: *id002
 description: Simple key/value adapter library.
 email: technoweenie@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - Gemfile
 - LICENSE.md
 - README.md
@@ -46,38 +61,52 @@ files:
 - horcrux.gemspec
 - lib/horcrux.rb
 - lib/horcrux/entity.rb
+- lib/horcrux/multiple.rb
 - lib/horcrux/serializers/gzip_serializer.rb
 - lib/horcrux/serializers/message_pack_serializer.rb
 - test/entity_test.rb
 - test/helper.rb
 - test/memory_test.rb
+- test/multiple_test.rb
 - test/serializer_test.rb
 homepage: http://github.com/technoweenie/horcrux
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
       version: 1.3.5
 requirements: []
+
 rubyforge_project: horcrux
-rubygems_version: 1.8.11
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 2
 summary: Simple key/value adapter library.
-test_files:
+test_files: 
 - test/entity_test.rb
 - test/helper.rb
 - test/memory_test.rb
+- test/multiple_test.rb
 - test/serializer_test.rb