dbldots_oedipus 0.0.16

data/spec/integration/index_spec.rb

@@ -0,0 +1,442 @@
+# 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::Index do
+  include_context "oedipus test rig"
+  include_context "oedipus posts_rt"
+
+  let(:conn)     { connection }
+  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, state: "" }
+      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, state: "" }
+      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, state: "" }
+      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, state: "" }
+      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 "#delete" 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 "entirely deletes the record" do
+        index.delete(1)
+        index.fetch(1).should be_nil
+      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, badgers!", 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, state: "" },
+          { id: 3, views: 41,   user_id: 0, state: "" },
+          { id: 4, views: 3003, user_id: 0, state: "" }
+        ]
+      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, state: "" },
+          { id: 3, views: 41,   user_id: 0, state: "" }
+        ]
+      end
+
+      pending "the sphinxql grammar does not currently support this, though I'm patching it" do
+        context "with string attributes" do
+          before(:each) do
+            index.insert(5, title: "No more badgers, please", views: 0, state: "new")
+          end
+
+          it "filters by the string attribute" do
+            index.search(state: "new")[:records].should == [{ id: 5, views: 0, user_id: 0, state: "new" }]
+          end
+        end
+      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, state: "" },
+          { id: 4, views: 3003, user_id: 0, state: "" }
+        ]
+      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, state: "" },
+          { id: 3, views: 41,   user_id: 0, state: "" }
+        ]
+      end
+
+      it "can use an offset" do
+        index.search("badgers", limit: 1, offset: 1)[:records].should == [
+          { id: 3, views: 41,   user_id: 0, state: "" }
+        ]
+      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, state: "" },
+          { id: 1, views: 150,  user_id: 0, state: "" },
+          { id: 3, views: 41,   user_id: 0, state: "" },
+        ]
+      end
+
+      context "by relevance" do
+        it "returns the results ordered by most relevant" do
+          records = index.search("badgers", order: {relevance: :desc})[:records]
+          records.first[:relevance].should > records.last[:relevance]
+        end
+      end
+    end
+
+    context "with attribute additions" do
+      it "fetches the additional attributes" do
+        index.search("badgers", attrs: [:*, "7 AS x"])[:records].should == [
+          { id: 1, views: 150,  user_id: 0, state: "", x: 7 },
+          { id: 3, views: 41,   user_id: 0, state: "", x: 7 },
+          { id: 4, views: 3003, user_id: 0, state: "", x: 7 },
+        ]
+      end
+    end
+
+    context "with attribute restrictions" do
+      it "fetches the restricted attributes" do
+        index.search("badgers", attrs: [:id, :views])[:records].should == [
+          { id: 1, views: 150  },
+          { id: 3, views: 41   },
+          { id: 4, views: 3003 },
+        ]
+      end
+    end
+  end
+
+  describe "#search", "with :facets" 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.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, state: "" },
+          { id: 3, views: 41,   user_id: 2, state: "" },
+          { id: 4, views: 3003, user_id: 1, state: "" }
+        ]
+      end
+
+      it "applies the filters on top of the base query" do
+        results[:facets][:popular][:records].should == [
+          { id: 1, views: 150,  user_id: 1, state: "" },
+          { id: 4, views: 3003, user_id: 1, state: "" }
+        ]
+        results[:facets][:di_carla][:records].should == [
+          { id: 3, views: 41, user_id: 2, state: "" }
+        ]
+      end
+    end
+
+    context "with overriding attribute filters" do
+      let(:results) do
+        index.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, state: "" }
+        ]
+      end
+    end
+
+    context "with overriding overriding fulltext queries" do
+      let(:results) do # FIXME: Weird RSpec bug is not clearing the previous result, hence the ridiculous naming
+        index.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, state: "" }
+        ]
+      end
+    end
+
+    context "with overriding refined fulltext queries" do
+      let(:results) do
+        index.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, state: "" },
+        ]
+      end
+    end
+
+    context "with multi-dimensional facets" do
+      let(:results) do
+        index.search(
+          "badgers",
+          facets: {
+            popular: {
+              views: Oedipus.gte(50),
+              facets: {
+                with_foxes: "%{query} & foxes"
+              }
+            },
+          }
+        )
+      end
+
+      it "merges the results in the outer facets" do
+        results[:facets][:popular][:records].should == [
+          { id: 1, views: 150,  user_id: 1, state: "" },
+          { id: 4, views: 3003, user_id: 1, state: "" }
+        ]
+      end
+
+      it "merges the results in the inner facets" do
+        results[:facets][:popular][:facets][:with_foxes][:records].should == [
+          { id: 1, views: 150,  user_id: 1, state: "" }
+        ]
+      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, state: "" },
+          { id: 3, views: 41,   user_id: 2, state: "" },
+          { id: 4, views: 3003, user_id: 1, state: "" }
+        ]
+        results[:rabbits][:records].should == [
+          { id: 2, views: 87, user_id: 1, state: "" }
+        ]
+      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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+##
+# Oedipus Sphinx 2 Search.
+# Copyright © 2012 Chris Corbyn.
+#
+# See LICENSE file for details.
+##
+
+require "bundler/setup"
+
+require "rspec"
+require "oedipus"
+
+RSpec.configure do |config|
+end