oedipus 0.0.1.pre1 → 0.0.1.pre2

data/ext/oedipus/oedipus.h

@@ -0,0 +1,50 @@
+/*-- encoding: utf-8 --*/
+
+/*
+ * Oedipus Sphinx 2 Search.
+ * Copyright © 2012 Chris Corbyn.
+ *
+ * See LICENSE file for details.
+ */
+
+#include <ruby.h>
+#include <mysql.h>
+
+/*! Internal struct used to reference a mysql connection */
+typedef struct {
+  /*! Boolean representing the connected state */
+  int   connected;
+  /*! The actual pointer allocated by mysql_init() */
+  MYSQL * ptr;
+} OdpMysql;
+
+/* -- Public methods -- */
+
+/*! Allocate and initialize a new mysql client */
+static VALUE odp_new(VALUE klass, VALUE host, VALUE port);
+
+/*! Initialize a new mysql client */
+static VALUE odp_initialize(VALUE self, VALUE host, VALUE port);
+
+/*! Connect, or reconnect to mysql */
+static VALUE odp_open(VALUE self);
+
+/*! Disconnect from mysql */
+static VALUE odp_close(VALUE self);
+
+/*! Execute an SQL non-read query and return the number of rows affected */
+static VALUE odp_execute(VALUE self, VALUE sql);
+
+/*! Execute several SQL read queries and return the result sets  */
+static VALUE odp_query(VALUE self, VALUE sql);
+
+/*! Cast the given field to a ruby data type */
+static VALUE odp_cast_value(MYSQL_FIELD f, char * v, unsigned long len);
+
+/* -- Internal methods -- */
+
+/*! Generic method to raise a connection error */
+static void odp_raise(VALUE self, const char *msg);
+
+/*! Free memory allocated to mysql */
+static void odp_free(OdpMysql *conn);

data/lib/oedipus/comparison/between.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Between comparison of range.
+  class Comparison::Between < Comparison
+    def to_s
+      [
+        "BETWEEN",
+        Connection.quote(v.first),
+        "AND",
+        Connection.quote(v.exclude_end? ? v.end - 1 : v.end)
+      ].join(" ")
+    end
+
+    def inverse
+      Comparison::Outside.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/equal.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Equality comparison of value.
+  class Comparison::Equal < Comparison
+    def to_s
+      "= #{Connection.quote(v)}"
+    end
+
+    def inverse
+      Comparison::NotEqual.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/gt.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Greater than comparison of +v+.
+  class Comparison::GT < Comparison
+    def to_s
+      "> #{Connection.quote(v)}"
+    end
+
+    def inverse
+      Comparison::LTE.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/gte.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Greater than or equal comparison of +v+.
+  class Comparison::GTE < Comparison
+    def to_s
+      ">= #{Connection.quote(v)}"
+    end
+
+    def inverse
+      Comparison::LT.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/in.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # IN comparison of +v+.
+  class Comparison::In < Comparison
+    def to_s
+      "IN (#{v.map { |o| Connection.quote(o)}.join(', ')})"
+    end
+
+    def inverse
+      Comparison::NotIn.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/lt.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Less than comparison of +v+.
+  class Comparison::LT < Comparison
+    def to_s
+      "< #{Connection.quote(v)}"
+    end
+
+    def inverse
+      Comparison::GTE.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/lte.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Less than or equal comparison of +v+.
+  class Comparison::LTE < Comparison
+    def to_s
+      "<= #{Connection.quote(v)}"
+    end
+
+    def inverse
+      Comparison::GT.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/not.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Negation comparison of value.
+  class Comparison::Not < Comparison
+    def initialize(v)
+      super(Comparison.of(v))
+    end
+
+    def to_s
+      v.inverse.to_s
+    end
+
+    def inverse
+      v
+    end
+  end
+end

data/lib/oedipus/comparison/not_equal.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Negation comparison of value.
+  class Comparison::NotEqual < Comparison
+    def to_s
+      "!= #{Connection.quote(v)}"
+    end
+
+    def inverse
+      Comparison::Equal.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/not_in.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # NOT IN comparison of +v+.
+  class Comparison::NotIn < Comparison
+    def to_s
+      "NOT IN (#{v.map { |o| Connection.quote(o)}.join(', ')})"
+    end
+
+    def inverse
+      Comparison::In.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/outside.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Outside comparison of range.
+  class Comparison::Outside < Comparison
+    def to_s
+      [
+        "NOT BETWEEN",
+        Connection.quote(v.first),
+        "AND",
+        Connection.quote(v.exclude_end? ? v.end - 1 : v.end)
+      ].join(" ")
+    end
+
+    def inverse
+      Comparison::Between.new(v)
+    end
+  end
+end

data/lib/oedipus/comparison/shortcuts.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  class Comparison
+    # Provides short methods for casting values to Comparisons.
+    module Shortcuts
+      extend self
+
+      # Return the Comparison for equality of +v+.
+      #
+      # @param [Object] v
+      #   any ruby object to compare in a query
+      #
+      # @return [Comparison::Equal]
+      #   an equality comparison of v
+      def eq(v)
+        Equal.new(v)
+      end
+
+      # Return the Comparison for inequality of +v+.
+      #
+      # @param [Object] v
+      #   any ruby object to compare in a query
+      #
+      # @return [Comparison::Equal]
+      #   an inequality comparison of v
+      def neq(v)
+        NotEqual.new(v)
+      end
+
+      # Return the Comparison for negation of +v+.
+      #
+      # @param [Object] v
+      #   any ruby object to compare in a query
+      #
+      # @return [Comparison::Not]
+      #   an negated comparison of v
+      def not(v)
+        Not.new(v)
+      end
+
+      # Return the Comparison for the range a..b.
+      #
+      # @param [Object] v
+      #   either a Range, or a number
+      #
+      # @param [Fixnum] b
+      #   if the first argument was a number, the other bound
+      #
+      # @return [Comparison::Between]
+      #   an between comparison of a..b
+      def between(a, b = nil)
+        Between.new(a.kind_of?(Range) ? a : a..b)
+      end
+
+      # Return the Comparison to exclude the range a..b.
+      #
+      # @param [Object] v
+      #   either a Range, or a number
+      #
+      # @param [Fixnum] b
+      #   if the first argument was a number, the other bound
+      #
+      # @return [Comparison::Outside]
+      #   an outside comparison of a..b
+      def outside(a, b = nil)
+        Outside.new(a.kind_of?(Range) ? a : a..b)
+      end
+
+      # Return the Comparison for any value in the set +v+.
+      #
+      # @param [Object] v
+      #   any ruby object to compare
+      #
+      # @return [Comparison::In]
+      #   the IN comparison for the values in v
+      def in(*v)
+        In.new(v.map { |el| el.respond_to?(:to_a) ? el.to_a : el }.flatten)
+      end
+
+      # Return the Comparison for any value NOT in the set +v+.
+      #
+      # @param [Object] v
+      #   any ruby object to compare
+      #
+      # @return [Comparison::NotIn]
+      #   the NOT IN comparison for the values in v
+      def not_in(*v)
+        NotIn.new(v.map { |el| el.respond_to?(:to_a) ? el.to_a : el }.flatten)
+      end
+
+      # Return the Comparison for >= +v+.
+      #
+      # @param [Object] v
+      #   a number to compare
+      #
+      # @return [Comparison::GTE]
+      #   a greater than or equal comparison for v
+      def gte(v)
+        GTE.new(v)
+      end
+
+      # Return the Comparison for > +v+.
+      #
+      # @param [Object] v
+      #   a number to compare
+      #
+      # @return [Comparison::GT]
+      #   a greater than comparison for v
+      def gt(v)
+        GT.new(v)
+      end
+
+      # Return the Comparison for <= +v+.
+      #
+      # @param [Object] v
+      #   a number to compare
+      #
+      # @return [Comparison::LTE]
+      #   a less than or equal comparison for v
+      def lte(v)
+        LTE.new(v)
+      end
+
+      # Return the Comparison for < +v+.
+      #
+      # @param [Object] v
+      #   a number to compare
+      #
+      # @return [Comparison::LT]
+      #   a less than comparison for v
+      def lt(v)
+        LT.new(v)
+      end
+    end
+  end
+end

data/lib/oedipus/comparison.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Represents a comparison operator and value.
+  class Comparison
+    class << self
+      # Return a suitable comparison object for +v+.
+      #
+      # The conversions are:
+      #
+      #   - leave Comparison objects unchanged
+      #   - convert real ranges to Between comparisons
+      #   - convert Infinity-bounded exclusive ranges to GT/LT comparisons
+      #   - convert Infinity-bounded inclusive ranges to GTE/LTE comparisons.
+      #   - convert everything else to an Equal comparison
+      #
+      # @param [Object] v
+      #   a ruby object to be compared
+      #
+      # @param [Comparison]
+      #   a comparison suitable for comparing the input
+      def of(v)
+        case v
+        when Comparison
+          v
+        when Range
+          if v.end == Float::INFINITY
+            v.exclude_end? ? Shortcuts.gt(v.first) : Shortcuts.gte(v.first)
+          elsif v.first == -Float::INFINITY
+            v.exclude_end? ? Shortcuts.lt(v.end) : Shortcuts.lte(v.end)
+          else
+            Shortcuts.between(v)
+          end
+        when Enumerable
+          Shortcuts.in(v)
+        else
+          Shortcuts.eq(v)
+        end
+      end
+    end
+
+    attr_reader :v
+
+    # Initialize a new Comparison for +v+.
+    #
+    # @param [Object] v
+    #   any ruby object to compare
+    def initialize(v)
+      @v = v
+    end
+
+    # Compare two comparisons for equality.
+    #
+    # @param [Comparison] other
+    #   another comparison to check
+    #
+    # @return [Boolean]
+    #   true if the comparisons are the same
+    def ==(other)
+      other.class == self.class && other.v == v
+    end
+
+    alias_method :eql?, :==
+
+    # Return the exact inverse of this comparison.
+    #
+    # @return [Comparison]
+    #   the inverse of the current comparison
+    def inverse
+      raise NotImplementedError, "Comparison#inverse must be defined by subclasses"
+    end
+
+    # Represent the comparison as a string.
+    #
+    # @return [String]
+    #   an expression to compare a LHS against v
+    def to_s
+      raise NotImplementedError, "Comparison#to_s must be defined by subclasses"
+    end
+  end
+end

data/lib/oedipus/connection.rb

@@ -7,22 +7,69 @@
 # See LICENSE file for details.
 ##
 
-require "mysql"
-
-# SphinxQL greets with charset number 0
-Mysql::Charset::NUMBER_TO_CHARSET[0] = Mysql::Charset::COLLATION_TO_CHARSET["utf8_general_ci"]
-
 module Oedipus
   # Provides an interface for talking to SphinxQL.
+  #
+  # Currently this class wraps a native mysql extension.
   class Connection
+    class << self
+      # Quote a value (of any type) for use in SphinxQL.
+      #
+      # @param [Object] v
+      #   the value to quote
+      #
+      # @return [Object]
+      #   the safe value
+      #
+      # Note that single quotes are added to strings.
+      def quote(v)
+        require "bigdecimal"
+        case v
+        when BigDecimal, Rational, Complex
+          v.to_f
+        when Numeric
+          v
+        when NilClass
+          "NULL"
+        else
+          "'#{escape_str(v.to_s)}'"
+        end
+      end
+
+      # Escape a string, without adding enclosing quotes.
+      #
+      # @param [String] str
+      #   the unsafe input string
+      #
+      # @return [String]
+      #   a safe string for use in SphinxQL
+      def escape_str(str)
+        str.gsub(/[\0\n\r\\\'\"\x1a]/) do |s|
+          case s
+          when "\0"   then "\\0"
+          when "\n"   then "\\n"
+          when "\r"   then "\\r"
+          when "\x1a" then "\\Z"
+          else "\\#{s}"
+          end
+        end
+      end
+    end
+
     # Instantiate a new Connection to a SphinxQL host.
     #
-    # @param [Hash]
+    # @param [String] server
+    #   a 'hostname:port' string
+    #
+    # @param [Hash] options
     #   a Hash containing :host and :port
     #
     # The connection will be established on initialization.
     def initialize(options)
-      @conn = ::Mysql.new(options[:host], nil, nil, nil, options[:port], nil, ::Mysql::CLIENT_MULTI_STATEMENTS | ::Mysql::CLIENT_MULTI_RESULTS)
+      options = options.kind_of?(String) ?
+        Hash[ [:host, :port].zip(options.split(":")) ] :
+        options
+      @conn = Oedipus::Mysql.new(options[:host], options[:port].to_i)
     end
 
     # Acess a specific index for querying.
@@ -36,15 +83,46 @@ module Oedipus
       Index.new(index_name, self)
     end
 
-    def execute(sql)
+    # Execute one or more queries in a batch.
+    #
+    # Queries should be separated by semicolons.
+    # Results are returned in a 2-dimensional array.
+    #
+    # @param [String] sql
+    #   one or more SphinxQL statements, separated by semicolons
+    #
+    # @return [Array]
+    #   an array of arrays, containing the returned records
+    #
+    # Note that SphinxQL does not support prepared statements.
+    def multi_query(sql)
       @conn.query(sql)
     end
 
-    def quote(v)
-      case v
-      when Numeric then v
-      else "'#{::Mysql.quote(v.to_s)}'"
-      end
+    # Execute a single read query.
+    #
+    # @param [String] sql
+    #   a single SphinxQL statement
+    #
+    # @return [Array]
+    #   an array of Hashes containing the matched records
+    #
+    # Note that SphinxQL does not support prepared statements.
+    def query(sql)
+      @conn.query(sql).first
+    end
+
+    # Execute a non-read query.
+    #
+    # @param [String] sql
+    #   a SphinxQL query, such as INSERT or REPLACE
+    #
+    # @return [Fixnum]
+    #   the number of affected rows
+    #
+    # Note that SphinxQL does not support prepared statements.
+    def execute(sql)
+      @conn.execute(sql)
     end
   end
 end

data/lib/oedipus/connection_error.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Raised on any error coming from Sphinx.
+  class ConnectionError < RuntimeError
+  end
+end