rufus-tokyo 1.0.3 → 1.0.4

data/.gitignore

@@ -0,0 +1,4 @@
+ext/*
+tmp/*
+pkg/*
+*~

data/CHANGELOG.txt

@@ -2,6 +2,12 @@
 = rufus-tokyo CHANGELOG.txt
 
 
+== rufus-tokyo - 1.0.4    released 2009/12/25
+
+- bug   : memory leak, gotten values not freed
+- todo  : Rufus::Tokyo::Tyrant and TyrantTable now reconnets (120 seconds)
+
+
 == rufus-tokyo - 1.0.3    released 2009/11/16
 
 - bug   : newer versions of FFI have [undocumented] bool type. Adapted.

data/Rakefile

@@ -0,0 +1,91 @@
+
+
+require 'lib/rufus/tokyo/version.rb'
+
+require 'rubygems'
+require 'rake'
+
+
+#
+# CLEAN
+
+require 'rake/clean'
+CLEAN.include('pkg', 'tmp', 'html')
+task :default => [ :clean ]
+
+
+#
+# GEM
+
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+
+  gem.version = Rufus::Tokyo::VERSION
+  gem.name = 'rufus-tokyo'
+
+  gem.summary =
+    'ruby-ffi based lib to access Tokyo Cabinet, Tyrant and Dystopia'
+  gem.description = %{
+Ruby-ffi based lib to access Tokyo Cabinet and Tyrant.
+
+The ffi-based structures are available via the Rufus::Tokyo namespace.
+There is a Rufus::Edo namespace that interfaces with Hirabayashi-san's native Ruby interface, and whose API is equal to the Rufus::Tokyo one.
+
+Finally rufus-tokyo includes ffi-based interfaces to Tokyo Dystopia (thanks to Jeremy Hinegardner).
+  }
+
+  gem.email = 'jmettraux@gmail.com'
+  gem.homepage = 'http://github.com/jmettraux/rufus-tokyo/'
+
+  gem.authors = [
+    'John Mettraux', 'Zev Blut', 'Jeremy Hinegardner', 'James Edward Gray II' ]
+
+  gem.rubyforge_project = 'rufus'
+
+  gem.test_file = 'spec/spec.rb'
+
+  gem.add_dependency 'ffi'
+  gem.add_development_dependency 'yard', '>= 0'
+
+  #gem.files = Dir['lib/**/*.rb'] + Dir['*.txt'] - [ 'lib/tokyotyrant.rb' ]
+  #gem.files.reject! { |fn| fn == 'lib/tokyotyrant.rb' }
+
+  # gemspec spec : http://www.rubygems.org/read/chapter/20
+end
+Jeweler::GemcutterTasks.new
+
+
+#
+# DOC
+
+begin
+
+  require 'yard'
+
+  YARD::Rake::YardocTask.new do |doc|
+    doc.options = [
+      '-o', 'html/rufus-tokyo', '--title',
+      "rufus-tokyo #{Rufus::Tokyo::VERSION}"
+    ]
+  end
+
+rescue LoadError
+
+  task :yard do
+    abort "YARD is not available : sudo gem install yard"
+  end
+end
+
+
+#
+# TO THE WEB
+
+task :upload_website => [ :clean, :yard ] do
+
+  account = 'jmettraux@rubyforge.org'
+  webdir = '/var/www/gforge-projects/rufus'
+
+  sh "rsync -azv -e ssh html/rufus-tokyo #{account}:#{webdir}/"
+end
+

data/lib/rufus/edo/README.txt

@@ -0,0 +1,101 @@
+
+= Rufus::Edo
+
+wrapping Hirabayashi-san's 'native' ruby bindings into a rubiyst-friendly set of Ruby classes.
+
+In order to use Rufus::Edo, you have to have the libtokyocabinet dynamic library installed on your system :
+
+  http://openwferu.rubyforge.org/tokyo.html
+
+Then you can install the 'native' C bindings.
+
+NOTE : I have only tested those native bindings with Ruby 1.8.6. To run them with JRuby, the best option is Rufus::Tokyo and its FFI bindings.
+
+NOTE : the Ruby tyrant library provided by Hirabayashi-san is not a C binding, it's a pure Ruby connector. It is slower than Rufus::Tokyo::Tyrant and Rufus::Tokyo::TyrantTable, but the advantage is that there is no need to install cabinet and tyrant C libraries to connect your Ruby code to your Tokyo Tyrant.
+
+
+== installation of the 'native' C bindings
+
+=== directly from http://1978th.net/tokyocabinet/
+
+Get the tokyocabinet-ruby package at :
+
+  http://1978th.net/tokyocabinet/rubypkg/
+
+unpack it :
+
+  tar xzvf tokyocabinet-ruby-1.29.tar.gz
+  cd tokyocabinet-ruby-1.29
+
+and then, as described at : http://tokyocabinet.sourceforge.net/rubydoc/
+
+  ruby extconf.rb
+  make
+  sudo make install
+
+
+== Rufus::Edo::Cabinet
+
+  require 'rufus/edo' # sudo gem install rufus-tokyo
+
+  db = Rufus::Edo::Cabinet.new('data.tch')
+
+  db['a'] = 'alpha'
+
+  # ...
+
+  db.close
+
+
+== Rufus::Edo::Table
+
+  require 'rufus/edo'
+
+  db = Rufus::Edo::Table.new('data.tct')
+
+  db['customer1'] = { 'name' => 'Taira no Kyomori', 'age' => '55' }
+
+  # ...
+
+  db.close
+
+
+== tyrant
+
+Hirabayashi-san's pure Ruby gem for accessing Tokyo Tyrant can be installed with :
+
+  sudo gem install careo-tokyotyrant --source http://gems.github.com
+
+It's also available at :
+
+  http://sourceforge.net/project/showfiles.php?group_id=200242
+  http://github.com/careo/tokyotyrant-ruby
+
+
+== Rufus::Edo::NetTyrant
+
+Note : 'NetTyrant' instead of 'Tyrant' to clearly show that this class isn't a C binding but a simple [pure Ruby] network implementation of a connection to a Tyrant.
+
+
+  require 'rufus/edo/ntyrant'
+
+  db = Rufus::Edo::NetTyrant.new('127.0.0.1', 45000)
+
+  db['a'] = 'alpha'
+
+  puts db['a]
+    # => 'alpha'
+
+  db.close
+
+
+== Rufus::Edo::NetTyrantTable
+
+  require 'rufus/edo/ntyrant'
+
+  t = Rufus::Edo::NetTyrantTable.new('127.0.0.1', 44502)
+
+  t['client0'] = { 'name' => 'Heike no Kyomori', 'country' => 'jp' }
+
+  t.close
+

data/lib/rufus/edo/tabcore.rb

@@ -533,9 +533,7 @@ module Rufus::Edo
     #
     def limit (i, offset=-1)
 
-      @query.respond_to?(:setlimit) ?
-        @query.setlimit(i, offset) :
-        @query.setmax(i)
+      @query.setlimit(i, offset)
     end
 
     # Sets the sort order for the result of the query

data/lib/rufus/tokyo.rb

@@ -29,8 +29,6 @@ require 'ffi' # sudo gem install ffi
 module Rufus
 module Tokyo
 
-  VERSION = '1.0.3'
-
   #
   # A common error class
   #
@@ -51,6 +49,7 @@ module Tokyo
 end
 end
 
+require 'rufus/tokyo/version'
 require 'rufus/tokyo/cabinet/lib'
 require 'rufus/tokyo/cabinet/util'
 require 'rufus/tokyo/cabinet/abstract'

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

@@ -46,7 +46,7 @@ module Rufus::Tokyo
     rescue LoadError => le
       raise(
         "didn't find Tokyo Cabinet libs on your system. " +
-        "Please install Tokyo Cabinet (http://tokyocabinet.sf.net) " +
+        "Please install Tokyo Cabinet (http://1978th.net/tokyocabinet/) " +
         "(see also http://openwferu.rubyforge.org/tokyo.html)"
       )
     end
@@ -66,6 +66,8 @@ module Rufus::Tokyo
     #
     attfunc :tcfree, [ :pointer ], :void
 
+    attfunc :free, [ :pointer ], :void
+
     #
     # tcadb functions
     #
@@ -177,12 +179,7 @@ module Rufus::Tokyo
     callback :TDBQRYPROC, [:pointer, :int, :pointer, :pointer], :int
     attfunc :qry_proc, :tctdbqryproc, [ :pointer, :TDBQRYPROC, :pointer], :bool
 
-
-    begin # since TC 1.4.10
-      attfunc :qry_setmax, :tctdbqrysetmax, [ :pointer, :int ], :void
-    rescue FFI::NotFoundError => nfe
-      attfunc :qry_setlimit, :tctdbqrysetlimit, [ :pointer, :int, :int ], :void
-    end
+    attfunc :qry_setlimit, :tctdbqrysetlimit, [ :pointer, :int, :int ], :void
 
     attfunc :qry_search, :tctdbqrysearch, [ :pointer ], :pointer
     attfunc :qry_searchout, :tctdbqrysearchout, [ :pointer ], :bool

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

@@ -43,8 +43,7 @@ module Rufus::Tokyo
   #   require 'rubygems'
   #   require 'rufus/tokyo/cabinet/table'
   #
-  #   t = Rufus::Tokyo::Table.new('table.tdb', :create, :write)
-  #     # '.tdb' suffix is a must
+  #   t = Rufus::Tokyo::Table.new('table.tct')
   #
   #   t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
   #   t['pk1'] = { 'name' => 'bob', 'age' => '18' }
@@ -76,10 +75,10 @@ module Rufus::Tokyo
     #
     # For example,
     #
-    #   t = Rufus::Tokyo::Table.new('table.tdb')
-    #     # '.tdb' suffix is a must
+    #   t = Rufus::Tokyo::Table.new('table.tct')
+    #     # '.tct' suffix is a must
     #
-    # will create the table.tdb (or simply open it if already present)
+    # will create the table.tct (or simply open it if already present)
     # and make sure we have write access to it.
     #
     # == parameters
@@ -118,11 +117,11 @@ module Rufus::Tokyo
     #
     # Some examples :
     #
-    #   t = Rufus::Tokyo::Table.new('table.tdb')
-    #   t = Rufus::Tokyo::Table.new('table.tdb#mode=r')
-    #   t = Rufus::Tokyo::Table.new('table.tdb', :mode => 'r')
-    #   t = Rufus::Tokyo::Table.new('table.tdb#opts=ld#mode=r')
-    #   t = Rufus::Tokyo::Table.new('table.tdb', :opts => 'ld', :mode => 'r')
+    #   t = Rufus::Tokyo::Table.new('table.tct')
+    #   t = Rufus::Tokyo::Table.new('table.tct#mode=r')
+    #   t = Rufus::Tokyo::Table.new('table.tct', :mode => 'r')
+    #   t = Rufus::Tokyo::Table.new('table.tct#opts=ld#mode=r')
+    #   t = Rufus::Tokyo::Table.new('table.tct', :opts => 'ld', :mode => 'r')
     #
     def initialize (path, params={})
 
@@ -722,9 +721,7 @@ module Rufus::Tokyo
     #
     def limit (i, offset=-1)
 
-      lib.respond_to?(:qry_setlimit) ?
-        lib.qry_setlimit(@query, i, offset) :
-        lib.qry_setmax(@query, i)
+      lib.qry_setlimit(@query, i, offset)
     end
 
     # Sets the sort order for the result of the query

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

@@ -63,11 +63,14 @@ module Rufus::Tokyo
 
       return nil if out.address == 0
 
-      return out.get_bytes(0, outlen.get_int(0))
+      out.get_bytes(0, outlen.get_int(0))
 
     ensure
 
       outlen.free
+
+      #clib.free(out)
+        # uncommenting that wreaks havoc
     end
   end
 

data/lib/rufus/tokyo/hmethods.rb

@@ -59,19 +59,19 @@ module Tokyo
     # Our classical 'each'
     #
     def each
-      # 
+      #
       # drop to Edo's C API calls to avoid two-step iteration
       # (keys() then each())
-      # 
+      #
       if defined?(@db) and %w[iterinit iternext].all? { |m| @db.respond_to?(m) }
         @db.iterinit
         while k = @db.iternext
           yield(k, self[k])
         end
-      # 
+      #
       # drop to Tokyo's FFI calls to avoid two-step iteration
       # (keys() then each())
-      # 
+      #
       elsif self.class.name != "Rufus::Tokyo::Table" and # use String for Edo
             defined?(@db)                            and
             respond_to?(:lib)                        and

data/lib/rufus/tokyo/outlen.rb

@@ -37,9 +37,13 @@ module Rufus::Tokyo
       out = lib.send(method, *args)
 
       return nil if out.address == 0
-      return out.get_bytes(0, outlen.get_int(0))
+
+      out.get_bytes(0, outlen.get_int(0))
+
     ensure
       outlen.free
+      #lib.tcfree(out)
+      lib.free(out)
     end
   end
 end

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

@@ -114,6 +114,14 @@ module Rufus::Tokyo
 
       self.default = params[:default]
       @default_proc ||= params[:default_proc]
+
+      #
+      # timeout and reconnect
+
+      # defaults to two minutes
+
+      timeout = params[:timeout] || 120.0
+      lib.tcrdbtune(@db, timeout, 1)
     end
 
     # Using the tyrant lib

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

@@ -44,7 +44,7 @@ module Rufus::Tokyo
     rescue LoadError => le
       raise(
         "didn't find Tokyo Tyrant libs on your system. " +
-        "Please install Tokyo Tyrant (http://tokyocabinet.sf.net) " +
+        "Please install Tokyo Tyrant (http://1978th.net/tokyotyrant/) " +
         "(see also http://openwferu.rubyforge.org/tokyo.html)"
       )
     end
@@ -54,6 +54,8 @@ module Rufus::Tokyo
       alias :attfunc :attach_function
     end
 
+    attfunc :free, [ :pointer ], :void
+
     # http://1978th.net/tokyotyrant/spex.html#tcrdbapi
 
     #
@@ -63,6 +65,8 @@ module Rufus::Tokyo
 
     attfunc :tcrdbstat, [ :pointer ], :string
 
+    attfunc :tcrdbtune, [ :pointer, :double, :int ], :bool
+
     attfunc :tcrdbopen, [ :pointer, :string, :int ], :bool
     attfunc :abs_close, :tcrdbclose, [ :pointer ], :bool
 
@@ -138,11 +142,7 @@ module Rufus::Tokyo
     attfunc :qry_addcond, :tcrdbqryaddcond, [ :pointer, :string, :int, :string ], :void
     attfunc :qry_setorder, :tcrdbqrysetorder, [ :pointer, :string, :int ], :void
 
-    begin
-      attfunc :qry_setmax, :tcrdbqrysetmax, [ :pointer, :int ], :void
-    rescue FFI::NotFoundError => nfe
-      attfunc :qry_setlimit, :tcrdbqrysetlimit, [ :pointer, :int, :int ], :void
-    end
+    attfunc :qry_setlimit, :tcrdbqrysetlimit, [ :pointer, :int, :int ], :void
 
     attfunc :qry_search, :tcrdbqrysearch, [ :pointer ], :pointer
     attfunc :qry_searchout, :tcrdbqrysearchout, [ :pointer ], :bool

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

@@ -75,7 +75,7 @@ module Rufus::Tokyo
     #   t['client0'] = { 'name' => 'Theodore Roosevelt', 'country' => 'usa' }
     #   t.close
     #
-    def initialize (host, port=0)
+    def initialize (host, port=0, params={})
 
       @db = lib.tcrdbnew
 
@@ -95,6 +95,14 @@ module Rufus::Tokyo
       end
 
       @default_proc = nil
+
+      #
+      # timeout and reconnect
+
+      # defaults to two minutes
+
+      timeout = params[:timeout] || 120.0
+      lib.tcrdbtune(@db, timeout, 1)
     end
 
     #