persistence 0.0.2 → 0.0.4

data/lib/persistence/object/flat/file/file_persistence.rb

@@ -42,22 +42,6 @@ module ::Persistence::Object::Flat::File::FilePersistence
   #
   attr_setting :persists_files_by_path? => :persist_files_by_path=
 
-  #####################################
-  #  persists_file_paths_as_objects?  #
-  #####################################
-
-  ###
-  #
-  # @method persists_file_paths_as_objects?
-  #
-  # Query whether File paths should be persisted as objects (rather than by strings).
-  #   Lookup chain is: File instance, File class, Persistence::Port::Bucket instance, Persistence::Port instance,
-  #   Persistence singleton.
-  #
-  # @return [true,false] Whether files should be persisted as objects rather than as strings.
-  #
-  attr_setting :persists_file_paths_as_objects? => :persist_file_paths_as_objects=
-
   #####################################
   #  persists_file_paths_as_strings?  #
   #####################################
@@ -72,7 +56,10 @@ module ::Persistence::Object::Flat::File::FilePersistence
   #
   # @return [true,false] Whether files should be persisted as strings rather than as objects.
   #
-  attr_setting :persists_file_paths_as_strings? => :persist_file_paths_as_strings=
+  attr_setting :persists_file_paths_as_strings? => :persists_file_paths_as_strings=
+
+  alias_method( :persist_file_paths_as_strings?, :persists_file_paths_as_strings? )
+  alias_method( :persist_file_paths_as_strings=, :persists_file_paths_as_strings= )
 
   ############################
   #  persist_files_by_path!  #
@@ -107,41 +94,5 @@ module ::Persistence::Object::Flat::File::FilePersistence
   end
 
   alias_method( :persists_files_by_content!, :persist_files_by_content! )
-
-  ####################################
-  #  persist_file_paths_as_objects!  #
-  ####################################
-
-  ###
-  # Declare that file paths should be persisted as objects (rather than strings).
-  #
-  def persist_file_paths_as_objects!
-
-    self.persist_file_paths_as_objects = true
-    self.persist_file_paths_as_strings = false
-
-    return self
-
-  end
-
-  alias_method( :persists_file_paths_as_objects!, :persist_file_paths_as_objects! )
-
-  ####################################
-  #  persist_file_paths_as_strings!  #
-  ####################################
-
-  ###
-  # Declare that file paths should be persisted as strings (rather than objects).
-  #
-  def persist_file_paths_as_strings!
-
-    self.persist_file_paths_as_strings = true
-    self.persist_file_paths_as_objects = false
-
-    return self
-
-  end
-    
-  alias_method( :persists_file_paths_as_strings!, :persist_file_paths_as_strings! )
   
 end

data/lib/persistence/object/flat/file/object_instance.rb

@@ -6,39 +6,36 @@ module ::Persistence::Object::Flat::File::ObjectInstance
 
   include ::Persistence::Object::Flat::File::FilePersistence
 
-  ##############
-  #  persist!  #
-  ##############
+  ##############################
+  #  persistence_hash_to_port  #
+  ##############################
+  
+  ###
+  # @private
+  #
+  # Generate hash representing object.
+  #
+  # @return [Hash] Hash representing information to reproduce object instance.
+  #
+  def persistence_hash_to_port
+
+    persistence_contents = nil
 
-  def persist!( *args )
-    
-    starting_pos = self.pos
-    
     # if we are persisting by file path
-    persistence_instance = nil
     if persists_files_by_path?
-      persistence_instance = ::Persistence::Object::Flat::File::Path.new( path )
+      persistence_contents = ::Persistence::Object::Flat::File::Path.new( path )
     # if we are persisting by file contents
     else
-      persistence_instance = ::Persistence::Object::Flat::File::Contents.new( self.readlines.join )
+      starting_pos = self.pos
+      persistence_contents = ::Persistence::Object::Flat::File::Contents.new( self.readlines.join )
+      # rewind file to wherever we started
+      self.pos = starting_pos
     end
 
-    persistence_instance.persistence_port   = persistence_port
-    persistence_instance.persistence_bucket = persistence_bucket
-    
-    # set new instance ID to current ID
-    persistence_instance.persistence_id = persistence_id
-    
-    persistence_instance.persist!( *args )
-
-    # if we got ID from persist! on our instance set our own ID to it
-    self.persistence_id = persistence_instance.persistence_id
+    primary_key = persistence_bucket.primary_key_for_attribute_name( self, self.class.to_s )
 
-    # rewind file to wherever we started
-    self.pos = starting_pos
+    return { primary_key => persistence_contents }
 
-    return self
-  
   end
 
   ################################
@@ -77,24 +74,6 @@ module ::Persistence::Object::Flat::File::ObjectInstance
     
   end
 
-  #####################################
-  #  persists_file_paths_as_objects?  #
-  #####################################
-
-  def persists_file_paths_as_objects?
-    
-    persists_file_paths_as_objects = nil
-    
-    persists_file_paths_as_objects = super
-    
-    if persists_file_paths_as_objects.nil?
-      persists_file_paths_as_objects = self.class.persists_file_paths_as_objects?
-    end
-    
-    return persists_file_paths_as_objects
-    
-  end
-
   #####################################
   #  persists_file_paths_as_strings?  #
   #####################################

data/lib/persistence/object/index.rb

@@ -75,7 +75,6 @@ module ::Persistence::Object::Index
   # @return [true,false] Whether index permits duplicates.
   #
   attr_setting :permits_duplicates?
-  
   self.permits_duplicates = false
 
   ###################

data/lib/persistence/object/index_hash.rb

@@ -32,7 +32,7 @@ module ::Persistence::Object::IndexHash
     end
     
     child_index_instance = index_instance.class.new( nil, parent_bucket, nil, nil, nil, index_instance )
-    
+
     return child_index_instance
     
   end

data/lib/persistence/object/object_instance.rb

@@ -4,7 +4,7 @@
 #
 module ::Persistence::Object::ObjectInstance
   
-  include ::Persistence::Object::ParsePersistenceArgs
+  include ::Persistence::Object::ParsePersistenceArgs::ObjectInstance
 
   include ::CascadingConfiguration::Setting
   include ::CascadingConfiguration::Hash
@@ -178,7 +178,7 @@ module ::Persistence::Object::ObjectInstance
   #
   def persist!( *args )
     
-    index_instance, key, no_key = parse_args_for_index_value_no_value( args, false )
+    index_instance, key, no_key = parse_object_args_for_index_value_no_value( args, false )
 
     # call super to ensure object is persisted
     unless persistence_port
@@ -196,7 +196,7 @@ module ::Persistence::Object::ObjectInstance
       end
 
       # and make sure we have an index that permits arbitrary keys
-      unless explicit_indexes[ index_instance.name ] == index_instance
+      unless self.class.explicit_indexes[ index_instance.name ] == index_instance
         raise ::Persistence::Exception::ExplicitIndexRequired,
               'Index ' + index_instance.name.to_s + ' was not declared as an explicit index '
               'and thus does not permit arbitrary keys.'
@@ -206,8 +206,8 @@ module ::Persistence::Object::ObjectInstance
       
     end
     
-    unless block_indexes.empty?
-      block_indexes.each do |this_index_name, this_block_index|
+    unless self.class.block_indexes.empty?
+      self.class.block_indexes.each do |this_index_name, this_block_index|
         this_block_index.index_object( self )
       end
     end
@@ -242,7 +242,7 @@ module ::Persistence::Object::ObjectInstance
   #
   def cease!
 
-    indexes.each do |this_index_name, this_index|
+    self.class.indexes.each do |this_index_name, this_index|
       this_index.delete_keys_for_object_id!( persistence_id )
     end
 
@@ -266,7 +266,7 @@ module ::Persistence::Object::ObjectInstance
   #
   # @return [CompositingHash{Symbol,String=>Persistence::Object::Index::ExplicitIndex}]
   #
-  attr_hash :explicit_indexes, ::Persistence::Object::IndexHash
+  attr_module_hash :explicit_indexes, ::Persistence::Object::IndexHash
   
   ###################
   #  block_indexes  #
@@ -280,7 +280,7 @@ module ::Persistence::Object::ObjectInstance
   #
   # @return [CompositingHash{Symbol,String=>Persistence::Object::Index::BlockIndex}]
   #
-  attr_hash :block_indexes, ::Persistence::Object::IndexHash
+  attr_module_hash :block_indexes, ::Persistence::Object::IndexHash
   
   #############
   #  indexes  #
@@ -294,16 +294,16 @@ module ::Persistence::Object::ObjectInstance
   #
   # @return [CompositingHash{Symbol,String=>Persistence::Object::Index}]
   #
-  attr_hash :indexes do
+  attr_module_hash :indexes do
     
     #======================#
     #  child_pre_set_hook  #
     #======================#
     
     def child_pre_set_hook( index_name, index_instance )
-      
+
       child_instance = nil
-      
+
       case index_instance
         when ::Persistence::Object::Index::ExplicitIndex
           child_instance = configuration_instance.explicit_indexes[ index_name ]

data/lib/persistence/object/parse_persistence_args.rb

@@ -4,115 +4,9 @@
 #
 # Internal helper for parsing args of the format: method, method( global_id ), method( index_name, value ),
 #   method( index_instance, value ), method( index_name => value ), method( index_instance => value ).
+#
 module ::Persistence::Object::ParsePersistenceArgs
 
-  #########################################
-  #  parse_args_for_index_value_no_value  #
-  #########################################
-  
-  ###
-  # Parse *args for index, key_value, no_value.
-  #
-  # @param args [Array] An array of args of the format: method, method( global_id ), method( index_name, value ),
-  #   method( index_instance, value ), method( index_name => value ), method( index_instance => value ).
-  #
-  # @param require_value [true,false] Whether key value must be provided; will throw exception if true and
-  #   key value is not provided.
-  #
-  # @return [Array] Array containing index instance, key value, whether key value was provided.
-  #
-  def parse_args_for_index_value_no_value( args, require_value = false )
-    
-    # * nil
-    #   - Cursor to primary bucket
-    # * :index
-    #   - Cursor to index
-    # * :index => persistence_key
-    #   - Object(s) for indexed key value
-    
-    index = nil
-    key_value = nil
-    no_value = nil
-    case args.count
-
-      when 0
-
-        no_value = true
-        if require_value
-          raise ::Persistence::Exception::KeyValueRequired, 
-                'Key value required.'
-        end
-
-      when 1
-
-        index_or_id = args[ 0 ]
-        if index_or_id.is_a?( Symbol ) or
-           index_or_id.is_a?( String )
-
-           index = indexes[ index_or_id ]
-           unless index
-             raise ::Persistence::Exception::ExplicitIndexRequired,
-                   'Explicit index ' + index_or_id.to_s + ' did not exist.'
-           end
-           no_value = true
-        
-        elsif index_or_id.respond_to?( :index_object )
-          
-          index = index_or_id
-          no_value = true
-          
-        elsif index_or_id.is_a?( Hash )
-        
-          key_value = index_or_id.values[ 0 ]
-          index_name = index_or_id.keys[ 0 ]
-          if index_name.is_a?( Symbol ) or
-             index_name.is_a?( String )
-             
-            index = indexes[ index_name ]
-            unless index
-              raise ::Persistence::Exception::ExplicitIndexRequired,
-                    'Explicit index :' + index_name.to_s + ' did not exist.'
-            end
-
-          end
-          no_value = false
-
-        else
-
-          # persistence_id - anything other than Symbol, String, Hash
-          key_value = args[ 0 ]
-          no_value = false
-          
-        end
-        
-      when 2
-
-        index_or_name = args[ 0 ]
-
-        index = index_or_name.respond_to?( :index_object ) ? index_or_name : indexes[ index_or_name ]
-        key_value = args[ 1 ]
-
-        if ! index and ! key_value
-          raise ::Persistence::Exception::ExplicitIndexRequired,
-                'Index ' + index_or_name.to_s + ' did not exist.'
-        end
-        no_value = false
-
-      else
-
-        raise 'Unexpected arguments ' + args.inspect + '.'
-
-    end
-    
-    # if we have a file we need to persist it like we would a sub-object
-    if key_value.is_a?( File )
-      key_value = process_file_key( key_value )
-    end
-    
-    return index, key_value, no_value
-    
-  end
-
   ######################
   #  process_file_key  #
   ######################
@@ -130,7 +24,7 @@ module ::Persistence::Object::ParsePersistenceArgs
 
     processed_key = nil
     
-    if persists_files_by_path?
+    if file_key.persists_files_by_path?
       processed_key = ::Persistence::Object::Flat::File::Path.new( file_key.path )
     else
       starting_pos  = file_key.pos

data/lib/persistence/object/parse_persistence_args/class_instance.rb

@@ -0,0 +1,124 @@
+
+###
+# @private
+#
+# Class-specific implementation for parsing persistence args.
+#
+# Internal helper for parsing args of the format: method, method( global_id ), method( index_name, value ),
+#   method( index_instance, value ), method( index_name => value ), method( index_instance => value ).
+#
+module ::Persistence::Object::ParsePersistenceArgs::ClassInstance
+
+  include ::Persistence::Object::ParsePersistenceArgs
+
+  ###############################################
+  #  parse_class_args_for_index_value_no_value  #
+  ###############################################
+  
+  ###
+  # Parse *args for index, key_value, no_value.
+  #
+  # @param args [Array] An array of args of the format: method, method( global_id ), method( index_name, value ),
+  #   method( index_instance, value ), method( index_name => value ), method( index_instance => value ).
+  #
+  # @param require_value [true,false] Whether key value must be provided; will throw exception if true and
+  #   key value is not provided.
+  #
+  # @return [Array] Array containing index instance, key value, whether key value was provided.
+  #
+  def parse_class_args_for_index_value_no_value( args, require_value = false )
+    
+    # * nil
+    #   - Cursor to primary bucket
+    # * :index
+    #   - Cursor to index
+    # * :index => persistence_key
+    #   - Object(s) for indexed key value
+    
+    index = nil
+    key_value = nil
+    no_value = nil
+    case args.count
+
+      when 0
+
+        no_value = true
+        if require_value
+          raise ::Persistence::Exception::KeyValueRequired, 
+                'Key value required.'
+        end
+
+      when 1
+
+        index_or_id = args[ 0 ]
+
+        case index_or_id
+
+          when ::Symbol, ::String
+
+            index = index( index_or_id, true )
+            no_value = true
+
+          when ::Hash
+
+            key_value = index_or_id.values[ 0 ]
+            index_name = index_or_id.keys[ 0 ]
+
+            case index_name
+
+              when ::Symbol, ::String
+
+                index = index( index_name, true )
+
+            end
+
+            no_value = false
+          
+          else
+
+            if index_or_id.respond_to?( :index_object )
+
+              index = index_or_id
+              no_value = true
+            
+            else
+
+              # persistence_id - anything other than Symbol, String, Hash
+              key_value = args[ 0 ]
+              no_value = false
+
+            end
+          
+        end
+        
+      when 2
+
+        index_or_name = args[ 0 ]
+
+        
+        if index_or_name.respond_to?( :index_object )
+          index = index_or_name
+        elsif index_or_name
+          index = index( index_or_name, true )
+        end
+        
+        key_value = args[ 1 ]
+
+        no_value = false
+
+      else
+
+        raise 'Unexpected arguments ' << args.inspect + '.'
+
+    end
+    
+    # if we have a file we need to persist it like we would a sub-object
+    if key_value.is_a?( ::File )
+      key_value = process_file_key( key_value )
+    end
+    
+    return index, key_value, no_value
+    
+  end
+
+end