jackowayed-rufus-tokyo 0.1.13.1 → 0.1.13.2

data/lib/rufus/tokyo/query.rb

@@ -0,0 +1,102 @@
+#--
+# 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
+
+  #
+  # Some constants shared by table implementations.
+  #
+  module QueryConstants
+
+    OPERATORS = {
+
+      # strings...
+
+      :streq => 0, # string equality
+      :eq => 0,
+      :eql => 0,
+      :equals => 0,
+
+      :strinc => 1, # string include
+      :inc => 1, # string include
+      :includes => 1, # string include
+
+      :strbw => 2, # string begins with
+      :bw => 2,
+      :starts_with => 2,
+      :strew => 3, # string ends with
+      :ew => 3,
+      :ends_with => 3,
+
+      :strand => 4, # string which include all the tokens in the given exp
+      :and => 4,
+
+      :stror => 5, # string which include at least one of the tokens
+      :or => 5,
+
+      :stroreq => 6, # string which is equal to at least one token
+
+      :strorrx => 7, # string which matches the given regex
+      :regex => 7,
+      :matches => 7,
+
+      # numbers...
+
+      :numeq => 8, # equal
+      :numequals => 8,
+      :numgt => 9, # greater than
+      :gt => 9,
+      :numge => 10, # greater or equal
+      :ge => 10,
+      :gte => 10,
+      :numlt => 11, # greater or equal
+      :lt => 11,
+      :numle => 12, # greater or equal
+      :le => 12,
+      :lte => 12,
+      :numbt => 13, # a number between two tokens in the given exp
+      :bt => 13,
+      :between => 13,
+
+      :numoreq => 14 # number which is equal to at least one token
+    }
+
+    TDBQCNEGATE = 1 << 24
+    TDBQCNOIDX = 1 << 25
+
+    DIRECTIONS = {
+      :strasc => 0,
+      :strdesc => 1,
+      :asc => 0,
+      :desc => 1,
+      :numasc => 2,
+      :numdesc => 3
+    }
+  end
+
+end
+end
+

data/lib/rufus/tokyo/transactions.rb

@@ -0,0 +1,74 @@
+#--
+# 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
+
+  #
+  # A mixin for structures to respond to tranbegin, trancommit and tranabort
+  #
+  module Transactions
+
+    #
+    # Transaction in a block.
+    #
+    #   table.transaction do
+    #     table['pk0'] => { 'name' => 'Fred', 'age' => '40' }
+    #     table['pk1'] => { 'name' => 'Brooke', 'age' => '76' }
+    #     table.abort if weather.bad?
+    #   end
+    #
+    # (This is a table example, a classical cabinet won't accept a hash
+    # as a value for its entries).
+    #
+    # If an error or an abort is trigger withing the transaction, it's rolled
+    # back. If the block executes successfully, it gets commited.
+    #
+    def transaction
+
+      return unless block_given?
+
+      begin
+        tranbegin
+        yield
+        trancommit
+      rescue Exception => e
+        tranabort
+      end
+    end
+
+    #
+    # Aborts the enclosing transaction
+    #
+    # See #transaction
+    #
+    def abort
+      raise "abort transaction !"
+    end
+  end
+
+end
+end
+

data/lib/rufus/tokyo/ttcommons.rb

@@ -0,0 +1,59 @@
+#--
+# 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
+
+  #
+  # #stat and #compte_ext_opts, that's all.
+  #
+  module TyrantCommons
+
+    # Returns a hash of information about the Tokyo Tyrant database (or table)
+    # at the other end of the connection.
+    #
+    def stat
+
+      do_stat.split("\n").inject({}) { |r, l|
+        kv = l.split("\t")
+        r[kv.first] = kv.last
+        r
+      }
+    end
+
+    # Computes the :int option for the "ext" function (triggering
+    # tyrant embedded lua functions)
+    #
+    def compute_ext_opts (opts)
+
+      r = 0
+      r = r | 1 if opts[:record_locking]
+      r = r | 2 if opts[:global_locking]
+      r
+    end
+  end
+end
+end
+

data/lib/rufus/tokyo/tyrant.rb

@@ -0,0 +1,35 @@
+#--
+# 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.
+#++
+
+
+require 'rufus/tokyo'
+
+
+module Rufus::Tokyo
+end
+
+require 'rufus/tokyo/tyrant/lib'
+require 'rufus/tokyo/tyrant/abstract'
+require 'rufus/tokyo/tyrant/table'
+

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

@@ -0,0 +1,138 @@
+#--
+# 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.
+#++
+
+
+require 'rufus/tokyo/ttcommons'
+
+
+module Rufus::Tokyo
+
+  #
+  # Connecting to a 'classic' tyrant server remotely
+  #
+  #   require 'rufus/tokyo/tyrant'
+  #   t = Rufus::Tokyo::Tyrant.new('127.0.0.1', 44001)
+  #   t['toto'] = 'blah blah'
+  #   t['toto'] # => 'blah blah'
+  #
+  class Tyrant < Cabinet
+
+    include TyrantCommons
+
+    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/tokyo/tyrant'
+    #    db = Rufus::Tokyo::Tyrant.new('/tmp/tyrant_socket')
+    #    db['a'] = 'alpha'
+    #    db.close
+    # )
+    #
+    # To connect to a classic TCP bound Tyrant (port 44001) :
+    #
+    #   t = Rufus::Tokyo::Tyrant.new('127.0.0.1', 44001)
+    #
+    def initialize (host, port=0)
+
+      @db = lib.tcrdbnew
+
+      @host = host
+      @port = port
+
+      (lib.tcrdbopen(@db, host, port) == 1) ||
+        raise("couldn't connect to tyrant at #{host}:#{port}")
+
+      if self.stat['type'] == 'table'
+
+        self.close
+
+        raise ArgumentError.new(
+          "tyrant at #{host}:#{port} is a table, " +
+          "use Rufus::Tokyo::TyrantTable instead to access it.")
+      end
+    end
+
+    # Using the tyrant lib
+    #
+    def lib
+      TyrantLib
+    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
+
+    # Calls a lua embedded function
+    # (http://tokyocabinet.sourceforge.net/tyrantdoc/#luaext)
+    #
+    # Options are :global_locking and :record_locking
+    #
+    # Returns the return value of the called function.
+    #
+    # Nil is returned in case of failure.
+    #
+    def ext (func_name, key, value, opts={})
+
+      lib.tcrdbext2(
+        @db, func_name.to_s, compute_ext_opts(opts), key.to_s, value.to_s
+      ) rescue nil
+    end
+
+    # Tyrant databases DO NOT support the 'defrag' call. Calling this method
+    # will raise an exception.
+    #
+    undef_method(:defrag)
+
+    protected
+
+    def do_call_misc (function, list_pointer)
+
+      lib.tcrdbmisc(@db, function, 0, list_pointer)
+        # opts always to 0 for now
+    end
+
+    # Returns the raw stat string from the Tyrant server.
+    #
+    def do_stat
+
+      lib.tcrdbstat(@db)
+    end
+  end
+end
+

data/lib/rufus/tokyo/tyrant/lib.rb

@@ -0,0 +1,149 @@
+#--
+# 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::Tokyo
+
+  #
+  # The libtokyocabinet.so methods get bound to this module
+  #
+  module TyrantLib #:nodoc#
+
+    extend FFI::Library
+
+    #
+    # find Tokyo Tyrant lib
+
+    paths = Array(ENV['TOKYO_TYRANT_LIB'] || %w{
+      /usr/lib/libtokyotyrant.so
+      /opt/local/lib/libtokyotyrant.dylib
+      /opt/local/lib/libtokyotyrant.so
+      /usr/local/lib/libtokyotyrant.dylib
+      /usr/local/lib/libtokyotyrant.so
+    })
+
+    begin
+
+      ffi_lib(*paths)
+
+    rescue LoadError => le
+      raise(
+        "didn't find Tokyo Tyrant libs on your system. " +
+        "Please install Tokyo Tyrant (http://tokyocabinet.sf.net) " +
+        "(see also http://openwferu.rubyforge.org/tokyo.html)"
+      )
+    end
+
+
+    class << self
+      alias :attfunc :attach_function
+    end
+
+    #
+    # tcrdb functions
+
+    attfunc :tcrdbnew, [], :pointer
+
+    attfunc :tcrdbstat, [ :pointer ], :string
+
+    attfunc :tcrdbopen, [ :pointer, :string, :int ], :int
+    attfunc :abs_close, :tcrdbclose, [ :pointer ], :int
+
+    attfunc :abs_del, :tcrdbdel, [ :pointer ], :void
+
+    attfunc :abs_rnum, :tcrdbrnum, [ :pointer ], :uint64
+    attfunc :abs_size, :tcrdbsize, [ :pointer ], :uint64
+
+    attfunc :abs_put2, :tcrdbput2, [ :pointer, :string, :string ], :int
+    attfunc :abs_get2, :tcrdbget2, [ :pointer, :string ], :string
+    attfunc :abs_out2, :tcrdbout2, [ :pointer, :string ], :int
+
+    attfunc :abs_iterinit, :tcrdbiterinit, [ :pointer ], :int
+    attfunc :abs_iternext2, :tcrdbiternext2, [ :pointer ], :string
+
+    attfunc :abs_vanish, :tcrdbvanish, [ :pointer ], :int
+
+    attfunc :abs_sync, :tcrdbsync, [ :pointer ], :int
+    attfunc :abs_copy, :tcrdbcopy, [ :pointer, :string ], :int
+
+    attfunc :abs_fwmkeys2, :tcrdbfwmkeys2, [ :pointer, :string, :int ], :pointer
+    attfunc :tcrdbmisc, [ :pointer, :string, :int, :pointer ], :pointer
+
+    attfunc :tcrdbext2, [ :pointer, :string, :int, :string, :string ], :string
+
+    attfunc :addint, :tcrdbaddint, [ :pointer, :string, :int, :int ], :int
+    attfunc :adddouble, :tcrdbadddouble, [ :pointer, :string, :int, :double ], :double
+
+    #
+    # table functions
+
+    attfunc :tab_close, :tcrdbclose, [ :pointer ], :int
+
+    attfunc :tab_genuid, :tcrdbtblgenuid, [ :pointer ], :int64
+
+    attfunc :tab_get, :tcrdbtblget, [ :pointer, :string, :int ], :pointer
+
+    attfunc :tab_iterinit, :tcrdbiterinit, [ :pointer ], :int
+    attfunc :tab_iternext2, :tcrdbiternext2, [ :pointer ], :string
+
+    attfunc :tab_put, :tcrdbtblput, [ :pointer, :string, :int, :pointer ], :int
+
+    attfunc :tab_out, :tcrdbtblout, [ :pointer, :string, :int ], :int
+
+    attfunc :tab_ecode, :tcrdbecode, [ :pointer ], :int
+    attfunc :tab_errmsg, :tcrdberrmsg, [ :int ], :string
+
+    attfunc :tab_del, :tcrdbdel, [ :pointer ], :void
+
+    attfunc :tab_rnum, :tcrdbrnum, [ :pointer ], :uint64
+
+    attfunc :tab_vanish, :tcrdbvanish, [ :pointer ], :int
+
+    attfunc :tab_setindex, :tcrdbtblsetindex, [ :pointer, :string, :int ], :int
+
+    attfunc :tab_fwmkeys2, :tcrdbfwmkeys2, [ :pointer, :string, :int ], :pointer
+
+    #
+    # qry functions
+
+    attfunc :qry_new, :tcrdbqrynew, [ :pointer ], :pointer
+    attfunc :qry_del, :tcrdbqrydel, [ :pointer ], :void
+
+    attfunc :qry_addcond, :tcrdbqryaddcond, [ :pointer, :string, :int, :string ], :void
+    attfunc :qry_setorder, :tcrdbqrysetorder, [ :pointer, :string, :int ], :void
+
+    begin
+      attfunc :qry_setmax, :tcrdbqrysetmax, [ :pointer, :int ], :void
+    rescue FFI::NotFoundError => nfe
+      attfunc :qry_setlimit, :tcrdbqrysetlimit, [ :pointer, :int, :int ], :void
+    end
+
+    attfunc :qry_search, :tcrdbqrysearch, [ :pointer ], :pointer
+
+    begin # since TC 1.4.21
+      attfunc :qry_count, :tcrdbqrysearchcount, [ :pointer ], :int
+    rescue FFI::NotFoundError => nfe
+    end
+  end
+end