persistence 0.0.1.alpha → 0.0.1

data/lib/persistence/adapter/mock/bucket/index.rb

@@ -0,0 +1,9 @@
+
+###
+# Index class for Mock adapter. Interface implementation provided in module so methods can be easily overridden.
+#
+class ::Persistence::Adapter::Mock::Bucket::Index
+
+  include ::Persistence::Adapter::Mock::Bucket::Index::IndexInterface
+  
+end

data/lib/persistence/adapter/mock/bucket/index/index_interface.rb

@@ -0,0 +1,155 @@
+
+###
+# Interface implementation for Index class instances.
+#
+module ::Persistence::Adapter::Mock::Bucket::Index::IndexInterface
+
+  ################
+  #  initialize  #
+  ################
+  
+  ###
+  # 
+  # @param index_name 
+  # @param parent_bucket 
+  # @param permits_duplicates 
+  #
+  def initialize( index_name, parent_bucket, permits_duplicates )
+
+    @name = index_name
+
+    @keys = { }
+    @reverse_keys = { }
+    @permits_duplicates = permits_duplicates
+    @parent_bucket = parent_bucket
+
+  end
+
+  ###################
+  #  parent_bucket  #
+  ###################
+  
+  ###
+  # Track parent bucket for this index.
+  #
+  # @!attribute[r]
+  #
+  # @return [Persistence::Adapter::Mock::Bucket] Parent bucket instance.
+  #
+  attr_accessor :parent_bucket
+
+  ############
+  #  cursor  #
+  ############
+
+  ###
+  # Create and return cursor instance for this index.
+  #
+  # @return [Persistence::Adapter::Mock::Cursor] New cursor instance.
+  #
+  def cursor
+    
+    return ::Persistence::Adapter::Mock::Cursor.new( @parent_bucket, self )
+
+  end
+
+  ###########
+  #  count  #
+  ###########
+  
+  ###
+  # Get the number of indexed objects in this index.
+  #
+  # @return [Integer] Number of indexed objects in this index.
+  #
+  def count
+    
+    return @keys.count
+    
+  end
+  
+  #########################
+  #  permits_duplicates?  #
+  #########################
+
+  ###
+  # Reports whether this index permits duplicate indexed entries per key.
+  #
+  # @return [true,false] Whether index permits duplicate entries.
+  #
+  def permits_duplicates?
+    
+    return @permits_duplicates
+
+  end
+
+  #####################
+  #  index_object_id  #
+  #####################
+
+  ###
+  # Index object ID for index key.
+  #
+  # @param global_id Object persistence ID for object lookup.
+  # @param key Key to index for later lookup of object ID in index.
+  #
+  # @return self
+  #
+  def index_object_id( global_id, key )
+
+    @keys[ key ] = global_id
+    @reverse_keys[ global_id ] = key
+    
+    return self
+
+  end
+
+  ###################
+  #  get_object_id  #
+  ###################
+
+  ###
+  # Retrieve indexed object ID for index key.
+  #
+  # @param key Previously indexed key for lookup in index.
+  #
+  # @return 
+  #
+  def get_object_id( key )
+
+    return @keys[ key ]
+  
+  end
+
+  ################################
+  #  delete_keys_for_object_id!  #
+  ################################
+
+  ###
+  # Delete all keys in this index for object ID.
+  #
+  # @param global_id Object persistence ID for object lookup.
+  #
+  # @return self
+  #
+  def delete_keys_for_object_id!( global_id )
+    
+    index_value_or_keys = @reverse_keys.delete( global_id )
+
+    if index_value_or_keys.is_a?( Array )
+
+      index_value_or_keys.each do |this_key|
+        @keys.delete( this_key )
+      end
+
+    else
+
+      @keys.delete( index_value_or_keys )
+
+    end
+    
+    return self
+    
+  end
+
+end

data/lib/persistence/adapter/mock/cursor.rb

@@ -0,0 +1,9 @@
+
+###
+# Cursor class for Mock adapter. Interface implementation provided in module so methods can be easily overridden.
+#
+class ::Persistence::Adapter::Mock::Cursor
+
+  include ::Persistence::Adapter::Mock::Cursor::CursorInterface
+  
+end

data/lib/persistence/adapter/mock/cursor/cursor_interface.rb

@@ -0,0 +1,238 @@
+
+###
+# Interface implementation for Mock adapter Cursor class instances.
+#
+module ::Persistence::Adapter::Mock::Cursor::CursorInterface
+
+  ################
+  #  initialize  #
+  ################
+
+  ###
+  # 
+  # @param bucket Cursor will open on bucket instance.
+  # @param index Cursor will open on index instance.
+  #
+  def initialize( bucket, index )
+
+    @persistence_bucket = bucket
+    @index = index
+
+    @id_source = index  ? index.instance_variable_get( :@keys )
+                        : bucket.instance_variable_get( :@objects )
+    
+    @current_position = ( @id_source || { } ).each
+
+  end
+  
+  ############################
+  #  supports_bucket_order?  #
+  ############################
+  
+  def supports_bucket_order?
+    
+    return true
+    
+  end
+
+  ###########################
+  #  supports_index_order?  #
+  ###########################
+
+  def supports_index_order?
+    
+    return true
+
+  end
+  
+  ###########
+  #  close  #
+  ###########
+  
+  ###
+  # Declare use of cursor complete.
+  #
+  def close
+    
+    # nothing required
+
+  end
+  
+  ################
+  #  persisted?  #
+  ################
+  
+  ###
+  # Query whether keys are persisted in cursor's current context.
+  #   Responsible for setting the cursor position.
+  #
+  # @overload persisted?( key, ... )
+  #
+  #   @param [Object] Key to look up.
+  #
+  # @return [true,false] Whether key(s) exist in cursor's current context.
+  #
+  def persisted?( *args )
+
+    # persisted? is responsible for setting the cursor position
+
+    key = nil
+    # we expect 0 or 1 arg
+    if args.count > 0
+      key = args[ 0 ]
+    else
+      # if we have no key we are asking if keys exist
+      @current_position.rewind
+
+      return @id_source.count > 0 ? true : false
+    end
+
+    has_key = false
+
+    # rewind to beginning of bucket
+    @current_position.rewind
+
+    # iterate until we find our key
+    begin
+      
+      while @current_item = @current_position.next
+        if @current_item[ 0 ] == key
+          has_key = true
+          break
+        end
+      end
+      
+    rescue StopIteration
+
+      @current_item = nil
+
+    end
+
+    return has_key
+
+  end
+
+  ###########
+  #  first  #
+  ###########
+  
+  ###
+  # Return the first object in cursor's current context.
+  #   Responsible for setting the cursor position.
+  #
+  # @return [Object] First object in cursor's current context.
+  #
+  def first
+
+    # first should set the cursor position and return the first ID or object hash
+
+    begin
+      @current_item = @current_position.rewind.peek
+    rescue StopIteration
+      @current_item = nil
+    end
+
+    return current
+
+  end
+
+  ###############
+  #  first_key  #
+  ###############
+  
+  ###
+  # Return the first key in cursor's current context.
+  #   Responsible for setting the cursor position.
+  #
+  # @return [Object] First key in cursor's current context.
+  #
+  def first_key
+    begin
+      @current_item = @current_position.rewind.peek
+    rescue StopIteration
+      @current_item = nil
+    end
+    return current_key
+  end
+
+  #############
+  #  current  #
+  #############
+
+  ###
+  # Return the current object in cursor's current context.
+  #
+  # @return [Object] Current object in cursor's current context.
+  #  
+  def current
+
+    # current should return the current ID or object hash
+
+    current_id = nil
+
+    if @current_item
+      if @index
+        current_id = @current_item[ 1 ]
+      else
+        current_id = @current_item[ 0 ]
+      end
+    end
+
+    return current_id
+
+  end
+
+  #################
+  #  current_key  #
+  #################
+  
+  ###
+  # Return the current key in cursor's current context.
+  #
+  # @return [Object] Current object in cursor's current context.
+  #  
+  def current_key
+    current_key = nil
+    if @current_item
+      current_key = @current_item[ 0 ]
+    end
+    return current_key
+  end
+
+  ##########
+  #  next  #
+  ##########
+  
+  ###
+  # Return the next object in cursor's current context.
+  #
+  # @return [Object] Next object in cursor's current context.
+  #  
+  def next
+    begin
+      @current_item = @current_position.next
+    rescue StopIteration
+      @current_item = nil
+    end
+    return current
+  end
+
+  ##############
+  #  next_key  #
+  ##############
+  
+  ###
+  # Return the next key in cursor's current context.
+  #
+  # @return [Object] Next key in cursor's current context.
+  #  
+  def next_key
+    begin
+      @current_item = @current_position.next
+    rescue StopIteration
+      @current_item = nil
+    end
+    return current_key
+  end
+
+end

data/lib/persistence/cursor.rb

@@ -0,0 +1,11 @@
+
+###
+# Cursor class. Interface implementation provided in module so methods can be easily overridden.
+#
+class ::Persistence::Cursor
+  
+  include ::Enumerable
+
+  include ::Persistence::Cursor::CursorInterface
+  
+end

data/lib/persistence/cursor/atomic.rb

@@ -0,0 +1,110 @@
+
+###
+# Cursor subclass that automatically performs atomic lookups on attributes. 
+#
+module ::Persistence::Cursor::Atomic
+
+  ################
+  #  get_object  #
+  ################
+
+  ###
+  # Get object for persistence ID using atomic attribute loading, regardless how attributes are declared.
+  #
+  # @param global_id Persistence ID to retrieve object.
+  #
+  # @return [Object] Object being retrieved for persistence ID.
+  #
+  def get_object( global_id )
+    
+    klass = @persistence_bucket.parent_port.get_class_for_object_id( global_id )
+    
+    object = nil
+    
+    if klass
+      object = klass.new
+      object.persistence_id = global_id
+      object.attrs_atomic!
+    end
+    
+    return object
+
+  end
+
+  #############
+  #  persist  #
+  #############
+
+  ###
+  # Load object with specified persistence ID.
+  #
+  # @param key Key to retrieve.
+  #
+  # @return [Object] Object for persistence ID.
+  #
+  def persist( key )
+    
+    return super.attrs_atomic!
+
+  end
+
+  ###########
+  #  first  #
+  ###########
+  
+  ###
+  # Persist first object in cursor context.
+  #
+  # @param [Integer] count How many objects to persist from start of cursor context.
+  #
+  # @return [Object,Array<Object>] Object or objects requested.
+  #
+  def first( count = 1 )
+    first_values = super
+    if first_values.is_a?( Array )
+      first_values.each do |this_value|
+        this_value.attrs_atomic!
+      end
+    elsif first_values
+      first_values.attrs_atomic!
+    end
+    return first_values
+  end
+
+  #############
+  #  current  #
+  #############
+  
+  ###
+  # Persist current object in cursor context.
+  #
+  # @return [Object,Array<Object>] Object requested.
+  #
+  def current
+    current_value = super
+    current_value.attrs_atomic! if current_value
+    return current_value
+  end
+
+  ##########
+  #  next  #
+  ##########
+  
+  ###
+  # Return the next object in cursor's current context.
+  #
+  # @return [Object] Next object in cursor's current context.
+  #  
+  def next( count = 1 )
+    next_values = super
+    if next_values.is_a?( Array )
+      next_values.each do |this_value|
+        this_value.attrs_atomic!
+      end
+    elsif next_values
+      next_values.attrs_atomic!
+    end
+    return next_values
+  end
+
+end