rufus-tokyo 1.0.3 → 1.0.4

data/lib/rufus/tokyo/version.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2009, John Mettraux, jmettraux@gmail.com
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+# Made in Japan.
+#++
+
+
+module Rufus
+module Tokyo
+
+  VERSION = '1.0.4'
+end
+end
+

data/rufus-tokyo.gemspec

@@ -0,0 +1,135 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rufus-tokyo}
+  s.version = "1.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["John Mettraux", "Zev Blut", "Jeremy Hinegardner", "James Edward Gray II"]
+  s.date = %q{2009-12-25}
+  s.description = %q{
+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).
+  }
+  s.email = %q{jmettraux@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG.txt",
+     "CREDITS.txt",
+     "LICENSE.txt",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "doc/decision_table.numbers",
+     "lib/rufus-edo.rb",
+     "lib/rufus-tokyo.rb",
+     "lib/rufus/edo.rb",
+     "lib/rufus/edo/README.txt",
+     "lib/rufus/edo/cabcore.rb",
+     "lib/rufus/edo/cabinet/abstract.rb",
+     "lib/rufus/edo/cabinet/table.rb",
+     "lib/rufus/edo/error.rb",
+     "lib/rufus/edo/ntyrant.rb",
+     "lib/rufus/edo/ntyrant/abstract.rb",
+     "lib/rufus/edo/ntyrant/table.rb",
+     "lib/rufus/edo/tabcore.rb",
+     "lib/rufus/tokyo.rb",
+     "lib/rufus/tokyo/cabinet/abstract.rb",
+     "lib/rufus/tokyo/cabinet/lib.rb",
+     "lib/rufus/tokyo/cabinet/table.rb",
+     "lib/rufus/tokyo/cabinet/util.rb",
+     "lib/rufus/tokyo/config.rb",
+     "lib/rufus/tokyo/dystopia.rb",
+     "lib/rufus/tokyo/dystopia/core.rb",
+     "lib/rufus/tokyo/dystopia/lib.rb",
+     "lib/rufus/tokyo/dystopia/words.rb",
+     "lib/rufus/tokyo/hmethods.rb",
+     "lib/rufus/tokyo/openable.rb",
+     "lib/rufus/tokyo/outlen.rb",
+     "lib/rufus/tokyo/query.rb",
+     "lib/rufus/tokyo/transactions.rb",
+     "lib/rufus/tokyo/ttcommons.rb",
+     "lib/rufus/tokyo/tyrant.rb",
+     "lib/rufus/tokyo/tyrant/abstract.rb",
+     "lib/rufus/tokyo/tyrant/ext.rb",
+     "lib/rufus/tokyo/tyrant/lib.rb",
+     "lib/rufus/tokyo/tyrant/table.rb",
+     "lib/rufus/tokyo/utils.rb",
+     "lib/rufus/tokyo/version.rb",
+     "rufus-tokyo.gemspec",
+     "spec/cabinet_btree_spec.rb",
+     "spec/cabinet_fixed_spec.rb",
+     "spec/cabinet_spec.rb",
+     "spec/cabinetconfig_spec.rb",
+     "spec/dystopia_core_spec.rb",
+     "spec/edo_cabinet_btree_spec.rb",
+     "spec/edo_cabinet_fixed_spec.rb",
+     "spec/edo_cabinet_spec.rb",
+     "spec/edo_ntyrant_spec.rb",
+     "spec/edo_ntyrant_table_spec.rb",
+     "spec/edo_table_spec.rb",
+     "spec/hmethods_spec.rb",
+     "spec/incr.lua",
+     "spec/openable_spec.rb",
+     "spec/shared_abstract_spec.rb",
+     "spec/shared_table_spec.rb",
+     "spec/shared_tyrant_spec.rb",
+     "spec/spec.rb",
+     "spec/spec_base.rb",
+     "spec/start_tyrants.sh",
+     "spec/stop_tyrants.sh",
+     "spec/table_spec.rb",
+     "spec/tyrant_spec.rb",
+     "spec/tyrant_table_spec.rb",
+     "spec/util_list_spec.rb",
+     "spec/util_map_spec.rb",
+     "tasks/dev.rb",
+     "test/bm0.rb",
+     "test/bm1_compression.rb",
+     "test/con0.rb",
+     "test/mem.rb",
+     "test/mem1.rb",
+     "test/readme0.rb",
+     "test/readme1.rb",
+     "test/readme2.rb",
+     "test/readme3.rb",
+     "test/readmes_test.sh"
+  ]
+  s.homepage = %q{http://github.com/jmettraux/rufus-tokyo/}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rufus}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ruby-ffi based lib to access Tokyo Cabinet, Tyrant and Dystopia}
+  s.test_files = [
+    "spec/spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<ffi>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<ffi>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<ffi>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/cabinet_btree_spec.rb

@@ -0,0 +1,92 @@
+
+#
+# Specifying rufus-tokyo
+#
+# Fri Aug 28 08:58:37 JST 2009
+#
+
+require File.dirname(__FILE__) + '/spec_base'
+
+require 'rufus/tokyo'
+
+FileUtils.mkdir('tmp') rescue nil
+
+DB_FILE = "tmp/cabinet_btree_spec.tcb"
+
+
+describe 'Rufus::Tokyo::Cabinet .tcb' do
+
+  before do
+    FileUtils.rm(DB_FILE) if File.exist? DB_FILE
+    @db = Rufus::Tokyo::Cabinet.new(DB_FILE)
+  end
+  after do
+    @db.close
+  end
+
+  it 'should accept duplicate values' do
+
+    @db.putdup('a', 'a0')
+    @db.putdup('a', 'a1')
+
+    @db.getdup('a').should.equal([ 'a0', 'a1' ])
+  end
+
+  it 'should be able to fetch keys for duplicate values' do
+    [ %w[John  Hornbeck],
+      %w[Tim   Gourley],
+      %w[Grant Schofield],
+      %w[James Gray],
+      %w[Dana  Gray] ].each do |first, last|
+      @db.putdup(last, first)
+    end
+    @db.keys.should.equal(%w[Gourley Gray Hornbeck Schofield])
+    @db.keys(:prefix => "G").should.equal(%w[Gourley Gray])
+  end
+end
+
+describe 'Rufus::Tokyo::Cabinet .tcb methods' do
+
+  it 'should fail on other structures' do
+
+    @db = Rufus::Tokyo::Cabinet.new(DB_FILE.sub(/\.tcb\z/, ".tch"))
+
+    lambda { @db.putdup('a', 'a0') }.should.raise(NoMethodError)
+
+    @db.close
+  end
+end
+
+describe 'Rufus::Tokyo::Cabinet .tcb order' do
+
+  before do
+    FileUtils.rm(DB_FILE) if File.exist? DB_FILE
+  end
+
+  it 'should default to a lexical order' do
+
+    db = Rufus::Tokyo::Cabinet.new(DB_FILE)
+    fields = [1, 2, 10, 11, 20, 21]
+    fields.each do |n|
+      db[n] = n
+    end
+    db.keys.should.equal(fields.map { |n| n.to_s }.sort)
+    db.close
+  end
+
+  it 'should allow an explicit :cmpfunc => :lexical' do
+
+    db = Rufus::Tokyo::Cabinet.new(DB_FILE, :cmpfunc => :lexical)
+    fields = [1, 2, 10, 11, 20, 21]
+    fields.each do |n|
+      db[n] = n
+    end
+    db.keys.should.equal(fields.map { |n| n.to_s }.sort)
+    db.close
+  end
+
+  #
+  # It's not possible to call tcbdbsetcmpfunc() through the abstract API, so
+  # changing comparison functions are only supported through the Edo interface.
+  #
+end

data/spec/cabinet_fixed_spec.rb

@@ -0,0 +1,33 @@
+require File.dirname(__FILE__) + '/spec_base'
+
+require 'rufus/tokyo'
+
+FileUtils.mkdir('tmp') rescue nil
+
+
+describe 'Rufus::Tokyo::Cabinet .tcf' do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_fixed_spec.tcf', :width => 4)
+    @db.clear
+  end
+  after do
+    @db.close
+  end
+
+  it 'should support keys' do
+    @db[1] = "one"
+    @db[2] = "two"
+    @db[3] = "three"
+    @db[7] = "seven"
+    @db.keys.should.equal(%w[1 2 3 7])
+  end
+
+  it 'should accept a width at creation' do
+
+    @db[1] = "one"
+    @db[2] = "two"
+    @db[3] = "three"
+    @db.to_a.should.equal([%w[1 one], %w[2 two], %w[3 thre]])
+  end
+end

data/spec/cabinet_spec.rb

@@ -0,0 +1,291 @@
+
+#
+# Specifying rufus-tokyo
+#
+# Sun Feb  8 15:02:08 JST 2009
+#
+
+require File.dirname(__FILE__) + '/spec_base'
+require File.dirname(__FILE__) + '/shared_abstract_spec'
+
+require 'rufus/tokyo'
+
+FileUtils.mkdir('tmp') rescue nil
+
+
+describe 'a missing Rufus::Tokyo::Cabinet' do
+
+  it 'should raise an error when opening in read-only mode' do
+
+    lambda {
+      Rufus::Tokyo::Cabinet.new('tmp/naidesuyo.tch', :mode => 'r')
+    }.should.raise(Rufus::Tokyo::TokyoError).message.should.equal(
+      "failed to open/create db 'tmp/naidesuyo.tch#mode=r' {:mode=>\"r\"}")
+  end
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like "an abstract structure"
+
+  it 'should return its path' do
+
+    @db.path.should.equal('tmp/cabinet_spec.tch')
+  end
+
+  it 'should create its underlying file' do
+
+    File.exist?('tmp/cabinet_spec.tch').should.equal(true)
+  end
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @n = 50
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+    @n.times { |i| @db["person#{i}"] = 'whoever' }
+    @n.times { |i| @db["animal#{i}"] = 'whichever' }
+    @db["toto#{0.chr}5"] = 'toto'
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'abstract structure #keys'
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'abstract structure with transactions'
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  it 'should accept a default value' do
+
+    cab = Rufus::Tokyo::Cabinet.new(
+      'tmp/cabinet_spec_default.tch', :default => '@?!')
+    cab['a'] = 'A'
+    cab.size.should.equal(1)
+    cab['b'].should.equal('@?!')
+    cab.close
+  end
+
+  it 'should accept a default value (later)' do
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec_default.tch')
+    cab.default = '@?!'
+    cab['a'] = 'A'
+    cab.size.should.equal(1)
+    cab['b'].should.equal('@?!')
+    cab.close
+  end
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+    3.times { |i| @db[i.to_s] = "val#{i}" }
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'abstract structure #lget/lput/ldelete'
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'abstract structure #add{int|double}'
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'abstract structure #putkeep'
+  behaves_like 'abstract structure #putcat'
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  it 'should copy correctly' do
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/spec_source.tch')
+    5000.times { |i| cab["key #{i}"] = "val #{i}" }
+    cab.size.should.equal(5000)
+    cab.copy('tmp/spec_target.tch')
+    cab.close
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/spec_target.tch')
+    cab.size.should.equal(5000)
+    cab['key 4999'].should.equal('val 4999')
+    cab.close
+
+    FileUtils.rm('tmp/spec_source.tch')
+    FileUtils.rm('tmp/spec_target.tch')
+  end
+
+  it 'should copy compactly' do
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/spec_source.tch')
+    100.times { |i| cab["key #{i}"] = "val #{i}" }
+    50.times { |i| cab.delete("key #{i}") }
+    cab.size.should.equal(50)
+    cab.compact_copy('tmp/spec_target.tch')
+    cab.close
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/spec_target.tch')
+    cab.size.should.equal(50)
+    cab['key 99'].should.equal('val 99')
+    cab.close
+
+    fs0 = File.size('tmp/spec_source.tch')
+    fs1 = File.size('tmp/spec_target.tch')
+    (fs0 > fs1).should.equal(true)
+
+    FileUtils.rm('tmp/spec_source.tch')
+    FileUtils.rm('tmp/spec_target.tch')
+  end
+
+  it 'should use open with a block will auto close the db correctly' do
+
+    res = Rufus::Tokyo::Cabinet.open('tmp/spec_source.tch') do |cab|
+      10.times { |i| cab["key #{i}"] = "val #{i}" }
+      cab.size.should.equal(10)
+      :result
+    end
+
+    res.should.equal(:result)
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/spec_source.tch')
+    10.times do |i|
+      cab["key #{i}"].should.equal("val #{i}")
+    end
+    cab.close
+
+    FileUtils.rm('tmp/spec_source.tch')
+  end
+
+  it 'should use open without a block just like calling new correctly' do
+
+    cab = Rufus::Tokyo::Cabinet.open('tmp/spec_source.tch')
+    10.times { |i| cab["key #{i}"] = "val #{i}" }
+    cab.size.should.equal(10)
+    cab.close
+
+    cab = Rufus::Tokyo::Cabinet.new('tmp/spec_source.tch')
+    10.times do |i|
+      cab["key #{i}"].should.equal("val #{i}")
+    end
+    cab.close
+
+    FileUtils.rm('tmp/spec_source.tch')
+  end
+
+  it 'should honour the :type parameter' do
+
+    cab = Rufus::Tokyo::Cabinet.open('tmp/toto.tch')
+    cab.clear
+    cab['hello'] = 'world'
+    cab.close
+
+    cab = Rufus::Tokyo::Cabinet.open('tmp/toto', :type => :hash)
+    cab['hello'].should.equal('world')
+    cab.close
+
+    FileUtils.rm('tmp/toto.tch')
+  end
+
+  it 'should respond to defrag (or not) (TC >= 1.4.21)' do
+
+    cab = Rufus::Tokyo::Cabinet.open('tmp/toto.tch')
+
+    if Rufus::Tokyo::CabinetLib.respond_to?(:tctdbsetdfunit)
+      cab.defrag
+      true.should.equal(true)
+    else
+      lambda() { cab.defrag }.should.raise(NotImplementedError)
+    end
+
+    cab.close
+  end
+end
+
+describe Rufus::Tokyo::Cabinet do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch')
+    @db.clear
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'an abstract structure flattening keys and values'
+end
+
+describe 'Rufus::Tokyo::Cabinet with a default value' do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new('tmp/cabinet_spec.tch', :default => 'Nemo')
+    @db.clear
+    @db['known'] = 'Ulysse'
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'an abstract structure with a default value'
+end
+
+describe 'Rufus::Tokyo::Cabinet with a default_proc' do
+
+  before do
+    @db = Rufus::Tokyo::Cabinet.new(
+      'tmp/cabinet_spec.tch',
+      :default_proc => lambda { |db, k| "default:#{k}" })
+    @db.clear
+    @db['known'] = 'Ulysse'
+  end
+  after do
+    @db.close
+  end
+
+  behaves_like 'an abstract structure with a default_proc'
+end
+