persistence-adapter-flat_file 0.0.1

data/lib/persistence/adapter/flat_file/marshal.rb

@@ -0,0 +1,29 @@
+
+# We use the file-system for a storage port in place of a database
+#
+# Global ID Sequence:      <home_directory>/global_id_sequence.ruby_yaml.txt
+# Global IDs:              <home_directory>/global_ids/bucket/key_class/key/global_id.ruby_yaml.txt
+# Bucket/key/class:       <home_directory>/bucket_class/id.ruby_yaml.txt
+#  Objects:
+# Attributes:              <home_directory>/objects/bucket/id#/flat_properties/attribute.ruby_yaml.txt
+# Delete Cascades:         <home_directory>/objects/bucket/id#/delete_cascades.ruby_yaml.txt
+#
+# [  Indexes:                <home_directory>/indexes/index/soft_link_to_key_in_bucket ] - not yet implemented
+
+# FIX - when concerned with multi-threading, Files will need to be locked while attribute modifications occur
+#       (or otherwise virtually locked using corresponding lock files).
+# FIX - add :lock_non_atomic option and corresponding :release to declare modifications to a non-atomic object complete
+# FIX - add transactions
+
+class ::Persistence::Adapter::FlatFile::Marshal
+
+  include ::Persistence::Adapter::FlatFile::AdapterInterface
+
+  SerializationClass              =  ::Marshal
+  SerializationMethod             =  :dump
+  UnserializationMethod           =  :load
+  StringifyClassnames             =  false
+  FileContentsAreTextNotBinary    =  false
+  SerializationExtension          =  '.ruby_marshal.bin'
+
+end

data/lib/persistence/adapter/flat_file/path_helpers.rb

@@ -0,0 +1,63 @@
+
+module ::Persistence::Adapter::FlatFile::PathHelpers
+
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
+
+  ######################################
+  #  file__path_encoded_name_from_key  #
+  ######################################
+
+  def file__path_encoded_name_from_key( key )
+
+    serialized_key = adapter_class::SerializationClass.__send__( adapter_class::SerializationMethod, key )
+
+    return ::Base64.encode64( serialized_key )
+
+  end
+
+  ######################################
+  #  file__key_from_path_encoded_name  #
+  ######################################
+
+  def file__key_from_path_encoded_name( digest )
+
+    serialized_key = ::Base64.decode64( digest )
+    unserialized_key = adapter_class::SerializationClass.__send__( adapter_class::UnserializationMethod, serialized_key )
+
+    return unserialized_key
+
+  end
+
+  ##################################
+  #  ensure_directory_path_exists  #
+  ##################################
+
+  def ensure_directory_path_exists( file_path )
+    
+    unless ::File.exists?( file_path )
+
+      path_parts = File.expand_path( file_path ).split( '/' )
+      # get rid of the first empty part from '/'
+      path_parts.shift
+      part = 0
+
+      while part < path_parts.count
+
+        directory = '/' + File.join( *path_parts[ 0 .. part ] )
+        unless ::Dir.exist?( directory )
+          ::Dir.mkdir( directory )
+        end
+
+        part += 1
+
+      end
+
+    end
+    
+    return self
+  
+  end
+
+end

data/lib/persistence/adapter/flat_file/serialization.rb

@@ -0,0 +1,85 @@
+
+module ::Persistence::Adapter::FlatFile::Serialization
+
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
+
+  ################################################
+  #  create_or_update_value_serialize_and_write  #
+  ################################################
+
+  def create_or_update_value_serialize_and_write( file_path, value )
+
+    if value.is_a?( Class )
+      value = ::Persistence::Adapter::FlatFile::ClassName.new( value.to_s )
+    end
+
+    # open file, get data, perform action, rewrite data if appropriate, close file
+    mode = 'w' + ( adapter_class::FileContentsAreTextNotBinary ? 't' : 'b' )
+    File.open( file_path, mode ) do |file|
+      serialized_value = adapter_class::SerializationClass.__send__( adapter_class::SerializationMethod, value )
+      file.write( serialized_value )
+    end
+    
+    return self
+    
+  end
+  
+  #####################################
+  #  open_read_unserialize_and_close  #
+  #####################################
+
+  def open_read_unserialize_and_close( file_path )
+    
+    return open_read_unserialize_perform_action_serialize_write_and_close( file_path )
+  
+  end
+  
+  ####################################################################
+  #  open_read_unserialize_perform_action_serialize_write_and_close  #
+  ####################################################################
+
+  def open_read_unserialize_perform_action_serialize_write_and_close( file_path )
+
+    unserialized_value = nil
+
+    # if we don't have a file we obviously don't have a value - return nil
+    if File.exists?( file_path )
+
+      # open file, get data, perform action, rewrite data if appropriate, close file
+      mode = 'r+' + ( adapter_class::FileContentsAreTextNotBinary ? 't' : 'b' )
+      File.open( file_path, mode ) do |file|
+        
+        # get serializeled version of last persistence ID assigned
+        serialized_value    =  file.read( file.size )
+        if serialized_value
+          unserialized_value = adapter_class::SerializationClass.__send__( adapter_class::UnserializationMethod, serialized_value )
+        end
+        
+        if unserialized_value.is_a?( ::Persistence::Adapter::FlatFile::ClassName )
+          unserialized_value = unserialized_value.split( '::' ).inject( Object ) { |namespace, next_part| namespace.const_get( next_part ) }
+        end
+
+        # perform action if provided and write new data back
+        if block_given?
+
+          serialized_value = adapter_class::SerializationClass.__send__( adapter_class::SerializationMethod, yield( unserialized_value ) )
+          if serialized_value.is_a?( Class )
+            serialized_value = ::Persistence::Adapter::FlatFile::ClassName.new( serialized_value.to_s )
+          end
+          file.rewind
+          file.truncate( 0 )
+          file.write( serialized_value )
+
+        end
+
+      end
+
+    end
+    
+    return unserialized_value
+    
+  end
+
+end

data/lib/persistence/adapter/flat_file/yaml.rb

@@ -0,0 +1,31 @@
+
+# We use the file-system for a storage port in place of a database
+#
+# Global ID Sequence:      <home_directory>/global_id_sequence.ruby_yaml.txt
+# Global IDs:              <home_directory>/global_ids/bucket/key_class/key/global_id.ruby_yaml.txt
+# Bucket/key/class:       <home_directory>/bucket_class/id.ruby_yaml.txt
+#  Objects:
+# Attributes:              <home_directory>/objects/bucket/id#/flat_properties/attribute.ruby_yaml.txt
+# Delete Cascades:         <home_directory>/objects/bucket/id#/delete_cascades.ruby_yaml.txt
+#
+# [  Indexes:                <home_directory>/indexes/index/soft_link_to_key_in_bucket ] - not yet implemented
+
+# FIX - when concerned with multi-threading, Files will need to be locked while attribute modifications occur
+#       (or otherwise virtually locked using corresponding lock files).
+# FIX - add :lock_non_atomic option and corresponding :release to declare modifications to a non-atomic object complete
+# FIX - add transactions
+
+require 'yaml'
+
+class ::Persistence::Adapter::FlatFile::YAML
+
+  include ::Persistence::Adapter::FlatFile::YAML::AdapterInterface
+  
+  SerializationClass              =  ::YAML
+  SerializationMethod             =  :dump
+  UnserializationMethod           =  :load
+  StringifyClassnames             =  true
+  FileContentsAreTextNotBinary    =  true
+  SerializationExtension          =  '.yaml'
+
+end

data/lib/persistence/adapter/flat_file/yaml/adapter_Interface.rb

@@ -0,0 +1,21 @@
+
+module ::Persistence::Adapter::FlatFile::YAML::AdapterInterface
+
+  include ::Persistence::Adapter::FlatFile::AdapterInterface
+  
+  #############################
+  #  get_class_for_object_id  #
+  #############################
+
+  def get_class_for_object_id( global_id )
+    
+    klass_string = open_read_unserialize_and_close( file__class_for_id( global_id ) )
+
+    # for YAML - can't store anonymous Class, but sometimes we need to store "Class", so we store all class as string and get back
+    klass = klass_string.split( '::' ).inject( Object ) { |namespace, next_part| namespace.const_get( next_part ) }
+
+    return klass
+
+  end
+  
+end

data/lib/persistence/adapter/namespaces.rb

@@ -0,0 +1,15 @@
+
+module ::Persistence
+  module Adapter
+    class FlatFile
+      class Bucket
+        class Index
+        end
+      end
+      class Cursor
+      end
+      class YAML
+      end
+    end
+  end
+end

data/lib/persistence/adapter/requires.rb

@@ -0,0 +1,32 @@
+
+basepath = 'flat_file'
+
+files = [
+ 
+  'path_helpers',
+  'serialization',
+
+  'class_name',
+
+  'bucket/index/index_interface',
+  'bucket/index',
+
+  'bucket/bucket_interface',
+  'bucket',
+
+  'cursor/cursor_interface',
+  'cursor',
+
+  'adapter_interface',
+
+  'marshal',
+  'yaml/adapter_interface',
+  'yaml'
+  
+]
+
+files.each do |this_file|
+  require_relative( File.join( basepath, this_file ) + '.rb' )
+end
+
+require_relative( basepath + '.rb' )

data/spec/Persistence/Adapter/flat_file/cursor_spec.rb

@@ -0,0 +1,28 @@
+
+require_relative '../../../../lib/persistence/adapter/flat_file.rb'
+
+describe ::Persistence::Adapter::FlatFile::Cursor do
+
+  # we have to specify a serialization class; we use Marshal for our example
+  unless $__persistence__spec__development__initialized_flatfile
+    class ::Persistence::Adapter::FlatFile
+      SerializationClass    =  ::Marshal
+      SerializationMethod   =  :dump
+      UnserializationMethod =  :load
+      SerializationExtension = '.ruby_marshal.bin'
+      FileContentsAreTextNotBinary = false
+      StringifyClassnames = false
+    end
+    $__persistence__spec__development__initialized_flatfile = true
+  end
+
+  temp_test_path = "/tmp/persistence-adapter-flat_file"
+  
+  ::FileUtils.rm_rf( temp_test_path ) if ::Dir.exist?( temp_test_path )
+  
+  $__persistence__spec__adapter__ = ::Persistence::Adapter::FlatFile.new( temp_test_path )
+
+  # adapter spec
+  require_relative File.join( ::Persistence::Adapter::Abstract.spec_location, 'Cursor_spec.rb' )
+
+end

data/spec/Persistence/Adapter/flat_file_spec.rb

@@ -0,0 +1,28 @@
+
+require_relative '../../../lib/persistence/adapter/flat_file.rb'
+
+describe ::Persistence::Adapter::FlatFile do
+
+  # we have to specify a serialization class; we use Marshal for our example
+  unless $__persistence__spec__development__initialized_flatfile
+    class ::Persistence::Adapter::FlatFile
+      SerializationClass    =  ::Marshal
+      SerializationMethod   =  :dump
+      UnserializationMethod =  :load
+      SerializationExtension = '.ruby_marshal.bin'
+      FileContentsAreTextNotBinary = false
+      StringifyClassnames = false
+    end
+    $__persistence__spec__development__initialized_flatfile = true
+  end
+
+  temp_test_path = "/tmp/persistence-adapter-flat_file"
+  
+  ::FileUtils.rm_rf( temp_test_path ) if ::Dir.exist?( temp_test_path )
+  
+  $__persistence__spec__adapter__ = ::Persistence::Adapter::FlatFile.new( temp_test_path )
+
+  # adapter spec
+  require_relative File.join( ::Persistence::Adapter::Abstract.spec_location, 'Adapter_spec.rb' )
+
+end

data/spec/Persistence/Adapter/marshal/cursor_spec.rb

@@ -0,0 +1,15 @@
+
+require_relative '../../../../lib/persistence/adapter/flat_file.rb'
+
+describe ::Persistence::Adapter::FlatFile::Marshal do
+  
+  temp_test_path = "/tmp/persistence-adapter-flat_file"
+  
+  ::FileUtils.rm_rf( temp_test_path ) if ::Dir.exist?( temp_test_path )
+  
+  $__persistence__spec__adapter__ = ::Persistence::Adapter::FlatFile::Marshal.new( temp_test_path )
+
+  # adapter spec
+  require_relative File.join( ::Persistence::Adapter::Abstract.spec_location, 'Cursor_spec.rb' )
+  
+end

data/spec/Persistence/Adapter/marshal_spec.rb

@@ -0,0 +1,15 @@
+
+require_relative '../../../lib/persistence/adapter/flat_file.rb'
+
+describe ::Persistence::Adapter::FlatFile::Marshal do
+  
+  temp_test_path = "/tmp/persistence-adapter-flat_file"
+  
+  ::FileUtils.rm_rf( temp_test_path ) if ::Dir.exist?( temp_test_path )
+  
+  $__persistence__spec__adapter__ = ::Persistence::Adapter::FlatFile::Marshal.new( temp_test_path )
+
+  # adapter spec
+  require_relative File.join( ::Persistence::Adapter::Abstract.spec_location, 'Adapter_spec.rb' )
+  
+end

data/spec/Persistence/Adapter/yaml/cursor_spec.rb

@@ -0,0 +1,15 @@
+
+require_relative '../../../../lib/persistence/adapter/flat_file.rb'
+
+describe ::Persistence::Adapter::FlatFile::YAML do
+  
+  temp_test_path = "/tmp/persistence-adapter-flat_file"
+  
+  ::FileUtils.rm_rf( temp_test_path ) if ::Dir.exist?( temp_test_path )
+  
+  $__persistence__spec__adapter__ = ::Persistence::Adapter::FlatFile::YAML.new( temp_test_path )
+
+  # adapter spec
+  require_relative File.join( ::Persistence::Adapter::Abstract.spec_location, 'Cursor_spec.rb' )
+  
+end

data/spec/Persistence/Adapter/yaml_spec.rb

@@ -0,0 +1,15 @@
+
+require_relative '../../../lib/persistence/adapter/flat_file.rb'
+
+describe ::Persistence::Adapter::FlatFile::YAML do
+  
+  temp_test_path = "/tmp/persistence-adapter-flat_file"
+  
+  ::FileUtils.rm_rf( temp_test_path ) if ::Dir.exist?( temp_test_path )
+  
+  $__persistence__spec__adapter__ = ::Persistence::Adapter::FlatFile::YAML.new( temp_test_path )
+
+  # adapter spec
+  require_relative File.join( ::Persistence::Adapter::Abstract.spec_location, 'Adapter_spec.rb' )
+  
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: persistence-adapter-flat_file
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Asher
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: persistence
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Implements necessary methods to run Persistence on top of the file system
+  without a database.
+email: asher@ridiculouspower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/persistence/adapter/flat_file/adapter_interface.rb
+- lib/persistence/adapter/flat_file/bucket/bucket_interface.rb
+- lib/persistence/adapter/flat_file/bucket/index/index_interface.rb
+- lib/persistence/adapter/flat_file/bucket/index.rb
+- lib/persistence/adapter/flat_file/bucket.rb
+- lib/persistence/adapter/flat_file/class_name.rb
+- lib/persistence/adapter/flat_file/cursor/cursor_interface.rb
+- lib/persistence/adapter/flat_file/cursor.rb
+- lib/persistence/adapter/flat_file/marshal.rb
+- lib/persistence/adapter/flat_file/path_helpers.rb
+- lib/persistence/adapter/flat_file/serialization.rb
+- lib/persistence/adapter/flat_file/yaml/adapter_Interface.rb
+- lib/persistence/adapter/flat_file/yaml.rb
+- lib/persistence/adapter/flat_file.rb
+- lib/persistence/adapter/namespaces.rb
+- lib/persistence/adapter/requires.rb
+- spec/Persistence/Adapter/flat_file/cursor_spec.rb
+- spec/Persistence/Adapter/flat_file_spec.rb
+- spec/Persistence/Adapter/marshal/cursor_spec.rb
+- spec/Persistence/Adapter/marshal_spec.rb
+- spec/Persistence/Adapter/yaml/cursor_spec.rb
+- spec/Persistence/Adapter/yaml_spec.rb
+- README.md
+- CHANGELOG.rdoc
+homepage: http://rubygems.org/gems/persistence-adapter-flat_file
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: persistence-adapter-flat_file
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Adapter to use flat files as storage port for Persistence.
+test_files: []
+has_rdoc: