rufus-tokyo 0.1.14 → 1.0.0

data/lib/rufus/tokyo.rb

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

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

@@ -24,6 +24,7 @@
 
 
 require 'rufus/tokyo/transactions'
+require 'rufus/tokyo/outlen'
 
 
 module Rufus::Tokyo
@@ -52,6 +53,7 @@ module Rufus::Tokyo
 
     include HashMethods
     include Transactions
+    include Outlen
 
     # Creates/opens the cabinet, raises an exception in case of
     # creation/opening failure.
@@ -189,8 +191,8 @@ module Rufus::Tokyo
 
       name = name + params.collect { |k, v| "##{k}=#{v}" }.join('')
 
-      (lib.tcadbopen(@db, name) == 1) ||
-        raise("failed to open/create db '#{name}'  #{params.inspect}")
+      (lib.tcadbopen(@db, name) == 1) || raise(
+        TokyoError.new("failed to open/create db '#{name}' #{params.inspect}"))
 
       self.default = params[:default]
       @default_proc ||= params[:default_proc]
@@ -249,6 +251,8 @@ module Rufus::Tokyo
     #
     def []= (k, v)
 
+      k = k.to_s; v = v.to_s
+
       lib.abs_put(@db, k, Rufus::Tokyo.blen(k), v, Rufus::Tokyo.blen(v))
     end
 
@@ -257,6 +261,8 @@ module Rufus::Tokyo
     #
     def putkeep (k, v)
 
+      k = k.to_s; v = v.to_s
+
       (lib.abs_putkeep(
         @db, k, Rufus::Tokyo.blen(k), v, Rufus::Tokyo.blen(v)) == 1)
     end
@@ -265,6 +271,8 @@ module Rufus::Tokyo
     #
     def get (k)
 
+      k = k.to_s
+
       outlen_op(:abs_get, k, Rufus::Tokyo.blen(k))
     end
     protected :get
@@ -274,6 +282,8 @@ module Rufus::Tokyo
     #
     def delete (k)
 
+      k = k.to_s
+
       v = self[k]
 
       (lib.abs_out(@db, k, Rufus::Tokyo.blen(k)) == 1) ? v : nil
@@ -412,6 +422,8 @@ module Rufus::Tokyo
     #
     def lget (keys)
 
+      keys = keys.collect { |k| k.to_s }
+
       Hash[*call_misc('getlist', Rufus::Tokyo::List.new(keys))]
     end
 
@@ -421,7 +433,12 @@ module Rufus::Tokyo
 
       call_misc(
         'putlist',
-        hash.inject(Rufus::Tokyo::List.new) { |l, (k, v)| l << k; l << v; l })
+        hash.inject(Rufus::Tokyo::List.new) { |l, (k, v)|
+          l << k.to_s
+          l << v.to_s
+          l
+        })
+
       self
     end
     alias :lput :merge!
@@ -430,6 +447,8 @@ module Rufus::Tokyo
     #
     def ldelete (keys)
 
+      keys = keys.collect { |k| k.to_s }
+
       call_misc('outlist', Rufus::Tokyo::List.new(keys))
     end
 
@@ -440,6 +459,8 @@ module Rufus::Tokyo
     #
     def incr (key, inc=1)
 
+      key = key.to_s
+
       v = inc.is_a?(Fixnum) ?
         lib.addint(@db, key, Rufus::Tokyo.blen(key), inc) :
         lib.adddouble(@db, key, Rufus::Tokyo.blen(key), inc)
@@ -475,7 +496,7 @@ module Rufus::Tokyo
     #
     def tranbegin
 
-      check_transaction_support
+      #check_transaction_support
 
       libcall(:tcadbtranbegin)
     end
@@ -487,7 +508,7 @@ module Rufus::Tokyo
     #
     def trancommit
 
-      check_transaction_support
+      #check_transaction_support
 
       libcall(:tcadbtrancommit)
     end
@@ -499,20 +520,19 @@ module Rufus::Tokyo
     #
     def tranabort
 
-      check_transaction_support
+      #check_transaction_support
 
       libcall(:tcadbtranabort)
     end
 
     protected
 
-    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
+    #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)
@@ -544,25 +564,6 @@ module Rufus::Tokyo
         raise TokyoError.new("call to #{lib_method} failed")
     end
 
-    # A wrapper for library returning a string (binary data potentially)
-    #
-    def outlen_op (method, *args)
-
-      args.unshift(@db)
-
-      outlen = FFI::MemoryPointer.new(:int)
-      args << outlen
-
-      out = lib.send(method, *args)
-
-      return nil if out.address == 0
-
-      return out.get_bytes(0, outlen.get_int(0))
-
-    ensure
-
-      outlen.free
-    end
   end
 end
 

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

@@ -29,18 +29,20 @@ module Rufus::Tokyo
   # The libtokyocabinet.so methods get bound to this module
   #
   module CabinetLib #:nodoc#
+
     extend FFI::Library
 
     #
     # find Tokyo Cabinet lib
 
-    paths = Array(ENV['TOKYO_CABINET_LIB'] || %w{
+    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
-    })
+    ])
 
     begin
 
@@ -107,12 +109,10 @@ module Rufus::Tokyo
     attfunc :addint, :tcadbaddint, [ :pointer, :string, :int, :int ], :int
     attfunc :adddouble, :tcadbadddouble, [ :pointer, :string, :int, :double ], :double
 
-    begin # since TC 1.4.13
-      attfunc :tcadbtranbegin, [ :pointer ], :int
-      attfunc :tcadbtrancommit, [ :pointer ], :int
-      attfunc :tcadbtranabort, [ :pointer ], :int
-    rescue FFI::NotFoundError => nfe
-    end
+    # since TC 1.4.13
+    attfunc :tcadbtranbegin, [ :pointer ], :int
+    attfunc :tcadbtrancommit, [ :pointer ], :int
+    attfunc :tcadbtranabort, [ :pointer ], :int
 
     #
     # tctdb functions
@@ -125,10 +125,8 @@ module Rufus::Tokyo
     attfunc :tctdbsetcache, [ :pointer, :uint32, :uint32, :uint32 ], :int
     attfunc :tctdbsetxmsiz, [ :pointer, :uint64 ], :int
 
-    begin # since TC 1.4.21
-      attfunc :tctdbsetdfunit, [ :pointer, :uint32 ], :int
-    rescue FFI::NotFoundError => nfe
-    end
+    # since TC 1.4.21
+    attfunc :tctdbsetdfunit, [ :pointer, :uint32 ], :int
 
     attfunc :tctdbopen, [ :pointer, :string, :int ], :int
 
@@ -189,10 +187,8 @@ module Rufus::Tokyo
     attfunc :qry_search, :tctdbqrysearch, [ :pointer ], :pointer
     attfunc :qry_searchout, :tctdbqrysearchout, [ :pointer ], :int
 
-    begin # since TC 1.4.12
-      attfunc :qry_count, :tctdbqrycount, [ :pointer ], :int
-    rescue FFI::NotFoundError => nfe
-    end
+    # since TC 1.4.12
+    attfunc :qry_count, :tctdbqrycount, [ :pointer ], :int
 
     #
     # tcmap functions
@@ -225,6 +221,5 @@ module Rufus::Tokyo
     attfunc :tclistremove, [ :pointer, :int, :pointer ], :pointer
     attfunc :tclistdel, [ :pointer ], :void
   end
-
 end
 

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

@@ -23,6 +23,7 @@
 #++
 
 
+require 'rufus/tokyo/utils'
 require 'rufus/tokyo/query'
 require 'rufus/tokyo/config'
 require 'rufus/tokyo/transactions'
@@ -188,6 +189,10 @@ module Rufus::Tokyo
     INDEX_TYPES = {
       :lexical => 0,
       :decimal => 1,
+      :token => 2,
+      :qgram => 3,
+      :opt => 9998,
+      :optimized => 9998,
       :void => 9999,
       :remove => 9999,
       :keep => 1 << 24
@@ -195,7 +200,17 @@ module Rufus::Tokyo
 
     # Sets an index on a column of the table.
     #
-    # Types maybe be :lexical or :decimal, use :keep to "add" and
+    # Types maybe be :lexical or :decimal.
+    #
+    # Recently (TC 1.4.26 and 1.4.27) inverted indexes have been added,
+    # they are :token and :qgram. There is an :opt index as well.
+    #
+    # Sorry couldn't find any good doc about those inverted indexes apart from :
+    #
+    #   http://alpha.mixi.co.jp/blog/?p=1147
+    #   http://www.excite-webtl.jp/world/english/web/?wb_url=http%3A%2F%2Falpha.mixi.co.jp%2Fblog%2F%3Fp%3D1147&wb_lp=JAEN&wb_dis=2&wb_submit=+%96%7C+%96%F3+
+    #
+    # Use :keep to "add" and
     # :remove (or :void) to "remove" an index.
     #
     # If column_name is :pk or "", the index will be set on the primary key.
@@ -204,7 +219,7 @@ module Rufus::Tokyo
     #
     def set_index (column_name, *types)
 
-      column_name = '' if column_name == :pk
+      column_name = column_name == :pk ? '' : column_name.to_s
 
       i = types.inject(0) { |i, t| i = i | INDEX_TYPES[t]; i }
 
@@ -224,6 +239,9 @@ module Rufus::Tokyo
     #
     def []= (pk, h_or_a)
 
+      pk = pk.to_s
+      h_or_a = Rufus::Tokyo.h_or_a_to_s(h_or_a)
+
       m = Rufus::Tokyo::Map[h_or_a]
 
       r = lib.tab_put(@db, pk, Rufus::Tokyo.blen(pk), m.pointer)
@@ -242,6 +260,8 @@ module Rufus::Tokyo
     #
     def delete (k)
 
+      k = k.to_s
+
       v = self[k]
       return nil unless v
       libcall(:tab_out, k, Rufus::Tokyo.blen(k))
@@ -305,7 +325,7 @@ module Rufus::Tokyo
 
     ensure
 
-      outlen.free if outlen
+      outlen && outlen.free
     end
 
     # Deletes all the entries whose key begin with the given prefix.
@@ -321,7 +341,7 @@ module Rufus::Tokyo
         ks = Rufus::Tokyo::List.new(ks)
         ks.each { |k| self.delete(k) }
       ensure
-        ks.free
+        ks && ks.free
       end
     end
 
@@ -331,7 +351,7 @@ module Rufus::Tokyo
     #
     def lget (keys)
 
-      keys.inject({}) { |h, k| v = self[k]; h[k] = v if v; h }
+      keys.inject({}) { |h, k| k = k.to_s; v = self[k]; h[k] = v if v; h }
     end
 
     # Returns the number of records in this table db
@@ -362,7 +382,7 @@ module Rufus::Tokyo
       return rs
 
     ensure
-      q.free
+      q && q.free
     end
 
     # Prepares and runs a query, returns an array of hashes (all Ruby)
@@ -376,7 +396,7 @@ module Rufus::Tokyo
       return a
 
     ensure
-      rs.free
+      rs && rs.free
     end
 
     # Prepares a query and then runs it and deletes all the results.
@@ -389,7 +409,7 @@ module Rufus::Tokyo
       return rs
 
     ensure
-      q.free
+      q && q.free
     end
 
     # Warning : this method is low-level, you probably only need
@@ -398,7 +418,6 @@ module Rufus::Tokyo
     # Direct call for 'transaction begin'.
     #
     def tranbegin
-
       libcall(:tctdbtranbegin)
     end
 
@@ -443,10 +462,10 @@ module Rufus::Tokyo
 
     def libcall (lib_method, *args)
 
-      #(lib.send(lib_method, @db, *args) == 1) or raise_error
+      (lib.send(lib_method, @db, *args) == 1) or raise_error
         # stack level too deep with JRuby 1.1.6 :(
 
-      (eval(%{ lib.#{lib_method}(@db, *args) }) == 1) or raise_error
+      #(eval(%{ lib.#{lib_method}(@db, *args) }) == 1) or raise_error
         # works with JRuby 1.1.6
     end
 
@@ -552,8 +571,18 @@ module Rufus::Tokyo
     #
     #   :numoreq # number which is equal to at least one token
     #
+    #   :ftsph # full-text phrase search
+    #   :ftsphrase
+    #   :phrase
+    #   :ftsand # full-text AND
+    #   :ftsor # full-text OR
+    #   :ftsex # full-text with 'compound' expression
+    #
     def add (colname, operator, val, affirmative=true, no_index=false)
 
+      colname = colname.to_s
+      val = val.to_s
+
       op = operator.is_a?(Fixnum) ? operator : OPERATORS[operator]
       op = op | TDBQCNEGATE unless affirmative
       op = op | TDBQCNOIDX if no_index
@@ -585,13 +614,15 @@ module Rufus::Tokyo
     #   :numdesc
     #
     def order_by (colname, direction=:strasc)
-      lib.qry_setorder(@query, colname, DIRECTIONS[direction])
+
+      lib.qry_setorder(@query, colname.to_s, DIRECTIONS[direction])
     end
 
     # When set to true, only the primary keys of the matching records will
     # be returned.
     #
     def pk_only (on=true)
+
       @opts[:pk_only] = on
     end
 
@@ -658,8 +689,8 @@ module Rufus::Tokyo
     #
     def run
 
-      @last_resultset =
-        TableResultSet.new(@table, lib.qry_search(@query), @opts)
+      #@last_resultset =
+      TableResultSet.new(@table, lib.qry_search(@query), @opts)
     end
 
     # Runs this query AND let all the matching records get deleted.
@@ -675,16 +706,17 @@ module Rufus::Tokyo
     #
     def count
 
-      if lib.respond_to?(:qry_count)
-        lib.qry_count(@query)
-      else
-        @last_resultset ? @last_resultset.size : 0
-      end
+      #if lib.respond_to?(:qry_count)
+      lib.qry_count(@query)
+      #else
+      #  @last_resultset ? @last_resultset.size : 0
+      #end
     end
 
     # Frees this data structure
     #
     def free
+
       lib.qry_del(@query)
       @query = nil
     end
@@ -719,6 +751,7 @@ module Rufus::Tokyo
     # The classical each
     #
     def each
+
       (0..size-1).each do |i|
         pk = @list[i]
         if @opts[:pk_only]
@@ -745,9 +778,9 @@ module Rufus::Tokyo
       @list.free
       @list = nil
     end
-
     alias :close :free
     alias :destroy :free
+
   end
 end