oedipus 0.0.1 → 0.0.2

data/README.md

@@ -10,14 +10,14 @@ ActiveRecord or DataMapper... though this will follow in separate gems.
 Oedipus provides a level of abstraction in terms of the ease with which faceted
 search may be implemented, while remaining light and simple.
 
-Data structures are managed using core ruby data type (Array and Hash), ensuring
+Data structures are managed using core ruby data types (Array and Hash), ensuring
 simplicity and flexibilty.
 
 ## Dependencies
 
   * ruby (>= 1.9)
   * sphinx (>= 2.0.2)
-  * mysql.h / client development libraries (>= 4.1)
+  * mysql client development libraries (>= 4.1)
 
 The gem builds a small (tiny) native extension for interfacing with mysql, as
 existing gems either did not support multi-queries, or were too flaky

data/ext/oedipus/oedipus.c

@@ -160,7 +160,7 @@ static VALUE odp_query(VALUE self, VALUE sql) {
 
 /* -- Internal functions -- */
 
-static void odp_raise(VALUE self, const char *msg) {
+static void odp_raise(VALUE self, const char * msg) {
   OdpMysql * conn;
 
   Data_Get_Struct(self, OdpMysql, conn);
@@ -168,7 +168,7 @@ static void odp_raise(VALUE self, const char *msg) {
            "%s. Error %u: %s", msg, mysql_errno(conn->ptr), mysql_error(conn->ptr));
 }
 
-static void odp_free(OdpMysql *conn) {
+static void odp_free(OdpMysql * conn) {
   if (conn->connected) {
     mysql_close(conn->ptr);
   }

data/ext/oedipus/oedipus.h

@@ -13,7 +13,7 @@
 /*! Internal struct used to reference a mysql connection */
 typedef struct {
   /*! Boolean representing the connected state */
-  int   connected;
+  int     connected;
   /*! The actual pointer allocated by mysql_init() */
   MYSQL * ptr;
 } OdpMysql;
@@ -47,4 +47,4 @@ static VALUE odp_cast_value(MYSQL_FIELD f, char * v, unsigned long len);
 static void odp_raise(VALUE self, const char *msg);
 
 /*! Free memory allocated to mysql */
-static void odp_free(OdpMysql *conn);
+static void odp_free(OdpMysql * conn);

data/lib/oedipus/rspec/test_harness.rb

@@ -0,0 +1,152 @@
+# 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 = status
+            }
+
+            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

data/lib/oedipus/version.rb

@@ -8,5 +8,5 @@
 ##
 
 module Oedipus
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/integration/connection_spec.rb

@@ -8,9 +8,20 @@
 ##
 
 require "spec_helper"
+require "oedipus/rspec/test_harness"
 
 describe Oedipus::Connection do
-  include Oedipus::TestHarness
+  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 }
 
   let(:conn) { Oedipus::Connection.new(searchd_host) }
 

data/spec/integration/index_spec.rb

@@ -8,12 +8,23 @@
 ##
 
 require "spec_helper"
+require "oedipus/rspec/test_harness"
 
 describe Oedipus::Index do
-  include Oedipus::TestHarness
+  include Oedipus::RSpec::TestHarness
 
-  let(:conn)  { Oedipus::Connection.new(searchd_host) }
-  let(:index) { Oedipus::Index.new(:posts_rt, conn) }
+  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(:index)    { Oedipus::Index.new(:posts_rt, conn) }
 
   describe "#insert" do
     context "with valid data" do

data/spec/spec_helper.rb

@@ -12,7 +12,5 @@ require "bundler/setup"
 require "rspec"
 require "oedipus"
 
-Dir[File.expand_path("../support/**/*rb", __FILE__)].each { |f| require f }
-
 RSpec.configure do |config|
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oedipus
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &10768160 !ruby/object:Gem::Requirement
+  requirement: &17523900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10768160
+  version_requirements: *17523900
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &10775820 !ruby/object:Gem::Requirement
+  requirement: &17785080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *10775820
+  version_requirements: *17785080
 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
@@ -73,13 +73,13 @@ files:
 - lib/oedipus/connection_error.rb
 - lib/oedipus/index.rb
 - lib/oedipus/query_builder.rb
+- lib/oedipus/rspec/test_harness.rb
 - lib/oedipus/version.rb
 - oedipus.gemspec
 - spec/data/.gitkeep
 - spec/integration/connection_spec.rb
 - spec/integration/index_spec.rb
 - spec/spec_helper.rb
-- spec/support/test_harness.rb
 - spec/unit/comparison/between_spec.rb
 - spec/unit/comparison/equal_spec.rb
 - spec/unit/comparison/gt_spec.rb
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3724018096309534563
+      hash: -2156223476035950462
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3724018096309534563
+      hash: -2156223476035950462
 requirements: []
 rubyforge_project: oedipus
 rubygems_version: 1.8.11
@@ -129,7 +129,6 @@ test_files:
 - spec/integration/connection_spec.rb
 - spec/integration/index_spec.rb
 - spec/spec_helper.rb
-- spec/support/test_harness.rb
 - spec/unit/comparison/between_spec.rb
 - spec/unit/comparison/equal_spec.rb
 - spec/unit/comparison/gt_spec.rb

data/spec/support/test_harness.rb

@@ -1,164 +0,0 @@
-# encoding: utf-8
-
-##
-# Oedipus Sphinx 2 Search.
-# Copyright © 2012 Chris Corbyn.
-#
-# See LICENSE file for details.
-##
-
-module Oedipus
-  # Mixed into RSpec suites to manage starting/stopping Sphinx and writing indexes.
-  module TestHarness
-    class << self
-      def included(base)
-        base.before(:all) do
-          unless ENV.key?("SEARCHD")
-            raise "You must specify a path to the Sphinx 'searchd' executable (>= 2.0.2)"
-          end
-
-          set_data_dir File.expand_path("../../data", __FILE__)
-          set_searchd  ENV["SEARCHD"]
-
-          prepare_data_dirs
-          write_sphinx_conf
-          start_searchd
-        end
-
-        base.before(:each) do
-          empty_indexes
-        end
-
-        base.after(:all) do
-          stop_searchd
-        end
-      end
-    end
-
-    # 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 = status
-          }
-
-          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
-      @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
-      @searchd ||= "searchd"
-    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
-      @data_dir ||= "./data"
-    end
-  end
-end