dbldots_oedipus 0.0.16

data/lib/oedipus/query_builder.rb

@@ -0,0 +1,185 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  # Constructs SphinxQL queries from the internal Hash format.
+  class QueryBuilder
+    # Initialize a new QueryBuilder for +index_name+.
+    #
+    # @param [Symbol] index_name
+    #   the name of the index being queried
+    def initialize(index_name)
+      @index_name = index_name
+    end
+
+    # Build a SphinxQL query for the fulltext search +query+ and filters in +filters+.
+    #
+    # @param [String] query
+    #   the fulltext query to execute (may be empty)
+    #
+    # @param [Hash] filters
+    #   additional attribute filters and other options
+    #
+    # @return [String]
+    #   a SphinxQL query
+    def select(query, filters)
+      where, *bind_values = conditions(query, filters)
+      [
+        [
+          from(filters),
+          where,
+          order_by(filters),
+          limits(filters)
+        ].join(" "),
+        *bind_values
+      ]
+    end
+
+    # Build a SphinxQL query to insert the record identified by +id+ with the given attributes.
+    #
+    # @param [Fixnum] id
+    #   the unique ID of the document to insert
+    #
+    # @param [Hash] attributes
+    #   a Hash of attributes
+    #
+    # @return [String]
+    #   the SphinxQL to insert the record
+    def insert(id, attributes)
+      into("INSERT", id, attributes)
+    end
+
+    # Build a SphinxQL query to update the record identified by +id+ with the given attributes.
+    #
+    # @param [Fixnum] id
+    #   the unique ID of the document to update
+    #
+    # @param [Hash] attributes
+    #   a Hash of attributes
+    #
+    # @return [String]
+    #   the SphinxQL to update the record
+    def update(id, attributes)
+      set_attrs, *bind_values = update_attributes(attributes)
+      [
+        [
+          "UPDATE #{@index_name} SET",
+          set_attrs,
+          "WHERE id = ?"
+        ].join(" "),
+        *bind_values.push(id)
+      ]
+    end
+
+    # Build a SphinxQL query to replace the record identified by +id+ with the given attributes.
+    #
+    # @param [Fixnum] id
+    #   the unique ID of the document to replace
+    #
+    # @param [Hash] attributes
+    #   a Hash of attributes
+    #
+    # @return [String]
+    #   the SphinxQL to replace the record
+    def replace(id, attributes)
+      into("REPLACE", id, attributes)
+    end
+
+    # Build a SphinxQL query to delete the record identified by +id+.
+    #
+    # @param [Fixnum] id
+    #   the unique ID of the document to delete
+    #
+    # @return [String]
+    #   the SphinxQL to delete the record
+    def delete(id)
+      ["DELETE FROM #{@index_name} WHERE id = ?", id]
+    end
+
+    private
+
+    RESERVED = [:attrs, :limit, :offset, :order]
+
+    def fields(filters)
+      filters.fetch(:attrs, [:*]).dup.tap do |fields|
+        if fields.none? { |a| /\brelevance\n/ === a } && normalize_order(filters).key?(:relevance)
+          fields << "WEIGHT() AS relevance"
+        end
+      end
+    end
+
+    def from(filters)
+      [
+        "SELECT",
+        fields(filters).join(", "),
+        "FROM",
+        @index_name
+      ].join(" ")
+    end
+
+    def into(type, id, attributes)
+      attrs, values = attributes.inject([[:id], [id]]) do |(a, b), (k, v)|
+        [a.push(k), b.push(v)]
+      end
+
+      [
+        [
+          type,
+          "INTO #{@index_name}",
+          "(#{attrs.join(', ')})",
+          "VALUES",
+          "(#{(['?'] * attrs.size).join(', ')})"
+        ].join(" "),
+        *values
+      ]
+    end
+
+    def conditions(query, filters)
+      sql = []
+      sql << ["MATCH(?)", query] unless query.empty?
+      sql.push(*attribute_conditions(filters))
+
+      exprs, bind_values = sql.inject([[], []]) do |(strs, values), v|
+        [strs.push(v.shift), values.push(*v)]
+      end
+
+      ["WHERE " << exprs.join(" AND "), *bind_values] if exprs.any?
+    end
+
+    def attribute_conditions(filters)
+      filters.reject{ |k, v| RESERVED.include?(k.to_sym) }.map do |k, v|
+        Comparison.of(v).to_sql.tap { |c| c[0].insert(0, "#{k} ") }
+      end
+    end
+
+    def update_attributes(attributes)
+      [
+        attributes.keys.map{ |k| "#{k} = ?" }.join(", "),
+        *attributes.values
+      ]
+    end
+
+    def order_by(filters)
+      return unless (order = normalize_order(filters)).any?
+
+      [
+        "ORDER BY",
+        order.map { |k, dir| "#{k} #{dir.to_s.upcase}" }.join(", ")
+      ].join(" ")
+    end
+
+    def normalize_order(filters)
+      Hash[Array(filters[:order]).map { |k, v| [k.to_sym, v || :asc] }]
+    end
+
+    def limits(filters)
+      "LIMIT #{filters[:offset].to_i}, #{filters[:limit].to_i}" if filters.key?(:limit)
+    end
+  end
+end

data/lib/oedipus/rspec/test_rig.rb

@@ -0,0 +1,132 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "rspec/core"
+require "tmpdir"
+
+# RSpec shared context that may be included to provide a pre-defined index.
+shared_context "oedipus posts_rt" do
+  def sphinx_indexes
+    <<-STR
+    index posts_rt
+    {
+      type = rt
+      path = #{data_dir}/posts_rt
+
+      rt_field       = title
+      rt_field       = body
+
+      rt_attr_uint   = user_id
+      rt_attr_uint   = views
+      rt_attr_string = state
+    }
+    STR
+  end
+end
+
+# RSpec shared context that may be included to start and stop sphinx between example groups.
+shared_context "oedipus test rig" do
+  before(:all) do
+    write_sphinx_config
+    start_sphinx
+  end
+
+  after(:all) do
+    stop_sphinx
+    clean_data_dir
+  end
+
+  after(:each) { empty_indexes }
+
+  # It is intended that any or all of the following be overridden in tests.
+  def connection
+    @connection ||= Oedipus::Connection.new(host: "127.0.0.1", port: 9399, verify: false)
+  end
+
+  def data_dir
+    @data_dir ||= Dir.mktmpdir("oedipus")
+  end
+
+  def searchd
+    ENV["SEARCHD"] || "searchd"
+  end
+
+  def sphinx_indexes
+    <<-IDX.strip.gsub(/^ {4}/, "")
+    index test_rt {
+      type     = rt
+      path     = #{data_dir}/test_rt
+      rt_field = test"
+    }
+    IDX
+  end
+
+  def sphinx_conf
+    <<-CONF.strip.gsub(/^ {4}/, "")
+    ##
+    # This file is automatically generated during tests
+    ##
+
+    #{sphinx_indexes}
+
+    searchd
+    {
+      compat_sphinxql_magics = 0
+
+      max_matches  = 2000
+      pid_file     = #{data_dir}/searchd.pid
+      listen       = #{connection.options[:host]}:#{connection.options[:port]}:mysql41
+      workers      = threads
+      log          = #{data_dir}/searchd.log
+      query_log    = #{data_dir}/searchd.log
+      binlog_path  = #{data_dir}
+    }
+    CONF
+  end
+
+  def write_sphinx_config
+    File.open("#{data_dir}/sphinx.conf", "w") do |f|
+      f << sphinx_conf
+    end
+  end
+
+  def start_sphinx
+    @pid = Process.spawn(
+      searchd, "-c", "#{data_dir}/sphinx.conf",
+      out: "#{data_dir}/searchd.out",
+      err: "#{data_dir}/searchd.err"
+    )
+    Process.wait(@pid)
+    raise "Couldn't start sphinx" unless $? == 0
+  end
+
+  def stop_sphinx
+    @pid = Process.spawn(
+      searchd, "-c", "#{data_dir}/sphinx.conf", "--stopwait",
+      out: "#{data_dir}/searchd.out",
+      err: "#{data_dir}/searchd.err"
+    )
+    Process.wait(@pid)
+    raise "Couldn't stop sphinx" unless $? == 0
+  end
+
+  def clean_data_dir
+    Dir["#{data_dir}/**/*"].each do |path|
+      File.delete(path)
+    end
+  end
+
+  def empty_indexes
+    connection.query("SHOW TABLES").each do |idx|
+      connection.query("SELECT id FROM #{idx['Index']}").each do |hash|
+        connection.execute("DELETE FROM #{idx['Index']} WHERE id = #{hash['id']}")
+      end
+    end
+  end
+end

data/lib/oedipus/version.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+module Oedipus
+  VERSION = "0.0.16"
+end

data/oedipus.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "oedipus/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dbldots_oedipus"
+  s.version     = Oedipus::VERSION
+  s.authors     = ["d11wtq", "dbldots"]
+  s.email       = ["dbldots@gmail.com"]
+  s.homepage    = "https://github.com/d11wtq/oedipus"
+  s.summary     = "Sphinx 2 Search Client for Ruby"
+  s.description = <<-DESC.gsub(/^ {4}/m, "")
+    == Sphinx 2 Comes to Ruby
+
+    Oedipus brings full support for Sphinx 2 to Ruby:
+
+      - real-time indexes (insert, replace, update, delete)
+      - faceted search (variations on a base query)
+      - multi-queries (multiple queries executed in a batch)
+      - full attribute filtering support
+
+    It works with 'stable' versions of Sphinx 2 (>= 2.0.2). All
+    features are implemented entirely through the SphinxQL interface.
+
+    -- dbldots: --
+    this gem release in general shouldn't be used. it fixes an issue
+    on mac os x where multi queries are broken.
+
+    this gem will be deleted as soon as the bug is fixed in the
+    original version.
+  DESC
+
+  s.rubyforge_project = "dbldots_oedipus"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.extensions    = ["ext/oedipus/extconf.rb"]
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake-compiler"
+end

data/spec/integration/connection/registry_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+require "oedipus/rspec/test_rig"
+
+describe Oedipus::Connection::Registry do
+  include_context "oedipus test rig"
+  include_context "oedipus posts_rt"
+
+  let(:registry) do
+    Object.new.tap { |o| o.send(:extend, Oedipus::Connection::Registry) }
+  end
+
+  describe "#connect" do
+    it "makes a new connection to a SphinxQL host" do
+      registry.connect(connection.options).should be_a_kind_of(Oedipus::Connection)
+    end
+  end
+
+  describe "#connection" do
+    context "without a name" do
+      let(:conn) { registry.connect(connection.options) }
+
+      it "returns an existing connection" do
+        conn.should equal registry.connection
+      end
+    end
+
+    context "with a name" do
+      let(:conn) { registry.connect(connection.options, :bob) }
+
+      it "returns the named connection" do
+        conn.should equal registry.connection(:bob)
+      end
+    end
+
+    context "with a bad name" do
+      it "raises an ArgumentError" do
+        expect { registry.connection(:wrong) }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/integration/connection_spec.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+require "oedipus/rspec/test_rig"
+
+describe Oedipus::Connection do
+  include_context "oedipus test rig"
+  include_context "oedipus posts_rt"
+
+  let(:conn) { Oedipus::Connection.new(connection.options) }
+
+  describe "#initialize" do
+    context "with a hosname:port string" do
+      context "on successful connection" do
+        it "returns the connection" do
+          Oedipus::Connection.new(
+            "#{connection.options[:host]}:#{connection.options[:port]}"
+          ).should be_a_kind_of(Oedipus::Connection)
+        end
+      end
+
+      context "on failed connection" do
+        it "raises an error" do
+          expect {
+            Oedipus::Connection.new("127.0.0.1:45346138")
+          }.to raise_error(Oedipus::ConnectionError)
+        end
+      end
+    end
+
+    context "with an options Hash" do
+      context "on successful connection" do
+        it "returns the connection" do
+          Oedipus::Connection.new(connection.options).should be_a_kind_of(Oedipus::Connection)
+        end
+      end
+
+      context "on failed connection" do
+        it "raises an error" do
+          expect {
+            Oedipus::Connection.new(:host => "127.0.0.1", :port => 45346138)
+          }.to raise_error(Oedipus::ConnectionError)
+        end
+      end
+    end
+  end
+
+  describe "#[]" do
+    it "returns an index" do
+      conn[:posts_rt].should be_a_kind_of(Oedipus::Index)
+    end
+  end
+
+  describe "#query" do
+    it "accepts integer bind parameters" do
+      conn.query("SELECT * FROM posts_rt WHERE views = ? AND user_id = ?", 1, 7)
+    end
+
+    xit "accepts float bind parameters" do
+      conn.query("SELECT * FROM posts_rt WHERE views = ? AND user_id = ?", 1.2, 7.2)
+    end
+
+    xit "accepts decimal bind parameters" do
+      require "bigdecimal"
+      conn.query("SELECT * FROM posts_rt WHERE views = ? AND user_id = ?", BigDecimal("1.2"), BigDecimal("7.2"))
+    end
+
+    xit "accepts string bind parameters" do
+      conn.query("SELECT * FROM posts_rt WHERE state = ?", "something")
+    end
+  end
+
+  describe "#multi_query" do
+    it "accepts integer bind parameters" do
+      conn.multi_query("SELECT * FROM posts_rt WHERE views = ? AND user_id = ?", 1, 7)
+    end
+
+    xit "accepts float bind parameters" do
+      conn.multi_query("SELECT * FROM posts_rt WHERE views = ? AND user_id = ?", 1.2, 7.2)
+    end
+
+    xit "accepts decimal bind parameters" do
+      require "bigdecimal"
+      conn.multi_query("SELECT * FROM posts_rt WHERE views = ? AND user_id = ?", BigDecimal("1.2"), BigDecimal("7.2"))
+    end
+
+    xit "accepts string bind parameters" do
+      conn.multi_query("SELECT * FROM posts_rt WHERE state = ?", "something")
+    end
+  end
+
+  describe "#execute" do
+    it "accepts integer bind parameters" do
+      conn.execute("REPLACE INTO posts_rt (id, views) VALUES (?, ?)", 1, 7)
+    end
+
+    it "accepts float bind parameters" do
+      conn.execute("REPLACE INTO posts_rt (id, views) VALUES (?, ?)", 1, 7.2)
+    end
+
+    it "accepts decimal bind parameters" do
+      require "bigdecimal"
+      conn.execute("REPLACE INTO posts_rt (id, views) VALUES (?, ?)", 1, BigDecimal("7.2"))
+    end
+
+    it "accepts string bind parameters" do
+      conn.execute("REPLACE INTO posts_rt (id, title) VALUES (?, ?)", 1, "an example with `\"this (quoted) string\\'")
+    end
+
+    it "doesn't confuse bind parameters in replacements" do
+      conn.execute("REPLACE INTO posts_rt (id, title, body) VALUES (?, ?, ?)", 1, "question?", "I think not")
+    end
+
+    it "ignores bind markers inside strings" do
+      conn.execute("REPLACE INTO posts_rt (id, title, state, body) VALUES (?, 'question?', 'other?', ?)", 1, "I think not")
+    end
+
+    it "ignores bind markers inside comments" do
+      conn.execute <<-SQL, 1, "A string"
+      /* is this a comment? *//* another comment ? */
+      REPLACE INTO posts_rt (id, title) VALUES (?, ?)
+      SQL
+    end
+
+    it "handles nil" do
+      conn.execute("REPLACE INTO posts_rt (id, title, state, body) VALUES (?, 'question?', 'other?', ?)", 1, nil)
+    end
+
+    it "handles true" do
+      conn.execute("REPLACE INTO posts_rt (id, views) VALUES (?, ?)", 1, true)
+    end
+
+    it "handles false" do
+      conn.execute("REPLACE INTO posts_rt (id, views) VALUES (?, ?)", 1, false)
+    end
+
+    it "handles really long strings" do
+      conn.execute("REPLACE INTO posts_rt (id, title, state, body) VALUES (?, 'question?', 'other?', ?)", 1, 'a' * 2_000_000)
+    end
+  end
+
+  describe "#close" do
+    before(:each) { conn.close }
+
+    it "disposes the internal pool" do
+      conn.instance_variable_get(:@pool).should be_empty
+    end
+  end
+end