rufus-tokyo 0.1.7 → 0.1.8

data/lib/rufus/edo/cabinet/abstract.rb

@@ -0,0 +1,203 @@
+#
+#--
+# 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"
+#
+# jmettraux@gmail.com
+#
+
+require 'tokyocabinet' # gem install careo-tokyocabinet
+
+require 'rufus/edo/cabcore'
+require 'rufus/tokyo/config'
+
+
+module Rufus::Edo
+
+  #
+  # A cabinet wired 'natively' to the libtokyocabinet.dynlib (approximatevely
+  # 2 times faster than the wiring over FFI).
+  #
+  # This class has the exact same methods as Rufus::Tokyo::Cabinet. It's faster
+  # though. The advantage of Rufus::Tokyo::Cabinet lies in that in runs on
+  # Ruby 1.8, 1.9 and JRuby.
+  #
+  # You need to have Hirabayashi-san's binding installed to use this
+  # Rufus::Edo::Cabinet :
+  #
+  #   http://github.com/jmettraux/rufus-tokyo/tree/master/lib/rufus/edo
+  #
+  # You can then write code like :
+  #
+  #   require 'rubygems'
+  #   require 'rufus/edo' # sudo gem install rufus-tokyo
+  #
+  #   db = Rufus::Edo::Cabinet.new('data.tch')
+  #
+  #   db['hello'] = 'world'
+  #
+  #   puts db['hello']
+  #     # -> 'world'
+  #
+  #   db.close
+  #
+  # This cabinet wraps hashes, b+ trees and fixed length databases. For tables,
+  # see Rufus::Edo::Table
+  #
+  class Cabinet
+
+    include Rufus::Edo::CabinetCore
+    include Rufus::Tokyo::CabinetConfig
+
+    #
+    # Initializes and open a cabinet (hash, b+ tree or fixed-size)
+    #
+    # db = Rufus::Edo::Cabinet.new('data.tch')
+    #   # or
+    # db = Rufus::Edo::Cabinet.new('data', :type => :hash)
+    #
+    # 3 types are recognized :hash (.tch), :btree (.tcb) and :fixed (.tcf). For
+    # tables, see Rufus::Edo::Table
+    #
+    # == parameters
+    #
+    # There are two ways to pass parameters at the opening of a db :
+    #
+    #   db = Rufus::Edo::Cabinet.new('data.tch#opts=ld#mode=w') # or
+    #   db = Rufus::Edo::Cabinet.new('data.tch', :opts => 'ld', :mode => 'w')
+    #
+    # most verbose :
+    #
+    #   db = Rufus::Edo::Cabinet.new(
+    #     'data', :type => :hash, :opts => 'ld', :mode => 'w')
+    #
+    # === mode
+    #
+    #   * :mode    a set of chars ('r'ead, 'w'rite, 'c'reate, 't'runcate,
+    #              'e' non locking, 'f' non blocking lock), default is 'wc'
+    #
+    # === other parameters
+    #
+    # 'On-memory hash database supports "bnum", "capnum", and "capsiz".
+    #  On-memory tree database supports "capnum" and "capsiz".
+    #  Hash database supports "mode", "bnum", "apow", "fpow", "opts",
+    #  "rcnum", and "xmsiz".
+    #  B+ tree database supports "mode", "lmemb", "nmemb", "bnum", "apow",
+    #  "fpow", "opts", "lcnum", "ncnum", and "xmsiz".
+    #  Fixed-length database supports "mode", "width", and "limsiz"'
+    #
+    #   * :opts    a set of chars ('l'arge, 'd'eflate, 'b'zip2, 't'cbs)
+    #              (usually empty or something like 'ld' or 'lb')
+    #
+    #   * :bnum    number of elements of the bucket array
+    #   * :apow    size of record alignment by power of 2 (defaults to 4)
+    #   * :fpow    maximum number of elements of the free block pool by
+    #              power of 2 (defaults to 10)
+    #   * :mutex   when set to true, makes sure only 1 thread at a time
+    #              accesses the table (well, Ruby, global thread lock, ...)
+    #
+    #   * :rcnum   specifies the maximum number of records to be cached.
+    #              If it is not more than 0, the record cache is disabled.
+    #              It is disabled by default.
+    #   * :lcnum   specifies the maximum number of leaf nodes to be cached.
+    #              If it is not more than 0, the default value is specified.
+    #              The default value is 2048.
+    #   * :ncnum   specifies the maximum number of non-leaf nodes to be
+    #              cached. If it is not more than 0, the default value is
+    #              specified. The default value is 512.
+    #
+    #   * :lmemb   number of members in each leaf page (defaults to 128) (btree)
+    #   * :nmemb   number of members in each non-leaf page (default 256) (btree)
+    #
+    #   * :width   width of the value of each record (default 255) (fixed)
+    #   * :limsiz  limit size of the database file (default 268_435_456) (fixed)
+    #
+    #   * :xmsiz   specifies the size of the extra mapped memory. If it is
+    #              not more than 0, the extra mapped memory is disabled.
+    #              The default size is 67108864.
+    #
+    #   * :capnum  specifies the capacity number of records.
+    #   * :capsiz  specifies the capacity size of using memory.
+    #
+    #
+    # = NOTE :
+    #
+    # On reopening a file, Cabinet will tend to stick to the parameters as
+    # set when the file was opened. To change that, have a look at the
+    # man pages of the various command line tools coming with Tokyo Cabinet.
+    #
+    def initialize (path, params={})
+
+      conf = determine_conf(path, params)
+
+      klass = {
+        :hash => TokyoCabinet::HDB,
+        :btree => TokyoCabinet::BDB,
+        :fixed => TokyoCabinet::FDB
+      }[conf[:type]]
+
+      @db = klass.new
+
+      #
+      # tune
+
+      tuning_parameters = case conf[:type]
+        when :hash then [ :bnum, :apow, :fpow, :opts ]
+        when :btree then [ :lmemb, :nmemb, :bnum, :apow, :fpow, :opts ]
+        when :fixed then [ :bnum, :width, :limsiz ]
+      end
+
+      @db.tune(*tuning_parameters.collect { |o| conf[o] })
+
+      #
+      # set cache
+
+      cache_values = case conf[:type]
+        when :hash then [ :rcnum ]
+        when :btree then [ :lcnum, :ncnum ]
+        when :fixed then nil
+      end
+
+      @db.setcache(*cache_values.collect { |o| conf[o] }) if cache_values
+
+      #
+      # set xmsiz
+
+      @db.setxmsiz(conf[:xmsiz]) unless conf[:type] == :fixed
+
+      #
+      # open
+
+      @db.open(conf[:path], conf[:mode]) || raise_error
+
+      #
+      # default
+
+      self.default = params[:default]
+      @default_proc ||= params[:default_proc]
+    end
+  end
+end
+

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

@@ -0,0 +1,147 @@
+#
+#--
+# 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"
+#
+# jmettraux@gmail.com
+#
+
+require 'tokyocabinet'
+
+require 'rufus/edo/error'
+require 'rufus/edo/tabcore'
+require 'rufus/tokyo/config'
+
+
+module Rufus::Edo
+
+  #
+  # Rufus::Edo::Table wraps Hirabayashi-san's Ruby bindings for Tokyo Cabinet
+  # tables.
+  #
+  # This class has the exact same methods as Rufus::Tokyo::Table. It's faster
+  # though. The advantage of Rufus::Tokyo::Table lies in that in runs on
+  # Ruby 1.8, 1.9 and JRuby.
+  #
+  # You need to have Hirabayashi-san's binding installed to use this
+  # Rufus::Edo::Table :
+  #
+  #   http://github.com/jmettraux/rufus-tokyo/tree/master/lib/rufus/edo
+  #
+  # Example usage :
+  #
+  #   require 'rufus/edo'
+  #   db = Rufus::Edo::Table.new('data.tct')
+  #   db['customer1'] = { 'name' => 'Taira no Kyomori', 'age' => '55' }
+  #   # ...
+  #   db.close
+  #
+  class Table
+
+    include Rufus::Tokyo::CabinetConfig
+    include Rufus::Edo::TableCore
+
+    #
+    # Initializes and open a table.
+    #
+    # db = Rufus::Edo::Table.new('data.tct')
+    #   # or
+    # db = Rufus::Edo::Table.new('data', :type => :table)
+    #   # or
+    # db = Rufus::Edo::Table.new('data')
+    #
+    # == parameters
+    #
+    # There are two ways to pass parameters at the opening of a db :
+    #
+    #   db = Rufus::Edo::Table.new('data.tct#opts=ld#mode=w') # or
+    #   db = Rufus::Edo::Table.new('data.tct', :opts => 'ld', :mode => 'w')
+    #
+    # === mode
+    #
+    #   * :mode    a set of chars ('r'ead, 'w'rite, 'c'reate, 't'runcate,
+    #              'e' non locking, 'f' non blocking lock), default is 'wc'
+    #
+    # === other parameters
+    #
+    #   * :opts    a set of chars ('l'arge, 'd'eflate, 'b'zip2, 't'cbs)
+    #              (usually empty or something like 'ld' or 'lb')
+    #
+    #   * :bnum    number of elements of the bucket array
+    #   * :apow    size of record alignment by power of 2 (defaults to 4)
+    #   * :fpow    maximum number of elements of the free block pool by
+    #              power of 2 (defaults to 10)
+    #
+    #   * :rcnum   specifies the maximum number of records to be cached.
+    #              If it is not more than 0, the record cache is disabled.
+    #              It is disabled by default.
+    #   * :lcnum   specifies the maximum number of leaf nodes to be cached.
+    #              If it is not more than 0, the default value is specified.
+    #              The default value is 2048.
+    #   * :ncnum   specifies the maximum number of non-leaf nodes to be
+    #              cached. If it is not more than 0, the default value is
+    #              specified. The default value is 512.
+    #
+    # = NOTE :
+    #
+    # On reopening a file, Cabinet will tend to stick to the parameters as
+    # set when the file was opened. To change that, have a look at the
+    # man pages of the various command line tools coming with Tokyo Cabinet.
+    #
+    def initialize (path, params={})
+
+      conf = determine_conf(path, params, :table)
+
+      @db = TokyoCabinet::TDB.new
+
+      #
+      # tune
+
+      @db.tune(conf[:bnum], conf[:apow], conf[:fpow], conf[:opts])
+
+      #
+      # set cache
+
+      @db.setcache(conf[:rcnum], conf[:lcnum], conf[:ncnum])
+
+      #
+      # set xmsiz
+
+      @db.setxmsiz(conf[:xmsiz])
+
+      #
+      # open
+
+      @db.open(conf[:path], conf[:mode]) || raise_error
+    end
+
+    protected
+
+    def table_query_class #:nodoc#
+      TokyoCabinet::TDBQRY
+    end
+  end
+end
+

data/lib/rufus/edo/error.rb

@@ -0,0 +1,41 @@
+#
+#--
+# 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"
+#
+# jmettraux@gmail.com
+#
+
+module Rufus
+module Edo
+
+  #
+  # A common error class
+  #
+  class EdoError < RuntimeError; end
+
+end
+end
+

data/lib/rufus/edo/ntyrant.rb

@@ -0,0 +1,4 @@
+
+require 'rufus/edo/ntyrant/abstract'
+require 'rufus/edo/ntyrant/table'
+

data/lib/rufus/edo/ntyrant/abstract.rb

@@ -0,0 +1,169 @@
+#
+#--
+# 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"
+#
+# jmettraux@gmail.com
+#
+
+require 'tokyotyrant' # gem install careo-tokyotyrant
+
+require 'rufus/edo/error'
+require 'rufus/edo/cabcore'
+require 'rufus/tokyo/stats'
+
+
+module Rufus::Edo
+
+  #
+  # Connecting to a 'classic' Tokyo Tyrant server remotely
+  #
+  #   require 'rufus/edo/ntyrant'
+  #   t = Rufus::Edo::NetTyrant.new('127.0.0.1', 44001)
+  #   t['toto'] = 'blah blah'
+  #   t['toto'] # => 'blah blah'
+  #
+  class NetTyrant
+
+    include Rufus::Edo::CabinetCore
+    include Rufus::Tokyo::TyrantStats
+
+    attr_reader :host, :port
+
+    #
+    # Connects to a given Tokyo Tyrant server.
+    #
+    # Note that if the port is not specified, the host parameter is expected
+    # to hold the path to a unix socket (not a TCP socket).
+    #
+    # (You can start a unix socket listening Tyrant with :
+    #
+    #    ttserver -host /tmp/tyrant_socket -port 0 data.tch
+    #
+    #  and then connect to it with rufus-tokyo via :
+    #
+    #    require 'rufus/edo/ntyrant'
+    #    db = Rufus::Edo::NetTyrant.new('/tmp/tyrant_socket')
+    #    db['a'] = 'alpha'
+    #    db.close
+    # )
+    #
+    # To connect to a classic TCP bound Tyrant (port 44001) :
+    #
+    #   t = Rufus::Edo::NetTyrant.new('127.0.0.1', 44001)
+    #
+    def initialize (host, port=0)
+
+      @host = host
+      @port = port
+
+      @db = TokyoTyrant::RDB.new
+      @db.open(host, port) || raise_error
+
+      if self.stat['type'] == 'table'
+
+        @db.close
+
+        raise ArgumentError.new(
+          "tyrant at #{host}:#{port} is a table, " +
+          "use Rufus::Edo::NetTyrantTable instead to access it.")
+      end
+    end
+
+    #
+    # Returns the 'weight' of the db (in bytes)
+    #
+    def weight
+
+      self.stat['size']
+    end
+
+    #
+    # isn't that a bit dangerous ? it creates a file on the server...
+    #
+    # DISABLED.
+    #
+    def copy (target_path)
+
+      #@db.copy(target_path)
+      raise 'not allowed to create files on the server'
+    end
+
+    #
+    # Copies the current cabinet to a new file.
+    #
+    # Does it by copying each entry afresh to the target file. Spares some
+    # space, hence the 'compact' label...
+    #
+    def compact_copy (target_path)
+
+      raise NotImplementedError.new('not creating files locally')
+    end
+
+    #
+    # Deletes all the entries whose keys begin with the given prefix
+    #
+    def delete_keys_with_prefix (prefix)
+
+      @db.misc('outlist', @db.fwmkeys(prefix, -1)) # -1 for no limits
+      nil
+    end
+
+    #
+    # Given a list of keys, returns a Hash { key => value } of the
+    # matching entries (in one sweep).
+    #
+    def lget (keys)
+
+      Hash[*@db.misc('getlist', keys)]
+    end
+
+    #
+    # Merges the given hash into this Tyrant and returns self.
+    #
+    def merge! (hash)
+
+      @db.misc('putlist', hash.inject([]) { |l, (k, v)| l << k; l << v; l })
+      self
+    end
+    alias :lput :merge!
+
+    #
+    # Given a list of keys, deletes all the matching entries (in one sweep).
+    #
+    def ldelete (keys)
+
+      @db.misc('outlist', keys)
+      nil
+    end
+
+    protected
+
+    def do_stat #:nodoc#
+      @db.stat
+    end
+  end
+end
+