rufus-tokyo 0.1.13 → 0.1.14

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = rufus-tokyo CHANGELOG.txt
 
 
+== rufus-tokyo - 0.1.14    released 2009/06/30
+
+- issue #2 : query#add with no_index=false by default
+- issue #1 : added query#delete and table#query_delete
+
+
 == rufus-tokyo - 0.1.13    released 2009/06/02
 
 - todo  : putkeep implementation (by Kamal)

data/CREDITS.txt

@@ -10,10 +10,11 @@ Zev Blut  http://www.iknow.co.jp/users/zev
 
 == contributors
 
+Matthew King  http://github.com/automatthew
 Kamal Fariz Mahyuddin  http://github.com/kamal
 Justin Reagor  http://blog.kineticweb.com/
 Benjami Yu  http://github.com/byu
-mebaran  http://github.com/mebaran
+Mark 'mebaran'  http://github.com/mebaran
 
 
 == finally

data/{README.txt → README.rdoc}

@@ -34,19 +34,20 @@ 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
-  jruby 1.2.0
+  ruby 1.9.1p129
+  jruby 1.1.6, 1.2.0, 1.3.1
 
   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 1.4.27 and TT 1.1.29
 
   tc-ruby 1.20 and tt-ruby 1.3 (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-ruby 1.26 and tt-ruby 1.10 (Rufus::Edo)
 
 
 === TC Abstract API
@@ -233,20 +234,20 @@ and then :
 
 more in the rdoc
 
-  http://rufus.rubyforge.org/rufus-tokyo/
-  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Cabinet.html
-  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Table.html
-  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Tyrant.html
-  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/TyrantTable.html
+* http://rufus.rubyforge.org/rufus-tokyo/
+* http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Cabinet.html
+* http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Table.html
+* http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Tyrant.html
+* http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/TyrantTable.html
 
 don't hesitate to "man ttserver" on the command line.
 
 or directly in the source
 
-  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/cabinet/abstract.rb
-  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/cabinet/table.rb
-  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/tyrant/abstract.rb
-  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/tyrant/table.rb
+* http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/cabinet/abstract.rb
+* http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/cabinet/table.rb
+* http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/tyrant/abstract.rb
+* http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/tyrant/table.rb
 
 
 == Tokyo Cabinet / Tyrant install
@@ -270,7 +271,7 @@ On the rufus-ruby list :
 
 == issue tracker
 
-  http://rubyforge.org/tracker/?atid=18584&group_id=4812&func=browse
+  http://github.com/jmettraux/rufus-tokyo/issues/
 
 
 == irc
@@ -289,14 +290,14 @@ http://github.com/jmettraux/rufus-tokyo
 
 many thanks to the author of Tokyo Cabinet, Mikio Hirabayashi, and to the authors of ruby-ffi
 
-  http://tokyocabinet.sourceforge.net
-  http://kenai.com/projects/ruby-ffi
+* http://tokyocabinet.sourceforge.net
+* http://kenai.com/projects/ruby-ffi
 
 
 == authors
 
-John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
-Zev Blut, http://www.iknow.co.jp/users/zev
+* John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
+* Zev Blut, http://www.iknow.co.jp/users/zev
 
 
 == the rest of Rufus

data/TODO.txt

@@ -21,4 +21,5 @@
 [o] unify m/l raise trick for util map/list
 
 [ ] misc calls (defrag) for Edo
+[ ] TT set master & co
 

data/lib/rufus/edo/cabcore.rb

@@ -188,9 +188,14 @@ module Rufus::Edo
     #
     def delete_keys_with_prefix (prefix)
 
-      #call_misc('outlist', lib.abs_fwmkeys2(@db, prefix, -1))
-      #  # -1 for no limits
-      @db.fwmkeys(prefix, -1).each { |k| self.delete(k) }
+      # only ADB has the #misc method...
+
+      if @db.respond_to?(:misc)
+        @db.misc('outlist', @db.fwmkeys(prefix, -1))
+      else
+        @db.fwmkeys(prefix, -1).each { |k| self.delete(k) }
+      end
+
       nil
     end
 
@@ -201,20 +206,29 @@ module Rufus::Edo
     #
     def lget (keys)
 
-      #Hash[*call_misc('getlist', Rufus::Tokyo::List.new(keys))]
-      keys.inject({}) { |h, k| v = self[k]; h[k] = v if v; h }
+      # only ADB has the #misc method...
+
+      if @db.respond_to?(:misc)
+        Hash[*@db.misc('getlist', keys)]
+      else
+        keys.inject({}) { |h, k| v = self[k]; h[k] = v if v; h }
+      end
     end
 
-    #--
+    #
     # default impl provided by HashMethods
     #
-    #def merge! (hash)
-    #  call_misc(
-    #    'putlist',
-    #    hash.inject(Rufus::Tokyo::List.new) { |l, (k, v)| l << k; l << v; l })
-    #  self
-    #end
-    #++
+    def merge! (hash)
+
+      # only ADB has the #misc method...
+
+      if @db.respond_to?(:misc)
+        @db.misc('putlist', hash.to_a.flatten)
+      else
+        super(hash)
+      end
+      self
+    end
     alias :lput :merge!
 
     # Given a list of keys, deletes all the matching entries (in one sweep).
@@ -223,8 +237,14 @@ module Rufus::Edo
     #
     def ldelete (keys)
 
-      #call_misc('outlist', Rufus::Tokyo::List.new(keys))
-      keys.each { |k| self.delete(k) }
+      # only ADB has the #misc method...
+
+      if @db.respond_to?(:misc)
+        @db.misc('outlist', keys)
+      else
+        keys.each { |k| self.delete(k) }
+      end
+
       nil
     end
 
@@ -247,6 +267,17 @@ module Rufus::Edo
     alias :add_double :incr
     alias :add_int :incr
 
+    # Triggers a defrag (TC >= 1.4.21 only)
+    #
+    def defrag
+
+      raise(NotImplementedError.new(
+        "defrag (misc) only available when opening db with :type => :abstract"
+      )) unless @db.respond_to?(:misc)
+
+      @db.misc('defrag', [])
+    end
+
     # Returns the underlying 'native' Ruby object (of the class devised by
     # Hirabayashi-san)
     #

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

@@ -150,6 +150,8 @@ module Rufus::Edo
       conf = determine_conf(path, params)
 
       klass = {
+        :abstract => defined?(TokyoCabinet::ADB) ?
+          TokyoCabinet::ADB : TokyoCabinet::HDB,
         :hash => TokyoCabinet::HDB,
         :btree => TokyoCabinet::BDB,
         :fixed => TokyoCabinet::FDB
@@ -161,40 +163,50 @@ module Rufus::Edo
       # tune
 
       tuning_parameters = case conf[:type]
+        when :abstract then nil
         when :hash then [ :bnum, :apow, :fpow, :opts ]
         when :btree then [ :lmemb, :nmemb, :bnum, :apow, :fpow, :opts ]
         when :fixed then [ :bnum, :width, :limsiz ]
       end
 
-      @db.tune(*tuning_parameters.collect { |o| conf[o] })
+      @db.tune(*tuning_parameters.collect { |o| conf[o] }) \
+        if tuning_parameters
 
       #
       # set cache
 
       cache_values = case conf[:type]
+        when :abstract then nil
         when :hash then [ :rcnum ]
         when :btree then [ :lcnum, :ncnum ]
         when :fixed then nil
       end
 
-      @db.setcache(*cache_values.collect { |o| conf[o] }) if cache_values
+      @db.setcache(*cache_values.collect { |o| conf[o] }) \
+        if cache_values
 
       #
       # set xmsiz
 
-      @db.setxmsiz(conf[:xmsiz]) unless conf[:type] == :fixed
+      @db.setxmsiz(conf[:xmsiz]) \
+        unless [ :abstract, :fixed ].include?(conf[:type])
 
       #
       # set dfunit (TC > 1.4.21)
 
-      @db.setdfunit(conf[:dfunit]) if @db.respond_to?(:setdfunit)
+      @db.setdfunit(conf[:dfunit]) \
+        if @db.respond_to?(:setdfunit)
 
       #
       # open
 
       @path = conf[:path]
 
-      @db.open(@path, conf[:mode]) || raise_error
+      if @db.class.name == 'TokyoCabinet::ADB'
+        @db.open(@path) || raise_error
+      else
+        @db.open(@path, conf[:mode]) || raise_error
+      end
 
       #
       # default

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

@@ -113,39 +113,6 @@ module Rufus::Edo
       raise NotImplementedError.new('not creating files locally')
     end
 
-    # Deletes all the entries whose keys begin with the given prefix
-    #
-    def delete_keys_with_prefix (prefix)
-
-      @db.misc('outlist', @db.fwmkeys(prefix, -1)) # -1 for no limits
-      nil
-    end
-
-    # Given a list of keys, returns a Hash { key => value } of the
-    # matching entries (in one sweep).
-    #
-    def lget (keys)
-
-      Hash[*@db.misc('getlist', keys)]
-    end
-
-    # Merges the given hash into this Tyrant and returns self.
-    #
-    def merge! (hash)
-
-      @db.misc('putlist', hash.inject([]) { |l, (k, v)| l << k; l << v; l })
-      self
-    end
-    alias :lput :merge!
-
-    # Given a list of keys, deletes all the matching entries (in one sweep).
-    #
-    def ldelete (keys)
-
-      @db.misc('outlist', keys)
-      nil
-    end
-
     # Calls a lua embedded function
     # (http://tokyocabinet.sourceforge.net/tyrantdoc/#luaext)
     #

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

@@ -97,9 +97,7 @@ 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)
+    # Gets multiple records in one sweep.
     #
     def lget (keys)
 
@@ -107,6 +105,7 @@ module Rufus::Edo
       r = @db.mget(h)
 
       raise 'lget failure' if r == -1
+
       h
     end
 

data/lib/rufus/edo/tabcore.rb

@@ -162,19 +162,24 @@ module Rufus::Edo
     #
     def delete_keys_with_prefix (prefix)
 
-      ks = @db.fwmkeys(prefix, -1) # -1 for no limit
-      ks.each { |k| self.delete(k) }
+      if @db.respond_to?(:misc)
+        @db.misc('outlist', @db.fwmkeys(prefix, -1))
+      else
+        ks = @db.fwmkeys(prefix, -1) # -1 for no limit
+        ks.each { |k| self.delete(k) }
+      end
     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.
+    # Returns a hash { key => record } of all the records matching the
+    # given keys.
     #
     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 }
+      if @db.respond_to?(:mget)
+        @db.mget(keys)
+      else
+        keys.inject({}) { |h, k| v = self[k]; h[k] = v if v; h }
+      end
     end
 
     # Returns the number of records in this table db
@@ -187,8 +192,10 @@ module Rufus::Edo
     # Prepares a query instance (block is optional)
     #
     def prepare_query (&block)
+
       q = TableQuery.new(table_query_class, self)
       block.call(q) if block
+
       q
     end
 
@@ -200,6 +207,13 @@ module Rufus::Edo
       prepare_query(&block).run
     end
 
+    # Prepares, runs AND delete all the matching records.
+    #
+    def query_delete (&block)
+
+      prepare_query(&block).delete
+    end
+
     # Warning : this method is low-level, you probably only need
     # to use #transaction and a block.
     #
@@ -361,7 +375,7 @@ module Rufus::Edo
     #
     #   :numoreq # number which is equal to at least one token
     #
-    def add (colname, operator, val, affirmative=true, no_index=true)
+    def add (colname, operator, val, affirmative=true, no_index=false)
 
       op = operator.is_a?(Fixnum) ? operator : OPERATORS[operator]
       op = op | TDBQCNEGATE unless affirmative
@@ -415,12 +429,64 @@ module Rufus::Edo
       @opts[:no_pk] = on
     end
 
+    # Process each record using the supplied block, which will be passed
+    # two parameters, the primary key and the value hash.
+    #
+    # The block passed to this method accepts two parameters : the [String]
+    # primary key and a Hash of the values for the record.
+    #
+    # The return value of the passed block does matter. Three different
+    # values are expected :stop, :delete or a Hash instance.
+    #
+    # :stop will make the iteration stop, further matching records will not
+    # be passed to the block
+    #
+    # :delete will let Tokyo Cabinet delete the record just seen.
+    #
+    # a Hash is passed to let TC update the values for the record just seen.
+    #
+    # Passing an array is possible : [ :stop, { 'name' => 'Toto' } ] will
+    # update the record just seen to a unique column 'name' and will stop the
+    # iteration. Likewise, returning [ :stop, :delete ] will work as well.
+    #
+    def process (&block)
+
+      @query.proc() do |key, val|
+
+        r = block.call(key, val)
+        r = [ r ] unless r.is_a?(Array)
+
+        if updated_value = r.find { |e| e.is_a?(Hash) }
+          val.merge!(updated_value)
+        end
+
+        r.inject(0) { |i, v|
+          case v
+          when :stop then i = i | 1 << 24
+          when :delete then i = i | 2
+          when Hash then i = i | 1
+          end
+          i
+        }
+      end
+
+      self
+    end
+
     # Runs this query (returns a TableResultSet instance)
     #
     def run
+
       @last_resultset = TableResultSet.new(@table, @query.search, @opts)
     end
 
+    # Runs this query AND immediately let the matching records get deleted.
+    #
+    def delete
+
+      @query.searchout || @table.raise_error
+    end
+
     # Returns the count of results this query return when last run.
     # Returns 0 if the query was not yet run.
     #

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

@@ -456,18 +456,6 @@ module Rufus::Tokyo
     alias :add_int :incr
     alias :add_double :incr
 
-    # Warning : this method is low-level, you probably only need
-    # to use #transaction and a block.
-    #
-    # Direct call for 'transaction begin'.
-    #
-    def tranbegin
-
-      check_transaction_support
-
-      libcall(:tcadbtranbegin)
-    end
-
     # Triggers a defrag run (TC >= 1.4.21 only)
     #
     def defrag
@@ -480,6 +468,18 @@ module Rufus::Tokyo
       call_misc('defrag', Rufus::Tokyo::List.new)
     end
 
+    # Warning : this method is low-level, you probably only need
+    # to use #transaction and a block.
+    #
+    # Direct call for 'transaction begin'.
+    #
+    def tranbegin
+
+      check_transaction_support
+
+      libcall(:tcadbtranbegin)
+    end
+
     # Warning : this method is low-level, you probably only need
     # to use #transaction and a block.
     #

data/lib/rufus/tokyo/cabinet/lib.rb

@@ -176,6 +176,10 @@ module Rufus::Tokyo
     attfunc :qry_addcond, :tctdbqryaddcond, [ :pointer, :string, :int, :string ], :void
     attfunc :qry_setorder, :tctdbqrysetorder, [ :pointer, :string, :int ], :void
 
+    callback :TDBQRYPROC, [:pointer, :int, :pointer, :pointer], :int
+    attfunc :qry_proc, :tctdbqryproc, [ :pointer, :TDBQRYPROC, :pointer], :int
+
+
     begin # since TC 1.4.10
       attfunc :qry_setmax, :tctdbqrysetmax, [ :pointer, :int ], :void
     rescue FFI::NotFoundError => nfe
@@ -183,6 +187,7 @@ module Rufus::Tokyo
     end
 
     attfunc :qry_search, :tctdbqrysearch, [ :pointer ], :pointer
+    attfunc :qry_searchout, :tctdbqrysearchout, [ :pointer ], :int
 
     begin # since TC 1.4.12
       attfunc :qry_count, :tctdbqrycount, [ :pointer ], :int

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

@@ -331,8 +331,6 @@ module Rufus::Tokyo
     #
     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
 
@@ -360,9 +358,11 @@ module Rufus::Tokyo
 
       q = prepare_query(&block)
       rs = q.run
-      q.free
 
-      rs
+      return rs
+
+    ensure
+      q.free
     end
 
     # Prepares and runs a query, returns an array of hashes (all Ruby)
@@ -372,9 +372,24 @@ module Rufus::Tokyo
 
       rs = do_query(&block)
       a = rs.to_a
+
+      return a
+
+    ensure
       rs.free
+    end
+
+    # Prepares a query and then runs it and deletes all the results.
+    #
+    def query_delete (&block)
+
+      q = prepare_query(&block)
+      rs = q.delete
 
-      a
+      return rs
+
+    ensure
+      q.free
     end
 
     # Warning : this method is low-level, you probably only need
@@ -537,7 +552,7 @@ module Rufus::Tokyo
     #
     #   :numoreq # number which is equal to at least one token
     #
-    def add (colname, operator, val, affirmative=true, no_index=true)
+    def add (colname, operator, val, affirmative=true, no_index=false)
 
       op = operator.is_a?(Fixnum) ? operator : OPERATORS[operator]
       op = op | TDBQCNEGATE unless affirmative
@@ -584,9 +599,61 @@ module Rufus::Tokyo
     # (hashes) returned
     #
     def no_pk (on=true)
+
       @opts[:no_pk] = on
     end
 
+    # Process each record using the supplied block, which will be passed
+    # two parameters, the primary key and the value hash.
+    #
+    # The block passed to this method accepts two parameters : the [String]
+    # primary key and a Hash of the values for the record.
+    #
+    # The return value of the passed block does matter. Three different
+    # values are expected :stop, :delete or a Hash instance.
+    #
+    # :stop will make the iteration stop, further matching records will not
+    # be passed to the block
+    #
+    # :delete will let Tokyo Cabinet delete the record just seen.
+    #
+    # a Hash is passed to let TC update the values for the record just seen.
+    #
+    # Passing an array is possible : [ :stop, { 'name' => 'Toto' } ] will
+    # update the record just seen to a unique column 'name' and will stop the
+    # iteration. Likewise, returning [ :stop, :delete ] will work as well.
+    #
+    # (by Matthew King)
+    #
+    def process (&block)
+
+      callback = lambda do |pk, pklen, map, opt_param|
+
+        key = pk.read_string(pklen)
+        val = Rufus::Tokyo::Map.new(map).to_h
+
+        r = block.call(key, val)
+        r = [ r ] unless r.is_a?(Array)
+
+        if updated_value = r.find { |e| e.is_a?(Hash) }
+          Rufus::Tokyo::Map.new(map).merge!(updated_value)
+        end
+
+        r.inject(0) { |i, v|
+          case v
+          when :stop then i = i | 1 << 24
+          when :delete then i = i | 2
+          when Hash then i = i | 1
+          end
+          i
+        }
+      end
+
+      lib.qry_proc(@query, callback, nil)
+
+      self
+    end
+
     # Runs this query (returns a TableResultSet instance)
     #
     def run
@@ -595,6 +662,13 @@ module Rufus::Tokyo
         TableResultSet.new(@table, lib.qry_search(@query), @opts)
     end
 
+    # Runs this query AND let all the matching records get deleted.
+    #
+    def delete
+
+      lib.qry_searchout(@query) || raise_error
+    end
+
     # Gets the count of records returned by this query.
     #
     # Note : the 'real' impl is only available since TokyoCabinet 1.4.12.

data/lib/rufus/tokyo/tyrant/lib.rb

@@ -143,6 +143,7 @@ module Rufus::Tokyo
     end
 
     attfunc :qry_search, :tcrdbqrysearch, [ :pointer ], :pointer
+    attfunc :qry_searchout, :tcrdbqrysearchout, [ :pointer ], :int
 
     begin # since TC 1.4.21
       attfunc :qry_count, :tcrdbqrysearchcount, [ :pointer ], :int

data/lib/rufus/tokyo.rb

@@ -29,7 +29,7 @@ require 'ffi' # sudo gem install ffi
 module Rufus
 module Tokyo
 
-  VERSION = '0.1.13'
+  VERSION = '0.1.14'
 
   #
   # A common error class

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-tokyo
 version: !ruby/object:Gem::Version 
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-02 00:00:00 +09:00
+date: 2009-06-30 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -29,7 +29,7 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.txt
+- README.rdoc
 - CHANGELOG.txt
 - CREDITS.txt
 files: 
@@ -64,8 +64,8 @@ files:
 - CHANGELOG.txt
 - CREDITS.txt
 - LICENSE.txt
-- README.txt
 - TODO.txt
+- README.rdoc
 has_rdoc: true
 homepage: http://rufus.rubyforge.org/
 licenses: []