oedipus 0.0.15 → 0.0.16

data/lib/oedipus/connection.rb

@@ -12,6 +12,8 @@ module Oedipus
   #
   # Currently this class wraps a native mysql extension.
   class Connection
+    attr_reader :options
+
     # Instantiate a new Connection to a SphinxQL host.
     #
     # @param [String] server
@@ -24,18 +26,21 @@ module Oedipus
     #
     # The underlying implementation uses a thread-safe connection pool.
     def initialize(options)
-      options = options.kind_of?(String) ?
-        Hash[ [:host, :port].zip(options.split(":")) ] :
-        options
+      @options =
+        if options.kind_of?(String)
+          Hash[ [:host, :port].zip(options.split(":")) ]
+        else
+          options.dup
+        end.tap { |o| o[:port] = o[:port].to_i }
 
       @pool = Pool.new(
-        host: options[:host],
-        port: options[:port].to_i,
-        size: options.fetch(:pool_size, 8),
+        host: @options[:host],
+        port: @options[:port],
+        size: @options.fetch(:pool_size, 8),
         ttl:  60
       )
 
-      assert_valid_pool
+      assert_valid_pool unless @options[:verify] == false
     end
 
     # Acess a specific index for querying.

data/lib/oedipus/rspec/test_rig.rb

@@ -0,0 +1,125 @@
+# 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, "--console", "-c", "#{data_dir}/sphinx.conf",
+      out: "#{data_dir}/searchd.out",
+      err: "#{data_dir}/searchd.err"
+    )
+    sleep 1
+  end
+
+  def stop_sphinx
+    Process.kill(:TERM, @pid) && Process.wait
+  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

@@ -8,5 +8,5 @@
 ##
 
 module Oedipus
-  VERSION = "0.0.15"
+  VERSION = "0.0.16"
 end

data/spec/integration/connection/registry_spec.rb

@@ -8,20 +8,11 @@
 ##
 
 require "spec_helper"
-require "oedipus/rspec/test_harness"
+require "oedipus/rspec/test_rig"
 
 describe Oedipus::Connection::Registry do
-  include Oedipus::RSpec::TestHarness
-
-  before(:all) do
-    set_data_dir File.expand_path("../../../data", __FILE__)
-    set_searchd  ENV["SEARCHD"]
-    start_searchd
-  end
-
-  after(:all) { stop_searchd }
-
-  before(:each) { empty_indexes }
+  include_context "oedipus test rig"
+  include_context "oedipus posts_rt"
 
   let(:registry) do
     Object.new.tap { |o| o.send(:extend, Oedipus::Connection::Registry) }
@@ -29,13 +20,13 @@ describe Oedipus::Connection::Registry do
 
   describe "#connect" do
     it "makes a new connection to a SphinxQL host" do
-      registry.connect(searchd_host).should be_a_kind_of(Oedipus::Connection)
+      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(searchd_host) }
+      let(:conn) { registry.connect(connection.options) }
 
       it "returns an existing connection" do
         conn.should equal registry.connection
@@ -43,7 +34,7 @@ describe Oedipus::Connection::Registry do
     end
 
     context "with a name" do
-      let(:conn) { registry.connect(searchd_host, :bob) }
+      let(:conn) { registry.connect(connection.options, :bob) }
 
       it "returns the named connection" do
         conn.should equal registry.connection(:bob)

data/spec/integration/connection_spec.rb

@@ -8,28 +8,21 @@
 ##
 
 require "spec_helper"
-require "oedipus/rspec/test_harness"
+require "oedipus/rspec/test_rig"
 
 describe Oedipus::Connection do
-  include Oedipus::RSpec::TestHarness
+  include_context "oedipus test rig"
+  include_context "oedipus posts_rt"
 
-  before(:all) do
-    set_data_dir File.expand_path("../../data", __FILE__)
-    set_searchd  ENV["SEARCHD"]
-    start_searchd
-  end
-
-  after(:all) { stop_searchd }
-
-  before(:each) { empty_indexes }
-
-  let(:conn) { Oedipus::Connection.new(searchd_host) }
+  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(searchd_host.values.join(":")).should be_a_kind_of(Oedipus::Connection)
+          Oedipus::Connection.new(
+            "#{connection.options[:host]}:#{connection.options[:port]}"
+          ).should be_a_kind_of(Oedipus::Connection)
         end
       end
 
@@ -45,7 +38,7 @@ describe Oedipus::Connection do
     context "with an options Hash" do
       context "on successful connection" do
         it "returns the connection" do
-          Oedipus::Connection.new(searchd_host).should be_a_kind_of(Oedipus::Connection)
+          Oedipus::Connection.new(connection.options).should be_a_kind_of(Oedipus::Connection)
         end
       end
 

data/spec/integration/index_spec.rb

@@ -8,22 +8,13 @@
 ##
 
 require "spec_helper"
-require "oedipus/rspec/test_harness"
+require "oedipus/rspec/test_rig"
 
 describe Oedipus::Index do
-  include Oedipus::RSpec::TestHarness
+  include_context "oedipus test rig"
+  include_context "oedipus posts_rt"
 
-  before(:all) do
-    set_data_dir File.expand_path("../../data", __FILE__)
-    set_searchd  ENV["SEARCHD"]
-    start_searchd
-  end
-
-  after(:all) { stop_searchd }
-
-  before(:each) { empty_indexes }
-
-  let(:conn)     { Oedipus::Connection.new(searchd_host) }
+  let(:conn)     { connection }
   let(:index)    { Oedipus::Index.new(:posts_rt, conn) }
 
   describe "#insert" do
@@ -340,7 +331,7 @@ describe Oedipus::Index do
     end
 
     context "with overriding overriding fulltext queries" do
-      let(:results) do
+      let(:results) do # FIXME: Weird RSpec bug is not clearing the previous result, hence the ridiculous naming
         index.search(
           "badgers",
           facets: {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oedipus
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-14 00:00:00.000000000 Z
+date: 2012-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &20925980 !ruby/object:Gem::Requirement
+  requirement: &15535840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20925980
+  version_requirements: *15535840
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &20925400 !ruby/object:Gem::Requirement
+  requirement: &15533700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20925400
+  version_requirements: *15533700
 description: ! "== Sphinx 2 Comes to Ruby\n\nOedipus brings full support for Sphinx
   2 to Ruby:\n\n  - real-time indexes (insert, replace, update, delete)\n  - faceted
   search (variations on a base query)\n  - multi-queries (multiple queries executed
@@ -77,7 +77,7 @@ files:
 - lib/oedipus/connection_error.rb
 - lib/oedipus/index.rb
 - lib/oedipus/query_builder.rb
-- lib/oedipus/rspec/test_harness.rb
+- lib/oedipus/rspec/test_rig.rb
 - lib/oedipus/version.rb
 - oedipus.gemspec
 - spec/data/.gitkeep
@@ -113,7 +113,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1288054359540287220
+      hash: 1033865904728202433
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1288054359540287220
+      hash: 1033865904728202433
 requirements: []
 rubyforge_project: oedipus
 rubygems_version: 1.8.11

data/lib/oedipus/rspec/test_harness.rb

@@ -1,152 +0,0 @@
-# encoding: utf-8
-
-##
-# Oedipus Sphinx 2 Search.
-# Copyright © 2012 Chris Corbyn.
-#
-# See LICENSE file for details.
-##
-
-module Oedipus
-  module RSpec
-    # Mixed into RSpec suites to manage starting/stopping Sphinx and writing indexes.
-    module TestHarness
-      # Set the path to the searchd executable.
-      #
-      # The version of Sphinx must be >= 2.0.2.
-      #
-      # @param [String] path
-      #   the absolute path to searchd
-      def set_searchd(path)
-        @searchd = path
-      end
-
-      # Set the path to a temporary directory for writing test data to.
-      #
-      # @param [String] path
-      #   the path to a writable directory whose contents may be completely deleted
-      def set_data_dir(path)
-        @data_dir = path
-      end
-
-      # Ensure that the temporary data directories exist and are clean.
-      def prepare_data_dirs
-        Dir.mkdir("#{data_dir}/index")  unless Dir.exist?("#{data_dir}/index")
-        Dir.mkdir("#{data_dir}/binlog") unless Dir.exist?("#{data_dir}/binlog")
-
-        clean_data_dirs
-      end
-
-      def empty_indexes
-        @conn ||= Oedipus::Connection.new(host: searchd_host[:host], port: searchd_host[:port])
-
-        @conn.query("SHOW TABLES").each do |idx|
-          @conn.query("SELECT id FROM #{idx['Index']}").each do |hash|
-            @conn.execute("DELETE FROM #{idx['Index']} WHERE id = #{hash['id']}")
-          end
-        end
-      end
-
-      # Write the sphinx.conf file, using #index_definiton.
-      #
-      # Sphinx will listen on localhost port 9399.
-      #
-      # Any string returned from #index_definition will be used to define one or more indexes.
-      def write_sphinx_conf
-        File.open(searchd_config, "wb") do |f|
-          f <<
-          <<-CONF.gsub(/^ {10}/m, "")
-            ##
-            # This file is automatically generated during tests
-            ##
-
-            index posts_rt
-            {
-              type = rt
-              path = #{data_dir}/index/posts_rt
-
-              rt_field       = title
-              rt_field       = body
-
-              rt_attr_uint   = user_id
-              rt_attr_uint   = views
-              rt_attr_string = state
-            }
-
-            searchd
-            {
-              compat_sphinxql_magics = 0
-
-              max_matches  = 2000
-              pid_file     = #{data_dir}/searchd.pid
-              listen       = #{searchd_host[:host]}:#{searchd_host[:port]}:mysql41
-              workers      = threads
-              log          = #{data_dir}/searchd.log
-              query_log    = #{data_dir}/searchd.log
-              binlog_path  = #{data_dir}/binlog
-            }
-          CONF
-        end
-      end
-
-      # Start the sphinx daemon in a child process and return the PID.
-      #
-      # Output is redirected to searchd.out and searchd.err in the data dir.
-      def start_searchd
-        prepare_data_dirs
-        write_sphinx_conf
-
-        @searchd_pid = Process.spawn(
-          searchd, "--console", "-c", searchd_config,
-          out: "#{data_dir}/searchd.out",
-          err: "#{data_dir}/searchd.err"
-        )
-        sleep 1
-      end
-
-      # Stop an already running sphinx daemon and wait for it to shutdown.
-      def stop_searchd
-        Process.kill("TERM", @searchd_pid) && Process.wait
-      end
-
-      private
-
-      def clean_data_dirs
-        clean_files("#{data_dir}/index/**/*")
-        clean_files("#{data_dir}/binlog/**/*")
-        clean_files("#{data_dir}/searchd.pid")
-        clean_files("#{data_dir}/searchd.out")
-        clean_files("#{data_dir}/searchd.err")
-        clean_files("#{data_dir}/sphinx.conf")
-      end
-
-      def searchd_host
-        { host: "127.0.0.1", port: 9399 }
-      end
-
-      def searchd_config
-        "#{data_dir}/sphinx.conf"
-      end
-
-      def clean_files(path)
-        Dir[path].each { |f| File.delete(f) unless File.directory?(f) }
-      end
-
-      def data_dir
-        unless @data_dir
-          raise "Path to data directory unknown: call #set_data_dir during test setup"
-        else
-          @data_dir
-        end
-      end
-
-      def searchd
-        unless @searchd
-          raise "Path to searchd unknown, perhaps you need to set the SEARCHD environment variable"
-        else
-          @searchd
-        end
-      end
-    end
-  end
-end