persistence-adapter-kyotocabinet 0.0.1

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

@@ -0,0 +1,6 @@
+
+class ::Persistence::Adapter::KyotoCabinet::Bucket::Index
+
+  include ::Persistence::Adapter::KyotoCabinet::Bucket::Index::IndexInterface
+
+end

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

@@ -0,0 +1,165 @@
+
+
+module ::Persistence::Adapter::KyotoCabinet::Bucket::Index::IndexInterface
+
+  include ::Persistence::Adapter::KyotoCabinet::DatabaseSupport
+
+  ################
+  #  initialize  #
+  ################
+
+  def initialize( index_name, parent_bucket, permits_duplicates )
+
+    @name = index_name
+
+    @parent_bucket = parent_bucket
+
+    @permits_duplicates = permits_duplicates
+
+    # get path info for index databases
+    bucket_name    = @bucket_name
+
+    @database__index = ::KyotoCabinet::DB.new
+    @database__index.open( file__index_database( bucket_name, index_name ), 
+                           parent_bucket.parent_adapter.class::DatabaseFlags )
+
+    @database__reverse_index = ::KyotoCabinet::DB.new
+    @database__reverse_index.open( file__reverse_index_database( bucket_name, index_name ), 
+                                   parent_bucket.parent_adapter.class::DatabaseFlags )
+
+  end
+
+  ###########
+  #  count  #
+  ###########
+  
+  def count
+    
+    return @database__index.count
+    
+  end
+
+  ###########
+  #  close  #
+  ###########
+  
+  def close
+    
+    @database__index.close
+    @database__reverse_index.close
+
+  end
+  
+  ############
+  #  delete  #
+  ############
+  
+  def delete
+    
+    # remove reverse index
+    File.delete( @database__reverse_index.path )
+
+    # remove index
+    File.delete( @database__index.path )
+    
+  end
+  
+  ############
+  #  cursor  #
+  ############
+
+  def cursor
+
+    return ::Persistence::Adapter::KyotoCabinet::Cursor.new( @parent_bucket, self, @database__index.cursor )
+
+  end
+
+  #########################
+  #  permits_duplicates?  #
+  #########################
+  
+  def permits_duplicates?
+
+    return @permits_duplicates
+
+  end
+
+  ###################
+  #  get_object_id  #
+  ###################
+
+  def get_object_id( key )
+
+    serialized_index_key = @parent_bucket.parent_adapter.class::SerializationClass.__send__( @parent_bucket.parent_adapter.class::SerializationMethod, key )
+
+    global_id = @database__index.get( serialized_index_key )
+    
+    return global_id ? global_id.to_i : nil
+
+  end
+  
+  #####################
+  #  index_object_id  #
+  #####################
+
+  def index_object_id( global_id, key )
+
+    serialized_index_key = @parent_bucket.parent_adapter.class::SerializationClass.__send__( @parent_bucket.parent_adapter.class::SerializationMethod, key )
+
+    # we point to object.persistence_id rather than primary key because the object.persistence_id is the object header
+    @database__index.set( serialized_index_key, global_id )
+    @database__reverse_index.set( global_id, serialized_index_key )
+
+  end
+
+  ################################
+  #  delete_keys_for_object_id!  #
+  ################################
+
+  def delete_keys_for_object_id!( global_id )
+
+    serialized_key = @database__reverse_index.get( global_id )
+    @database__reverse_index.remove( global_id )
+    @database__index.remove( serialized_key )    
+
+  end
+
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
+
+  ##########################
+  #  file__index_database  #
+  ##########################
+
+  def file__index_database( bucket_name, index_name )
+
+    index_file_name = bucket_name.to_s + '__index_' + index_name.to_s + '__' + extension__bucket_index_database
+
+    return File.join( @parent_bucket.parent_adapter.home_directory, index_file_name )
+
+  end
+
+  ##################################
+  #  file__reverse_index_database  #
+  ##################################
+
+  def file__reverse_index_database( bucket_name, index_name )
+    
+    index_file_name = bucket_name.to_s + '__reverse_index_' + index_name.to_s + '__' + extension__bucket_index_database
+    
+    return File.join( @parent_bucket.parent_adapter.home_directory, index_file_name )
+
+  end
+
+  ######################################
+  #  extension__bucket_index_database  #
+  ######################################
+
+  def extension__bucket_index_database
+    
+    return extension__database( :tree )
+
+  end
+
+end

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

@@ -0,0 +1,6 @@
+
+class ::Persistence::Adapter::KyotoCabinet::Cursor
+
+  include ::Persistence::Adapter::KyotoCabinet::Cursor::CursorInterface
+    
+end

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

@@ -0,0 +1,163 @@
+
+module ::Persistence::Adapter::KyotoCabinet::Cursor::CursorInterface
+
+  ################
+  #  initialize  #
+  ################
+
+  def initialize( parent_bucket, parent_index, cursor_instance )
+
+    @parent_bucket = parent_bucket
+    @parent_index = parent_index
+
+    @cursor_instance = cursor_instance
+    
+  end
+  
+  ############################
+  #  supports_bucket_order?  #
+  ############################
+  
+  def supports_bucket_order?
+    
+    return true
+    
+  end
+
+  ###########################
+  #  supports_index_order?  #
+  ###########################
+
+  def supports_index_order?
+    
+    return true
+
+  end
+  
+  ###########
+  #  close  #
+  ###########
+  
+  def close
+    
+    @cursor_instance.disable
+
+  end
+  
+  ################
+  #  persisted?  #
+  ################
+
+  # persisted? is responsible for setting the cursor position
+  def persisted?( *args )
+
+    has_key = false
+    no_key  = false
+    key = nil
+    case args.count
+    when 1
+      key = args[0]
+    when 0
+      no_key = true
+    end
+
+    # if we have no args we are asking whether any keys exist
+    if no_key
+      
+      has_key = true unless ( @parent_index || @parent_bucket ).count == 0
+      
+    else
+      
+      serialized_key = nil
+      if @parent_index
+        serialized_key = @parent_bucket.parent_adapter.class::SerializationClass.__send__( @parent_bucket.parent_adapter.class::SerializationMethod, key )
+      else
+        serialized_key = key
+      end
+
+      has_key = @cursor_instance.jump( serialized_key )
+
+    end
+    
+    return has_key
+
+  end
+
+  ###########
+  #  first  #
+  ###########
+  
+  # first should set the cursor position and return the first ID or object hash
+  def first
+    @cursor_instance.jump( nil )
+    return current
+  end
+
+  ###############
+  #  first_key  #
+  ###############
+  
+  # first should set the cursor position and return the first ID or object hash
+  def first_key
+    @cursor_instance.jump( nil )
+    return current_key
+  end
+
+  #############
+  #  current  #
+  #############
+  
+  # current should return the current ID or object hash
+  def current
+    if global_id = @cursor_instance.get_value
+      global_id = global_id.to_i
+    end
+    # return ID
+    return global_id
+  end
+
+  #################
+  #  current_key  #
+  #################
+  
+  # current should return the current ID or object hash
+  def current_key
+
+    unserialized_key = nil
+
+    if serialized_key_or_id_string = @cursor_instance.get_key
+
+      # if we have an index we have serialized key
+      if @parent_index
+        unserialized_key = @parent_bucket.parent_adapter.class::SerializationClass.__send__( @parent_bucket.parent_adapter.class::UnserializationMethod, serialized_key_or_id_string )
+      # if not we just have an ID string
+      else
+        unserialized_key = serialized_key_or_id_string.to_i
+      end
+    
+    end
+    
+    # return ID
+    return unserialized_key
+    
+  end
+
+  ##########
+  #  next  #
+  ##########
+  
+  def next
+    @cursor_instance.step
+    return current
+  end
+
+  ##############
+  #  next_key  #
+  ##############
+  
+  def next_key
+    @cursor_instance.step
+    return current_key
+  end
+    
+end

data/lib/persistence/adapter/kyotocabinet/database_support.rb

@@ -0,0 +1,122 @@
+# ::Persistence::Adapter::KyotoCabinet::Locations
+#
+# DatabaseSupport for ::Persistence Adapter for Kyoto Cabinet
+
+module ::Persistence::Adapter::KyotoCabinet::DatabaseSupport
+
+  ##################################################################################################
+      private ######################################################################################
+  ##################################################################################################
+
+  #########################
+  #  extension__database  #
+  #########################
+  
+  def extension__database( db_type )
+
+    extension = nil
+    
+    case db_type
+      when :hash
+        # ".kch" - hash database (HashDB)
+        extension = '.kch'
+      when :tree
+        # ".kct" - tree database (TreeDB)
+        extension = '.kct'
+      when :dir
+        # ".kcd" - directory hash database (DirDB)
+        extension = '.kcd'
+      when :forest
+        # ".kcf" - directory tree database (ForestDB)
+        extension = '.kcf'
+      else
+        raise 'Unknown database type. Expected :hash, :tree, :dir, or :forest.'
+    end
+    
+    return extension
+    
+  end
+  
+  #######################
+  #  options__database  #
+  #######################
+  
+  def options__database()
+    
+    # Compression:
+
+    # All databases support:
+    # * "opts"
+    # * "zcomp"
+    # * "zkey"
+    # HashDB and TreeDB database also support:
+    # * "apow"
+    # * "fpow"
+    # * "bnum"
+    # * "msiz"
+    # * "dfunit"
+    # TreeDB and ForestDB also support:
+    # * "psiz"
+    # * "rcomp"
+    # * "pccap"
+    case db_type
+      when :hash, :tree, :dir, :forest
+      when :hash, :tree
+      when :tree, :forest
+    end
+
+    # Tuning Parameters:
+
+    # * "log" is for the original "tune_logger" and the value specifies:
+    #   - the path of the log file
+    #   - "-" for stdout
+    #   - "+" for stderr 
+
+    # * "logkinds" specifies kinds of logged messages and the value can be:
+    #   - "debug"
+    #   - "info"
+    #   - "warn"
+    #   - "error"
+
+    # * "logpx" specifies the prefix of each log message.
+
+    # * "opts" is for "tune_options" and the value can contain:
+    #   - "s" for the small option
+    #   - "l" for the linear option
+    #   - "c" for the compress option
+
+    # * "bnum" corresponds to "tune_bucket".
+
+    # * "zcomp" is for "tune_compressor":
+    #   - "zlib" for the ZLIB raw compressor
+    #   - "def" for the ZLIB deflate compressor
+    #   - "gz" for the ZLIB gzip compressor
+    #   - "lzo" for the LZO compressor
+    #   - "lzma" for the LZMA compressor
+    #   - "arc" for the Arcfour cipher
+
+    # * "zkey" specifies the cipher key of the compressor.
+
+    # * "capcnt" is for "cap_count".
+
+    # * "capsiz" is for "cap_size".
+
+    # * "psiz" is for "tune_page".
+
+    # * "rcomp" is for "tune_comparator" and the value can be:
+    #   - "lex" for the lexical comparator
+    #   - "dec" for the decimal comparator
+
+    # * "pccap" is for "tune_page_cache".
+
+    # * "apow" is for "tune_alignment".
+
+    # * "fpow" is for "tune_fbp".
+
+    # * "msiz" is for "tune_map".
+
+    # * "dfunit" is for "tune_defrag".
+    
+  end
+
+end