rufus-tokyo 0.1.7 → 0.1.8

data/CHANGELOG.txt

@@ -2,6 +2,13 @@
 = rufus-tokyo CHANGELOG.txt
 
 
+== rufus-tokyo - 0.1.8    released 2009/02/27
+
+- added : support for Hirabayashi-san 'native' Ruby classes via Rufus::Edo
+- todo  : implemented #delete_keys_with_prefix (naive impl for tables)
+- added : lget/ldelete and merge! to Rufus::Tokyo::Cabinet and ::Tyrant
+
+
 == rufus-tokyo - 0.1.7    released 2009/02/19
 
 - todo  : Rufus::Tokyo::Cabinet.new('filename', :type => :hash) now OK (Zev)

data/CREDITS.txt

@@ -5,10 +5,14 @@
 == authors
 
 John Mettraux  http://jmettraux.wordpress.com
-Justin Reagor  http://blog.kineticweb.com/
 Zev Blut  http://www.iknow.co.jp/users/zev
 
 
+== contributors
+
+Justin Reagor  http://blog.kineticweb.com/
+
+
 == finally
 
 many thanks to the author of Tokyo Cabinet (Mikio Hirabayashi) and 

data/README.txt

@@ -13,6 +13,13 @@ The 'abstract' and the 'table' API are covered for now.
   (see after 'usage' for how to install Tokyo Cabinet (and Tyrant) if required)
 
 
+== Rufus::Edo
+
+Note : Rufus::Tokyo focuses on leveraging Hirabayashi-san's C libraries via ruby-ffi, but the gem rufus-tokyo also contains Rufus::Edo which wraps the Tokyo Cabinet/Tyrant author's [native] C bindings :
+
+  http://github.com/jmettraux/rufus-tokyo/tree/master/lib/rufus/edo
+
+
 == usage
 
 hereafter TC references Tokyo Cabinet, while TT references Tokyo Tyrant.
@@ -48,7 +55,7 @@ http://tokyocabinet.sourceforge.net/spex-en.html#tctdbapi
   require 'rubygems'
   require 'rufus/tokyo'
 
-  t = Rufus::Tokyo::Table.new('table.tdb')
+  t = Rufus::Tokyo::Table.new('table.tct')
 
   t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
   t['pk1'] = { 'name' => 'bob', 'age' => '18' }
@@ -123,6 +130,19 @@ Rufus::Tokyo::Tyrant instances have a #stat method :
     #   fd => 7
 
 
+Note that it's also OK to make a Tokyo Tyrant server listen on a unix socket :
+
+  ttserver -host /tmp/ttsocket -port 0 data.tch
+
+and then :
+
+  require 'rubygems'
+  require 'rufus/tokyo/tyrant'
+  db = Rufus::Tokyo::Tyrant.new('/tmp/ttsocket')
+  db['a'] = 'alpha'
+  db.close
+
+
 === TT remote table
 
 to start a ttserver (backed by a table), on the command line :
@@ -172,6 +192,19 @@ Rufus::Tokyo::TyrantTable instances have a #stat method :
     #   fd => 10
 
 
+Note that it's also OK to make a Tokyo Tyrant server listen on a unix socket :
+
+  ttserver -host /tmp/tttsocket -port 0 data.tct
+
+and then :
+
+  require 'rubygems'
+  require 'rufus/tokyo/tyrant'
+  t = Rufus::Tokyo::TyrantTable.new('/tmp/tttsocket')
+  t['customer0'] = { 'name' => 'Heike no Kyomori', 'age' => '75' }
+  t.close
+
+
 == rdoc
 
 more in the rdoc
@@ -239,7 +272,6 @@ many thanks to the author of Tokyo Cabinet, Mikio Hirabayashi, and to the author
 == authors
 
 John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
-Justin Reagor, http://blog.kineticweb.com/
 Zev Blut, http://www.iknow.co.jp/users/zev
 
 

data/TODO.txt

@@ -1,5 +1,14 @@
 
-[ ] implement keys and values
-[ ] wire optimize()
+[ ] table : bench find(1) after set_index
+[ ] table : bench insert(1) after set_index
+
+[x] align edo#new on tokyo#new
+[ ] horizontal (bdb hdb fdb) tests for tokyo and edo
+
+[x] rdoc unix socket for tyrant
+[x] edo : tran
+[ ] bench ux socket
+[ ] impl lget/lput/ldelete in Rufus::Edo::Cabinet
+
 [ ] maybe supported different libs for migrations...
 

data/lib/rufus-edo.rb

@@ -0,0 +1,3 @@
+
+require 'rufus/edo'
+

data/lib/rufus/edo.rb

@@ -0,0 +1,44 @@
+#
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++
+#
+
+#
+# "made in Japan"
+#
+# jmettraux@gmail.com
+#
+
+begin
+
+  require 'tokyocabinet'
+
+rescue LoadError
+
+  raise LoadError.new(
+    "tokyocabinet 'native' C bindings not present on your system, " +
+    "see http://github.com/jmettraux/rufus-tokyo/tree/master/lib/rufus/edo")
+end
+
+require 'rufus/edo/cabinet/abstract'
+require 'rufus/edo/cabinet/table'
+

data/lib/rufus/edo/cabcore.rb

@@ -0,0 +1,292 @@
+#
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#++
+#
+
+#
+# "made in Japan"
+#
+# jmettraux@gmail.com
+#
+
+require 'rufus/tokyo/hmethods'
+require 'rufus/tokyo/transactions'
+
+
+module Rufus::Edo
+
+  #
+  # The base cabinet methods are gathered here. They focus on wrapping
+  # Hirabayashi-san's methods.
+  #
+  # This module is included by Edo::Cabinet and Edo::NTyrant. Placing the
+  # methods in this module avoids having to load 'TokyoCabinet' when using
+  # only rufus/edo/ntyrant.
+  #
+  module CabinetCore
+
+    include Rufus::Tokyo::HashMethods
+    include Rufus::Tokyo::Transactions
+
+    def self.included (target_module)
+
+      target_module.module_eval do
+        #
+        # Same args as initialize, but can take a block form that will
+        # close the db when done. Similar to File.open (via Zev)
+        #
+        def self.open (name, params={})
+          db = self.new(name, params)
+          if block_given?
+            yield db
+            nil
+          else
+            db
+          end
+        ensure
+          db.close if block_given? && db
+        end
+      end
+    end
+
+    #
+    # No comment
+    #
+    def []= (k, v)
+      @db.put(k, v) || raise_error
+    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.
+    #
+    def delete (k)
+      v = self[k]
+      @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).
+    #
+    def clear
+      @db.vanish || raise_error
+      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.
+    #
+    def close
+      @db.close || raise_error
+    end
+
+    #
+    # Copies the current cabinet to a new file.
+    #
+    # Returns true if it was successful.
+    #
+    def copy (target_path)
+      @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
+    # space, hence the 'compact' label...
+    #
+    def compact_copy (target_path)
+      @other_db = self.class.new(target_path)
+      self.each { |k, v| @other_db[k] = v }
+      @other_db.close
+    end
+
+    #
+    # "synchronize updated contents of an abstract database object with
+    # the file and the device"
+    #
+    def sync
+      @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)
+    # in a Ruby array.
+    #
+    #   :prefix --> returns only the keys who match a given string prefix
+    #
+    #   :limit --> returns a limited number of keys
+    #
+    def keys (options={})
+
+      if pref = options[:prefix]
+
+        @db.fwmkeys(pref, options[:limit] || -1)
+
+      else
+
+        limit = options[:limit] || -1
+        limit = nil if limit < 1
+
+        l = []
+
+        @db.iterinit
+
+        while (k = @db.iternext)
+          break if limit and l.size >= limit
+          l << k
+        end
+
+        l
+      end
+    end
+
+    #
+    # Deletes all the entries whose keys begin with the given prefix
+    #
+    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) }
+      nil
+    end
+
+    #
+    # Given a list of keys, returns a Hash { key => value } of the
+    # matching entries (in one sweep).
+    #
+    # Warning : this is a naive (slow) implementation.
+    #
+    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 }
+    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
+    #++
+    alias :lput :merge!
+
+    #
+    # Given a list of keys, deletes all the matching entries (in one sweep).
+    #
+    # Warning : this is a naive (slow) implementation.
+    #
+    def ldelete (keys)
+
+      #call_misc('outlist', Rufus::Tokyo::List.new(keys))
+      keys.each { |k| self.delete(k) }
+      nil
+    end
+
+    #
+    # 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
+    #     db['a'] = 'alpha'
+    #     db['b'] = 'bravo'
+    #     db.abort if something_went_wrong?
+    #   end
+    #
+    # Note that fixed-length dbs do not support transactions. It will result
+    # in a NoMethodError.
+    #
+    def tranbegin
+      @db.tranbegin
+    end
+
+    #
+    # This is rather low-level use #transaction and a block for a higher-level
+    # technique.
+    #
+    # Note that fixed-length dbs do not support transactions. It will result
+    # in a NoMethodError.
+    #
+    def trancommit
+      @db.trancommit
+    end
+
+    #
+    # This is rather low-level use #transaction and a block for a higher-level
+    # technique.
+    #
+    # Note that fixed-length dbs do not support transactions. It will result
+    # in a NoMethodError.
+    #
+    def tranabort
+      @db.tranabort
+    end
+
+    protected
+
+    def raise_error
+      code = @db.ecode
+      message = @db.errmsg(code)
+      raise EdoError.new("(err #{code}) #{message}")
+    end
+  end
+end
+