kissifer-hash-persistent 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 kissifer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= hash-persistent
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 kissifer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hash-persistent"
+    gem.summary = %Q{Library of base classes to simplify persisting objects and collections to a moneta store}
+    gem.email = "tierneydrchris@gmail.com"
+    gem.homepage = "http://github.com/kissifer/hash-persistent"
+    gem.authors = ["kissifer"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+  spec.spec_opts = ['--options spec/spec.opts']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hash-persistent #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/hash-persistent.gemspec

@@ -0,0 +1,60 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hash-persistent}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["kissifer"]
+  s.date = %q{2009-06-23}
+  s.email = %q{tierneydrchris@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "hash-persistent.gemspec",
+     "lib/hash-persistent.rb",
+     "lib/hash-persistent/collection.rb",
+     "lib/hash-persistent/counter.rb",
+     "lib/hash-persistent/extended_store.rb",
+     "lib/hash-persistent/resource.rb",
+     "lib/hash-persistent/store.rb",
+     "spec/collection_spec.rb",
+     "spec/counter_spec.rb",
+     "spec/extended_store_spec.rb",
+     "spec/resource_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/store_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/kissifer/hash-persistent}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Library of base classes to simplify persisting objects and collections to a moneta store}
+  s.test_files = [
+    "spec/collection_spec.rb",
+     "spec/counter_spec.rb",
+     "spec/extended_store_spec.rb",
+     "spec/resource_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/store_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/hash-persistent/collection.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/resource')
+
+module HashPersistent
+  module Collection
+    include HashPersistent::Resource
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      attr_accessor :basis
+      
+      def on_watched_store_save_event(store_for_collection, saved_object)
+        raise "Cannot collect objects without a basis for the collection. Set :basis class attribute" unless @basis
+        return unless saved_object.respond_to?(:basis) && saved_object.respond_to?(:key)
+        
+        collection_resource = store_for_collection.find(saved_object.send(:basis))
+        unless collection_resource
+          collection_resource = new
+          collection_resource.store = store_for_collection
+          collection_resource.key = saved_object.send(:basis)
+        end
+        
+        collection_resource.collected_keys << saved_object.send(:key)
+        collection_resource.collected_keys.uniq!
+        collection_resource.save
+      end
+
+      def on_watched_store_delete_event(store_for_collection, deleted_object)
+        raise "Cannot collect objects without a basis for the collection. Set :basis class attribute" unless @basis
+        return unless deleted_object.respond_to?(:basis) && deleted_object.respond_to?(:key)
+        
+        collection_resource = store_for_collection.find(deleted_object.send(:basis))
+        return unless collection_resource
+
+        collection_resource.collected_keys.delete(deleted_object.send(:key))
+        
+        if collection_resource.collected_keys == []
+          collection_resource.delete
+        else
+          collection_resource.save
+        end
+      end
+    end
+    
+    def collected_keys
+      @collected_keys ||= []
+    end
+
+    def collected_resources
+      @collected_keys.collect do |key|
+        resource = store.watching.find(key)
+        raise "Collected key not found in watched store" unless resource
+        resource
+      end
+    end
+  end
+end

data/lib/hash-persistent/counter.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+
+module HashPersistent  
+  class Counter
+    def initialize(store, key)
+      raise ArgumentError unless store.is_a?(HashPersistent::Store) and key.respond_to?(:to_s) and key.to_s.length != 0
+      @store = store
+      @key = key
+      
+      unless @store.find(@key)
+        counter = OpenStruct.new
+        counter.key = @key
+        counter.count = 0
+        @store.save(counter)
+      end
+    end
+    
+    def next
+      counter = @store.find(@key)
+      next_count = counter.count
+      counter.count += 1
+      @store.save(counter)
+      next_count
+    end
+  end
+end

data/lib/hash-persistent/extended_store.rb

@@ -0,0 +1,49 @@
+require File.expand_path(File.dirname(__FILE__) + '/store')
+
+module HashPersistent
+  class ExtendedStore
+    attr_reader :store
+    
+    def initialize(store)
+      @store = store
+      yield self if block_given?
+    end
+    
+    def find(key)
+      a_singleton = singleton_keys.find do |singleton|
+       key.match(singleton[0])
+     end
+
+      if a_singleton
+        find_or_create(key, a_singleton[1], *a_singleton[2], &a_singleton[3])
+      else
+        @store.find(key)
+      end
+    end
+
+    def save(object)
+      @store.save(object)
+    end
+
+    def delete(object)
+      @store.delete(object)
+    end
+
+    def create(key, class_to_create, *args, &block)
+      @store.create(key, class_to_create, *args, &block)
+    end
+
+    def find_or_create(key, class_to_create, *args, &block)
+      @store.find_or_create(key, class_to_create, *args, &block)
+    end
+    
+    def singleton_key(pattern, class_to_create, *args, &block)
+      "1".match(pattern) # a test to check the duck typing early
+      singleton_keys << [pattern, class_to_create, args, block]
+    end
+
+    def singleton_keys
+      @singleton_keys ||= []
+    end
+  end
+end

data/lib/hash-persistent/resource.rb

@@ -0,0 +1,20 @@
+module HashPersistent
+  module Resource
+    attr_accessor :store, :key
+    
+    def save
+      @store.save(self) if @store
+    end
+
+    def delete
+      @store.delete(self) if @store
+    end
+
+    def move(new_store)
+      delete
+      @store = new_store
+      save
+    end
+  end
+end
+

data/lib/hash-persistent/store.rb

@@ -0,0 +1,67 @@
+module HashPersistent
+  class Store
+    attr_reader :key_value_store, :key_prefix, :cached_to
+    
+    def initialize(key_value_store, key_prefix)
+      raise ArgumentError unless key_value_store.respond_to?(:has_key?) and key_prefix.respond_to?(:to_s)
+      @key_value_store = key_value_store
+      @key_prefix = key_prefix
+      yield self if block_given?
+    end
+    
+    def cached_to=(cache)
+      raise ArgumentError unless cache.is_a?(HashPersistent::Store) if cache
+      @cached_to = cache
+    end
+    
+    def save(object)
+      store_this = object.dup
+      store_this.store = nil if store_this.respond_to?(:store)
+      @key_value_store[@key_prefix + store_this.key] = store_this
+
+      @cached_to.save(object) if @cached_to
+
+      object.store = self if object.respond_to?(:store)
+      self
+    end
+
+    def delete(object)
+      @key_value_store.delete(@key_prefix + object.key)
+      @cached_to.delete(object) if @cached_to
+
+      object.store = self if object.respond_to?(:store)
+      self
+    end
+
+    def find(key)
+      if @cached_to
+        found = @cached_to.find(key)
+        unless found
+          found = @key_value_store[@key_prefix + key]
+          @cached_to.save(found) if found
+        end
+      else
+        found = @key_value_store[@key_prefix + key]
+      end
+      return nil unless found
+
+      object = found.dup
+      object.store = self if object.respond_to?(:store)
+
+      object
+    end
+
+    def create(key, class_to_create, *args, &block)
+      object = class_to_create.new(*args, &block)
+      object.key = key
+      object.store = self if object.respond_to?(:store)
+      object
+    end
+    
+    def find_or_create(key, class_to_create, *args, &block)
+      #TODO: Lock?
+      save(create(key, class_to_create, *args, &block)) unless find(key)
+      find(key)
+    end
+  end
+end

data/lib/hash-persistent.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH << File.dirname(__FILE__)
+
+require 'rubygems'
+require 'hash-persistent/store'
+require 'hash-persistent/extended_store'
+require 'hash-persistent/resource'
+require 'hash-persistent/collection'
+require 'hash-persistent/counter'

data/spec/collection_spec.rb

@@ -0,0 +1,269 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'ostruct'
+
+__END__
+
+class CollectionFoo
+  include HashPersistent::Collection
+end
+
+class CollectionDoNotSetABasis
+  include HashPersistent::Collection
+end
+
+describe "A class that includes HashPersistent::Collection" do
+  it "should include the HashPersistent::Resource module" do
+    CollectionFoo.included_modules.should include(HashPersistent::Resource)
+  end
+  
+  it "should acquire on_watched_store_save_event() and on_watched_store_delete_event() methods" do
+    CollectionFoo.respond_to?(:on_watched_store_save_event).should be_true
+    CollectionFoo.respond_to?(:on_watched_store_delete_event).should be_true
+  end
+  
+  it "should acquire a basis attribute" do
+    CollectionFoo.basis = "foo"
+    CollectionFoo.basis.should == "foo"
+  end
+  
+  context "(when not given a basis)" do
+    it "should complain when given a save event" do
+      lambda{CollectionDoNotSetABasis.on_watched_store_save_event("store", "saved_object")}.should raise_error
+    end
+
+    it "should complain when given a delete event" do
+      lambda{CollectionDoNotSetABasis.on_watched_store_delete_event("store", "deleted_object")}.should raise_error
+    end
+  end
+  
+  context "(when a save event happens)" do
+    before(:each) do
+      CollectionFoo.basis = :basis
+      @store = HashPersistent::Store.new({}, "")
+    end
+    
+    it "should create a resource for the basis if one does not exist" do
+      object = OpenStruct.new
+      object.key = "key"
+      object.basis = "basis"
+
+      CollectionFoo.on_watched_store_save_event(@store, object)
+      @store.find("basis").should_not be_nil
+    end
+
+    it "should collect the saved keys for a basis, in the resource for that basis" do
+      object = OpenStruct.new
+      object.basis = "basis"
+
+      object.key = "key_1"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      object.key = "key_2"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      collection_resource = @store.find("basis")
+      collection_resource.collected_keys.should include("key_1")
+      collection_resource.collected_keys.should include("key_2")
+    end
+
+    it "should not duplicate keys in the resource for the basis" do
+      object = OpenStruct.new
+      object.basis = "basis"
+
+      object.key = "key_1"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      object.key = "key_2"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      collection_resource = @store.find("basis")
+      collection_resource.collected_keys.size.should == 2
+    end
+
+    it "should not cross-contaminate keys between bases" do
+      object = OpenStruct.new
+
+      object.basis = "basis_1"
+      object.key = "key_1A"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+      object.key = "key_1B"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      object.basis = "basis_2"
+      object.key = "key_2"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      collection_resource_1 = @store.find("basis_1")
+      collection_resource_2 = @store.find("basis_2")
+      
+      collection_resource_1.collected_keys.should     include("key_1A")
+      collection_resource_1.collected_keys.should     include("key_1B")
+      collection_resource_1.collected_keys.should_not include("key_2")
+
+      collection_resource_2.collected_keys.should_not include("key_1A")
+      collection_resource_2.collected_keys.should_not include("key_1B")
+      collection_resource_2.collected_keys.should     include("key_2")
+    end
+  end
+
+  context "(when a delete event happens)" do
+    before(:each) do
+      CollectionFoo.basis = :basis
+      @store = HashPersistent::Store.new({}, "")
+    end
+    
+    it "should not complain when asked to remove a key from an unknown basis" do
+      object = OpenStruct.new
+
+      object.basis = "basis"
+      object.key = "key"
+      lambda{CollectionFoo.on_watched_store_delete_event(@store, object)}.should_not raise_error
+    end
+    
+    it "should delete the key from the resource for a basis" do
+      object = OpenStruct.new
+
+      object.basis = "basis"
+      object.key = "key_1"
+      CollectionFoo.on_watched_store_save_event(@store, object) # save
+      object.key = "key_2"
+      CollectionFoo.on_watched_store_save_event(@store, object) # save
+
+      object.key = "key_1"
+      CollectionFoo.on_watched_store_delete_event(@store, object) # delete
+
+      collection_resource = @store.find("basis")
+      
+      collection_resource.collected_keys.should     include("key_2")
+      collection_resource.collected_keys.should_not include("key_1")
+    end
+
+    it "should not complain when asked to remove a non-existent key from the basis" do
+      object = OpenStruct.new
+
+      object.basis = "basis"
+      object.key = "key_1"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+
+      object.key = "key_2"
+      lambda{CollectionFoo.on_watched_store_delete_event(@store, object)}.should_not raise_error
+    end
+
+    it "should remove the resource for a basis when the last key is removed" do
+      object = OpenStruct.new
+
+      object.basis = "basis"
+      object.key = "key"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+      CollectionFoo.on_watched_store_delete_event(@store, object)
+      
+      @store.find("basis").should be_nil
+    end
+    
+    it "should not complain when asked to remove a key from a deleted basis" do
+      object = OpenStruct.new
+
+      object.basis = "basis"
+      object.key = "key"
+      CollectionFoo.on_watched_store_save_event(@store, object)
+      CollectionFoo.on_watched_store_delete_event(@store, object)
+      lambda{CollectionFoo.on_watched_store_delete_event(@store, object)}.should_not raise_error
+    end
+  end
+  
+  it "should do nothing when told about save or delete events for objects with no key attribute" do
+    store = HashPersistent::Store.new({}, "")
+    object = OpenStruct.new
+    object.basis = "fred"
+
+    CollectionFoo.on_watched_store_save_event(store, object)
+    store.key_value_store.should == {}
+    CollectionFoo.on_watched_store_delete_event(store, object)
+    store.key_value_store.should == {}    
+  end
+
+  it "should do nothing when told about save or delete events for objects with no basis attribute" do
+    store = HashPersistent::Store.new({}, "")
+    object = OpenStruct.new
+    object.key = "fred"
+
+    CollectionFoo.on_watched_store_save_event(store, object)
+    store.key_value_store.should == {}
+    CollectionFoo.on_watched_store_delete_event(store, object)
+    store.key_value_store.should == {}    
+  end
+  
+  context "(dereferencing collected keys)" do
+    it "should provide a convenient means to retrieve/dereference collected resources" do
+      watched_store = HashPersistent::Store.new({}, "")
+      watching_store = HashPersistent::Store.new({}, "")
+      watching_store.watch(watched_store)
+      watching_store.managed_class = CollectionFoo
+      CollectionFoo.basis = :basis
+      
+      object = OpenStruct.new
+
+      object.basis = "fred"
+      object.key = "1"
+      watched_store.save(object)
+
+      object.basis = "fred"
+      object.key = "2"
+      watched_store.save(object)
+
+      object.basis = "barney"
+      object.key = "3"
+      watched_store.save(object)
+      
+      fred = watching_store.find("fred")
+      fred.collected_resources.should include(watched_store.find("1"))
+      fred.collected_resources.should include(watched_store.find("2"))
+    end
+
+    it "should complain if asked to dereference a resource that does not exist in the watched store" do
+      watched_store = HashPersistent::Store.new({}, "")
+      watching_store = HashPersistent::Store.new({}, "")
+      watching_store.managed_class = CollectionFoo
+      watching_store.watch(watched_store)
+      CollectionFoo.basis = :basis
+      
+      object = OpenStruct.new
+      object.basis = "fred"
+      object.key = "1"
+      watched_store.save(object)
+
+      object.basis = "fred"
+      object.key = "2"
+      watched_store.save(object)
+
+      watched_store.watched_by = nil
+      watched_store.delete(object)
+      watched_store.watched_by = watching_store
+
+      fred = watching_store.find("fred")
+      lambda{fred.collected_resources}.should raise_error
+    end
+
+    it "should complain if asked to dereference a resource but does not know what store it's watching" do
+      watched_store = HashPersistent::Store.new({}, "")
+      watching_store = HashPersistent::Store.new({}, "")
+      watching_store.managed_class = CollectionFoo
+      watched_store.watched_by = watching_store # Note, only on-way relationship here
+      CollectionFoo.basis = :basis
+      
+      object = OpenStruct.new
+      object.basis = "fred"
+      object.key = "1"
+      watched_store.save(object)
+
+      object.basis = "fred"
+      object.key = "2"
+      watched_store.save(object)
+
+      fred = watching_store.find("fred")
+      lambda{fred.collected_resources}.should raise_error
+    end
+  end
+end
+

data/spec/counter_spec.rb

@@ -0,0 +1,61 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HashPersistent::Counter" do
+  context "(instantiation)" do
+    it "should expect to persist to a HashPersistent::Store and a string-like key" do
+      HashPersistent::Counter.new(HashPersistent::Store.new({}, ""), "key")
+    end
+
+    it "should reject an incorrect store type" do
+      lambda {HashPersistent::Counter.new(1, "key")}.should raise_error(ArgumentError)
+    end
+
+    it "should reject a non-string-like key" do
+      lambda {HashPersistent::Counter.new(HashPersistent::Store.new({}, ""), Dummy_NoStringRep.new)}.should raise_error(ArgumentError)
+    end
+
+    it "should reject an empty string key" do
+      lambda {HashPersistent::Counter.new(HashPersistent::Store.new({}, ""), "")}.should raise_error(ArgumentError)
+    end
+
+    it "should add an count object to the store" do
+      store = HashPersistent::Store.new({}, "")
+      HashPersistent::Counter.new(store, "counter_name")
+      store.find("counter_name").count.should == 0
+    end
+
+    it "should not change the count object in the store if already present" do
+      store = HashPersistent::Store.new({}, "")
+      counter_1 = HashPersistent::Counter.new(store, "counter_name")
+      counter_1.next.should == 0
+      counter_1.next.should == 1
+      counter_1.next.should == 2
+
+      counter_2 = HashPersistent::Counter.new(store, "counter_name")
+      store.find("counter_name").count.should == 3
+    end
+  end
+  
+  context "(generating unique ids)" do    
+    it "should increment the count value in the store when a new id is requested" do
+      store = HashPersistent::Store.new({}, "")
+      counter = HashPersistent::Counter.new(store, "counter_name")
+      counter.next
+      store.find("counter_name").count.should == 1
+      counter.next
+      store.find("counter_name").count.should == 2
+    end
+    
+    it "should return the count held in the store when a new id is requested" do
+      store = HashPersistent::Store.new({}, "")
+      counter = HashPersistent::Counter.new(store, "counter_name")
+      counter.next.should == 0
+      counter.next.should == 1
+      counter.next.should == 2
+    end
+  end
+
+  context "(concurrent access)" do
+    it "should correctly protect against use by mutliple threads/processes"
+  end
+end

data/spec/extended_store_spec.rb

@@ -0,0 +1,103 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "HashPersistent::ExtendedStore" do
+  context "(instantiation)" do
+    it "should initialise its store attribute" do
+      store = HashPersistent::Store.new(Hash.new, "prefix::")
+      extended_store = HashPersistent::ExtendedStore.new(store)
+      extended_store.store.should == store
+    end
+  end
+  
+  context "(in default configuration)" do
+    it "should delegate the find method to its store" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.store.should_receive(:find).with("a_key")
+      extended_store.find("a_key")
+    end
+
+    it "should delegate the save method to its store" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      object = OpenStruct.new
+      object.key = "a_key"
+      extended_store.store.should_receive(:save).with(object)
+      extended_store.save(object)
+    end
+
+    it "should delegate the delete method to its store" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      object = OpenStruct.new
+      object.key = "a_key"
+      extended_store.store.should_receive(:delete).with(object)
+      extended_store.delete(object)
+    end
+
+    it "should delegate the create method to its store" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.store.should_receive(:create).with("key", OpenStruct)
+      extended_store.create("key", OpenStruct)
+    end
+
+    it "should delegate the find_or_create method to its store" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.store.should_receive(:find_or_create).with("key", OpenStruct)
+      extended_store.find_or_create("key", OpenStruct)
+    end
+  end
+  
+  context "(singleton keys)" do
+    it "should allow a singleton key pattern to be specified" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.singleton_key("foo", OpenStruct)
+
+      HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, "")) do |store|
+        store.singleton_key "foo", OpenStruct
+      end
+    end
+
+    it "should reject a pattern that cannot be matched against a string" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      lambda{extended_store.singleton_key(1, OpenStruct)}.should raise_error
+    end
+
+    it "should not redirect find for keys that do not match the singleton pattern" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.singleton_key("foo", OpenStruct)
+
+      extended_store.store.should_receive(:find).with("bar")
+      extended_store.store.should_not_receive(:find_or_create)
+
+      extended_store.find("bar")
+    end
+
+    it "should redirect find to find_or_create for keys that match the singleton pattern" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.singleton_key("foo", OpenStruct, "arg1", "arg2")
+
+      extended_store.store.should_receive(:find_or_create).with("food", OpenStruct, "arg1", "arg2")
+      extended_store.store.should_not_receive(:find)
+
+      extended_store.find("food")
+    end
+
+    it "should allow multiple patterns to be specified" do
+      extended_store = HashPersistent::ExtendedStore.new(HashPersistent::Store.new({}, ""))
+      extended_store.singleton_key("foo", OpenStruct, "arg1", "arg2")
+      extended_store.singleton_key("bar", Object, "arg3", "arg4")
+
+      extended_store.store.should_receive(:find_or_create).with("food", OpenStruct, "arg1", "arg2")
+      extended_store.find("food")
+
+      extended_store.store.should_receive(:find_or_create).with("barney", Object, "arg3", "arg4")
+      extended_store.find("barney")
+    end
+  end
+  
+  context "(proxy stores)" do
+    it "should be clever"
+  end
+
+  context "(watching objects)" do
+    it "should be clever"
+  end
+end

data/spec/resource_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class ResourceFoo
+  include HashPersistent::Resource
+end
+
+
+describe "A class that includes HashPersistent::Resource" do
+  it "should acquire a store attribute" do
+    resource = ResourceFoo.new
+    resource.store = "foo"
+    resource.store.should == "foo"
+  end
+
+  it "should acquire a key attribute" do
+    resource = ResourceFoo.new
+    resource.key = "foo"
+    resource.key.should == "foo"
+  end
+
+  it "should be savable to its store" do
+    resource = ResourceFoo.new
+    mock_store = "dummy"
+    resource.store = mock_store
+    
+    mock_store.should_receive(:save).with(resource)
+    resource.save
+  end
+
+  it "should be deletable from its store" do
+    resource = ResourceFoo.new
+    mock_store = "dummy"
+    resource.store = mock_store
+    
+    mock_store.should_receive(:delete).with(resource)
+    resource.delete
+  end
+
+  it "should be movable from one store to another" do
+    resource = ResourceFoo.new
+    mock_store = "dummy" # We use only one so that we can use rspec to check the order of the messages...
+    resource.store = mock_store
+    
+    mock_store.should_receive(:delete).with(resource).ordered
+    mock_store.should_receive(:save).with(resource).ordered
+    resource.move(mock_store)
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format nested

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'rubygems'
+require 'spec'
+require 'ostruct'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hash-persistent'
+
+class Dummy_NoStringRep
+  undef to_s
+end
+
+class Dummy_RestrictedHash < Hash
+  undef each, each_key, each_pair, each_value
+  #TODO: expand this list, or just add dependency one of the moneta implementations?
+end
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/store_spec.rb

@@ -0,0 +1,370 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+class ClassWithKey
+  attr_accessor :key, :var
+  def initialize(key, var)
+    @key = key
+    @var = var
+  end
+  
+  def ==(other)
+    (other.class == ClassWithKey) && (key == other.key) && (var == other.var)
+  end
+end
+
+class ClassWithKeyAndStore
+  attr_accessor :key, :store, :var
+
+  def initialize(key = nil)
+    @key = key
+  end
+end
+
+describe "HashPersistent::Store" do
+  context "(instantiation)" do
+    it "should expect to persist to a hash-like key_value_store, with a string-like key_prefix" do
+      HashPersistent::Store.new({}, "_prefix")
+    end
+
+    it "should reject a non-hash-like key_value_store" do
+      lambda {HashPersistent::Store.new(1, "_prefix")}.should raise_error(ArgumentError)
+    end
+
+    it "should reject a non-string-like key_prefix" do
+      lambda {HashPersistent::Store.new({}, Dummy_NoStringRep.new)}.should raise_error(ArgumentError)
+    end
+    
+    it "should maintain a key_value_store attribute" do
+      a_hash = {}
+      HashPersistent::Store.new(a_hash, "").key_value_store.should == a_hash
+    end
+
+    it "should maintain a key_prefix attribute" do
+      HashPersistent::Store.new({}, "foo_bar").key_prefix.should == "foo_bar"
+    end
+  end
+  
+  context "(saving)" do
+    it "should refuse to save an object that does not provide a non-nil key" do
+      lambda{HashPersistent::Store.new({}, "").save(1)}.should raise_error
+      object = ClassWithKey.new(nil, "foo")
+      lambda{HashPersistent::Store.new({}, "").save(object)}.should raise_error
+    end
+    
+    it "should add the object, referenced by its prefixed key, to the store" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      object = ClassWithKey.new("foo", "bar")
+      store.save(object).key_value_store["prefix::foo"].should == object
+    end
+    
+    it "should overwrite an object with same prefixed key in the store" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      object_1 = ClassWithKey.new("foo", "bar")
+      object_2 = ClassWithKey.new("foo", "baz")
+      store.save(object_1).save(object_2).key_value_store["prefix::foo"].should == object_2
+    end
+  end
+  
+  context "(deleting)" do
+    it "should refuse to delete an object that does not provide a non-nil key" do
+      lambda{HashPersistent::Store.new({}, "").delete(1)}.should raise_error
+      object = ClassWithKey.new(nil, "foo")
+      lambda{HashPersistent::Store.new({}, "").delete(object)}.should raise_error
+    end
+
+    it "should delete a pair from the store based on the object's prefixed key" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      object = ClassWithKey.new("foo", "bar")
+      store.save(object).delete(object).key_value_store["prefix::foo"].should be_nil
+    end
+
+    it "should not complain if the prefixed key does not exist in the store" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      object = ClassWithKey.new("foo", "bar")
+      lambda{store.delete(object)}.should_not raise_error
+    end
+  end
+
+  context "(finding)" do
+    it "should retrieve an object that has the correct key" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      object = ClassWithKey.new("foo", "bar")
+      store.save(object).find("foo").should == object
+    end
+
+    it "should return nil if no object is found with the correct key" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      object = ClassWithKey.new("foo", "bar")
+      store.find("foo").should be_nil
+      store.save(object).delete(object).find("foo").should be_nil
+    end
+  end
+
+  context "(creating)" do
+    it "should create objects on request" do
+      new_object = ClassWithKeyAndStore.new
+      ClassWithKeyAndStore.should_receive(:new).with("arg1", "arg2").and_return(new_object)
+      object = HashPersistent::Store.new({}, "prefix::").create("a_key", ClassWithKeyAndStore, "arg1", "arg2")
+      object.should == new_object
+    end
+    
+    it "should set the key attribute of created objects" do
+      block = lambda{"foo"}
+      object = HashPersistent::Store.new({}, "prefix::").create("a_key", ClassWithKeyAndStore)
+      object.key.should == "a_key"
+    end
+    
+    it "should be able to create and save when the requested key is not found" do
+      store = HashPersistent::Store.new({}, "")
+      store.find_or_create("a_key", OpenStruct, {:foo => "bar"})
+      store.find("a_key").should_not be_nil
+      store.find("a_key").foo.should == "bar"
+    end
+
+    it "should not create or modify when the requested key is found" do
+      store = HashPersistent::Store.new({}, "")
+      store.save(store.create("a_key", OpenStruct, {:foo => "bar"}))
+
+      store.find_or_create("a_key", OpenStruct, {:foo => "baz", :fred => "barney"})
+
+      store.find("a_key").should_not be_nil
+      store.find("a_key").fred.should be_nil
+      store.find("a_key").foo.should == "bar"
+    end
+  end
+  
+  context "(isolation of objects in in-memory stores)" do
+    it "should return a copy of the object found in the store" do
+      store = HashPersistent::Store.new({}, "")
+      object = ClassWithKey.new("foo", "bar")
+      store.save(object).find("foo").should_not equal(store.key_value_store["foo"])
+    end
+    
+    it "should save a copy of the object being saved" do
+      store = HashPersistent::Store.new({}, "")
+      object = ClassWithKey.new("foo", "bar")
+      store.save(object)
+      store.key_value_store["foo"].should_not equal(object)
+    end
+  end
+  
+  context "(handling objects that expose a store attribute)" do
+    it "should set the store attribute of a created object" do
+      store = HashPersistent::Store.new({}, "prefix::")
+      store.create("key", ClassWithKeyAndStore).store.should == store
+    end
+
+    it "should set the store attribute of a saved object" do
+      object = ClassWithKeyAndStore.new("foo")
+      store = HashPersistent::Store.new({}, "")
+      store.save(object)
+      object.store.should == store
+    end
+
+    it "should not save the store attribute into the store" do
+      object = ClassWithKeyAndStore.new("foo")
+      object.store = "faa"
+
+      store = HashPersistent::Store.new({}, "")
+      store.save(object)
+
+      store.key_value_store["foo"].store.should be_nil
+    end
+
+    it "should set the store attribute of a found object" do
+      object = ClassWithKeyAndStore.new("foo")
+      object.store = "faa"
+
+      store = HashPersistent::Store.new({}, "")
+      store.save(object).find("foo").store.should == store
+    end
+
+    it "leave the in-store object's store attribute nil after finding/returning the object" do
+      object = ClassWithKeyAndStore.new("foo")
+      object.store = "faa"
+
+      store = HashPersistent::Store.new({}, "")
+      store.save(object).find("foo")
+      store.key_value_store["foo"].store.should be_nil
+    end
+
+    it "set the object's store attribute after deleting the object" do
+      store = HashPersistent::Store.new({}, "")
+      object = ClassWithKeyAndStore.new("foo")
+
+      store.save(object)
+      object.store = nil
+      store.delete(object)
+      object.store.should == store
+    end
+  end
+
+  context "(use of restricted Hash API)" do
+    it "should not require Hash methods that are not implemented in Moneta"
+  end
+
+  context "(caching)" do
+    it "should accept a HashPersistent::Store cache" do
+      cache = HashPersistent::Store.new({}, "")
+      store = HashPersistent::Store.new({}, "") do |the_store|
+        the_store.cached_to = cache
+      end
+      store.cached_to.should == cache
+    end
+
+    # TODO: can relax this?
+    # We'd like to reproduce some nice behaviours in the cache (like unsetting object.store on saving)
+    it "should reject a cache of the wrong type" do
+      store = HashPersistent::Store.new({}, "")
+      lambda{store.cached_to = {}}.should raise_error(ArgumentError)
+    end
+
+    it "should allow the cache to be unset using nil" do
+      store = HashPersistent::Store.new({}, "")
+      store.cached_to = nil
+      store.cached_to.should == nil
+    end
+    
+    context "if supplied a cache" do
+      it "should also save an object to the cache when saving" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+        cache.should_receive(:save) do |the_save_object|
+          the_save_object.key.should == "foo"
+        end
+        store.save(object)
+      end
+      
+      it "should also delete an object from the cache when deleting" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+        store.save(object)
+
+        cache.should_receive(:delete) do |the_delete_object|
+          the_delete_object.key.should == "foo"
+        end
+        store.delete(object)
+      end
+      
+      it "should save an object to the cache if it is not present on find()" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        
+        object = ClassWithKeyAndStore.new("foo")
+        store.save(object)
+
+        # We're making an assumption here that no data is copied to the cache when we do this
+        store.cached_to = cache
+
+        cache.should_receive(:save) do |the_save_object|
+          the_save_object.key.should == "foo"
+        end
+        store.find("foo")
+      end
+      
+      it "should return the object from the cache if it is present on find()" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+        object.var = "bar"
+        store.save(object)
+        
+        object.var = "baz"
+        cache.save(object)
+        
+        store.find("foo").var.should == "baz"
+      end
+
+      it "should not hit the store if the object is present in the cache on find()" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+        store.save(object)
+        
+        # We assume that Fixnum is missing methods required in find(), but we verify this assumption below
+        class HashPersistent::Store
+          def hack_key_value_store
+            @key_value_store = 1
+          end
+        end
+        
+        store.hack_key_value_store
+
+        lambda{store.find("foo")}.should_not raise_error
+
+        store.cached_to = nil
+        lambda{store.find("foo")}.should raise_error
+
+        class HashPersistent::Store
+          undef hack_key_value_store
+        end        
+      end
+      
+      it "should correctly set the object's store attribute when saving" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+        store.save(object)
+        object.store.should == store
+      end
+
+      it "should correctly set the object's store attribute when deleting" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+
+        store.save(object)
+        object.store = nil
+
+        store.delete(object)
+        object.store.should == store
+      end
+      
+      it "should correctly set the object's store attribute when finding/caching" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        
+        object = ClassWithKeyAndStore.new("foo")
+        store.save(object)
+
+        store.cached_to = cache
+        found = store.find("foo")
+        
+        found.store.should == store
+      end
+      
+      it "should correctly set the object's store attribute when finding from the cache" do
+        cache = HashPersistent::Store.new({}, "")
+        store = HashPersistent::Store.new({}, "")
+        store.cached_to = cache
+        
+        object = ClassWithKeyAndStore.new("foo")
+        store.save(object)
+        
+        store.find("foo").store.should == store
+      end
+    end
+  end
+  
+  context "(consistency of store, watched store and cache after errors occur)" do
+    it "should do something both boring and predictable"
+  end
+  
+  context "(concurrent access)" do
+    it "should use locks and such to handle access from multiple threads/processes"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: kissifer-hash-persistent
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- kissifer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-23 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: tierneydrchris@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- hash-persistent.gemspec
+- lib/hash-persistent.rb
+- lib/hash-persistent/collection.rb
+- lib/hash-persistent/counter.rb
+- lib/hash-persistent/extended_store.rb
+- lib/hash-persistent/resource.rb
+- lib/hash-persistent/store.rb
+- spec/collection_spec.rb
+- spec/counter_spec.rb
+- spec/extended_store_spec.rb
+- spec/resource_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/store_spec.rb
+has_rdoc: false
+homepage: http://github.com/kissifer/hash-persistent
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Library of base classes to simplify persisting objects and collections to a moneta store
+test_files: 
+- spec/collection_spec.rb
+- spec/counter_spec.rb
+- spec/extended_store_spec.rb
+- spec/resource_spec.rb
+- spec/spec_helper.rb
+- spec/store_spec.rb