oklahoma_mixer 0.2.0 → 0.3.0

data/CHANGELOG.rdoc

@@ -2,6 +2,13 @@
 
 Below is a complete listing of changes for each revision of Oklahoma Mixer.
 
+== 0.3.0
+
+* Added the empty?() method
+* Added the ability to set an Array of duplicates at once for B+Tree Databases
+* Added Table Database support (document storage, queries/searches, and indexes)
+* Switched to autoloading database interfaces as they are used
+
 == 0.2.0
 
 * Added a to_hash() iterator that can preserve defaults

data/README.rdoc

@@ -46,3 +46,7 @@ When I was in Japan, people would ask where I was from.  When I would tell them,
 It turns out Oklahoma Mixer is a song in Japan.  I had to track it down in a music store.  It's kind of a camp song medley, including things like the Hokey Pokey.  I'm not too sure what that has to do with Oklahoma, but at least they had heard of where I'm from.
 
 On a more practical side, this interface to Tokyo Cabinet is from Oklahoma.  I intend it to _mix_ together all of the great features of that library in some exciting new ways.  Thus, Oklahoma Mixer it is.
+
+== Is there any documentation yet?
+
+I'll write some proper API documentation down the road a bit, but users playing with the preview releases can read about how to use this library in {the Tokyo Cabinet series on my blog}[http://blog.grayproductions.net/articles/using_keyvalue_stores_from_ruby].

data/Rakefile

@@ -8,7 +8,7 @@ task :default => :test
 
 Rake::TestTask.new do |test|
   test.libs    << "test"
-  test.pattern =  "test/*_test.rb"
+  test.pattern =  "test/**/*_test.rb"
   test.warning =  true
   test.verbose =  true
 end

data/TODO.rdoc

@@ -3,9 +3,8 @@
 The following is a list of planned expansions for Oklahoma Mixer in the order I
 intend to address them.
 
-1. Add support for Table Databases
+1. Add support for Tokyo Tyrant
 2. Ensure Ruby 1.9 compatibility
 3. Write API documentation
-4. Add support for Tokyo Tyrant
+4. Include some higher level abstractions like mixed tables, queues, and shards
 5. Add support for Tokyo Dystopia
-6. Include some higher level abstractions like mixed tables, queues, and shards

data/lib/oklahoma_mixer.rb

@@ -1,30 +1,17 @@
-require "ffi"
-
-require "oklahoma_mixer/error"
-require "oklahoma_mixer/utilities"
-
-require "oklahoma_mixer/extensible_string/c"
-require "oklahoma_mixer/extensible_string"
-require "oklahoma_mixer/array_list/c"
-require "oklahoma_mixer/array_list"
-require "oklahoma_mixer/cursor/c"
-require "oklahoma_mixer/cursor"
-
-require "oklahoma_mixer/hash_database/c"
-require "oklahoma_mixer/hash_database"
-require "oklahoma_mixer/b_tree_database/c"
-require "oklahoma_mixer/b_tree_database"
-require "oklahoma_mixer/fixed_length_database/c"
-require "oklahoma_mixer/fixed_length_database"
-
 module OklahomaMixer
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
+  
+  autoload :HashDatabase,        "oklahoma_mixer/hash_database"
+  autoload :BTreeDatabase,       "oklahoma_mixer/b_tree_database"
+  autoload :FixedLengthDatabase, "oklahoma_mixer/fixed_length_database"
+  autoload :TableDatabase,       "oklahoma_mixer/table_database"
   
   def self.open(path, *args)
     db_class = case File.extname(path).downcase
                when ".tch" then HashDatabase
                when ".tcb" then BTreeDatabase
                when ".tcf" then FixedLengthDatabase
+               when ".tct" then TableDatabase
                else             fail ArgumentError, "unsupported database type"
                end
     db       = db_class.new(path, *args)

data/lib/oklahoma_mixer/array_list.rb

@@ -1,18 +1,32 @@
+require "oklahoma_mixer/array_list/c"
+
 module OklahomaMixer
   class ArrayList  # :nodoc:
-    def initialize(pointer = C.new)
-      @pointer = pointer
+    def initialize(pointer_or_size)
+      @pointer = case pointer_or_size
+                 when FFI::Pointer then pointer_or_size
+                 else                   C.new2(pointer_or_size.to_i)
+                 end
     end
     
+    attr_reader :pointer
+    
     def shift
-      C.read_from_func(:shift, @pointer)
+      value = C.read_from_func(:shift, @pointer)
+      block_given? ? yield(value) : value
     end
     
-    include Enumerable
-    
-    def each
+    def map
+      values = [ ]
       while value = shift
-        yield value
+        values << yield(value)
+      end
+      values
+    end
+    
+    def push(*values)
+      values.each do |value|
+        C.push(@pointer, *yield(value))
       end
     end
 

data/lib/oklahoma_mixer/array_list/c.rb

@@ -1,3 +1,5 @@
+require "oklahoma_mixer/utilities"
+
 module OklahomaMixer
   class ArrayList
     module C  # :nodoc:
@@ -5,11 +7,17 @@ module OklahomaMixer
 
       prefix :tclist
       
-      def_new_and_del_funcs
+      func :name    => :new2,
+           :args    => :int,
+           :returns => :pointer
+      func :name    => :del,
+           :args    => :pointer
       
       func :name    => :shift,
            :args    => [:pointer, :pointer],
            :returns => :pointer
+      func :name    => :push,
+           :args    => [:pointer, :pointer, :int]
     end
   end
 end

data/lib/oklahoma_mixer/b_tree_database.rb

@@ -1,3 +1,8 @@
+require "oklahoma_mixer/array_list"
+require "oklahoma_mixer/cursor"
+require "oklahoma_mixer/hash_database"
+require "oklahoma_mixer/b_tree_database/c"
+
 module OklahomaMixer
   class BTreeDatabase < HashDatabase
     ###################
@@ -11,7 +16,7 @@ module OklahomaMixer
            options.fetch(:bnum,   0).to_i,
            options.fetch(:apow,  -1).to_i,
            options.fetch(:fpow,  -1).to_i,
-           to_enum_int(options.fetch(:opts, 0xFF), :opt) )
+           cast_to_enum_int(options.fetch(:opts, 0xFF), :opt) )
     end
     
     ################################
@@ -20,7 +25,14 @@ module OklahomaMixer
 
     def store(key, value, mode = nil)
       if mode == :dup
-        try(:putdup, cast_key_in(key), cast_value_in(value))
+        if value.is_a? Array
+          Utilities.temp_list(value.size) do |list|
+            list.push(*value) { |string| cast_value_in(string) }
+            try(:putdup3, cast_key_in(key), list.pointer)
+          end
+        else
+          try(:putdup, cast_key_in(key), cast_value_in(value))
+        end
         value
       else
         super
@@ -42,7 +54,7 @@ module OklahomaMixer
                                            *[ start,  include_start,
                                               finish, include_finish,
                                               limit ].flatten ) )
-          list.to_a
+          list.map { |key| cast_key_out(key) }
         ensure
           list.free if list
         end
@@ -63,7 +75,7 @@ module OklahomaMixer
             [ ]
           else
             list = ArrayList.new(pointer)
-            list.to_a
+            list.map { |value| cast_value_out(value) }
           end
         ensure
           list.free if list
@@ -100,14 +112,15 @@ module OklahomaMixer
     def each_key(start = nil)
       cursor_in_loop(start) do |iterator|
         throw(:finish_iteration) unless key = iterator.key
-        yield key
+        yield cast_key_out(key)
       end
     end
     
     def each(start = nil)
       cursor_in_loop(start) do |iterator|
         throw(:finish_iteration) unless key_and_value = iterator.key_and_value
-        yield key_and_value
+        yield [ cast_key_out(key_and_value.first),
+                cast_value_out(key_and_value.last) ]
       end
     end
     alias_method :each_pair, :each
@@ -115,14 +128,15 @@ module OklahomaMixer
     def reverse_each(start = nil)
       cursor_in_loop(start, :reverse) do |iterator|
         throw(:finish_iteration) unless key_and_value = iterator.key_and_value
-        yield key_and_value
+        yield [ cast_key_out(key_and_value.first),
+                cast_value_out(key_and_value.last) ]
       end
     end
     
     def each_value(start = nil)
       cursor_in_loop(start) do |iterator|
         throw(:finish_iteration) unless value = iterator.value
-        yield value
+        yield cast_value_out(value)
       end
     end
     
@@ -130,7 +144,9 @@ module OklahomaMixer
       cursor(start) do |iterator|
         loop do
           break unless key_and_value = iterator.key_and_value
-          break unless iterator.send(yield(*key_and_value) ? :delete : :next)
+          test = yield( cast_key_out(key_and_value.first),
+                        cast_value_out(key_and_value.last) )
+          break unless iterator.send(test ? :delete : :next)
         end
       end
     end

data/lib/oklahoma_mixer/b_tree_database/c.rb

@@ -1,3 +1,5 @@
+require "oklahoma_mixer/utilities"
+
 module OklahomaMixer
   class BTreeDatabase < HashDatabase
     module C  # :nodoc:
@@ -26,6 +28,9 @@ module OklahomaMixer
       func :name    => :putdup,
            :args    => [:pointer, :pointer, :int, :pointer, :int],
            :returns => :bool
+      func :name    => :putdup3,
+           :args    => [:pointer, :pointer, :int, :pointer],
+           :returns => :bool
       func :name    => :out3,
            :args    => [:pointer, :pointer, :int],
            :returns => :bool

data/lib/oklahoma_mixer/cursor.rb

@@ -1,3 +1,6 @@
+require "oklahoma_mixer/extensible_string"
+require "oklahoma_mixer/cursor/c"
+
 module OklahomaMixer
   class Cursor  # :nodoc:
     def initialize(b_tree_pointer, start = nil, reverse = false)

data/lib/oklahoma_mixer/cursor/c.rb

@@ -1,3 +1,5 @@
+require "oklahoma_mixer/utilities"
+
 module OklahomaMixer
   class Cursor
     module C  # :nodoc:

data/lib/oklahoma_mixer/error.rb

@@ -2,5 +2,7 @@ module OklahomaMixer
   module Error
     class TransactionError < RuntimeError; end
     class CabinetError     < RuntimeError; end
+    class QueryError       < RuntimeError; end
+    class IndexError       < RuntimeError; end
   end
 end

data/lib/oklahoma_mixer/extensible_string.rb

@@ -1,7 +1,9 @@
+require "oklahoma_mixer/extensible_string/c"
+
 module OklahomaMixer
   class ExtensibleString  # :nodoc:
-    def initialize(pointer = C.new)
-      @pointer = pointer
+    def initialize
+      @pointer = C.new
     end
     
     attr_reader :pointer

data/lib/oklahoma_mixer/extensible_string/c.rb

@@ -1,3 +1,5 @@
+require "oklahoma_mixer/utilities"
+
 module OklahomaMixer
   class ExtensibleString
     module C  # :nodoc:

data/lib/oklahoma_mixer/fixed_length_database.rb

@@ -1,3 +1,6 @@
+require "oklahoma_mixer/hash_database"
+require "oklahoma_mixer/fixed_length_database/c"
+
 module OklahomaMixer
   class FixedLengthDatabase < HashDatabase
     ###################
@@ -45,7 +48,7 @@ module OklahomaMixer
           array = list.get_array_of_uint64(0, count.get_int(0))
           array.shift if array.first == start  and not include_start
           array.pop   if array.last  == finish and not include_finish
-          array
+          array  # cast not needed:  already Integer
         ensure
           Utilities.free(list) if list
         end
@@ -62,7 +65,7 @@ module OklahomaMixer
         return self unless key = try( :iternext,
                                       :failure  => 0,
                                       :no_error => {22 => nil} )
-        yield key
+        yield key  # cast not needed:  already Integer
       end
     end
     
@@ -86,10 +89,15 @@ module OklahomaMixer
     def cast_key_in(key)
       case key
       when :min, :max, :prev, :next, "min", "max", "prev", "next"
-        C::IDS["FDBID#{key.to_s.upcase}".to_sym]
+        lib::IDS["FDBID#{key.to_s.upcase}".to_sym]
       else
         key.to_i
       end
     end
+    
+    # Override to prevent String manipulations on ID.
+    def cast_key_out(integer)
+      integer
+    end
   end
 end

data/lib/oklahoma_mixer/fixed_length_database/c.rb

@@ -1,3 +1,5 @@
+require "oklahoma_mixer/utilities"
+
 module OklahomaMixer
   class FixedLengthDatabase < HashDatabase
     module C  # :nodoc:

data/lib/oklahoma_mixer/hash_database.rb

@@ -1,3 +1,8 @@
+require "oklahoma_mixer/error"
+require "oklahoma_mixer/extensible_string"
+require "oklahoma_mixer/array_list"
+require "oklahoma_mixer/hash_database/c"
+
 module OklahomaMixer
   class HashDatabase
     #################
@@ -34,7 +39,9 @@ module OklahomaMixer
       tune(options)
       
       warn "mode option supersedes mode argument" if mode and options[:mode]
-      try(:open, path, to_enum_int(options.fetch(:mode, mode || "wc"), :mode))
+      try( :open,
+           path,
+           cast_to_enum_int(options.fetch(:mode, mode || "wc"), :mode) )
     rescue Exception
       close if defined?(@db) and @db
       raise
@@ -45,7 +52,7 @@ module OklahomaMixer
            options.fetch(:bnum,  0).to_i,
            options.fetch(:apow, -1).to_i,
            options.fetch(:fpow, -1).to_i,
-           to_enum_int(options.fetch(:opts, 0xFF), :opt) )
+           cast_to_enum_int(options.fetch(:opts, 0xFF), :opt) )
     end
     
     attr_reader :path
@@ -130,7 +137,7 @@ module OklahomaMixer
     def fetch(key, *default)
       if value = try( :read_from_func, :get, cast_key_in(key),
                       :failure => nil, :no_error => {22 => nil} )
-        value
+        cast_value_out(value)
       else
         if block_given?
           warn "block supersedes default value argument" unless default.empty?
@@ -164,7 +171,7 @@ module OklahomaMixer
       prefix = options.fetch(:prefix, "").to_s
       limit  = options.fetch(:limit,  -1)
       list   = ArrayList.new(lib.fwmkeys(@db, prefix, prefix.size, limit))
-      list.to_a
+      list.map { |key| cast_key_out(key) }
     ensure
       list.free if list
     end
@@ -205,6 +212,10 @@ module OklahomaMixer
     end
     alias_method :length, :size
     
+    def empty?
+      size.zero?
+    end
+    
     #################
     ### Iteration ###
     #################
@@ -217,7 +228,7 @@ module OklahomaMixer
         return self unless key = try( :read_from_func, :iternext,
                                       :failure  => nil,
                                       :no_error => {22 => nil} )
-        yield key
+        yield cast_key_out(key)
       end
     end
     
@@ -228,7 +239,7 @@ module OklahomaMixer
           Utilities.temp_xstr do |value|
             return self unless try( :iternext3, key.pointer, value.pointer,
                                     :no_error => {22 => false} )
-            yield [key.to_s, value.to_s]
+            yield [cast_key_out(key.to_s), cast_value_out(value.to_s)]
           end
         end
       end
@@ -327,7 +338,7 @@ module OklahomaMixer
       end
     end
     
-    def to_enum_int(str_or_int, name)
+    def cast_to_enum_int(str_or_int, name)
       return str_or_int if str_or_int.is_a? Integer
       const = "#{name.to_s.upcase}S"
       names = self.class.const_get(const)
@@ -361,5 +372,11 @@ module OklahomaMixer
     end
     alias_method :cast_key_in,   :cast_to_bytes_and_length
     alias_method :cast_value_in, :cast_to_bytes_and_length
+    
+    def cast_to_encoded_string(string)
+      string
+    end
+    alias_method :cast_key_out,   :cast_to_encoded_string
+    alias_method :cast_value_out, :cast_to_encoded_string
   end
 end