oedipus 0.0.1.pre1 → 0.0.1.pre2

data/spec/integration/index_spec.rb

@@ -0,0 +1,353 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Index do
+  include Oedipus::TestHarness
+
+  let(:conn)  { Oedipus::Connection.new(searchd_host) }
+  let(:index) { Oedipus::Index.new(:posts_rt, conn) }
+
+  describe "#insert" do
+    context "with valid data" do
+      it "returns the number of rows inserted" do
+        index.insert(
+          10,
+          title:   "Badgers",
+          body:    "They live in setts, do badgers.",
+          views:   721,
+          user_id: 7
+        ).should == 1
+      end
+    end
+
+    context "with invalid data" do
+      it "raises an error" do
+        expect {
+          index.insert(
+            10,
+            bad_field: "Invalid",
+            body:      "They live in setts, do badgers.",
+            views:     721,
+            user_id:   7
+          )
+        }.to raise_error(Oedipus::ConnectionError)
+      end
+    end
+  end
+
+  describe "#fetch" do
+    before(:each) do
+      index.insert(1, title: "Badgers and foxes",       views: 150)
+      index.insert(2, title: "Rabbits and hares",       views: 73)
+      index.insert(3, title: "Clowns and cannon girls", views: 1)
+    end
+
+    context "with a valid document ID" do
+      it "returns the matched document" do
+        index.fetch(2).should == { id: 2, views: 73,  user_id: 0, status: "" }
+      end
+    end
+
+    context "with a bad document ID" do
+      it "returns nil" do
+        index.fetch(7).should be_nil
+      end
+    end
+  end
+
+  describe "#update" do
+    before(:each) do
+      index.insert(1, title: "Badgers and foxes", views: 150, user_id: 7)
+    end
+
+    context "with valid data" do
+      it "returns the number of rows modified" do
+        index.update(1, views: 721).should == 1
+      end
+
+      it "modifies the data" do
+        index.update(1, views: 721)
+        index.fetch(1).should == { id: 1, views: 721, user_id: 7, status: "" }
+      end
+    end
+
+    context "with unmatched data" do
+      it "returns 0" do
+        index.update(3, views: 721).should == 0
+      end
+    end
+
+    context "with invalid data" do
+      it "raises an error" do
+        expect {
+          index.update(1, bad_field: "Invalid", views: 721)
+        }.to raise_error(Oedipus::ConnectionError)
+      end
+    end
+  end
+
+  describe "#replace" do
+    before(:each) do
+      index.insert(
+        1,
+        title:   "Badgers",
+        body:    "They live in setts, do badgers.",
+        views:   721,
+        user_id: 7
+      )
+    end
+
+    context "with valid existing data" do
+      it "returns the number of rows inserted" do
+        index.replace(1, title: "Badgers and foxes", views: 150).should == 1
+      end
+
+      it "entirely replaces the record" do
+        index.replace(1, title: "Badgers and foxes", views: 150)
+        index.fetch(1).should == { id: 1, views: 150, user_id: 0, status: "" }
+      end
+    end
+
+    context "with valid new data" do
+      it "returns the number of rows inserted" do
+        index.replace(2, title: "Beer and wine", views: 15).should == 1
+      end
+
+      it "entirely replaces the record" do
+        index.replace(2, title: "Beer and wine", views: 15)
+        index.fetch(2).should == { id: 2, views: 15, user_id: 0, status: "" }
+      end
+    end
+
+    context "with invalid data" do
+      it "raises an error" do
+        expect {
+          index.replace(1, bad_field: "Badgers and foxes", views: 150)
+        }.to raise_error(Oedipus::ConnectionError)
+      end
+    end
+  end
+
+  describe "#search" do
+    before(:each) do
+      index.insert(1, title: "Badgers and foxes",   views: 150)
+      index.insert(2, title: "Rabbits and hares",   views: 87)
+      index.insert(3, title: "Badgers in the wild", views: 41)
+      index.insert(4, title: "Badgers for all!",    views: 3003)
+    end
+
+    context "by fulltext matching" do
+      it "indicates the number of records found" do
+        index.search("badgers")[:total_found].should == 3
+      end
+
+      it "includes the matches records" do
+        index.search("badgers")[:records].should == [
+          { id: 1, views: 150,  user_id: 0, status: "" },
+          { id: 3, views: 41,   user_id: 0, status: "" },
+          { id: 4, views: 3003, user_id: 0, status: "" }
+        ]
+      end
+    end
+
+    context "by attribute filtering" do
+      it "indicates the number of records found" do
+        index.search(views: 40..90)[:total_found].should == 2
+      end
+
+      it "includes the matches records" do
+        index.search(views: 40..90)[:records].should == [
+          { id: 2, views: 87,   user_id: 0, status: "" },
+          { id: 3, views: 41,   user_id: 0, status: "" }
+        ]
+      end
+    end
+
+    context "by fulltext with attribute filtering" do
+      it "indicates the number of records found" do
+        index.search("badgers", views: Oedipus.gt(100))[:total_found].should == 2
+      end
+
+      it "includes the matches records" do
+        index.search("badgers", views: Oedipus.gt(100))[:records].should == [
+          { id: 1, views: 150,  user_id: 0, status: "" },
+          { id: 4, views: 3003, user_id: 0, status: "" }
+        ]
+      end
+    end
+
+    context "with limits" do
+      it "still indicates the number of records found" do
+        index.search("badgers", limit: 2)[:total_found].should == 3
+      end
+
+      it "returns the limited subset of the results" do
+        index.search("badgers", limit: 2)[:records].should == [
+          { id: 1, views: 150,  user_id: 0, status: "" },
+          { id: 3, views: 41,   user_id: 0, status: "" }
+        ]
+      end
+
+      it "can use an offset" do
+        index.search("badgers", limit: 1, offset: 1)[:records].should == [
+          { id: 3, views: 41,   user_id: 0, status: "" }
+        ]
+      end
+    end
+
+    context "with ordering" do
+      it "returns the results ordered accordingly" do
+        index.search("badgers", order: {views: :desc})[:records].should == [
+          { id: 4, views: 3003, user_id: 0, status: "" },
+          { id: 1, views: 150,  user_id: 0, status: "" },
+          { id: 3, views: 41,   user_id: 0, status: "" },
+        ]
+      end
+    end
+  end
+
+  describe "#multi_search" do
+    before(:each) do
+      index.insert(1, title: "Badgers and foxes",   views: 150,  user_id: 1)
+      index.insert(2, title: "Rabbits and hares",   views: 87,   user_id: 1)
+      index.insert(3, title: "Badgers in the wild", views: 41,   user_id: 2)
+      index.insert(4, title: "Badgers for all!",    views: 3003, user_id: 1)
+    end
+
+    context "by fulltext querying" do
+      it "indicates the number of results for each query" do
+        results = index.multi_search(
+          badgers: "badgers",
+          rabbits: "rabbits"
+        )
+        results[:badgers][:total_found].should == 3
+        results[:rabbits][:total_found].should == 1
+      end
+
+      it "returns the records for each search" do
+        results = index.multi_search(
+          badgers: "badgers",
+          rabbits: "rabbits"
+        )
+        results[:badgers][:records].should == [
+          { id: 1, views: 150,  user_id: 1, status: "" },
+          { id: 3, views: 41,   user_id: 2, status: "" },
+          { id: 4, views: 3003, user_id: 1, status: "" }
+        ]
+        results[:rabbits][:records].should == [
+          { id: 2, views: 87, user_id: 1, status: "" }
+        ]
+      end
+    end
+
+    context "by attribute filtering" do
+      it "indicates the number of results for each query" do
+        results = index.multi_search(
+          shiela: {user_id: 1},
+          barry:  {user_id: 2}
+        )
+        results[:shiela][:total_found].should == 3
+        results[:barry][:total_found].should == 1
+      end
+    end
+  end
+
+  describe "#faceted_search" do
+    before(:each) do
+      index.insert(1, title: "Badgers and foxes",   body: "Badgers", views: 150,  user_id: 1)
+      index.insert(2, title: "Rabbits and hares",   body: "Rabbits", views: 87,   user_id: 1)
+      index.insert(3, title: "Badgers in the wild", body: "Test",    views: 41,   user_id: 2)
+      index.insert(4, title: "Badgers for all!",    body: "For all", views: 3003, user_id: 1)
+    end
+
+    context "with additional attribute filters" do
+      let(:results) do
+        index.faceted_search(
+          "badgers",
+          facets: {
+            popular:  {views: Oedipus.gte(50)},
+            di_carla: {user_id: 2}
+          }
+        )
+      end
+
+      it "returns the main results in the top-level" do
+        results[:records].should == [
+          { id: 1, views: 150,  user_id: 1, status: "" },
+          { id: 3, views: 41,   user_id: 2, status: "" },
+          { id: 4, views: 3003, user_id: 1, status: "" }
+        ]
+      end
+
+      it "applies the filters on top of the base query" do
+        results[:facets][:popular][:records].should == [
+          { id: 1, views: 150,  user_id: 1, status: "" },
+          { id: 4, views: 3003, user_id: 1, status: "" }
+        ]
+        results[:facets][:di_carla][:records].should == [
+          { id: 3, views: 41, user_id: 2, status: "" }
+        ]
+      end
+    end
+
+    context "with overriding attribute filters" do
+      let(:results) do
+        index.faceted_search(
+          "badgers",
+          user_id: 1,
+          facets: {
+            di_carla: {user_id: 2}
+          }
+        )
+      end
+
+      it "applies the filters on top of the base query" do
+        results[:facets][:di_carla][:records].should == [
+          { id: 3, views: 41, user_id: 2, status: "" }
+        ]
+      end
+    end
+
+    context "with overriding overriding fulltext queries" do
+      let(:results) do
+        index.faceted_search(
+          "badgers",
+          facets: {
+            rabbits: "rabbits"
+          }
+        )
+      end
+
+      it "entirely replaces the base query" do
+        results[:facets][:rabbits][:records].should == [
+          { id: 2, views: 87, user_id: 1, status: "" }
+        ]
+      end
+    end
+
+    context "with overriding refined fulltext queries" do
+      let(:results) do
+        index.faceted_search(
+          "badgers",
+          facets: {
+            in_body: "@body (%{query})"
+          }
+        )
+      end
+
+      it "merges the queries" do
+        results[:facets][:in_body][:records].should == [
+          { id: 1, views: 150,  user_id: 1, status: "" },
+        ]
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,33 +7,12 @@
 # See LICENSE file for details.
 ##
 
-require "rspec"
 require "bundler/setup"
+
+require "rspec"
 require "oedipus"
 
 Dir[File.expand_path("../support/**/*rb", __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|
-  include Oedipus::TestHarness
-
-  config.before(:suite) 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
-
-  config.before(:each) do
-    empty_indexes
-  end
-
-  config.after(:suite) do
-    stop_searchd
-  end
 end

data/spec/support/test_harness.rb

@@ -8,8 +8,33 @@
 ##
 
 module Oedipus
-  # Mixed into RSpec suites to manage starting/stopping Sphinx.
+  # 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.
@@ -37,15 +62,11 @@ module Oedipus
     end
 
     def empty_indexes
-      require "mysql"
-      @conn ||= ::Mysql.new(searchd_host[:host], nil, nil, nil, searchd_host[:port])
-
-      idxs = @conn.query("SHOW TABLES")
+      @conn ||= Oedipus::Connection.new(host: searchd_host[:host], port: searchd_host[:port])
 
-      while idx = idxs.fetch_hash
-        docs = @conn.query("SELECT id FROM #{idx['Index']}")
-        while hash = docs.fetch_hash
-          @conn.query("DELETE FROM #{idx['Index']} WHERE id = #{hash['id']}")
+      @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

data/spec/unit/comparison/between_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::Between do
+  context "with an inclusive range" do
+    let(:comparison) { Oedipus::Comparison::Between.new(42..100) }
+
+    it "draws as BETWEEN x AND y" do
+      comparison.to_s.should == "BETWEEN 42 AND 100"
+    end
+
+    it "inverses as NOT BETWEEN x AND y" do
+      comparison.inverse.to_s.should == "NOT BETWEEN 42 AND 100"
+    end
+  end
+
+  context "with an exclusive range" do
+    let(:comparison) { Oedipus::Comparison::Between.new(42...100) }
+
+    it "draws as BETWEEN x AND y-1" do
+      comparison.to_s.should == "BETWEEN 42 AND 99"
+    end
+
+    it "inverses as NOT BETWEEN x AND y-1" do
+      comparison.inverse.to_s.should == "NOT BETWEEN 42 AND 99"
+    end
+  end
+end

data/spec/unit/comparison/equal_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::Equal do
+  let(:comparison) { Oedipus::Comparison::Equal.new('test') }
+
+  it "draws as = v" do
+    comparison.to_s.should == "= 'test'"
+  end
+
+  it "inverses as != v" do
+    comparison.inverse.to_s.should == "!= 'test'"
+  end
+end

data/spec/unit/comparison/gt_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::GT do
+  let(:comparison) { Oedipus::Comparison::GT.new(42) }
+
+  it "draws as > v" do
+    comparison.to_s.should == "> 42"
+  end
+
+  it "inverses as <= v" do
+    comparison.inverse.to_s.should == "<= 42"
+  end
+end

data/spec/unit/comparison/gte_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::GTE do
+  let(:comparison) { Oedipus::Comparison::GTE.new(42) }
+
+  it "draws as >= v" do
+    comparison.to_s.should == ">= 42"
+  end
+
+  it "inverses as < v" do
+    comparison.inverse.to_s.should == "< 42"
+  end
+end

data/spec/unit/comparison/in_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::In do
+  let(:comparison) { Oedipus::Comparison::In.new([1, 2, 3]) }
+
+  it "draws as IN (x, y, z)" do
+    comparison.to_s.should == "IN (1, 2, 3)"
+  end
+
+  it "inverses as NOT IN (x, y, z)" do
+    comparison.inverse.to_s.should == "NOT IN (1, 2, 3)"
+  end
+end

data/spec/unit/comparison/lt_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::LT do
+  let(:comparison) { Oedipus::Comparison::LT.new(42) }
+
+  it "draws as < v" do
+    comparison.to_s.should == "< 42"
+  end
+
+  it "inverses as >= v" do
+    comparison.inverse.to_s.should == ">= 42"
+  end
+end

data/spec/unit/comparison/lte_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::LTE do
+  let(:comparison) { Oedipus::Comparison::LTE.new(42) }
+
+  it "draws as <= v" do
+    comparison.to_s.should == "<= 42"
+  end
+
+  it "inverses as > v" do
+    comparison.inverse.to_s.should == "> 42"
+  end
+end

data/spec/unit/comparison/not_equal_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::NotEqual do
+  let(:comparison) { Oedipus::Comparison::NotEqual.new('test') }
+
+  it "draws as != v" do
+    comparison.to_s.should == "!= 'test'"
+  end
+
+  it "inverses as = v" do
+    comparison.inverse.to_s.should == "= 'test'"
+  end
+end

data/spec/unit/comparison/not_in_spec.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::NotIn do
+  let(:comparison) { Oedipus::Comparison::NotIn.new([1, 2, 3]) }
+
+  it "draws as NOT IN (x, y, z)" do
+    comparison.to_s.should == "NOT IN (1, 2, 3)"
+  end
+
+  it "inverses as IN (x, y, z)" do
+    comparison.inverse.to_s.should == "IN (1, 2, 3)"
+  end
+end

data/spec/unit/comparison/not_spec.rb

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "spec_helper"
+
+describe Oedipus::Comparison::In do
+  context "with a non-comparison" do
+    let(:comparison) { Oedipus::Comparison::Not.new(0..10) }
+
+    it "converts to a comparison" do
+      comparison.v.should be_a_kind_of(Oedipus::Comparison)
+    end
+
+    it "returns the comparison as its inverse" do
+      comparison.inverse.should == comparison.v
+    end
+  end
+
+  context "with a comparison" do
+    let(:original)   { Oedipus::Comparison::GTE.new(7) }
+    let(:comparison) { Oedipus::Comparison::Not.new(original) }
+
+    it "draws as the inverse of the comparison" do
+      comparison.to_s.should == original.inverse.to_s
+    end
+
+    it "inverses as the original" do
+      comparison.inverse.to_s == original.to_s
+    end
+  end
+end