persistence 0.0.1.alpha → 0.0.1

data/spec/persistence/object/flat/file_spec.rb

@@ -0,0 +1,64 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe ::Persistence::Object::Flat::File do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a file object to a persistence port and get it back" do
+    class ::Persistence::Object::Flat::File::FileMock < File
+      include ::Persistence::Object::Flat::File
+      explicit_index :explicit_index
+    end
+    class ::Persistence::Object::Flat::File::Contents
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    class ::Persistence::Object::Flat::File::Path
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    file_object = ::Persistence::Object::Flat::File::FileMock.open( __FILE__, 'r' )
+    file_object.persistence_port.persist_files_by_path!
+    file_object.persistence_port.persist_file_paths_as_strings!
+    file_object.persist!
+    
+    persisted_file = ::Persistence::Object::Flat::File::FileMock.persist( file_object.persistence_id )
+    persisted_file.should == file_object.path
+    file_object.persistence_port.persist_file_paths_as_objects!
+    persisted_file = ::Persistence::Object::Flat::File::FileMock.persist( file_object.persistence_id )
+    persisted_file.path.should == file_object.path
+    
+    file_object.persistence_port.persists_files_by_content!
+    file_object.persist!
+    persisted_file = ::Persistence::Object::Flat::File::FileMock.persist( file_object.persistence_id )
+    persisted_file.should == file_object.readlines.join
+    file_object.cease!
+    ::Persistence::Object::Flat::File::FileMock.persist( file_object.persistence_id ).should == nil
+
+    file_object.persistence_port.persist_files_by_path!
+    file_object.persistence_port.persist_file_paths_as_strings!
+    file_object.persist!( :explicit_index => __FILE__ )
+    
+    persisted_file = ::Persistence::Object::Flat::File::FileMock.persist( :explicit_index => __FILE__ )
+    persisted_file.should == file_object.path
+    file_object.persistence_port.persist_file_paths_as_objects!
+    persisted_file = ::Persistence::Object::Flat::File::FileMock.persist( :explicit_index => __FILE__ )
+    persisted_file.path.should == file_object.path
+    
+    file_object.persistence_port.persists_files_by_content!
+    file_object.persist!( :explicit_index => __FILE__ )
+    persisted_file = ::Persistence::Object::Flat::File::FileMock.persist( :explicit_index => __FILE__ )
+    persisted_file.should == file_object.readlines.join
+    ::Persistence::Object::Flat::File::FileMock.cease!( :explicit_index => __FILE__ )
+    ::Persistence::Object::Flat::File::FileMock.persist( :explicit_index => __FILE__ ).should == nil
+
+  end
+  
+end

data/spec/persistence/object/flat/fixnum_spec.rb

@@ -0,0 +1,32 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe Fixnum do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a fixnum number object to a persistence port and get it back" do
+    class Fixnum
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    fixnum_object = 420
+    fixnum_object.persist!
+    Fixnum.persist( fixnum_object.persistence_id ).should == fixnum_object
+    fixnum_object.cease!
+    Fixnum.persist( fixnum_object.persistence_id ).should == nil
+
+    storage_key   = 12
+    fixnum_object.persist!( :explicit_index, storage_key )
+    Fixnum.persist( :explicit_index, storage_key ).should == fixnum_object
+    Fixnum.cease!( :explicit_index, storage_key )
+    Fixnum.persist( :explicit_index, storage_key ).should == nil
+  end
+  
+end

data/spec/persistence/object/flat/float_spec.rb

@@ -0,0 +1,32 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe Float do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a float number object to a persistence port and get it back" do
+    class Float
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    float_object  = 42.020
+    float_object.persist!
+    Float.persist( float_object.persistence_id ).should == float_object
+    float_object.cease!
+    Float.persist( float_object.persistence_id ).should == nil
+  
+    storage_key   = 37.0012
+    float_object.persist!( :explicit_index, storage_key )
+    Float.persist( :explicit_index, storage_key ).should == float_object
+    Float.cease!( :explicit_index, storage_key )
+    Float.persist( :explicit_index, storage_key ).should == nil
+  end
+  
+end

data/spec/persistence/object/flat/indexing_spec.rb

@@ -0,0 +1,38 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe ::Persistence::Object::Flat do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )  
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )  
+  end
+  
+  #############
+  #  persist  #
+  #############
+  
+  it 'can persist a flat object and test whether it has been persisted' do
+    class ::Persistence::Object::Flat::Mock < ::String
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+      block_index :first_letter do
+        chars.first
+      end
+    end
+    instance = ::Persistence::Object::Flat::Mock.new
+    instance.persist!
+    instance.persistence_id.should_not == nil
+    ::Persistence::Object::Flat::Mock.persisted?( instance.persistence_id ).should == true
+    ::Persistence::Object::Flat::Mock.persist( instance.persistence_id ).should == instance
+    instance_two = ::Persistence::Object::Flat::Mock.new( 'test' )
+    instance_two.persist!( :explicit_index => :some_value )
+    instance_two.persistence_id.should_not == nil
+    ::Persistence::Object::Flat::Mock.persist( :explicit_index, :some_value ).should == instance_two
+    ::Persistence::Object::Flat::Mock.persist( :first_letter => 't' ).should == instance_two
+  end
+    
+end

data/spec/persistence/object/flat/rational_spec.rb

@@ -0,0 +1,33 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe Rational do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a rational number object to a persistence port and get it back" do
+    class Rational
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    rational_object = Rational( 42, 37 )
+    rational_object.persist!
+    Rational.persist( rational_object.persistence_id ).should == rational_object
+    rational_object.cease!
+    Rational.persist( rational_object.persistence_id ).should == nil
+
+    rational_object = Rational( 42, 37 )
+    storage_key     = Rational( 42, 420 )
+    rational_object.persist!( :explicit_index, storage_key )
+    Rational.persist( :explicit_index, storage_key ).should == rational_object
+    Rational.cease!( :explicit_index, storage_key )
+    Rational.persist( :explicit_index, storage_key ).should == nil
+  end
+  
+end

data/spec/persistence/object/flat/regexp_spec.rb

@@ -0,0 +1,32 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe ::Persistence::Object::Flat do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a regexp object to a persistence port and get it back" do
+    class ::Persistence::Object::Flat::RegexpMock < Regexp
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    regexp_object = ::Persistence::Object::Flat::RegexpMock.new( /some_regexp_([A-Za-z])/ )
+    regexp_object.persist!
+    ::Persistence::Object::Flat::RegexpMock.persist( regexp_object.persistence_id ).should == regexp_object
+    regexp_object.cease!
+    ::Persistence::Object::Flat::RegexpMock.persist( regexp_object.persistence_id ).should == nil
+
+    storage_key   = /regexp_storage_key/
+    regexp_object.persist!( :explicit_index, storage_key )
+    ::Persistence::Object::Flat::RegexpMock.persist( :explicit_index, storage_key ).should == regexp_object
+    ::Persistence::Object::Flat::RegexpMock.cease!( :explicit_index, storage_key )
+    ::Persistence::Object::Flat::RegexpMock.persist( :explicit_index, storage_key ).should == nil
+  end
+  
+end

data/spec/persistence/object/flat/string_spec.rb

@@ -0,0 +1,34 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe ::Persistence::Object::Flat do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a string object to a persistence port and get it back" do
+    class ::Persistence::Object::Flat::StringMock < String
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    string_object = ::Persistence::Object::Flat::StringMock.new( "some string" )
+    string_object.persist!
+    string_object.persistence_id.should_not == nil
+    ::Persistence::Object::Flat::StringMock.persist( string_object.persistence_id ).should == string_object
+    string_object.cease!
+    ::Persistence::Object::Flat::StringMock.persist( string_object.persistence_id ).should == nil
+  
+    string_object = Persistence::Object::Flat::StringMock.new( "some string" )
+    storage_key   = "string storage key"
+    string_object.persist!( :explicit_index, storage_key )
+    Persistence::Object::Flat::StringMock.persist( :explicit_index, storage_key ).should == string_object
+    Persistence::Object::Flat::StringMock.cease!( :explicit_index, storage_key )
+    Persistence::Object::Flat::StringMock.persist( :explicit_index, storage_key ).should == nil
+  end
+  
+end

data/spec/persistence/object/flat/symbol_spec.rb

@@ -0,0 +1,32 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe Symbol do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a symbol object to a persistence port and get it back" do
+    class Symbol
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    symbol_object = :symbol
+    storage_key   = :symbol_storage_key
+    symbol_object.persist!( :explicit_index, storage_key )
+    Symbol.persist( :explicit_index, storage_key ).should == symbol_object
+    symbol_object.cease!
+    Symbol.persist( :explicit_index, storage_key ).should == nil
+
+    symbol_object.persist!
+    Symbol.persist( symbol_object.persistence_id ).should == symbol_object
+    symbol_object.cease!
+    Symbol.persist( symbol_object.persistence_id ).should == nil
+  end
+
+end

data/spec/persistence/object/flat/true_class_spec.rb

@@ -0,0 +1,32 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe TrueClass do
+  
+  before :all do
+    ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  end
+  
+  after :all do
+    ::Persistence.disable_port( :mock )
+  end
+
+  it "can put a true object to a persistence port and get it back" do
+    class TrueClass
+      include ::Persistence::Object::Flat
+      explicit_index :explicit_index
+    end
+    true_object = true
+    true_object.persist!
+    TrueClass.persist( true_object.persistence_id ).should == true_object
+    true_object.cease!
+    TrueClass.persist( true_object.persistence_id ).should == nil
+
+    storage_key = false
+    true_object.persist!( :explicit_index, storage_key )
+    TrueClass.persist( :explicit_index, storage_key ).should == true_object
+    true_object.cease!
+    TrueClass.persist( :explicit_index, storage_key ).should == nil
+  end
+  
+end

data/spec/persistence/object/indexes/block_index_spec.rb

@@ -0,0 +1,119 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+describe ::Persistence::Object::Index::BlockIndex do
+
+  #################################
+  #  block_index                  #
+  #  block_index_with_duplicates  #
+  #  has_block_index?             #
+  #  index                        #
+  #################################
+  
+  it 'can declare an arbitrary key/value index on an object' do
+    class ::Persistence::Object::Index::BlockIndex::Mock
+  
+      include ::Persistence::Object::Complex
+      
+      block_index :block_index do |key, value|
+        return value
+      end
+  
+      block_index_with_duplicates :block_index_with_duplicates do |key, value|
+        return value
+      end
+      
+      has_block_index?( :block_index ).should == true
+      has_index?( :block_index ).should == true
+      has_block_index?( :block_index_with_duplicates ).should == true
+      has_index?( :block_index_with_duplicates ).should == true
+      index( :block_index ).is_a?( ::Persistence::Object::Index ).should == true
+      index( :block_index_with_duplicates ).is_a?( ::Persistence::Object::Index ).should == true
+      
+    end    
+  end
+  
+  ##################
+  #  index_object  #
+  ##################
+
+  it 'can index an object by passing it to a block' do
+    # we want this test without port enabled to start
+    ::Persistence.disable_port( :mock )
+
+    ::Persistence::Object::Index::BlockIndex::IndexExistingObjects = ::Module.new
+    rspec = self
+    ::Persistence::Object::Index::BlockIndex::IndexExistingObjects.module_eval do
+      
+      class IndexMock
+        include ::Persistence::Object::Complex
+        attr_accessor :some_value
+      end
+        
+      object = IndexMock.new
+  
+      ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+  
+      indexing_proc = Proc.new do |object|
+        object.some_value
+      end
+      
+      index_instance = ::Persistence::Object::Index::BlockIndex.new( :block_index, object.persistence_bucket, false, & indexing_proc )
+  
+      # test keys required for block with no returns
+      index_instance.requires_keys = true
+      Proc.new { index_instance.index_object( object ) }.should rspec.raise_error
+      # test keys not required for block with no returns
+      index_instance.requires_keys = false
+      Proc.new { index_instance.index_object( object ) }.should_not rspec.raise_error
+    
+      # now to test indexing we want to require keys be generated
+      index_instance.requires_keys = true
+    
+      object.some_value = :some_key
+      object.persist!
+      index_instance.index_object( object )
+      index_instance.persisted?( :some_key ).should == true
+  
+      ::Persistence.disable_port( :mock )
+  
+    end
+  end
+
+  ############################
+  #  index_existing_objects  #
+  ############################
+
+  it 'can index an object by passing it to a block' do
+    module ::Persistence::Object::Index::BlockIndex::IndexExistingObjects
+      
+      class ObjectInstance
+        include ::Persistence::Object::Complex
+        attr_accessor :some_value
+      end
+
+      ::Persistence.enable_port( :mock, ::Persistence::Adapter::Mock.new )
+    
+      object = ObjectInstance.new
+
+      object.persist!
+    
+      ObjectInstance.persist( object.persistence_id ).should == object
+
+      indexing_proc = Proc.new do |object|
+        :some_key
+      end
+
+      index_instance = ::Persistence::Object::Index::BlockIndex.new( :other_block_index, object.persistence_bucket, false, & indexing_proc )
+
+      index_instance.persisted?( :some_key ).should == false
+    
+      index_instance.index_existing_objects
+      index_instance.persisted?( :some_key ).should == true
+
+      ::Persistence.disable_port( :mock )
+
+    end
+  end
+  
+end