persistence 0.0.1.alpha → 0.0.1

data/spec/persistence/adapter/mock/cursor_spec.rb

@@ -0,0 +1,64 @@
+
+require_relative '../../../../lib/persistence.rb'
+
+require_relative '../mock_helpers.rb'
+
+describe ::Persistence::Adapter::Mock::Cursor do
+
+  before :all do
+
+    adapter = ::Persistence::Adapter::Mock.new
+
+    @objects = [ ]
+    @bucket = adapter.persistence_bucket( ::Persistence::Adapter::Abstract::Mock::Object.to_s )
+    ::Persistence::Adapter::Abstract::Mock::Object.instance_persistence_bucket = @bucket
+    @index = @bucket.create_index( :name, false )
+    5.times do |this_number|
+      instance = ::Persistence::Adapter::Abstract::Mock::Object.new
+      instance.name = 'Number ' << this_number.to_s
+      @bucket.put_object!( instance )
+      @bucket.index( :name ).index_object_id( instance.persistence_id, instance.name )
+      @objects.push( instance )
+    end    
+
+  end
+
+  ################
+  #  first       #
+  #  get_key     #
+  #  persisted?  #
+  #  current     #
+  #  next        #
+  ################
+
+  it 'it can return an object ID for persistence ID' do
+    
+    # persistence id
+    bucket_cursor = @bucket.cursor
+    bucket_cursor.first.should == 0
+    bucket_cursor.persisted?( 1 ).should == true
+    bucket_cursor.current.should == 1
+    bucket_cursor.next.should == 2
+    bucket_cursor.next.should == 3
+    bucket_cursor.next.should == 4
+    bucket_cursor.persisted?( 3 ).should == true
+    bucket_cursor.persisted?( 2 ).should == true
+    
+  end
+
+  it 'it can return an object ID for key' do
+    
+    # index
+    index_cursor = @index.cursor
+    index_cursor.first.should == 0
+    index_cursor.persisted?( "Number 1" ).should == true
+    index_cursor.current_key.should == "Number 1"
+    index_cursor.current.should == 1
+    index_cursor.next_key.should == "Number 2"
+    index_cursor.next.should == 3
+    index_cursor.persisted?( "Number 2" ).should == true
+    index_cursor.next.should == 3
+    
+  end
+
+end

data/spec/persistence/adapter/mock_helpers.rb

@@ -0,0 +1,27 @@
+
+module ::Persistence::Adapter::Abstract::Mock
+end
+
+basepath = 'mock_helpers'
+
+files = [ 
+  
+  'bucket',
+  'object',
+  'port',
+  
+  'integration/note',
+  'integration/notes_array',
+  'integration/dictionary_hash',
+  'integration/user',
+  'integration/user/address',
+  'integration/user/dictionary_entry',
+  'integration/user/sub_account'
+  
+  ]
+
+  files.each do |this_file|
+    require_relative( File.join( basepath, this_file ) + '.rb' )
+  end
+
+  require_relative( basepath + '.rb' )

data/spec/persistence/adapter/mock_helpers/bucket.rb

@@ -0,0 +1,10 @@
+
+class ::Persistence::Adapter::Abstract::Mock::Bucket
+  
+  attr_accessor :name
+  
+  def initialize( name )
+    @name = name
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/integration/dictionary_hash.rb

@@ -0,0 +1,4 @@
+
+class ::Persistence::Adapter::Abstract::Mock::DictionaryHash < ::Hash
+  include ::Persistence
+end

data/spec/persistence/adapter/mock_helpers/integration/note.rb

@@ -0,0 +1,18 @@
+
+class ::Persistence::Adapter::Abstract::Mock::Note
+  
+  include ::Persistence
+  
+  attr_atomic_accessor :date, :subject, :content
+  
+  def populate
+
+    self.date = ::Date.today.to_s
+    
+    self.subject = 'Subject ' + rand( 100000000 ).to_s
+    
+    self.content = 'Content ' + rand( 100000000 ).to_s
+    
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/integration/notes_array.rb

@@ -0,0 +1,4 @@
+
+class ::Persistence::Adapter::Abstract::Mock::NotesArray < ::Array
+  include ::Persistence
+end

data/spec/persistence/adapter/mock_helpers/integration/user.rb

@@ -0,0 +1,44 @@
+
+class ::Persistence::Adapter::Abstract::Mock::User
+
+  include ::Persistence
+  
+  attr_atomic_accessor :username, :firstname, :lastname, :address, :alternate_address, :url, :notes, :dictionary, :subaccount
+  
+  def populate
+
+    self.username = 'User ' + rand( 100000000 ).to_s
+    self.firstname = 'First ' + rand( 100000000 ).to_s
+    self.lastname = 'Last ' + rand( 100000000 ).to_s
+      
+    # new visitors have an address
+    self.address = ::Persistence::Adapter::Abstract::Mock::User::Address.new
+
+    ::Persistence::Adapter::Abstract::Mock::User::Address.instance_persistence_bucket
+
+    # new visitors have an address
+    self.alternate_address = ::Persistence::Adapter::Abstract::Mock::User::Address.new
+    
+    self.notes = ::Persistence::Adapter::Abstract::Mock::NotesArray.new
+
+    new_note = ::Persistence::Adapter::Abstract::Mock::Note.new
+    self.notes.push( new_note )
+
+    self.notes.persist!
+
+    self.dictionary = ::Persistence::Adapter::Abstract::Mock::DictionaryHash.new
+
+    new_entry = ::Persistence::Adapter::Abstract::Mock::User::DictionaryEntry.new
+    new_entry.populate
+    self.dictionary[ 'Some Word ' + rand( 100000000 ).to_s ] = new_entry
+    self.dictionary.persist!
+    
+#    self.subaccount = ::Persistence::Adapter::Abstract::Mock::User::SubAccount.new( self )
+
+    if rand( 100000000 ) > 75000000
+      self.url = 'URL ' + rand( 100000000 ).to_s
+    end
+
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/integration/user/address.rb

@@ -0,0 +1,18 @@
+
+class ::Persistence::Adapter::Abstract::Mock::User::Address
+  
+  include ::Persistence
+
+  attr_atomic_accessor :number, :street, :city, :state, :zipcode
+  
+  def populate
+        
+    self.number = rand( 100000000 )
+    self.street = 'Street ' + rand( 100000000 ).to_s
+    self.city = 'City ' + rand( 100000000 ).to_s
+    self.state = 'State ' + rand( 100000000 ).to_s
+    self.zipcode = rand( 10000 ).to_s
+  
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/integration/user/dictionary_entry.rb

@@ -0,0 +1,12 @@
+
+class ::Persistence::Adapter::Abstract::Mock::User::DictionaryEntry < String
+  
+  include ::Persistence
+  
+  def populate
+  
+    replace( 'Some Other Word ' + rand( 100000000 ).to_s )
+    
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/integration/user/sub_account.rb

@@ -0,0 +1,15 @@
+
+class ::Persistence::Adapter::Abstract::Mock::User::SubAccount
+  
+  include ::Persistence
+  
+  attr_atomic_accessor :username, :parent_user
+
+  def populate( parent_user = nil )
+    
+    self.user = ::Persistence::Adapter::Abstract::Mock::User.new
+    self.parent_user = parent_user
+    
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/object.rb

@@ -0,0 +1,87 @@
+
+class ::Persistence::Adapter::Abstract::Mock::Object
+
+  include ::CascadingConfiguration::Setting
+  attr_class_configuration :instance_persistence_bucket, :instance_persistence_port
+  attr_local_configuration :adapter, :persistence_bucket, :persistence_port
+  attr_instance_setting :persistence_id
+  attr_object_configuration :instance_persistence_bucket
+  include ::CascadingConfiguration::Hash
+  
+  attr_accessor :value, :name
+  
+  #######################################
+  #  self.non_atomic_attribute_readers  #
+  #######################################
+
+  def self.non_atomic_attribute_readers
+    return @non_atomic_attribute_readers ||= [ ]
+  end
+  
+  ##############################
+  #  persistence_hash_to_port  #
+  ##############################
+  
+  def persistence_hash_to_port
+    persistence_hash = { }
+    instance_variables.each do |this_variable|
+      persistence_hash[ this_variable ] = instance_variable_get( this_variable )
+    end
+    return persistence_hash
+  end
+
+  ######################
+  #  persistence_port  #
+  ######################
+
+  def persistence_port
+    return super || self.class.instance_persistence_port
+  end
+
+  ########################
+  #  persistence_bucket  #
+  ########################
+
+  def persistence_bucket
+    return super || self.class.instance_persistence_bucket
+  end
+
+  ###########################
+  #  load_persistence_hash  #
+  ###########################
+
+  def load_persistence_hash( port, persistence_hash )
+    persistence_hash.each do |this_variable, this_value|
+      instance_variable_set( this_variable, this_value )
+    end
+  end
+  
+  ##################################
+  #  non_atomic_attribute_readers  #
+  ##################################
+  
+  def non_atomic_attribute_readers
+    return [ ]
+  end
+  
+  ##############################
+  #  atomic_attribute_readers  #
+  ##############################
+  
+  def atomic_attribute_readers
+    return [ ]
+  end
+
+  ##############
+  #  persist!  #
+  ##############
+
+  def persist!
+    
+    persistence_bucket.put_object!( self )
+    
+    return self
+    
+  end
+  
+end

data/spec/persistence/adapter/mock_helpers/port.rb

@@ -0,0 +1,21 @@
+
+class ::Persistence::Adapter::Abstract::Mock::Port
+  
+  def initialize( name, adapter )
+    @name = name
+    @adapter = adapter
+  end
+  
+  def enable
+    @enabled = true
+  end
+
+  def enabled?
+    return @enabled
+  end
+  
+  def disable
+    @enabled = false
+  end
+
+end

data/spec/persistence/adapter/mock_spec.rb

@@ -0,0 +1,211 @@
+
+require_relative '../../../lib/persistence.rb'
+
+require_relative './mock_helpers.rb'
+
+describe ::Persistence::Adapter::Mock do
+  
+  before( :all ) do
+    @adapter = ::Persistence::Adapter::Mock.new( '/tmp/persistence_home' )
+    @object = ::Persistence::Adapter::Abstract::Mock::Object.new
+    @object.persistence_port = ::Persistence::Adapter::Abstract::Mock::Port.new( :test_port, @adapter )
+    @object.persistence_port.enable
+    @object.persistence_bucket = ::Persistence::Adapter::Abstract::Mock::Bucket.new( @object.class.to_s )
+    @object.value = :some_value
+    @bucket = @adapter.persistence_bucket( @object.persistence_bucket.name )
+    @value_index = nil
+    @duplicate_value_index = nil
+  end
+  
+  ################
+  #  initialize  #
+  #  enable      #
+  #  disable     #
+  #  enabled?    #
+  ################
+
+  it 'can initialize enabled state, enable, disable, and report whether enabled' do
+    @object.persistence_port.instance_eval do
+      enabled?.should == true
+      disable
+      enabled?.should == false
+      enable
+      enabled?.should == true
+    end
+  end
+
+  #################
+  #  put_object!  #
+  #################
+
+  it "can put and get an object with simple properties and sub objects" do
+  
+    # put_object!
+    @bucket.put_object!( @object )
+    @object.persistence_id.should_not == nil
+    
+    retrieved_object_hash = @bucket.get_object( @object.persistence_id )
+    retrieved_object_hash.should == @object.persistence_hash_to_port
+    
+  end
+
+  ###########
+  #  count  #
+  ###########
+  
+  it 'can report how many objects are persisted' do
+    
+    @bucket.count.should == 1
+    
+  end
+
+  ####################
+  #  delete_object!  #
+  ####################
+
+  it "can delete an object" do
+
+    # delete_object!
+    @bucket.delete_object!( @object.persistence_id )
+    @bucket.get_object( @object.persistence_id ).should == nil
+
+    # now put it back
+    @object.persistence_id = nil
+    @bucket.put_object!( @object )
+    retrieved_object_hash = @bucket.get_object( @object.persistence_id )
+    retrieved_object_hash.should == @object.persistence_hash_to_port
+    
+  end
+
+  ##############################
+  #  get_bucket_name_for_object_id  #
+  ##############################
+
+  it "can get a bucket for a given object ID" do
+
+    # get_bucket_name_for_object_id
+    @adapter.get_bucket_name_for_object_id( @object.persistence_id ).should == @object.persistence_bucket.name
+  
+  end
+
+  #############################
+  #  get_class_for_object_id  #
+  #############################
+
+  it "can get a class for a given object ID" do
+
+    # get_class_for_object_id
+    @adapter.get_class_for_object_id( @object.persistence_id ).should == @object.class
+  
+  end
+
+  ####################
+  #  put_attribute!  #
+  ####################
+
+  it "can put a attribute for an object" do
+  
+    # put_attribute!
+    primary_key = @bucket.primary_key_for_attribute_name( @object, :attribute )
+    @bucket.put_attribute!( @object, primary_key, 'attribute!' )
+  
+  end
+
+  ###################
+  #  get_attribute  #
+  ###################
+
+  it "can get a attribute for an object" do
+
+    # get_attribute
+    primary_key = @bucket.primary_key_for_attribute_name( @object, :attribute )
+    @bucket.get_attribute( @object, primary_key ).should == 'attribute!'
+  
+  end
+
+  #######################
+  #  delete_attribute!  #
+  #######################
+
+  it "can delete a attribute on an object" do
+
+    # delete_attribute!
+    primary_key = @bucket.primary_key_for_attribute_name( @object, :attribute )
+    @bucket.delete_attribute!( @object, primary_key )
+    @bucket.get_attribute( @object, primary_key ).should == nil
+  
+  end
+
+  ##################
+  #  create_index  #
+  #  has_index?    #
+  #  index         #
+  ##################
+
+  it 'can create an index on a class so instances can be retrieved by key and report whether a given index exists' do
+    @bucket.create_index( :key, false )
+    @bucket.has_index?( :key ).should == true
+    @bucket.index( :key ).should_not == nil
+    @bucket.create_index( :duplicate_key, true )
+    @bucket.has_index?( :duplicate_key ).should == true
+    @bucket.index( :duplicate_key ).should_not == nil
+  end
+
+  #########################
+  #  permits_duplicates?  #
+  #########################
+
+  it 'can report whether an index permits duplicate entries' do
+    @bucket.index( :key ).permits_duplicates?.should == false
+    @bucket.index( :duplicate_key ).permits_duplicates?.should == true
+  end
+
+  ##################
+  #  index_object  #
+  ##################
+
+  it 'can index an object based on a created index so that the object ID can be retrieved by key' do
+    @bucket.index( :key ).index_object_id( @object.persistence_id, @object.value )
+    @bucket.index( :key ).get_object_id( @object.value ).should == @object.persistence_id
+  end
+
+  ###########
+  #  count  #
+  ###########
+  
+  it 'can report how many objects are persisted' do
+    
+    @bucket.index( :key ).count.should == 1
+    
+  end
+
+  ###################
+  #  get_object_id  #
+  ###################
+
+  it "can get the object ID corresponding to a key in a bucket" do
+  
+    # get_object_id_for_index_and_key
+    @bucket.index( :key ).get_object_id( @object.value ).should == @object.persistence_id
+
+  end
+
+  ################################
+  #  delete_keys_for_object_id!  #
+  ################################
+
+  it 'can delete index values for an object' do
+    @bucket.index( :key ).delete_keys_for_object_id!( @object.persistence_id )
+    ( @bucket.index( :key ).get_object_id( @object.value ) ? true : false ).should == false
+  end
+
+  ##################
+  #  delete_index  #
+  ##################
+
+  it 'can delete an index that has been created on a class attribute' do
+    @bucket.delete_index( :key )
+    @bucket.has_index?( :key ).should == false
+  end
+  
+end