rufus-tokyo 1.0.0 → 1.0.1

data/CHANGELOG.txt

@@ -2,6 +2,16 @@
 = rufus-tokyo CHANGELOG.txt
 
 
+== rufus-tokyo - 1.0.1    released 2009/09/18
+
+- todo      : add #putcat to Cabinet / Tyrant (Edo and Tokyo)
+- todo      : implemented search/union/intersection/difference for tables
+- todo      : added #putdup and #get4 to Cabinet (Edo and Tokyo)
+- todo      : better dylib 'detection' (Pietro Ferrari)
+- todo      : aliased lget to mget (thanks Runa)
+- todo      : proper Abort exception (Kenneth Kalmer)
+
+
 == rufus-tokyo - 1.0.0    released 2009/07/23
 
 - todo      : merged in Jeremy Hinegardner's Dystopia work

data/CREDITS.txt

@@ -11,6 +11,8 @@ Jeremy Hinegardner  http://www.copiousfreetime.org/
 
 == contributors
 
+Pietro Ferrari  http://github.com/pietroferrari
+Kenneth Kalmer  http://www.opensourcery.co.za/
 Adam Keys  http://github.com/therealadam
 Marcos Piccinini  http://github.com/nofxx
 Matthew King  http://github.com/automatthew
@@ -22,6 +24,9 @@ Mark 'mebaran'  http://github.com/mebaran
 
 == feedback / support
 
+James Edward Gray II  http://blog.grayproductions.net/
+Alexandre Gravem
+Philippe Monnet  http://blog.monnet-usa.com/
 Ilya Grigorik  http://igvita.com
 Elise Huard  http://blog.elisehuard.be/
 

data/README.rdoc

@@ -31,15 +31,27 @@ the rdoc is at http://rufus.rubyforge.org/rufus-tokyo/
 
 this 'master' branch/version of rufus-tokyo works with
 
-  ffi 0.3.1, 0.3.5
+  ffi 0.3.1, 0.3.5, 0.4.0, 0.5.0
 
   ruby 1.8.6
   ruby 1.9.1p129
   jruby 1.1.6, 1.2.0, 1.3.1
 
-  TC 1.4.27 / 28 and TT 1.1.29
+  TC 1.4.27 / 29 and TT 1.1.29 / 33
 
-  tc-ruby 1.26 and tt-ruby 1.10 (Rufus::Edo)
+  tc-ruby 1.26 / 29 and tt-ruby 1.10 / 12 (Rufus::Edo)
+
+
+== Rufus::Tokyo : pointing to the right library
+
+By default Rufus::Tokyo (the FFI side) searches for Tokyo Cabinet and Tyrant dynamic libraries under /usr/lib/, /usr/lib64/, /opt/local/lib/ and /usr/local/lib/
+
+If you had to install Tokyo Cabinet (and Tokyo Tyrant) in another location, you can set the environment variables TOKYO_CABINET_LIB and TOKYO_TYRANT_LIB to point to the absolute path of the dynamic library, like in :
+
+  export TOKYO_CABINET_LIB = /home/toto/tc/libtokyocabinet.so
+  export TOKYO_TYRANT_LIB = /home/toto/tc/libtokyotyrant.so
+
+So that your rufus-tokyo enabled Ruby application can see the libraries.
 
 
 === TC Abstract API

data/TODO.txt

@@ -34,4 +34,5 @@
 
 [ ] implement q.metasearch(q, u)
 [ ] kwic ?
+[x] maybe Edo::Abort vs Tokyo::Abort
 

data/lib/rufus/edo/cabcore.rb

@@ -79,7 +79,8 @@ module Rufus::Edo
       @db.put(k, v) || raise_error
     end
 
-    # No comment
+    # Like #put but doesn't overwrite the value if already set. Returns true
+    # only if there no previous entry for k.
     #
     def putkeep (k, v)
 
@@ -88,6 +89,18 @@ module Rufus::Edo
       @db.putkeep(k, v)
     end
 
+    # Appends the given string at the end of the current string value for key k.
+    # If there is no record for key k, a new record will be created.
+    #
+    # Returns true if successful.
+    #
+    def putcat (k, v)
+
+      k = k.to_s; v = v.to_s
+
+      @db.putcat(k, v)
+    end
+
     # (The actual #[] method is provided by HashMethods)
     #
     def get (k)
@@ -235,6 +248,8 @@ module Rufus::Edo
       end
     end
 
+    alias :mget :lget
+
     # Default impl provided by HashMethods
     #
     def merge! (hash)

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

@@ -214,6 +214,23 @@ module Rufus::Edo
       self.default = params[:default]
       @default_proc ||= params[:default_proc]
     end
+
+    # This is a B+ Tree method only, puts a value for a key who has
+    # [potentially] multiple values.
+    #
+    def putdup (k, v)
+
+      @db.putdup(k, v)
+    end
+
+    # This is a B+ Tree method only, returns all the values for a given
+    # key.
+    #
+    def get4 (k)
+
+      @db.getlist(k)
+    end
+    alias :getdup :get4
   end
 end
 

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

@@ -109,6 +109,8 @@ module Rufus::Edo
       h
     end
 
+    alias :mget :lget
+
     def transaction #:nodoc#
       raise NoMethodError.new("NetTyrant : transactions not supported")
     end

data/lib/rufus/edo/tabcore.rb

@@ -202,6 +202,8 @@ module Rufus::Edo
       end
     end
 
+    alias :mget :lget
+
     # Returns the number of records in this table db
     #
     def size
@@ -272,8 +274,120 @@ module Rufus::Edo
       @db
     end
 
+    # Returns the union of the listed queries
+    #
+    #   r = table.union(
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # will return a hash { primary_key => record } of the values matching
+    # the first query OR the second.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def union (*queries)
+
+      search(:union, *queries)
+    end
+
+    # Returns the intersection of the listed queries
+    #
+    #   r = table.intersection(
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # will return a hash { primary_key => record } of the values matching
+    # the first query AND the second.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def intersection (*queries)
+
+      search(:intersection, *queries)
+    end
+
+    # Returns the difference of the listed queries
+    #
+    #   r = table.intersection(
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # will return a hash { primary_key => record } of the values matching
+    # the first query OR the second but not both.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def difference (*queries)
+
+      search(:difference, *queries)
+    end
+
+    # A #search a la ruby-tokyotyrant
+    # (http://github.com/actsasflinn/ruby-tokyotyrant/tree)
+    #
+    #   r = table.search(
+    #     :intersection,
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # Accepts the symbols :union, :intersection, :difference or :diff as
+    # first parameter.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def search (type, *queries)
+
+      run_query = true
+      run_query = queries.pop if queries.last == false
+
+      raise(
+        ArgumentError.new("pass at least one prepared query")
+      ) if queries.size < 1
+
+      t = META_TYPES[type]
+
+      raise(
+        ArgumentError.new("no search type #{type.inspect}")
+      ) unless t
+
+      q = queries.shift.original
+      qs = queries.collect { |qq| qq.original }
+
+      pks = q.metasearch(qs, META_TYPES[type])
+
+      run_query ? lget(pks) : pks
+    end
+
     protected
 
+    META_TYPES = {
+      :union => 0, :intersection => 1, :difference => 2, :diff => 2
+    }
+
     # Returns the value (as a Ruby Hash) else nil
     #
     # (the actual #[] method is provided by HashMethods)
@@ -335,6 +449,13 @@ module Rufus::Edo
       @opts = {}
     end
 
+    # Returns the original, underlying RDBQUERY instance.
+    #
+    def original
+
+      @query
+    end
+
     # Adds a condition
     #
     #   table.query { |q|

data/lib/rufus/tokyo.rb

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

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

@@ -267,6 +267,19 @@ module Rufus::Tokyo
         @db, k, Rufus::Tokyo.blen(k), v, Rufus::Tokyo.blen(v)) == 1)
     end
 
+    # Appends the given string at the end of the current string value for key k.
+    # If there is no record for key k, a new record will be created.
+    #
+    # Returns true if successful.
+    #
+    def putcat (k, v)
+
+      k = k.to_s; v = v.to_s
+
+      (lib.abs_putcat(
+        @db, k, Rufus::Tokyo.blen(k), v, Rufus::Tokyo.blen(v)) == 1)
+    end
+
     # (The actual #[] method is provided by HashMethods
     #
     def get (k)
@@ -427,6 +440,8 @@ module Rufus::Tokyo
       Hash[*call_misc('getlist', Rufus::Tokyo::List.new(keys))]
     end
 
+    alias :mget :lget
+
     # Merges the given hash into this Cabinet (or Tyrant) and returns self.
     #
     def merge! (hash)
@@ -525,14 +540,55 @@ module Rufus::Tokyo
       libcall(:tcadbtranabort)
     end
 
+    #--
+    #
+    # BTREE methods
+    #
+    #++
+
+    # This is a B+ Tree method only, puts a value for a key who has
+    # [potentially] multiple values.
+    #
+    def putdup (k, v)
+
+      lib.tcbdbputdup(
+        as_btree, k, Rufus::Tokyo.blen(k), v, Rufus::Tokyo.blen(v))
+    end
+
+    # This is a B+ Tree method only, returns all the values for a given
+    # key.
+    #
+    def get4 (k)
+
+      l = lib.tcbdbget4(as_btree, k, Rufus::Tokyo.blen(k))
+
+      Rufus::Tokyo::List.new(l).release
+    end
+    alias :getdup :get4
+
     protected
 
+    # Returns the pointer to the btree hiding behind the abstract structure.
+    #
+    # Will raise an argument error if the structure behind the abstract db
+    # is not a B+ Tree structure.
+    #
+    def as_btree
+
+      raise(NoMethodError.new("cannot call B+ Tree function on #{@path}")) \
+        if ! @path.match(/\.tcb$/)
+
+      lib.tcadbreveal(@db)
+    end
+
+    #--
     #def check_transaction_support
     #  raise(TokyoError.new(
     #    "The version of Tokyo Cabinet you're using doesn't support " +
     #    "transactions for non-table structures. Upgrade to TC >= 1.4.13.")
     #  ) unless lib.respond_to?(:tcadbtranbegin)
     #end
+    #++
 
     # Wrapping tcadbmisc or tcrdbmisc
     # (and taking care of freeing the list_pointer)

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

@@ -35,14 +35,9 @@ module Rufus::Tokyo
     #
     # find Tokyo Cabinet lib
 
-    paths = Array(ENV['TOKYO_CABINET_LIB'] || %w[
-      /usr/lib/libtokyocabinet.so
-      /usr/lib64/libtokyocabinet.so
-      /opt/local/lib/libtokyocabinet.dylib
-      /opt/local/lib/libtokyocabinet.so
-      /usr/local/lib/libtokyocabinet.dylib
-      /usr/local/lib/libtokyocabinet.so
-    ])
+    paths =
+      Array(ENV['TOKYO_CABINET_LIB'] ||
+      Dir['/{opt,usr}/{,local/}lib{,64}/libtokyocabinet.{dylib,so*}'])
 
     begin
 
@@ -93,6 +88,7 @@ module Rufus::Tokyo
     attfunc :abs_out, :tcadbout, [ :pointer, :pointer, :int ], :int
 
     attfunc :abs_putkeep, :tcadbputkeep, [ :pointer, :pointer, :int, :pointer, :int ], :int
+    attfunc :abs_putcat, :tcadbputcat, [ :pointer, :pointer, :int, :pointer, :int ], :int
 
     attfunc :abs_iterinit, :tcadbiterinit, [ :pointer ], :int
     attfunc :abs_iternext, :tcadbiternext, [ :pointer, :pointer ], :pointer
@@ -109,6 +105,8 @@ module Rufus::Tokyo
     attfunc :addint, :tcadbaddint, [ :pointer, :string, :int, :int ], :int
     attfunc :adddouble, :tcadbadddouble, [ :pointer, :string, :int, :double ], :double
 
+    attfunc :tcadbreveal, [ :pointer ], :pointer
+
     # since TC 1.4.13
     attfunc :tcadbtranbegin, [ :pointer ], :int
     attfunc :tcadbtrancommit, [ :pointer ], :int
@@ -163,6 +161,8 @@ module Rufus::Tokyo
 
     attfunc :tab_fwmkeys, :tctdbfwmkeys, [ :pointer, :pointer, :int, :int ], :pointer
 
+    attfunc :tab_metasearch, :tctdbmetasearch, [ :pointer, :int, :int ], :pointer
+
     #
     # tctdbqry functions
     #
@@ -190,6 +190,14 @@ module Rufus::Tokyo
     # since TC 1.4.12
     attfunc :qry_count, :tctdbqrycount, [ :pointer ], :int
 
+    #
+    # tcbdb functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tcbdbapi
+
+    attfunc :tcbdbputdup, [ :pointer, :pointer, :int, :pointer, :int ], :int
+    attfunc :tcbdbget4, [ :pointer, :pointer, :int ], :pointer
+
     #
     # tcmap functions
     #

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

@@ -354,6 +354,8 @@ module Rufus::Tokyo
       keys.inject({}) { |h, k| k = k.to_s; v = self[k]; h[k] = v if v; h }
     end
 
+    alias :mget :lget
+
     # Returns the number of records in this table db
     #
     def size
@@ -442,11 +444,132 @@ module Rufus::Tokyo
     # Returns the actual pointer to the Tokyo Cabinet table
     #
     def pointer
+
       @db
     end
 
+    # Returns the union of the listed queries
+    #
+    #   r = table.union(
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # will return a hash { primary_key => record } of the values matching
+    # the first query OR the second.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def union (*queries)
+
+      search(:union, *queries)
+    end
+
+    # Returns the intersection of the listed queries
+    #
+    #   r = table.intersection(
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # will return a hash { primary_key => record } of the values matching
+    # the first query AND the second.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def intersection (*queries)
+
+      search(:intersection, *queries)
+    end
+
+    # Returns the difference of the listed queries
+    #
+    #   r = table.intersection(
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # will return a hash { primary_key => record } of the values matching
+    # the first query OR the second but not both.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def difference (*queries)
+
+      search(:difference, *queries)
+    end
+
+    # A #search a la ruby-tokyotyrant
+    # (http://github.com/actsasflinn/ruby-tokyotyrant/tree)
+    #
+    #   r = table.search(
+    #     :intersection,
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'es'
+    #     },
+    #     @t.prepare_query { |q|
+    #       q.add 'lang', :includes, 'li'
+    #     }
+    #   )
+    #
+    # Accepts the symbols :union, :intersection, :difference or :diff as
+    # first parameter.
+    #
+    # If the last element element passed to this method is the value 'false',
+    # the return value will the array of matching primary keys.
+    #
+    def search (type, *queries)
+
+      run_query = true
+      run_query = queries.pop if queries.last == false
+
+      raise(
+        ArgumentError.new("pass at least one prepared query")
+      ) if queries.size < 1
+
+      raise(
+        ArgumentError.new("pass instances of Rufus::Tokyo::TableQuery only")
+      ) if queries.find { |q| q.class != TableQuery }
+
+      t = META_TYPES[type]
+
+      raise(
+        ArgumentError.new("no search type #{type.inspect}")
+      ) unless t
+
+      qs = FFI::MemoryPointer.new(:pointer, queries.size)
+      qs.write_array_of_pointer(queries.collect { |q| q.pointer })
+
+      r = lib.tab_metasearch(qs, queries.size, t)
+
+      qs.free
+
+      pks = Rufus::Tokyo::List.new(r).release
+
+      run_query ? lget(pks) : pks
+    end
+
     protected
 
+    META_TYPES = {
+      :union => 0, :intersection => 1, :difference => 2, :diff => 2
+    }
+
     # Returns the value (as a Ruby Hash) else nil
     #
     # (the actual #[] method is provided by HashMethods)
@@ -510,10 +633,20 @@ module Rufus::Tokyo
       @opts = {}
     end
 
+    # Returns the FFI lib the table uses.
+    #
     def lib
+
       @table.lib
     end
 
+    # Returns the underlying pointer.
+    #
+    def pointer
+
+      @query
+    end
+
     # Adds a condition
     #
     #   table.query { |q|

data/lib/rufus/tokyo/dystopia/lib.rb

@@ -35,14 +35,7 @@ module Rufus::Tokyo
     #
     # find Tokyo Dystopia lib
 
-    paths = Array(ENV['TOKYO_DYSTOPIA_LIB'] || %w{
-      /usr/lib/libtokyodystopia.so
-      /usr/lib64/libtokyodystopia.so
-      /opt/local/lib/libtokyodystopia.dylib
-      /opt/local/lib/libtokyodystopia.so
-      /usr/local/lib/libtokyodystopia.dylib
-      /usr/local/lib/libtokyodystopia.so
-    })
+    paths = Array(ENV['TOKYO_DYSTOPIA_LIB'] || Dir['/{opt,usr}/{,local/}lib{,64}/libtokyodystopia.{dylib,so*}'])
 
     path = paths.find { |path| File.exist?(path) }
 

data/lib/rufus/tokyo/transactions.rb

@@ -54,8 +54,11 @@ module Tokyo
         tranbegin
         yield
         trancommit
+      rescue Rufus::Tokyo::Transactions::Abort
+        tranabort
       rescue Exception => e
         tranabort
+        raise e
       end
     end
 
@@ -65,8 +68,13 @@ module Tokyo
     # See #transaction
     #
     def abort
-      raise "abort transaction !"
+      raise Abort, "abort transaction !"
     end
+
+    #
+    # Exception used to abort transactions
+    #
+    class Abort < RuntimeError; end
   end
 
 end

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

@@ -35,14 +35,7 @@ module Rufus::Tokyo
     #
     # find Tokyo Tyrant lib
 
-    paths = Array(ENV['TOKYO_TYRANT_LIB'] || %w[
-      /usr/lib/libtokyotyrant.so
-      /usr/lib64/libtokyotyrant.so
-      /opt/local/lib/libtokyotyrant.dylib
-      /opt/local/lib/libtokyotyrant.so
-      /usr/local/lib/libtokyotyrant.dylib
-      /usr/local/lib/libtokyotyrant.so
-    ])
+    paths = Array(ENV['TOKYO_TYRANT_LIB'] || Dir['/{opt,usr}/{,local/}lib{,64}/libtokyotyrant.{dylib,so*}'])
 
     begin
 
@@ -82,6 +75,7 @@ module Rufus::Tokyo
     attfunc :abs_out, :tcrdbout, [ :pointer, :pointer, :int ], :int
 
     attfunc :abs_putkeep, :tcrdbputkeep, [ :pointer, :pointer, :int, :pointer, :int ], :int
+    attfunc :abs_putcat, :tcrdbputcat, [ :pointer, :pointer, :int, :pointer, :int ], :int
 
     attfunc :abs_iterinit, :tcrdbiterinit, [ :pointer ], :int
     attfunc :abs_iternext, :tcrdbiternext, [ :pointer, :pointer ], :pointer
@@ -128,6 +122,8 @@ module Rufus::Tokyo
 
     attfunc :tab_fwmkeys, :tcrdbfwmkeys, [ :pointer, :pointer, :int, :int ], :pointer
 
+    attfunc :tab_metasearch, :tcrdbmetasearch, [ :pointer, :int, :int ], :pointer
+
     #
     # qry functions
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rufus-tokyo
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - John Mettraux
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-23 00:00:00 +09:00
+date: 2009-09-18 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: 
 - ffi
 rubyforge_project: rufus
-rubygems_version: 1.3.2
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: ruby-ffi based lib to access Tokyo Cabinet and Tyrant