rufus-tokyo 1.0.1 → 1.0.2

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

@@ -49,6 +49,7 @@ module Rufus::Edo
 
     include Rufus::Edo::TableCore
     include Rufus::Tokyo::TyrantCommons
+    include Rufus::Tokyo::NoTransactions
 
     attr_reader :host, :port
 
@@ -87,6 +88,8 @@ module Rufus::Edo
       @db = TokyoTyrant::RDBTBL.new
       @db.open(host, port) || raise_error
 
+      @default_proc = nil
+
       if self.stat['type'] != 'table'
 
         @db.close
@@ -99,9 +102,9 @@ module Rufus::Edo
 
     # Gets multiple records in one sweep.
     #
-    def lget (keys)
+    def lget (*keys)
 
-      h = keys.inject({}) { |h, k| h[k] = nil; h }
+      h = keys.flatten.inject({}) { |hh, k| hh[k] = nil; hh }
       r = @db.mget(h)
 
       raise 'lget failure' if r == -1
@@ -111,22 +114,6 @@ module Rufus::Edo
 
     alias :mget :lget
 
-    def transaction #:nodoc#
-      raise NoMethodError.new("NetTyrant : transactions not supported")
-    end
-    def abort #:nodoc#
-      raise NoMethodError.new("NetTyrant : transactions not supported")
-    end
-    def tranbegin #:nodoc#
-      raise NoMethodError.new("NetTyrant : transactions not supported")
-    end
-    def trancommit #:nodoc#
-      raise NoMethodError.new("NetTyrant : transactions not supported")
-    end
-    def tranabort #:nodoc#
-      raise NoMethodError.new("NetTyrant : transactions not supported")
-    end
-
     # Calls a lua embedded function
     # (http://tokyocabinet.sourceforge.net/tyrantdoc/#luaext)
     #

data/lib/rufus/edo/tabcore.rb

@@ -26,12 +26,13 @@
 require 'rufus/tokyo/utils'
 require 'rufus/tokyo/query'
 require 'rufus/tokyo/transactions'
+require 'rufus/tokyo/openable'
 
 
 module Rufus::Edo
 
   #
-  # Methods common to the two table classes (cabinet + ntyrant) found in
+  # Methods common to the two table classes (table + ntyrant) found in
   # Rufus::Edo
   #
   module TableCore
@@ -39,6 +40,11 @@ module Rufus::Edo
     include Rufus::Tokyo::HashMethods
     include Rufus::Tokyo::Transactions
 
+    # Add the open() method to all Table type classes.
+    def self.included(target)
+      target.extend(Rufus::Tokyo::Openable)
+    end
+
     # Closes the table (and frees the datastructure allocated for it),
     # raises an exception in case of failure.
     #
@@ -88,7 +94,7 @@ module Rufus::Edo
 
       column_name = column_name == :pk ? '' : column_name.to_s
 
-      i = types.inject(0) { |i, t| i = i | INDEX_TYPES[t]; i }
+      i = types.inject(0) { |ii, t| ii | INDEX_TYPES[t] }
 
       @db.setindex(column_name, i) || raise_error
     end
@@ -154,46 +160,24 @@ module Rufus::Edo
     #
     def keys (options={})
 
-      if pref = options[:prefix]
-
-        @db.fwmkeys(pref, options[:limit] || -1)
-
-      else
-
-        limit = options[:limit] || -1
-        limit = nil if limit < 1
+      pref = options.fetch(:prefix, "")
 
-        @db.iterinit
-
-        l = []
-
-        while (k = @db.iternext)
-          break if limit and l.size >= limit
-          l << k
-        end
-
-        l
-      end
+      @db.fwmkeys(pref, options[:limit] || -1)
     end
 
     # Deletes all the entries whose key begin with the given prefix.
     #
     def delete_keys_with_prefix (prefix)
 
-      if @db.respond_to?(:misc)
-        @db.misc('outlist', @db.fwmkeys(prefix, -1))
-      else
-        ks = @db.fwmkeys(prefix, -1) # -1 for no limit
-        ks.each { |k| self.delete(k) }
-      end
+      query_delete { |q| q.add('', :strbw, prefix) }
     end
 
     # Returns a hash { key => record } of all the records matching the
     # given keys.
     #
-    def lget (keys)
+    def lget (*keys)
 
-      keys = Rufus::Tokyo::h_or_a_to_s(keys)
+      keys = Rufus::Tokyo::h_or_a_to_s(keys.flatten)
 
       if @db.respond_to?(:mget)
         @db.mget(keys)
@@ -236,6 +220,15 @@ module Rufus::Edo
       prepare_query(&block).delete
     end
 
+    # Prepares, runs AND counts all the matching records.
+    #
+    def query_count (&block)
+
+      prepare_query { |q|
+        q.pk_only  # improve efficiency, since we have to do the query
+      }.count
+    end
+
     # Warning : this method is low-level, you probably only need
     # to use #transaction and a block.
     #
@@ -443,10 +436,10 @@ module Rufus::Edo
     #
     def initialize (query_class, table)
 
-      @table = table
-      @query = query_class.new(table.original)
-
-      @opts = {}
+      @table   = table
+      @query   = query_class.new(table.original)
+      @opts    = {}
+      @has_run = false
     end
 
     # Returns the original, underlying RDBQUERY instance.
@@ -624,7 +617,7 @@ module Rufus::Edo
     # Runs this query (returns a TableResultSet instance)
     #
     def run
-
+      @has_run        = true
       @last_resultset = TableResultSet.new(@table, @query.search, @opts)
     end
 
@@ -642,7 +635,7 @@ module Rufus::Edo
 
       #@query.count
         # not yet implemented by Hirabayashi-san
-
+      run.free unless @has_run
       @last_resultset ? @last_resultset.size : 0
     end
 

data/lib/rufus/tokyo.rb

@@ -29,7 +29,7 @@ require 'ffi' # sudo gem install ffi
 module Rufus
 module Tokyo
 
-  VERSION = '1.0.1'
+  VERSION = '1.0.2'
 
   #
   # A common error class

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

@@ -25,6 +25,8 @@
 
 require 'rufus/tokyo/transactions'
 require 'rufus/tokyo/outlen'
+#require 'rufus/tokyo/config'
+require 'rufus/tokyo/openable'
 
 
 module Rufus::Tokyo
@@ -54,6 +56,8 @@ module Rufus::Tokyo
     include HashMethods
     include Transactions
     include Outlen
+    #include CabinetConfig
+    extend Openable
 
     # Creates/opens the cabinet, raises an exception in case of
     # creation/opening failure.
@@ -124,11 +128,29 @@ module Rufus::Tokyo
     #   db = Rufus::Tokyo::Cabinet.new(
     #     'data', :type => :hash, :opts => 'ld', :mode => 'w')
     #
-    # === mode
+    # === :mode
     #
     #   * :mode    a set of chars ('r'ead, 'w'rite, 'c'reate, 't'runcate,
     #              'e' non locking, 'f' non blocking lock), default is 'wc'
     #
+    # === :default and :default_proc
+    #
+    # Much like a Ruby Hash, a Cabinet accepts a default value or a default_proc
+    #
+    #   db = Rufus::Tokyo::Cabinet.new('data.tch', :default => 'xxx')
+    #   db['fred'] = 'Astaire'
+    #   p db['fred'] # => 'Astaire'
+    #   p db['ginger'] # => 'xxx'
+    #
+    #   db = Rufus::Tokyo::Cabinet.new(
+    #     'data.tch',
+    #     :default_proc => lambda { |cab, key| "not found : '#{k}'" }
+    #   p db['ginger'] # => "not found : 'ginger'"
+    #
+    # The first arg passed to the default_proc is the cabinet itself, so this
+    # opens up interesting possibilities.
+    #
+    #
     # === other parameters
     #
     # 'On-memory hash database supports "bnum", "capnum", and "capsiz".
@@ -178,6 +200,9 @@ module Rufus::Tokyo
     #
     def initialize (name, params={})
 
+      #conf = determine_conf(path, params)
+        # not using it
+
       @db = lib.tcadbnew
 
       name = '*' if name == :mem_hash # in memory hash database
@@ -188,35 +213,20 @@ module Rufus::Tokyo
       end
 
       @path = name
+      @type = File.extname(@path)[1..-1]
 
       name = name + params.collect { |k, v| "##{k}=#{v}" }.join('')
 
-      (lib.tcadbopen(@db, name) == 1) || raise(
+      (lib.tcadbopen(@db, name) != 0) || raise(
         TokyoError.new("failed to open/create db '#{name}' #{params.inspect}"))
 
+      #
+      # default value|proc
+
       self.default = params[:default]
       @default_proc ||= params[:default_proc]
     end
 
-    # Same args as initialize, but can take a block form that will
-    # close the db when done. Similar to File.open
-    #
-    def self.open (name, params={})
-
-      db = self.new(name, params)
-
-      if block_given?
-        yield db
-        nil
-      else
-        db
-      end
-
-    ensure
-
-      db.close if block_given? && db
-    end
-
     # Returns a new in-memory hash. Accepts the same optional params hash
     # as new().
     #
@@ -382,41 +392,20 @@ module Rufus::Tokyo
     #
     def keys (options={})
 
-      outlen = nil
-
-      if pre = options[:prefix]
+      if @type == "tcf"
+        min, max = "min", "max"
+        l        = lib.tcfdbrange2( as_fixed, min, Rufus::Tokyo.blen(min),
+                                              max, Rufus::Tokyo.blen(max), -1)
+      else
+        pre = options.fetch(:prefix, "")
 
         l = lib.abs_fwmkeys(
           @db, pre, Rufus::Tokyo.blen(pre), options[:limit] || -1)
-
-        l = Rufus::Tokyo::List.new(l)
-
-        options[:native] ? l : l.release
-
-      else
-
-        limit = options[:limit] || -1
-        limit = nil if limit < 1
-
-        l = options[:native] ? Rufus::Tokyo::List.new : []
-
-        lib.abs_iterinit(@db)
-
-        outlen = FFI::MemoryPointer.new(:int)
-
-        loop do
-          break if limit and l.size >= limit
-          out = lib.abs_iternext(@db, outlen)
-          break if out.address == 0
-          l << out.get_bytes(0, outlen.get_int(0))
-        end
-
-        l
       end
 
-    ensure
+      l = Rufus::Tokyo::List.new(l)
 
-      outlen.free if outlen
+      options[:native] ? l : l.release
     end
 
     # Deletes all the entries whose keys begin with the given prefix
@@ -433,9 +422,9 @@ module Rufus::Tokyo
     # Given a list of keys, returns a Hash { key => value } of the
     # matching entries (in one sweep).
     #
-    def lget (keys)
+    def lget (*keys)
 
-      keys = keys.collect { |k| k.to_s }
+      keys = keys.flatten.collect { |k| k.to_s }
 
       Hash[*call_misc('getlist', Rufus::Tokyo::List.new(keys))]
     end
@@ -460,11 +449,11 @@ module Rufus::Tokyo
 
     # Given a list of keys, deletes all the matching entries (in one sweep).
     #
-    def ldelete (keys)
+    def ldelete (*keys)
 
-      keys = keys.collect { |k| k.to_s }
-
-      call_misc('outlist', Rufus::Tokyo::List.new(keys))
+      call_misc(
+        'outlist',
+        Rufus::Tokyo::List.new(keys.flatten.collect { |k| k.to_s }))
     end
 
     # Increments the value stored under the given key with the given increment
@@ -472,6 +461,11 @@ module Rufus::Tokyo
     #
     # Accepts an integer or a double value.
     #
+    # Warning : Tokyo Cabinet/Tyrant doesn't store counter values as regular
+    # strings (db['key'] won't yield something that replies properly to #to_i)
+    #
+    # Use #counter_value(k) to get the current value set for the counter.
+    #
     def incr (key, inc=1)
 
       key = key.to_s
@@ -482,7 +476,7 @@ module Rufus::Tokyo
 
       raise(TokyoError.new(
         "incr failed, there is probably already a string value set " +
-        "for the key '#{key}'"
+        "for the key '#{key}'. Make sure there is no value before incrementing"
       )) if v == Rufus::Tokyo::INT_MIN || (v.respond_to?(:nan?) && v.nan?)
 
       v
@@ -492,6 +486,15 @@ module Rufus::Tokyo
     alias :add_int :incr
     alias :add_double :incr
 
+    # Returns the current value for a counter (a float or an int).
+    #
+    # See #incr
+    #
+    def counter_value (key)
+
+      incr(key, 0.0) rescue incr(key, 0)
+    end
+
     # Triggers a defrag run (TC >= 1.4.21 only)
     #
     def defrag
@@ -581,6 +584,27 @@ module Rufus::Tokyo
       lib.tcadbreveal(@db)
     end
 
+    # Returns the pointer to the fixed-width database hiding behind the
+    # abstract structure.
+    #
+    # Will raise an argument error if the structure behind the abstract db
+    # is not a fixed-width structure.
+    #
+    def as_fixed
+
+      raise(NoMethodError.new("cannot call Fixed-width function on #{@path}")) \
+        if ! @path.match(/\.tcf$/)
+
+      lib.tcadbreveal(@db)
+    end
+
+    # Advanced function. Initially added to uncover tc{b|f|h}dbsetmutex().
+    #
+    def call_non_abstract_function (funcname, *args)
+
+      lib.send(lib.tcadbreveal(@db), "#{@type}#{funcname}", *args)
+    end
+
     #--
     #def check_transaction_support
     #  raise(TokyoError.new(
@@ -616,8 +640,8 @@ module Rufus::Tokyo
 
     def libcall (lib_method, *args)
 
-      (eval(%{ lib.#{lib_method}(@db, *args) }) == 1) or \
-        raise TokyoError.new("call to #{lib_method} failed")
+      raise TokyoError.new("call to #{lib_method} failed") \
+        unless lib.send(lib_method, @db, *args) == 1
     end
 
   end

data/lib/rufus/tokyo/cabinet/lib.rb

@@ -198,6 +198,13 @@ module Rufus::Tokyo
     attfunc :tcbdbputdup, [ :pointer, :pointer, :int, :pointer, :int ], :int
     attfunc :tcbdbget4, [ :pointer, :pointer, :int ], :pointer
 
+    #
+    # tcfdb functions
+    #
+    # http://tokyocabinet.sourceforge.net/spex-en.html#tcfdbapi
+
+    attfunc :tcfdbrange2, [ :pointer, :pointer, :int, :pointer, :int, :int ], :pointer
+
     #
     # tcmap functions
     #