genki-kyototycoon 0.6.0.1

data/.gitignore

@@ -0,0 +1 @@
+coverage/

data/Changes.md

@@ -0,0 +1,52 @@
+## v0.6.0
+
+* added KyotoTycoon::Cursor for cursor support
+* always close socket at script exit
+
+## v0.5.6
+
+* fixed for ruby 1.8.7
+
+## v0.5.5
+
+* fixed bulk methods. [Thanks rickyrobinson!](https://github.com/uu59/kyototycoon-ruby/pull/1/files)
+
+## v0.5.4
+
+* Added bin/kyototycoon-console. it's like as Sequel's `sequel` script
+
+## v0.5.3
+
+* fixed bug using base64 encoding
+* regenerate socket when that closed
+
+## v0.5.2
+
+* fixed encoded response handling
+* fixed miss named method
+
+## v0.5.1
+
+* changing server dicision logic
+* added KT::Stream.run
+
+## v0.5.0
+
+* Always Keep-Alive connection
+* remove Tsvrpc::Nethttp, and KT#agent=
+* default KT#colenc = :B (Base64)
+* modified benchmark/*.rb
+
+## v0.1.2
+
+* added KT#configure, KT#create
+* added KT#incr, KT#decr, KT#decrement
+* rspec connect to localhost:19999 for safety
+
+## v0.1.1
+
+* fixed always xt=0
+
+## v0.1.0
+
+* first release

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    genki-kyototycoon (0.6.0.1)
+      msgpack
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    msgpack (0.4.6)
+    rake (0.9.2)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    simplecov (0.4.2)
+      simplecov-html (~> 0.4.4)
+    simplecov-html (0.4.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  genki-kyototycoon!
+  jeweler (~> 1.5.1)
+  rspec (~> 2.1.0)
+  simplecov

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 uu59<a@tt25.org>
+
+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.

data/README.markdown

@@ -0,0 +1,155 @@
+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
+
+    $ gem install kyototycoon
+
+# Example
+
+## Simple case
+
+    @kt = KyotoTycoon.new('localhost', 1978)
+
+    # traditional style
+    @kt.set('foo', 123)
+    p @kt.get('foo') # => "123".  carefully, it is String, not Integer, by default
+
+    # Ruby's hash style
+    @kt['bar'] = 42
+    p @kt['bar'] # => "42".
+    @kt[:baz] = :aaa # => key/value are automatically #to_s
+
+    @kt.delete(:foo)
+
+
+## Complex case
+    # KT#configure for instance setting store.
+
+    KyotoTycoon.configure(:generic) do |kt|
+      kt.db = '*' # on memory
+    end
+
+    # connect any host, any port
+    KyotoTycoon.configure(:favicon, 'remotehost', 12345) do |kt|
+      kt.db = 'favicons.kch' # DB file as KT known
+    end
+
+    @kt = KyotoTycoon.create(:generic) # got KT instance by KT#configure(:generic) rules
+
+    # set/bulk_set/get/bulk_get uses msgpack. default as :default
+    @kt.serializer = :msgpack
+
+    # KT library logging
+    logger = Logger.new(STDERR)
+    logger.level = Logger::WARN
+    @kt.logger = logger
+    # or you can use these:
+    # @kt.logger = 'ktlib.log'
+    # @kt.logger = STDOUT
+    # @kt.logger = Logger.new(STDOUT)
+
+    # standby server
+    @kt.connect_timeout = 0.5 # => wait 0.5 sec for connection open
+    @kt.servers << ['server2', 1978] # standby server that will use when primary server (a.k.a. KT#new(host, port)) is dead.
+    @kt.servers << ['server3', 1978] # same as above
+
+    # key/value encoding from :U or :B(default). default as base64 because it seems better than URL encode for me.
+    @kt.colenc = :U
+
+    # get/set
+    @kt.set('foo', 42, 100) # => expire at 100 seconds after
+    @kt['foo'] # => 42. it is interger by msgpack serializer works
+
+    # delete all record
+    @kt.clear
+
+    # bulk set/get
+    @kt.set_bulk({
+      'foo' => 'foo',
+      'bar' => 'bar',
+    })
+    @kt.get_bulk([:foo, 'bar']) # => {'_foo' => 'foo', '_bar' => 'bar', 'num' => '2'}
+    @kt.remove_bulk([:foo, :bar])
+
+    # it can store when msgpack using.
+    @kt['baz'] = {'a' => 'a', 'b' => 'b'}
+    @kt['baz'] # => {'a' => 'a', 'b' => 'b}
+
+    # increment
+    @kt.increment('bar') # => 1
+    @kt.increment('bar') # => 2
+    @kt.increment('bar', 10) # => 12
+    @kt.increment('bar', -5) # => 7
+
+    # shorthand
+    @kt.incr('foo') # => 1
+    @kt.decr('foo') # => 0
+
+    # delete keys
+    @kt.delete(:foo, :bar, :baz)
+
+    # prefix keys
+    @kt.match_prefix('fo') # => all start with 'fo' keys
+    @kt.match_regex('^fo') # => save as above
+    @kt.match_regex(/^fo/) # => save as above
+
+    # reporting / statistics
+    p @kt.report
+    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)
+
+# Other case for `ktremotemgr slave | ...`
+
+    $ cat foo.rb
+    require "rubygems"
+    require "kyototycoon"
+
+    KyotoTycoon::Stream.run($stdin) do |line|
+      case line.cmd
+        when 'clear'
+          puts "all record cleared!"
+        when 'set'
+          puts "#{line.key} get #{line.value} value"
+        when 'remove'
+          puts "#{line.key} is removed at #{line.time.strftime('%Y-%m-%d %H:%M:%S')}"
+      end
+    end
+
+    $ ktremotemgr slave -uw | ruby foo.rb
+
+# Trap
+
+KyotoTycoon is based on HTTP so all variable types are become String.
+It means `(@kt["counter"] ||= 1) < 10` does not work by default.
+
+Using :msgpack serializer for avoid this trap.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+def do_rspec(opts=["-c"])
+  system(*['rspec', opts, 'spec/'].flatten)
+end
+
+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
+
+  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
+
+namespace :gem do
+  desc "build gem"
+  task :build do
+    system("gem build kyototycoon.gemspec")
+  end
+
+  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")
+
+    # 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/VERSION

@@ -0,0 +1 @@
+0.5.4

data/benchmark/bulk.rb

@@ -0,0 +1,15 @@
+# -- coding: utf-8
+
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
+
+bulk={}
+50000.times.map{|n|
+  bulk[n.to_s] = "#{n}-#{rand}"
+}
+job = lambda {|kt|
+  kt.set_bulk(bulk)
+  kt.get_bulk(bulk.keys)
+  kt.clear
+}
+
+benchmark(job)

data/benchmark/bulk_bigdata.rb

@@ -0,0 +1,15 @@
+# -- coding: utf-8
+
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
+
+bulk={}
+str = "string ああ" * 10000
+100.times.map{|n|
+  bulk[n.to_s] = str
+}
+job = lambda {|kt|
+  kt.set_bulk(bulk)
+  kt.get_bulk(bulk.keys)
+  kt.clear
+}
+benchmark(job)

data/benchmark/getset.rb

@@ -0,0 +1,12 @@
+# -- coding: utf-8
+
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
+
+job = lambda {|kt|
+  1000.times{|n|
+    kt.set(n.to_s, n)
+    kt.get(n)
+  }
+  kt.clear
+}
+benchmark(job)

data/benchmark/getset_while_1sec.rb

@@ -0,0 +1,21 @@
+# -- coding: utf-8
+
+require File.expand_path("#{File.dirname(__FILE__)}/helper.rb")
+
+job = lambda {|kt|
+  cnt = 0
+  begin
+    timeout(1){
+      loop do
+        kt[:foo] = :bar
+        kt[:foo]
+        cnt += 1
+      end
+    }
+  rescue Timeout::Error
+  end
+  kt.clear
+  cnt
+}
+
+benchmark(job)

data/benchmark/helper.rb

@@ -0,0 +1,22 @@
+# -- coding: utf-8
+
+require "benchmark"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'kyototycoon.rb'
+
+def benchmark(job)
+  kt = KyotoTycoon.new('0.0.0.0', 19999)
+  Benchmark.bm do |x|
+    %w!B U!.each{|colenc|
+      %w!default msgpack!.each{|serializer|
+        x.report("#{serializer}, colenc=#{colenc}") {
+          kt.serializer=serializer.to_sym
+          kt.colenc = colenc.to_sym
+          job.call(kt)
+        }
+      }
+    }
+  end
+end
+

data/bin/kyototycoon-console

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require "irb"
+require "optparse"
+require "rubygems"
+require File.expand_path('../lib/kyototycoon.rb', File.dirname(__FILE__))
+
+options = {
+  :host => 'localhost',
+  :port => 1978,
+}
+
+OptionParser.new do |opts|
+  opts.on('-h VAL', '--host=VAL', 'hostname'){|v| options[:host] = v}
+  opts.on('-p VAL', '--port=VAL', 'port numver'){|v| options[:port] = v}
+  opts.parse! ARGV
+end
+
+KT = KyotoTycoon.new(options[:host], options[:port])
+
+puts "="*30
+puts "You can use KyotoTycoon object for KT"
+puts "options are: #{options.inspect}"
+puts "="*30
+
+IRB.start

data/kyototycoon.gemspec

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = %q{genki-kyototycoon}
+  s.version = "0.6.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["uu59"]
+  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}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage = %q{http://github.com/uu59/kyototycoon-ruby}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{KyotoTycoon client for Ruby}
+
+  s.add_dependency(%q<msgpack>, [">= 0"])
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+    
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

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
+      ObjectSpace.define_finalizer(self){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
+      res = request('/rpc/cur_seize')
+      [res["key"], res["value"], res["xt"]]
+    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/serializer/default.rb

@@ -0,0 +1,15 @@
+# -- coding: utf-8
+
+class KyotoTycoon
+  module Serializer
+    class Default
+      def self.encode(obj)
+        obj
+      end
+
+      def self.decode(str)
+        str
+      end
+    end
+  end
+end

data/lib/kyototycoon/serializer/msgpack.rb

@@ -0,0 +1,21 @@
+# -- coding: utf-8
+
+require "rubygems"
+begin
+  require "msgpack"
+rescue LoadError
+end
+
+class KyotoTycoon
+  module Serializer
+    class Msgpack
+      def self.encode(obj)
+        obj.to_msgpack
+      end
+
+      def self.decode(str)
+        MessagePack.unpack(str) if str
+      end
+    end
+  end
+end

data/lib/kyototycoon/serializer.rb

@@ -0,0 +1,9 @@
+# -- coding: utf-8
+
+class KyotoTycoon
+  module Serializer
+    def self.get(adaptor)
+      const_get(adaptor.to_s.capitalize)
+    end
+  end
+end