ntalbott-rufus-tokyo 0.1.14

data/CHANGELOG.txt

@@ -0,0 +1,112 @@
+
+= rufus-tokyo CHANGELOG.txt
+
+
+== rufus-tokyo - 0.1.14    not yet released
+
+- issue #2 : query#add with no_index=false by default
+- issue #1 : added query#delete and table#query_delete
+
+
+== rufus-tokyo - 0.1.13    released 2009/06/02
+
+- todo  : putkeep implementation (by Kamal)
+- todo  : support for binary data (map, list, cabinet, table, tokyo/edo)
+- todo  : added #defrag to Rufus::Tokyo::Cabinet
+- todo  : added :dfunit to databases that support it
+- todo  : added #addint and #adddouble (#incr)
+
+
+== rufus-tokyo - 0.1.12    released 2009/04/07
+
+- todo  : added ext method for calling embedded Lua function (Tyrant)
+- todo  : added transaction support for Rufus::Tokyo::Cabinet
+- todo  : mimicking query.count in rufus/edo
+- todo  : implemented query.count (TC 1.4.12 and TT 1.1.20 only) rufus/tokyo
+
+
+== rufus-tokyo - 0.1.11    released 2009/03/25
+
+- todo  : autodetecting /usr/lib/libtokyocabinet.so and
+          /usr/lib/libtokyotyrant.so (thanks mebaran)
+
+
+== rufus-tokyo - 0.1.10    released 2009/03/19
+
+- bug   : had to adapt to TC 1.4.10 and TT 1.1.17 new "setlimit"
+
+
+== rufus-tokyo - 0.1.9    released 2009/02/27
+
+- bug   : sudo gem install rufus-tokyo was failing because of
+          lib/tokyotyrant.rb. Fixed.
+
+
+== 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)
+- todo  : more documentation for Rufus::Tokyo::Cabinet#new
+- added : Rufus::Tokyo::Cabinet has a open method that takes a block like
+          File.open (Zev)
+- todo  : aligned Rufus::Tokyo::Table#new on ::Cabinet#new
+- todo  : added opts (:prefix, :limit, :native) to Rufus::Tokyo::Cabinet#keys,
+          Rufus::Tokyo::Table#keys and the corresponding Tyrant classes
+
+
+== rufus-tokyo - 0.1.6    released 2009/02/16
+
+- todo : Tyrant and TyrantTable now complain when used in lieu of each other
+- todo : implemented Tyrant and TyrantTable #stat
+- todo : made tran begin/abort/commit directly available (framework builders)
+- todo : implemented Rufus::Tokyo::Table#transaction
+- bug  : JRuby support back in
+- todo : implemented Rufus::Tokyo::Map#[] (class method)
+- todo : simplified Table and TyrantTable #[]=
+- bug  : preventing table#[]= from segfaulting on bad input (Justin)
+
+
+== rufus-tokyo - 0.1.5    released 2009/02/13
+
+- todo : implemented set_index (cabinet / tyrant tables)
+- todo : namespace simplification (Justin)
+- todo : implemented Rufus::Tokyo::TyrantTable
+- todo : implemented Rufus::Tokyo::Tyrant
+- todo : moved tests to bacon (spec/)
+
+
+== rufus-tokyo - 0.1.4    released 2009/02/02
+
+- todo #23780 : hmethods for Rufus::Tokyo::Table
+
+
+== rufus-tokyo - 0.1.3    released 2009/01/29
+
+- todo : implemented Rufus::Tokyo::Table (and query)
+- todo : implemented Rufus::Tokyo::List
+- todo : implemented Rufus::Tokyo::Map
+- todo : implemented Cabinet#compact_copy
+- todo : implemented Cabinet#copy
+
+
+== rufus-tokyo - 0.1.2    released 2009/01/23
+
+- todo : implemented Cabinet#keys and #values
+
+
+== rufus-tokyo - 0.1.1    released 2009/01/23
+
+- bug  : fixed dependency, it's ffi not ruby-ffi
+- todo : implemented Cabinet#clear
+
+
+== rufus-tokyo - 0.1.0    released 2009/01/23
+
+- initial release
+

data/CREDITS.txt

@@ -0,0 +1,27 @@
+
+= CREDITS.txt rufus-tokyo gem
+
+
+== authors
+
+John Mettraux  http://jmettraux.wordpress.com
+Zev Blut  http://www.iknow.co.jp/users/zev
+
+
+== contributors
+
+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
+Mark 'mebaran'  http://github.com/mebaran
+
+
+== finally
+
+many thanks to the author of Tokyo Cabinet (Mikio Hirabayashi) and 
+the authors of ruby-ffi
+
+  http://tokyocabinet.sourceforge.net
+  http://kenai.com/projects/ruby-ffi
+

data/README.txt

@@ -0,0 +1,310 @@
+
+= rufus-tokyo
+
+ruby-ffi based interface to Tokyo Cabinet and Tokyo Tyrant.
+
+The 'abstract' and the 'table' API are covered for now.
+
+
+== installation
+
+  sudo gem install rufus-tokyo
+
+  (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.
+
+the rdoc is at http://rufus.rubyforge.org/rufus-tokyo/
+
+
+== version [mis]match
+
+this version of rufus-tokyo works with
+
+  ffi 0.3.1, 0.3.5
+
+  ruby 1.8.6
+  ruby 1.9.1p0
+  jruby 1.1.6
+  jruby 1.2.0
+
+  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-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 Abstract API
+
+http://tokyocabinet.sourceforge.net/spex-en.html#tcadbapi
+
+to create a hash (file named 'data.tch')
+
+  require 'rubygems'
+  require 'rufus/tokyo'
+
+  db = Rufus::Tokyo::Cabinet.new('data.tch')
+
+  db['nada'] = 'surf'
+
+  p db['nada'] # => 'surf'
+  p db['lost'] # => nil
+
+  5000.times { |i| db[i.to_s] = "x" }
+
+  p db.inject { |r, (k, v)| k } # => 4999
+
+  db.close
+
+
+=== TC Table API
+
+http://tokyocabinet.sourceforge.net/spex-en.html#tctdbapi
+
+  require 'rubygems'
+  require 'rufus/tokyo'
+
+  t = Rufus::Tokyo::Table.new('table.tct')
+
+  t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
+  t['pk1'] = { 'name' => 'bob', 'age' => '18' }
+  t['pk2'] = { 'name' => 'charly', 'age' => '45' }
+  t['pk3'] = { 'name' => 'doug', 'age' => '77' }
+  t['pk4'] = { 'name' => 'ephrem', 'age' => '32' }
+
+  p t.query { |q|
+    q.add_condition 'age', :numge, '32'
+    q.order_by 'age'
+  }
+    # => [ {"name"=>"ephrem", :pk=>"pk4", "age"=>"32"},
+    #      {"name"=>"charly", :pk=>"pk2", "age"=>"45"} ]
+
+  t.close
+
+Note that the Tokyo Cabinet Table API does support transactions :
+
+  p t.size
+    # => 0
+
+  t.transaction do
+    t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
+    t['pk1'] = { 'name' => 'bob', 'age' => '18' }
+    t.abort
+  end
+
+  p t.size
+    # => 0
+
+
+=== TT remote db
+
+http://tokyocabinet.sourceforge.net/tyrantdoc/
+
+to start a ttserver (backed by a hash), on the command line
+
+  ttserver -port 45001 data.tch
+
+
+then, in Ruby :
+
+  require 'rubygems'
+  require 'rufus/tokyo/tyrant'
+
+  db = Rufus::Tokyo::Tyrant.new('localhost', 45001)
+
+  db['nada'] = 'surf'
+
+  p db['nada'] # => 'surf'
+  p db['lost'] # => nil
+
+  db.close
+
+
+Rufus::Tokyo::Tyrant instances have a #stat method :
+
+  puts db.stat.inject('') { |s, (k, v)| s << "#{k} => #{v}\n" }
+    # =>
+    #   pid => 7566
+    #   loadavg => 0.398438
+    #   size => 528736
+    #   rnum => 0
+    #   time => 1234764065.305923
+    #   sid => 898521513
+    #   type => hash
+    #   bigend => 0
+    #   ru_sys => 3.398698
+    #   version => 1.1.15
+    #   ru_user => 2.155215
+    #   ru_real => 3218.451152
+    #   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 :
+
+  ttserver -port 45002 data.tct
+
+
+then, in Ruby, much like a local table :
+
+  require 'rubygems'
+  require 'rufus/tokyo/tyrant'
+
+  t = Rufus::Tokyo::TyrantTable.new('localhost', 45002)
+
+  t['pk0'] = { 'name' => 'alfred', 'age' => '22' }
+  t['pk1'] = { 'name' => 'bob', 'age' => '18' }
+  t['pk2'] = { 'name' => 'charly', 'age' => '45' }
+  t['pk3'] = { 'name' => 'doug', 'age' => '77' }
+  t['pk4'] = { 'name' => 'ephrem', 'age' => '32' }
+
+  p t.query { |q|
+    q.add_condition 'age', :numge, '32'
+    q.order_by 'age'
+  }
+    # => [ {"name"=>"ephrem", :pk=>"pk4", "age"=>"32"},
+    #      {"name"=>"charly", :pk=>"pk2", "age"=>"45"} ]
+
+  t.close
+
+
+Rufus::Tokyo::TyrantTable instances have a #stat method :
+
+  puts t.stat.inject('') { |s, (k, v)| s << "#{k} => #{v}\n" }
+    # =>
+    #   pid => 7569
+    #   loadavg => 0.295410
+    #   size => 935792
+    #   rnum => 0
+    #   time => 1234764228.942014
+    #   sid => 1027604232
+    #   type => table
+    #   bigend => 0
+    #   ru_sys => 5.966750
+    #   version => 1.1.15
+    #   ru_user => 2.601947
+    #   ru_real => 3382.084479
+    #   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
+
+  http://rufus.rubyforge.org/rufus-tokyo/
+  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Cabinet.html
+  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Table.html
+  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/Tyrant.html
+  http://rufus.rubyforge.org/rufus-tokyo/classes/Rufus/Tokyo/TyrantTable.html
+
+don't hesitate to "man ttserver" on the command line.
+
+or directly in the source
+
+  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/cabinet/abstract.rb
+  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/cabinet/table.rb
+  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/tyrant/abstract.rb
+  http://github.com/jmettraux/rufus-tokyo/blob/master/lib/rufus/tokyo/tyrant/table.rb
+
+
+== Tokyo Cabinet / Tyrant install
+
+a compilation of notes is available at :
+
+  http://openwferu.rubyforge.org/tokyo.html
+
+
+== dependencies
+
+the ruby gem 'ffi'
+
+
+== mailing list
+
+On the rufus-ruby list :
+
+  http://groups.google.com/group/rufus-ruby
+
+
+== issue tracker
+
+  http://github.com/jmettraux/rufus-tokyo/issues/
+
+
+== irc
+
+irc.freenode.net #ruote
+
+
+== source
+
+http://github.com/jmettraux/rufus-tokyo
+
+  git clone git://github.com/jmettraux/rufus-tokyo.git
+
+
+== credits
+
+many thanks to the author of Tokyo Cabinet, Mikio Hirabayashi, and to the authors of ruby-ffi
+
+  http://tokyocabinet.sourceforge.net
+  http://kenai.com/projects/ruby-ffi
+
+
+== authors
+
+John Mettraux, jmettraux@gmail.com, http://jmettraux.wordpress.com
+Zev Blut, http://www.iknow.co.jp/users/zev
+
+
+== the rest of Rufus
+
+http://rufus.rubyforge.org
+
+
+== license
+
+MIT
+

data/spec/spec.rb

@@ -0,0 +1,9 @@
+
+#
+# specifying rufus-tokyo
+#
+# Sun Feb  8 13:12:54 JST 2009
+#
+
+Dir["#{File.dirname(__FILE__)}/*_spec.rb"].each { |path| load(path) }
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: ntalbott-rufus-tokyo
+version: !ruby/object:Gem::Version 
+  version: 0.1.14
+platform: ruby
+authors: 
+- John Mettraux
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-16 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ffi
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: jmettraux@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- CHANGELOG.txt
+- CREDITS.txt
+files: 
+- README.txt
+- CHANGELOG.txt
+- CREDITS.txt
+has_rdoc: true
+homepage: http://rufus.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- ffi
+rubyforge_project: rufus
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: ruby-ffi based lib to access Tokyo Cabinet and Tyrant
+test_files: 
+- spec/spec.rb