rufus-tokyo 0.1.14 → 1.0.0

data/CHANGELOG.txt

@@ -2,6 +2,15 @@
 = rufus-tokyo CHANGELOG.txt
 
 
+== rufus-tokyo - 1.0.0    released 2009/07/23
+
+- todo      : merged in Jeremy Hinegardner's Dystopia work
+- issue #13 : to_s for keys and values (thanks Elise and Ilya)
+- todo      : added full-text search ops :ftsphrase, :ftsex, :ftsor and :ftsand
+- todo      : added inverted index types, :token, :qgram, :opt
+- todo      : dropped 'backward compability' TC[/TT] 1.4.28+ ftw
+
+
 == rufus-tokyo - 0.1.14    released 2009/06/30
 
 - issue #2 : query#add with no_index=false by default

data/CREDITS.txt

@@ -6,17 +6,26 @@
 
 John Mettraux  http://jmettraux.wordpress.com
 Zev Blut  http://www.iknow.co.jp/users/zev
+Jeremy Hinegardner  http://www.copiousfreetime.org/
 
 
 == contributors
 
+Adam Keys  http://github.com/therealadam
+Marcos Piccinini  http://github.com/nofxx
 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
+Benjamin Yu  http://github.com/byu
 Mark 'mebaran'  http://github.com/mebaran
 
 
+== feedback / support
+
+Ilya Grigorik  http://igvita.com
+Elise Huard  http://blog.elisehuard.be/
+
+
 == finally
 
 many thanks to the author of Tokyo Cabinet (Mikio Hirabayashi) and 

data/README.rdoc

@@ -29,7 +29,7 @@ the rdoc is at http://rufus.rubyforge.org/rufus-tokyo/
 
 == version [mis]match
 
-this version of rufus-tokyo works with
+this 'master' branch/version of rufus-tokyo works with
 
   ffi 0.3.1, 0.3.5
 
@@ -37,16 +37,8 @@ this version of rufus-tokyo works with
   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 1.4.27 / 28 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)
 
 
@@ -268,6 +260,10 @@ On the rufus-ruby list :
 
   http://groups.google.com/group/rufus-ruby
 
+Note : Flinn Muller started an english speaking mailing list for TC / TT / TD 
+
+  http://groups.google.com/group/tokyocabinet-users
+
 
 == issue tracker
 
@@ -293,12 +289,14 @@ many thanks to the author of Tokyo Cabinet, Mikio Hirabayashi, and to the author
 * http://tokyocabinet.sourceforge.net
 * http://kenai.com/projects/ruby-ffi
 
+dystopia interface developed with and sponsored by Seven Scale <http://sevenscale.com/>,
+creators of Open Syslog.
 
 == authors
 
 * John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
 * Zev Blut, http://www.iknow.co.jp/users/zev
-
+* Jeremy Hinegardner http://github.com/copiousfreetime (Tokyo Dystopia)
 
 == the rest of Rufus
 

data/TODO.txt

@@ -7,19 +7,31 @@
 
 [o] rdoc unix socket for tyrant
 [o] edo : tran
-[ ] bench ux socket
+[x] bench ux socket
 
 [o] TT (TC) call [lua] function
-[ ] queryout
+[o] queryout
 
 [o] impl lget/lput/ldelete in Rufus::Edo::Cabinet
 
-[ ] maybe supported different libs for migrations...
+[x] maybe supported different libs for migrations...
+    no, tctools are here for that.
 
-[ ] document ENV['TOKYO_TYRANT_LIB'] & _CABINET_
+[ ] document ENV['TOKYO_TYRANT_LIB'] & _CABINET_ / LD_LIBRARY_PATH
 
 [o] unify m/l raise trick for util map/list
 
-[ ] misc calls (defrag) for Edo
+[o] misc calls (defrag) for Edo
 [ ] TT set master & co
 
+[o] drop 'backward compatibility' (post 0.1.14)
+[o] qgram, token, opt inverted index types
+[o] new query FTS conds
+
+[ ] table/delete_keys_with_prefix, use searchout
+
+[ ] first integration of Jeremy's work on Dystopia
+
+[ ] implement q.metasearch(q, u)
+[ ] kwic ?
+

data/lib/rufus/edo/cabcore.rb

@@ -73,19 +73,26 @@ module Rufus::Edo
     # No comment
     #
     def []= (k, v)
+
+      k = k.to_s; v = v.to_s
+
       @db.put(k, v) || raise_error
     end
 
     # No comment
     #
     def putkeep (k, v)
+
+      k = k.to_s; v = v.to_s
+
       @db.putkeep(k, v)
     end
 
     # (The actual #[] method is provided by HashMethods)
     #
     def get (k)
-      @db.get(k)
+
+      @db.get(k.to_s)
     end
     protected :get
 
@@ -93,13 +100,17 @@ module Rufus::Edo
     # else nil.
     #
     def delete (k)
+
+      k = k.to_s
       v = self[k]
+
       @db.out(k) ? v : nil
     end
 
     # Returns the number of records in the 'cabinet'
     #
     def size
+
       @db.rnum
     end
 
@@ -108,13 +119,16 @@ module Rufus::Edo
     # 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
 
@@ -122,6 +136,7 @@ module Rufus::Edo
     # returns true in case of success.
     #
     def close
+
       @db.close || raise_error
     end
 
@@ -130,6 +145,7 @@ module Rufus::Edo
     # Returns true if it was successful.
     #
     def copy (target_path)
+
       @db.copy(target_path)
     end
 
@@ -139,6 +155,7 @@ module Rufus::Edo
     # 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
@@ -148,6 +165,7 @@ module Rufus::Edo
     # the file and the device"
     #
     def sync
+
       @db.sync || raise_error
     end
 
@@ -206,6 +224,8 @@ module Rufus::Edo
     #
     def lget (keys)
 
+      keys = keys.collect { |k| k.to_s }
+
       # only ADB has the #misc method...
 
       if @db.respond_to?(:misc)
@@ -215,8 +235,7 @@ module Rufus::Edo
       end
     end
 
-    #
-    # default impl provided by HashMethods
+    # Default impl provided by HashMethods
     #
     def merge! (hash)
 
@@ -237,6 +256,8 @@ module Rufus::Edo
     #
     def ldelete (keys)
 
+      keys = keys.collect { |k| k.to_s }
+
       # only ADB has the #misc method...
 
       if @db.respond_to?(:misc)
@@ -253,6 +274,8 @@ module Rufus::Edo
     #
     def incr (key, val=1)
 
+      key = key.to_s
+
       v = val.is_a?(Fixnum) ? @db.addint(key, val) : @db.adddouble(key, val)
 
       raise(EdoError.new(
@@ -271,9 +294,9 @@ module Rufus::Edo
     #
     def defrag
 
-      raise(NotImplementedError.new(
-        "defrag (misc) only available when opening db with :type => :abstract"
-      )) unless @db.respond_to?(:misc)
+      #raise(NotImplementedError.new(
+      #  "defrag (misc) only available when opening db with :type => :abstract"
+      #)) unless @db.respond_to?(:misc)
 
       @db.misc('defrag', [])
     end

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

@@ -122,7 +122,7 @@ module Rufus::Edo
     #
     # Nil is returned in case of failure.
     #
-    def ext (func_name, key, value, opts={})
+    def ext (func_name, key='', value='', opts={})
 
       @db.ext(func_name.to_s, key.to_s, value.to_s, compute_ext_opts(opts))
     end

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

@@ -125,6 +125,20 @@ module Rufus::Edo
       raise NoMethodError.new("NetTyrant : transactions not supported")
     end
 
+    # Calls a lua embedded function
+    # (http://tokyocabinet.sourceforge.net/tyrantdoc/#luaext)
+    #
+    # Options are :global_locking and :record_locking
+    #
+    # Returns the return value of the called function.
+    #
+    # Nil is returned in case of failure.
+    #
+    def ext (func_name, key='', value='', opts={})
+
+      @db.ext(func_name.to_s, key.to_s, value.to_s, compute_ext_opts(opts))
+    end
+
     protected
 
     def table_query_class #:nodoc#

data/lib/rufus/edo/tabcore.rb

@@ -23,6 +23,7 @@
 #++
 
 
+require 'rufus/tokyo/utils'
 require 'rufus/tokyo/query'
 require 'rufus/tokyo/transactions'
 
@@ -55,6 +56,10 @@ module Rufus::Edo
     INDEX_TYPES = {
       :lexical => 0,
       :decimal => 1,
+      :token => 2,
+      :qgram => 3,
+      :opt => 9998,
+      :optimized => 9998,
       :void => 9999,
       :remove => 9999,
       :keep => 1 << 24
@@ -62,16 +67,26 @@ module Rufus::Edo
 
     # 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.
     #
-    # Raises an exception in case of failure.
+    # Returns true in case of success.
     #
     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 }
 
@@ -91,9 +106,12 @@ module Rufus::Edo
     #
     def []= (pk, h_or_a)
 
+      pk = pk.to_s
+
       m = h_or_a.is_a?(Hash) ? h_or_a : Hash[*h_or_a]
+      m = Rufus::Tokyo.h_or_a_to_s(m)
 
-      verify_value(m)
+      #verify_value(m)
 
       @db.put(pk, m) || raise_error
     end
@@ -107,7 +125,7 @@ module Rufus::Edo
     #
     def delete (k)
 
-      # have to work around... :(
+      k = k.to_s
 
       val = @db[k]
       return nil unless val
@@ -175,6 +193,8 @@ module Rufus::Edo
     #
     def lget (keys)
 
+      keys = Rufus::Tokyo::h_or_a_to_s(keys)
+
       if @db.respond_to?(:mget)
         @db.mget(keys)
       else
@@ -260,7 +280,7 @@ module Rufus::Edo
     #
     def get (k)
 
-      @db.get(k)
+      @db.get(k.to_s)
     end
 
     # Obviously something went wrong, let's ask the db about it and raise
@@ -274,17 +294,14 @@ module Rufus::Edo
       raise EdoError.new("(err #{err_code}) #{err_msg}")
     end
 
-    def verify_value (h)
-
-      h.each { |k, v|
-
-        next if k.is_a?(String) and v.is_a?(String)
-
-        raise ArgumentError.new(
-          "only String keys and values are accepted " +
-          "( #{k.inspect} => #{v.inspect} )")
-      }
-    end
+    #def verify_value (h)
+    #  h.each { |k, v|
+    #    next if k.is_a?(String) and v.is_a?(String)
+    #    raise ArgumentError.new(
+    #      "only String keys and values are accepted " +
+    #      "( #{k.inspect} => #{v.inspect} )")
+    #  }
+    #end
   end
 
   #
@@ -375,8 +392,18 @@ module Rufus::Edo
     #
     #   :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
@@ -410,7 +437,7 @@ module Rufus::Edo
     #
     def order_by (colname, direction=:strasc)
 
-      @query.setorder(colname, DIRECTIONS[direction])
+      @query.setorder(colname.to_s, DIRECTIONS[direction])
     end
 
     # When set to true, only the primary keys of the matching records will