persistence 0.0.1.alpha → 0.0.1

data/lib/persistence/object/flat.rb

@@ -0,0 +1,17 @@
+
+###
+# Convenience module for extending flat object types (singletons and instances) with persistence capabilities.
+#   Flat object types include: Bignum, Fixnum, Complex, Rational, TrueClass, FalseClass, 
+#                              String, Symbol, Regexp, File, NilClass.
+#
+module ::Persistence::Object::Flat
+  
+  extend ModuleCluster::Define::ClusterCascades
+  
+  include ::Persistence::Object::ObjectInstance
+  include_or_extend_cascades_prepend_extends ::Persistence::Object::ClassInstance
+  
+  include ::Persistence::Object::Flat::ObjectInstance
+  include_or_extend_cascades_prepend_extends ::Persistence::Object::Flat::ClassInstance
+
+end

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

@@ -0,0 +1,34 @@
+
+###
+# Class methods for flat objects enabled with persistence capabilities.
+#
+module ::Persistence::Object::Flat::ClassInstance
+
+  #############
+  #  persist  #
+  #############
+  
+  def persist( *args )
+
+    persistence_value = nil
+
+    index_instance, key, no_key = parse_args_for_index_value_no_value( args )
+
+    # if no key, open a cursor for a list
+    if no_key
+
+      persistence_value = ::Persistence::Cursor.new( instance_persistence_bucket, index_instance )
+
+    else
+
+      global_id = index_instance ? index_instance.get_object_id( key ) : key
+      
+      persistence_value = instance_persistence_port.get_flat_object( global_id )
+
+    end
+    
+    return persistence_value
+
+  end
+
+end

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

@@ -0,0 +1,14 @@
+
+###
+# Convenience module for extending File with persistence capabilities.
+#
+module ::Persistence::Object::Flat::File
+
+  extend ModuleCluster::Define::ClusterCascades
+  
+  include ::Persistence::Object::Flat
+  
+  include ::Persistence::Object::Flat::File::ObjectInstance
+  include_or_extend_cascades_prepend_extends ::Persistence::Object::Flat::File::ClassInstance
+    
+end

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

@@ -0,0 +1,122 @@
+
+###
+# Class methods for File objects enabled with persistence capabilities.
+#
+module ::Persistence::Object::Flat::File::ClassInstance
+
+  include ::Persistence::Object::Flat::File::FilePersistence
+  
+  #############
+  #  persist  #
+  #############
+  
+  def persist( *args )
+
+    persistence_value = super
+
+    if persists_file_paths_as_objects?  and 
+       persistence_value.is_a?( ::Persistence::Object::Flat::File::Path )
+
+      persistence_value = File.open( persistence_value, 
+                                     persistence_value.mode || 'r' )
+
+    end
+    
+    return persistence_value
+
+  end
+
+  ################################
+  #  persists_files_by_content?  #
+  ################################
+
+  def persists_files_by_content?
+    
+    persists_files_by_content = nil
+    
+    persists_files_by_content = super
+    
+    if persists_files_by_content.nil?
+      persists_files_by_content = instance_persistence_bucket.persists_files_by_content?
+    end
+    
+    return persists_files_by_content
+    
+  end
+
+  #############################
+  #  persists_files_by_path?  #
+  #############################
+
+  ###
+  # Query whether File instances should be persisted by path (rather than by content).
+  #   Lookup chain is: File instance, File class, Persistence::Port::Bucket instance, Persistence::Port instance,
+  #   Persistence singleton.
+  #
+  # @return [true,false] Whether files should be persisted by path rather than by content.
+  #
+  def persists_files_by_path?
+    
+    persists_files_by_path = nil
+    
+    persists_files_by_path = super
+    
+    if persists_files_by_path.nil?
+      persists_files_by_path = instance_persistence_bucket.persists_files_by_path?
+    end
+    
+    return persists_files_by_path
+    
+  end
+
+  #####################################
+  #  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.
+  #
+  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 = instance_persistence_bucket.persists_file_paths_as_objects?
+    end
+    
+    return persists_file_paths_as_objects
+    
+  end
+
+  #####################################
+  #  persists_file_paths_as_strings?  #
+  #####################################
+
+  ###
+  # Query whether File paths should be persisted as strings (rather than by objects).
+  #   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 strings rather than as objects.
+  #
+  def persists_file_paths_as_strings?
+    
+    persists_file_paths_as_strings = nil
+    
+    persists_file_paths_as_strings = super
+    
+    if persists_file_paths_as_strings.nil?
+      persists_file_paths_as_strings = instance_persistence_bucket.persists_file_paths_as_strings?
+    end
+    
+    return persists_file_paths_as_strings
+    
+  end
+
+end

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

@@ -0,0 +1,7 @@
+
+###
+# Subclass of {::String} used for persisting file contents.
+#
+class ::Persistence::Object::Flat::File::Contents < ::String
+  
+end

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

@@ -0,0 +1,147 @@
+
+###
+# Common module used for look-up chain for file persistence configuration.
+#   Lookup chain is: File instance, File class, Persistence::Port::Bucket instance, Persistence::Port instance,
+#   Persistence singleton.
+#
+module ::Persistence::Object::Flat::File::FilePersistence
+
+  include ::CascadingConfiguration::Setting
+  
+  extend self
+
+  ################################
+  #  persists_files_by_content?  #
+  ################################
+
+  ###
+  #
+  # @method persists_files_by_content?
+  #
+  # Query whether File instances should be persisted by content (rather than by path).
+  #   Lookup chain is: File instance, File class, Persistence::Port::Bucket instance, Persistence::Port instance,
+  #   Persistence singleton.
+  #
+  # @return [true,false] Whether files should be persisted by content rather than by path.
+  #
+  attr_setting :persists_files_by_content? => :persist_files_by_content=
+  
+  #############################
+  #  persists_files_by_path?  #
+  #############################
+
+  ###
+  #
+  # @method persists_files_by_path?
+  #
+  # Query whether File instances should be persisted by path (rather than by content).
+  #   Lookup chain is: File instance, File class, Persistence::Port::Bucket instance, Persistence::Port instance,
+  #   Persistence singleton.
+  #
+  # @return [true,false] Whether files should be persisted by path rather than by content.
+  #
+  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?  #
+  #####################################
+
+  ###
+  #
+  # @method persists_file_paths_as_strings?
+  #
+  # Query whether File paths should be persisted as strings (rather than by objects).
+  #   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 strings rather than as objects.
+  #
+  attr_setting :persists_file_paths_as_strings? => :persist_file_paths_as_strings=
+
+  ############################
+  #  persist_files_by_path!  #
+  ############################
+  
+  ###
+  # Declare that files should be persisted by path (rather than by contents).
+  #
+  def persist_files_by_path!
+    
+    self.persist_files_by_path = true
+    self.persist_files_by_content = false
+
+    return self
+
+  end
+  
+  ###############################
+  #  persist_files_by_content!  #
+  ###############################
+
+  ###
+  # Declare that files should be persisted by contents (rather than by path).
+  #
+  def persist_files_by_content!
+
+    self.persist_files_by_content = true
+    self.persist_files_by_path = false
+
+    return self
+
+  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

@@ -0,0 +1,116 @@
+
+###
+# Instance methods for File objects enabled with persistence capabilities.
+#
+module ::Persistence::Object::Flat::File::ObjectInstance
+
+  include ::Persistence::Object::Flat::File::FilePersistence
+
+  ##############
+  #  persist!  #
+  ##############
+
+  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 )
+    # if we are persisting by file contents
+    else
+      persistence_instance = ::Persistence::Object::Flat::File::Contents.new( self.readlines.join )
+    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
+
+    # rewind file to wherever we started
+    self.pos = starting_pos
+
+    return self
+  
+  end
+
+  ################################
+  #  persists_files_by_content?  #
+  ################################
+
+  def persists_files_by_content?
+    
+    persists_files_by_content = nil
+    
+    persists_files_by_content = super
+    
+    if persists_files_by_content.nil?
+      persists_files_by_content = self.class.persists_files_by_content?
+    end
+    
+    return persists_files_by_content
+    
+  end
+
+  #############################
+  #  persists_files_by_path?  #
+  #############################
+
+  def persists_files_by_path?
+    
+    persists_files_by_path = nil
+    
+    persists_files_by_path = super
+    
+    if persists_files_by_path.nil?
+      persists_files_by_path = self.class.persists_files_by_path?
+    end
+    
+    return persists_files_by_path
+    
+  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?  #
+  #####################################
+
+  def persists_file_paths_as_strings?
+    
+    persists_file_paths_as_strings = nil
+    
+    persists_file_paths_as_strings = super
+    
+    if persists_file_paths_as_strings.nil?
+      persists_file_paths_as_strings = self.class.persists_file_paths_as_strings?
+    end
+    
+    return persists_file_paths_as_strings
+    
+  end
+
+end