rufus-tokyo 0.1.12 → 0.1.13

data/CHANGELOG.txt

@@ -2,6 +2,15 @@
 = rufus-tokyo CHANGELOG.txt
 
 
+== rufus-tokyo - 0.1.13    released 2009/06/02
+
+- todo  : putkeep implementation (by Kamal)
+- todo  : support for binary data (map, list, cabinet, table, tokyo/edo)
+- todo  : added #defrag to Rufus::Tokyo::Cabinet
+- todo  : added :dfunit to databases that support it
+- todo  : added #addint and #adddouble (#incr)
+
+
 == rufus-tokyo - 0.1.12    released 2009/04/07
 
 - todo  : added ext method for calling embedded Lua function (Tyrant)

data/CREDITS.txt

@@ -10,6 +10,7 @@ Zev Blut  http://www.iknow.co.jp/users/zev
 
 == contributors
 
+Kamal Fariz Mahyuddin  http://github.com/kamal
 Justin Reagor  http://blog.kineticweb.com/
 Benjami Yu  http://github.com/byu
 mebaran  http://github.com/mebaran

data/README.txt

@@ -31,6 +31,8 @@ the rdoc is at http://rufus.rubyforge.org/rufus-tokyo/
 
 this version of rufus-tokyo works with
 
+  ffi 0.3.1, 0.3.5
+
   ruby 1.8.6
   ruby 1.9.1p0
   jruby 1.1.6
@@ -39,9 +41,12 @@ this version of rufus-tokyo works with
   TC 1.4.9 and TT 1.1.16
   TC 1.4.10 and TT 1.1.17 (adds the offset arg to query.limit)
   TC 1.4.11 and TT 1.1.18
+  TC 1.4.13 and TT 1.1.22 (added query.count)
+  TC 1.4.21 and TT 1.1.27
 
   tc-ruby 1.20 and tt-ruby 1.3 (Rufus::Edo)
-  tc-ruby 1.21 and tt-ruby 1.4 (Rufus::Edo)
+  tc-ruby 1.21 and tt-ruby 1.5 (Rufus::Edo)
+  tc-ruby 1.21 and tt-ruby 1.7 (Rufus::Edo)
 
 
 === TC Abstract API

data/TODO.txt

@@ -1,20 +1,24 @@
 
-[x] table : bench find(1) after set_index
-[x] table : bench insert(1) after set_index
+[o] table : bench find(1) after set_index
+[o] table : bench insert(1) after set_index
 
-[x] align edo#new on tokyo#new
+[o] align edo#new on tokyo#new
 [ ] horizontal (bdb hdb fdb) tests for tokyo and edo
 
-[x] rdoc unix socket for tyrant
-[x] edo : tran
+[o] rdoc unix socket for tyrant
+[o] edo : tran
 [ ] bench ux socket
 
-[ ] TT (TC) call [lua] function
+[o] TT (TC) call [lua] function
 [ ] queryout
 
-[ ] impl lget/lput/ldelete in Rufus::Edo::Cabinet
+[o] impl lget/lput/ldelete in Rufus::Edo::Cabinet
 
 [ ] maybe supported different libs for migrations...
 
 [ ] document ENV['TOKYO_TYRANT_LIB'] & _CABINET_
 
+[o] unify m/l raise trick for util map/list
+
+[ ] misc calls (defrag) for Edo
+

data/lib/rufus/edo/cabcore.rb

@@ -63,22 +63,32 @@ module Rufus::Edo
       end
     end
 
+    # Returns the path to this database.
     #
+    def path
+
+      @path
+    end
+
     # No comment
     #
     def []= (k, v)
       @db.put(k, v) || raise_error
     end
 
+    # No comment
     #
-    # (The actual #[] method is provided by HashMethods
+    def putkeep (k, v)
+      @db.putkeep(k, v)
+    end
+
+    # (The actual #[] method is provided by HashMethods)
     #
     def get (k)
       @db.get(k)
     end
     protected :get
 
-    #
     # Removes a record from the cabinet, returns the value if successful
     # else nil.
     #
@@ -87,14 +97,12 @@ module Rufus::Edo
       @db.out(k) ? v : nil
     end
 
-    #
     # Returns the number of records in the 'cabinet'
     #
     def size
       @db.rnum
     end
 
-    #
     # Removes all the records in the cabinet (use with care)
     #
     # Returns self (like Ruby's Hash does).
@@ -104,14 +112,12 @@ module Rufus::Edo
       self
     end
 
-    #
     # Returns the 'weight' of the db (in bytes)
     #
     def weight
       @db.fsiz
     end
 
-    #
     # Closes the cabinet (and frees the datastructure allocated for it),
     # returns true in case of success.
     #
@@ -119,7 +125,6 @@ module Rufus::Edo
       @db.close || raise_error
     end
 
-    #
     # Copies the current cabinet to a new file.
     #
     # Returns true if it was successful.
@@ -128,7 +133,6 @@ module Rufus::Edo
       @db.copy(target_path)
     end
 
-    #
     # Copies the current cabinet to a new file.
     #
     # Does it by copying each entry afresh to the target file. Spares some
@@ -140,7 +144,6 @@ module Rufus::Edo
       @other_db.close
     end
 
-    #
     # "synchronize updated contents of an abstract database object with
     # the file and the device"
     #
@@ -148,7 +151,6 @@ module Rufus::Edo
       @db.sync || raise_error
     end
 
-    #
     # Returns an array of all the primary keys in the db.
     #
     # With no options given, this method will return all the keys (strings)
@@ -182,7 +184,6 @@ module Rufus::Edo
       end
     end
 
-    #
     # Deletes all the entries whose keys begin with the given prefix
     #
     def delete_keys_with_prefix (prefix)
@@ -193,7 +194,6 @@ module Rufus::Edo
       nil
     end
 
-    #
     # Given a list of keys, returns a Hash { key => value } of the
     # matching entries (in one sweep).
     #
@@ -217,7 +217,6 @@ module Rufus::Edo
     #++
     alias :lput :merge!
 
-    #
     # Given a list of keys, deletes all the matching entries (in one sweep).
     #
     # Warning : this is a naive (slow) implementation.
@@ -229,15 +228,33 @@ module Rufus::Edo
       nil
     end
 
+    # Increments the value stored under the given key with the given increment
+    # (defaults to 1 (integer)).
     #
+    def incr (key, val=1)
+
+      v = val.is_a?(Fixnum) ? @db.addint(key, val) : @db.adddouble(key, val)
+
+      raise(EdoError.new(
+        "incr failed, there is probably already a string value set " +
+        "for the key '#{key}'"
+      )) unless v
+
+      v
+    end
+    alias :adddouble :incr
+    alias :addint :incr
+    alias :add_double :incr
+    alias :add_int :incr
+
     # Returns the underlying 'native' Ruby object (of the class devised by
     # Hirabayashi-san)
     #
     def original
+
       @db
     end
 
-    #
     # This is rather low-level, you'd better use #transaction like in
     #
     #   db.transaction do
@@ -253,7 +270,6 @@ module Rufus::Edo
       @db.tranbegin
     end
 
-    #
     # This is rather low-level use #transaction and a block for a higher-level
     # technique.
     #
@@ -264,7 +280,6 @@ module Rufus::Edo
       @db.trancommit
     end
 
-    #
     # This is rather low-level use #transaction and a block for a higher-level
     # technique.
     #

data/lib/rufus/edo/cabinet/abstract.rb

@@ -66,7 +66,6 @@ module Rufus::Edo
     include Rufus::Edo::CabinetCore
     include Rufus::Tokyo::CabinetConfig
 
-    #
     # Initializes and open a cabinet (hash, b+ tree or fixed-size)
     #
     # db = Rufus::Edo::Cabinet.new('data.tch')
@@ -136,6 +135,9 @@ module Rufus::Edo
     #   * :capnum  specifies the capacity number of records.
     #   * :capsiz  specifies the capacity size of using memory.
     #
+    #   * :dfunit  unit step number. If it is not more than 0,
+    #              the auto defragmentation is disabled. (Since TC 1.4.21)
+    #
     #
     # = NOTE :
     #
@@ -182,10 +184,17 @@ module Rufus::Edo
 
       @db.setxmsiz(conf[:xmsiz]) unless conf[:type] == :fixed
 
+      #
+      # set dfunit (TC > 1.4.21)
+
+      @db.setdfunit(conf[:dfunit]) if @db.respond_to?(:setdfunit)
+
       #
       # open
 
-      @db.open(conf[:path], conf[:mode]) || raise_error
+      @path = conf[:path]
+
+      @db.open(@path, conf[:mode]) || raise_error
 
       #
       # default

data/lib/rufus/edo/cabinet/table.rb

@@ -58,7 +58,6 @@ module Rufus::Edo
     include Rufus::Tokyo::CabinetConfig
     include Rufus::Edo::TableCore
 
-    #
     # Initializes and open a table.
     #
     # db = Rufus::Edo::Table.new('data.tct')
@@ -99,6 +98,9 @@ module Rufus::Edo
     #              cached. If it is not more than 0, the default value is
     #              specified. The default value is 512.
     #
+    #   * :dfunit  unit step number. If it is not more than 0,
+    #              the auto defragmentation is disabled. (Since TC 1.4.21)
+    #
     # = NOTE :
     #
     # On reopening a file, Cabinet will tend to stick to the parameters as
@@ -126,15 +128,30 @@ module Rufus::Edo
 
       @db.setxmsiz(conf[:xmsiz])
 
+      #
+      # set dfunit (TC > 1.4.21)
+
+      @db.setdfunit(conf[:dfunit]) if @db.respond_to?(:setdfunit)
+
       #
       # open
 
-      @db.open(conf[:path], conf[:mode]) || raise_error
+      @path = conf[:path]
+
+      @db.open(@path, conf[:mode]) || raise_error
+    end
+
+    # Returns the path to this table.
+    #
+    def path
+
+      @path
     end
 
     protected
 
     def table_query_class #:nodoc#
+
       TokyoCabinet::TDBQRY
     end
   end

data/lib/rufus/edo/ntyrant/table.rb

@@ -97,6 +97,19 @@ module Rufus::Edo
       end
     end
 
+    # This implementation of lget relies on the mget provided by
+    # Hirabayashi-san in his native ruby library (all the other rufus
+    # tables do multiple gets for now)
+    #
+    def lget (keys)
+
+      h = keys.inject({}) { |h, k| h[k] = nil; h }
+      r = @db.mget(h)
+
+      raise 'lget failure' if r == -1
+      h
+    end
+
     def transaction #:nodoc#
       raise NoMethodError.new("NetTyrant : transactions not supported")
     end

data/lib/rufus/edo/tabcore.rb

@@ -38,7 +38,6 @@ module Rufus::Edo
     include Rufus::Tokyo::HashMethods
     include Rufus::Tokyo::Transactions
 
-    #
     # Closes the table (and frees the datastructure allocated for it),
     # raises an exception in case of failure.
     #
@@ -46,7 +45,6 @@ module Rufus::Edo
       @db.close || raise_error
     end
 
-    #
     # Generates a unique id (in the context of this Table instance)
     #
     def generate_unique_id
@@ -62,7 +60,6 @@ module Rufus::Edo
       :keep => 1 << 24
     }
 
-    #
     # Sets an index on a column of the table.
     #
     # Types maybe be :lexical or :decimal, use :keep to "add" and
@@ -81,7 +78,6 @@ module Rufus::Edo
       @db.setindex(column_name, i) || raise_error
     end
 
-    #
     # Inserts a record in the table db
     #
     #   table['pk0'] = [ 'name', 'fred', 'age', '45' ]
@@ -102,7 +98,6 @@ module Rufus::Edo
       @db.put(pk, m) || raise_error
     end
 
-    #
     # Removes an entry in the table
     #
     # (might raise an error if the delete itself failed, but returns nil
@@ -121,7 +116,6 @@ module Rufus::Edo
       val
     end
 
-    #
     # Removes all records in this table database
     #
     # Raises an error if something went wrong
@@ -131,7 +125,6 @@ module Rufus::Edo
       @db.vanish || raise_error
     end
 
-    #
     # Returns an array of all the primary keys in the table
     #
     # With no options given, this method will return all the keys (strings)
@@ -165,7 +158,6 @@ module Rufus::Edo
       end
     end
 
-    #
     # Deletes all the entries whose key begin with the given prefix.
     #
     def delete_keys_with_prefix (prefix)
@@ -174,7 +166,17 @@ module Rufus::Edo
       ks.each { |k| self.delete(k) }
     end
 
+    # No 'misc' methods for the table library, so this lget is equivalent
+    # to calling get for each key. Hoping later versions of TC will provide
+    # a mget method.
     #
+    def lget (keys)
+
+      # TODO : maybe investigate a query on the column 'primary_key' ?
+
+      keys.inject({}) { |h, k| v = self[k]; h[k] = v if v; h }
+    end
+
     # Returns the number of records in this table db
     #
     def size
@@ -182,7 +184,6 @@ module Rufus::Edo
       @db.rnum
     end
 
-    #
     # Prepares a query instance (block is optional)
     #
     def prepare_query (&block)
@@ -191,7 +192,6 @@ module Rufus::Edo
       q
     end
 
-    #
     # Prepares and runs a query, returns an array of hashes (all Ruby)
     # (takes care of freeing the query and the result set structures)
     #
@@ -200,7 +200,6 @@ module Rufus::Edo
       prepare_query(&block).run
     end
 
-    #
     # Warning : this method is low-level, you probably only need
     # to use #transaction and a block.
     #
@@ -211,7 +210,6 @@ module Rufus::Edo
       @db.tranbegin || raise_error
     end
 
-    #
     # Warning : this method is low-level, you probably only need
     # to use #transaction and a block.
     #
@@ -222,7 +220,6 @@ module Rufus::Edo
       @db.trancommit || raise_error
     end
 
-    #
     # Warning : this method is low-level, you probably only need
     # to use #transaction and a block.
     #
@@ -233,7 +230,6 @@ module Rufus::Edo
       @db.tranabort || raise_error
     end
 
-    #
     # Returns the underlying 'native' Ruby object (of the class devised by
     # Hirabayashi-san)
     #
@@ -244,7 +240,6 @@ module Rufus::Edo
 
     protected
 
-    #
     # Returns the value (as a Ruby Hash) else nil
     #
     # (the actual #[] method is provided by HashMethods)
@@ -254,7 +249,6 @@ module Rufus::Edo
       @db.get(k)
     end
 
-    #
     # Obviously something went wrong, let's ask the db about it and raise
     # an EdoError
     #
@@ -286,7 +280,6 @@ module Rufus::Edo
 
     include Rufus::Tokyo::QueryConstants
 
-    #
     # Creates a query for a given Rufus::Tokyo::Table
     #
     # Queries are usually created via the #query (#prepare_query #do_query)
@@ -311,7 +304,6 @@ module Rufus::Edo
       @opts = {}
     end
 
-    #
     # Adds a condition
     #
     #   table.query { |q|
@@ -379,7 +371,6 @@ module Rufus::Edo
     end
     alias :add_condition :add
 
-    #
     # Sets the max number of records to return for this query.
     #
     # (If you're using TC >= 1.4.10 the optional 'offset' (skip) parameter
@@ -392,7 +383,6 @@ module Rufus::Edo
         @query.setmax(i)
     end
 
-    #
     # Sets the sort order for the result of the query
     #
     # The 'direction' may be :
@@ -409,7 +399,6 @@ module Rufus::Edo
       @query.setorder(colname, DIRECTIONS[direction])
     end
 
-    #
     # When set to true, only the primary keys of the matching records will
     # be returned.
     #
@@ -418,7 +407,6 @@ module Rufus::Edo
       @opts[:pk_only] = on
     end
 
-    #
     # When set to true, the :pk (primary key) is not inserted in the record
     # (hashes) returned
     #
@@ -427,14 +415,12 @@ module Rufus::Edo
       @opts[:no_pk] = on
     end
 
-    #
     # Runs this query (returns a TableResultSet instance)
     #
     def run
       @last_resultset = TableResultSet.new(@table, @query.search, @opts)
     end
 
-    #
     # Returns the count of results this query return when last run.
     # Returns 0 if the query was not yet run.
     #
@@ -446,7 +432,6 @@ module Rufus::Edo
       @last_resultset ? @last_resultset.size : 0
     end
 
-    #
     # Frees this data structure
     #
     def free
@@ -471,7 +456,6 @@ module Rufus::Edo
       @opts = query_opts
     end
 
-    #
     # Returns the count of element in this result set
     #
     def size
@@ -481,7 +465,6 @@ module Rufus::Edo
 
     alias :length :size
 
-    #
     # The classical each
     #
     def each
@@ -497,7 +480,6 @@ module Rufus::Edo
       end
     end
 
-    #
     # Returns an array of hashes
     #
     def to_a
@@ -505,7 +487,6 @@ module Rufus::Edo
       self.collect { |m| m }
     end
 
-    #
     # Frees this query (the underlying Tokyo Cabinet list structure)
     #
     def free