kyototycoon 0.5.6 → 0.6.0

data/Changes.md

@@ -1,3 +1,8 @@
+## v0.6.0
+
+* added KyotoTycoon::Cursor for cursor support
+* always close socket at script exit
+
 ## v0.5.6
 
 * fixed for ruby 1.8.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    kyototycoon (0.5.6)
+    kyototycoon (0.6.0)
       msgpack
 
 GEM

data/README.markdown

@@ -2,11 +2,13 @@ KyotoTycoon client for Ruby.
 
 # Feature / Fixture
 
+* cursor object supported(v0.6.0+)
 * Usable console as `$ bin/kyototycoon-console -h localhost -p 1991` like a Sequel(v0.5.4+)
 * Always Keep-Alive connect (v0.5.0+)
 * You can choise key/value encoding from URI or Base64
 * You can use MessagePack tranparency
 * Benchmark scripts appended(they are connect to localhost:19999)
+* Both Ruby versions supported 1.8.7 / 1.9.2
 
 # Install
 
@@ -106,6 +108,22 @@ KyotoTycoon client for Ruby.
     p @kt.status
     all_record_count = @kt.status['count']
 
+# Cursor samples
+
+For B+Tree type database only.
+http://fallabs.com/kyotocabinet/spex.html#tutorial_dbchart
+
+    @kt.clear
+    100.times{|n|
+      @kt.set("%02d" % n, n) # 00, 01, 02 .. 99
+    }
+    cur = @kt.cursor
+    cur.jump("90")
+    cur.each{|k,v| puts v} # => 90, 91, 92 .. 99
+
+    cur.jump("05")
+    cur.find_all{|k,v| k.to_i < 10} # => 05, 06, 07, 08, 09. Because it started with 05
+
 # Requirements
 
 - msgpack(optional)

data/Rakefile

@@ -9,42 +9,53 @@ rescue Bundler::BundlerError => e
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "kyototycoon"
-  gem.homepage = "http://github.com/uu59/kyototycoon-ruby"
-  gem.license = "MIT"
-  gem.summary = %Q{KyotoTycoon client for Ruby}
-  gem.description = %Q{KyotoTycoon client for Ruby}
-  gem.email = "a@tt25.org"
-  gem.authors = ["uu59"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+def do_rspec(opts=["-c"])
+  system(*['rspec', opts, 'spec/'].flatten)
 end
-Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/*.rb']
+desc "run rspec"
+task :rspec do
+  do_rspec
 end
+namespace :rspec do
+  desc "run rspec with coverage"
+  task :cov do
+    ENV["COV"]="1"
+    do_rspec
+  end
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
+  desc "run rspec with all of installed versions of ruby"
+  task :rvm do
+    system("rvm exec 'ruby -e \"puts %Q!=!*48\";ruby -v;rspec -c spec/'")
+  end
 end
 
-task :default => :spec
+namespace :gem do
+  desc "build gem"
+  task :build do
+    system("gem build kyototycoon.gemspec")
+  end
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  desc "versioning"
+  task :version do
+    ver = ENV["VER"]
+    if ver.nil?
+      puts "version is not specified."
+      puts "Usage: VER=x.x.x rake ..."
+      exit
+    end
+    date = Time.now.strftime("%Y-%m-%d")
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "test #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+    # Prefer GNU sed to BSD sed
+    sed = [`which gsed`, `which sed`].map{|s| s.strip}.join(" ").strip.split(" ").first
+    system("echo lib/kyototycoon.rb  | xargs #{sed} -E -i \"s/VERSION = '[0-9.]+'/VERSION = '#{ver}'/g\"")
+    system("echo kyototycoon.gemspec | xargs #{sed} -E -i 's/s.version\s*=\s*\".*\"/s.version = \"#{ver}\"/g'")
+    system("echo Gemfile.lock        | xargs #{sed} -E -i 's/kyototycoon \(.*?\)/kyototycoon (#{ver})/g'")
+    system("echo kyototycoon.gemspec | xargs #{sed} -E -i 's/s.date = .*$/s.date = %q{#{date}}/g'")
+    system("git add -u")
+    puts "= NOTICE ="
+    puts "ver #{ver}, edit Changes.md for what changed and commit, git tag #{ver}"
+  end
 end
+
+task :default => ["rspec"]

data/kyototycoon.gemspec

@@ -3,11 +3,11 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name = %q{kyototycoon}
-  s.version = "0.5.6"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["uu59"]
-  s.date = %q{2011-07-30}
+  s.date = %q{2011-08-10}
   s.default_executable = %q{kyototycoon-console}
   s.description = %q{KyotoTycoon client for Ruby}
   s.email = %q{k@uu59.org}

data/lib/kyototycoon/cursor.rb

@@ -0,0 +1,96 @@
+# -- coding: utf-8
+
+class KyotoTycoon
+  class Cursor
+    include Enumerable
+    attr_reader :cur
+
+    def initialize(kt, cur)
+      @kt = kt
+      @cur = cur
+      at_exit { delete! }
+    end
+
+    def each(&block)
+      return to_enum(:each) unless block_given?
+      jump if current == [nil,nil]
+      start_key = key
+      begin
+        @kt.logger.debug("cursor each start with key=#{start_key}")
+        loop do
+          tmp = current(1)
+          @kt.logger.debug("cursor each key=#{tmp.first}")
+          break if tmp == [nil,nil]
+          block.call(tmp)
+        end
+      ensure
+        jump(start_key)
+      end
+    end
+
+    def jump(key=nil)
+      request('/rpc/cur_jump',{:key => key})
+      self
+    end
+
+    def jump_back(key=nil)
+      request('/rpc/cur_jump_back',{:key => key})
+      self
+    end
+
+    def step
+      request('/rpc/cur_step')
+      self
+    end
+    alias_method :next, :step
+
+    def step_back
+      request('/rpc/cur_step_back')
+      self
+    end
+    alias_method :prev, :step_back
+
+    def value(step=nil)
+      request('/rpc/cur_get_value', {"step" => step})["value"]
+    end
+
+    def value=(value, xt=nil, step=nil)
+      request('/rpc/cur_set_value', {
+        "value" => value,
+        "xt" => xt,
+        "step" => step,
+      })
+    end
+
+    def key(step=nil)
+      request('/rpc/cur_get_key', {"step" => step})["key"]
+    end
+
+    def current(step=nil)
+      res = request('/rpc/cur_get', {"step" => step})
+      [res["key"], res["value"]]
+    end
+
+    def seize(xt=nil)
+      res = request('/rpc/cur_seize', {"xt" => xt})
+      [res["key"], res["value"]]
+    end
+
+    def remove
+      request('/rpc/cur_remove')
+    end
+
+    def delete!
+      request('/rpc/cur_delete')
+    end
+
+    private
+    def request(path, params={})
+      params.merge!({
+        :CUR => @cur,
+      })
+      res = @kt.request(path, params)
+      Tsvrpc.parse(res[:body], res[:colenc])
+    end
+  end
+end

data/lib/kyototycoon/tsvrpc/skinny.rb

@@ -11,6 +11,7 @@ class KyotoTycoon
         @tpl << "Content-Length: %d\r\n"
         @tpl << "Content-Type: text/tab-separated-values; colenc=%s\r\n"
         @tpl << "\r\n%s"
+        at_exit { finish }
       end
 
       def request(path, params, colenc)
@@ -49,7 +50,7 @@ class KyotoTycoon
       end
 
       def finish
-        @sock.close if @sock
+        @sock.close if @sock && !@sock.closed?
       end
     end
   end

data/lib/kyototycoon.rb

@@ -5,6 +5,7 @@ require "cgi"
 require "socket"
 require "base64"
 require "timeout"
+require "kyototycoon/cursor.rb"
 require "kyototycoon/serializer.rb"
 require "kyototycoon/serializer/default.rb"
 require "kyototycoon/serializer/msgpack.rb"
@@ -13,7 +14,7 @@ require "kyototycoon/tsvrpc/skinny.rb"
 require "kyototycoon/stream.rb"
 
 class KyotoTycoon
-  VERSION = '0.5.6'
+  VERSION = '0.6.0'
 
   attr_accessor :colenc, :connect_timeout, :servers
   attr_reader :serializer, :logger, :db
@@ -55,6 +56,7 @@ class KyotoTycoon
     @logger = Logger.new(nil)
     @colenc = :B
     @connect_timeout = 0.5
+    @cursor = 1
   end
 
   def serializer= (adaptor=:default)
@@ -146,15 +148,11 @@ class KyotoTycoon
       params
     }
     res = request('/rpc/get_bulk', params)
-    ret = {}
     bulk = Tsvrpc.parse(res[:body], res[:colenc])
-    bulk = bulk.find_all{|k,v| k.match(/^_/)}.inject({}){|r,kv| r[kv.first] = kv.last; r}
-    ret = bulk.reduce({}) do |hash, (k,v)|
-      key = k.match(/^_/) ? k[1..-1] : k
-      hash[key] = @serializer.decode(v)
-      hash
-    end
-    ret
+    bulk.delete_if{|k,v| k.match(/^[^_]/)}.inject({}){|r, (k,v)|
+      r[k[1..-1]] = @serializer.decode(v)
+      r
+    }
   end
 
   def remove_bulk(keys)
@@ -166,6 +164,10 @@ class KyotoTycoon
     Tsvrpc.parse(res[:body], res[:colenc])
   end
 
+  def cursor(cur_id=nil)
+    Cursor.new(self, cur_id || @cursor += 1)
+  end
+
   def clear
     request('/rpc/clear')
   end

data/spec/cursor_spec.rb

@@ -0,0 +1,89 @@
+# -- coding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+describe KyotoTycoon do
+  before(:each) do
+    @kt = KyotoTycoon.new('localhost', 19999)
+    100.times{|n|
+      @kt["#{"%02d" % n}foo"] = "foo#{n}"
+    }
+  end
+
+  it 'should handle cursor object' do
+    cur = @kt.cursor
+    cur.jump("33")
+    cur.key.should == "33foo"
+    cur.value.should == "foo33"
+    cur.current.should == [ "33foo","foo33" ]
+    cur.value = "new"
+    @kt["33foo"].should == "new"
+
+    cur.step
+    cur.key.should == "34foo"
+    cur.value.should == "foo34"
+    cur.remove
+    @kt["34foo"].should be_nil
+
+    cur.jump('55')
+    cur.seize.should == ["55foo","foo55"]
+    @kt["55foo"].should be_nil
+  end
+
+  it 'should handle cursor steps' do
+    # If you got failed in this section, it's a KyotoCabinet's bug
+    # It has been fixed at KyotoCabinet 1.2.70
+    # c.f.
+    # https://gist.github.com/1117611
+    # https://twitter.com/#!/fallabs/status/98079688550916097
+    cur = @kt.cursor
+    cur.jump
+    cur.key.should == "00foo"
+
+    cur.jump_back
+    cur.key.should == "99foo"
+    cur.jump
+    cur.key.should == "00foo"
+
+    cur.jump("50")
+    cur.step
+    cur.key.should == "51foo"
+    cur.step_back
+    cur.key.should == "50foo"
+    cur.step
+    cur.key.should == "51foo"
+  end
+
+  it "should handle multiple cursors" do
+    cur = @kt.cursor
+    cur2 = @kt.cursor
+    cur.jump("33")
+    cur.cur.should_not == cur2.cur
+    cur.key.should_not == cur2.key
+  end
+
+  it "should keep current position after called #each" do
+    cur = @kt.cursor
+    cur.jump("49")
+    cur.each{|k,v| } # no-op
+    cur.key.should == "49foo"
+  end
+
+  it "should handle #each" do
+    cur = @kt.cursor
+    cur.find{|k,v| k == "non-exists"}.should be_nil
+    cur.find_all{|k,v| k.match(/3[234]foo/)}.should == [
+      %w!32foo foo32!,
+      %w!33foo foo33!,
+      %w!34foo foo34!,
+    ]
+    cur.jump("33")
+    cur.find_all{|k,v| k.match(/3[234]foo/)}.should == [
+      %w!33foo foo33!,
+      %w!34foo foo34!,
+    ]
+
+    cur.jump
+    cur.find{|k,v| k == "15foo"}.should == ["15foo", "foo15"]
+  end
+end

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@
 !!!!!!!!!!!!!
 
 This script access http://0.0.0.0:19999/ and destroy all records.
-Be carefully for run, and run `ktserver -port 19999 '*'` before testing.
+Be carefully for run, and run `ktserver -port 19999 '%'` before testing.
 
 =end
 

metadata

@@ -1,108 +1,80 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: kyototycoon
-version: !ruby/object:Gem::Version 
-  hash: 7
+version: !ruby/object:Gem::Version
+  version: 0.6.0
   prerelease: 
-  segments: 
-  - 0
-  - 5
-  - 6
-  version: 0.5.6
 platform: ruby
-authors: 
+authors:
 - uu59
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-07-30 00:00:00 +10:00
+date: 2011-08-10 00:00:00.000000000 +10:00
 default_executable: kyototycoon-console
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: msgpack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152635020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2152635020
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152632340 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 11
-        segments: 
-        - 2
-        - 1
-        - 0
+      - !ruby/object:Gem::Version
         version: 2.1.0
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2152632340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152631480 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: jeweler
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2152631480
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2152627020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
+      - !ruby/object:Gem::Version
         version: 1.5.1
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: simplecov
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2152627020
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2152621760 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *2152621760
 description: KyotoTycoon client for Ruby
 email: k@uu59.org
-executables: 
+executables:
 - kyototycoon-console
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.markdown
-files: 
+files:
 - .gitignore
 - Changes.md
 - Gemfile
@@ -119,6 +91,7 @@ files:
 - bin/kyototycoon-console
 - kyototycoon.gemspec
 - lib/kyototycoon.rb
+- lib/kyototycoon/cursor.rb
 - lib/kyototycoon/serializer.rb
 - lib/kyototycoon/serializer/default.rb
 - lib/kyototycoon/serializer/msgpack.rb
@@ -126,45 +99,42 @@ files:
 - lib/kyototycoon/tsvrpc.rb
 - lib/kyototycoon/tsvrpc/skinny.rb
 - spec/connect_spec.rb
+- spec/cursor_spec.rb
 - spec/ktslave.txt
 - spec/options_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/uu59/kyototycoon-ruby
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -4066968270942491999
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: KyotoTycoon client for Ruby
-test_files: 
+test_files:
 - spec/connect_spec.rb
+- spec/cursor_spec.rb
 - spec/ktslave.txt
 - spec/options_spec.rb
 - spec/spec_helper.rb