oedipus 0.0.3 → 0.0.4

data/README.md

@@ -251,7 +251,7 @@ it does two optimizations, though in future this will likely improve further, so
 using this technique to do your faceted searches is a good idea.
 
 ``` ruby
-results = sphinx[:articles].facted_search(
+results = sphinx[:articles].search(
   "badgers",
   facets: {
     popular:         { views: 100..10000 },

data/lib/oedipus/index.rb

@@ -117,26 +117,12 @@ module Oedipus
     # @example Attribute search only
     #   index.search(author_id: 57)
     #
-    # @param [String] query
-    #   a fulltext query
-    #
-    # @param [Hash] filters
-    #   attribute filters, limits, sorting and other options
-    #
-    # @return [Hash]
-    #   a Hash containing meta data, with the records in :records
-    def search(*args)
-      multi_search(_main_: args)[:_main_]
-    end
-
-    # Perform a faceted search on the index, using a base query and one or more facets.
-    #
-    # The base query is inherited by each facet, which may override (or refine) the
-    # query.
+    # When performing a faceted search, the base query is inherited by each facet, which
+    # may override (or refine) the query.
     #
     # The results returned include a :facets key, containing the results for each facet.
     #
-    # @example
+    # @example Performing a faceted search
     #   index.faceted_search(
     #     "cats | dogs",
     #     category_id: 7,
@@ -146,16 +132,34 @@ module Oedipus
     #     }
     #   )
     #
-    # @param [String] fulltext_query
-    #   a fulltext query to search on, optional
+    # @param [String] query
+    #   a fulltext query
     #
     # @param [Hash] options
-    #   attribute filters and facets in a sub-hash
+    #   attribute filters, limits, sorting, facets and other options
+    #
+    # @option [Hash] facets
+    #   variations on the main search to return nested in the result
+    #
+    # @option [Array] attrs
+    #   attributes to fetch from the index, either as Symbols, or SphinxQL fragments
+    #
+    # @option [Hash] order
+    #   an attr => direction mapping of sort orders
+    #
+    # @option [Fixnum] limit
+    #   a limit to apply, defaults to 20 inside Sphinx itself
+    #
+    # @option [Fixnum] offset
+    #   an offset to apply, defaults to 0
+    #
+    # @option [Object] everything_else
+    #   all additional options are taken to be attribute filters
     #
     # @return [Hash]
-    #   a Hash whose top-level result set is for the main query and which
-    #   contains a :facets element with keys mapping 1:1 for all facets
-    def faceted_search(*args)
+    #   a Hash containing meta data, with the records in :records, and if any
+    #   facets were included, the facets inside the :facets Hash
+    def search(*args)
       query, options = extract_query_data(args)
       main_query     = [query, options.reject { |k, _| k == :facets }]
       facets         = merge_queries(main_query, options.fetch(:facets, {}))
@@ -167,6 +171,17 @@ module Oedipus
       end
     end
 
+    # Perform a faceted search on the index, using a base query and one or more facets.
+    #
+    # This method is deprecated and will be removed in version 1.0. Use #search instead.
+    #
+    # @deprecated
+    #
+    # @see #search
+    def faceted_search(*args)
+      search(*args)
+    end
+
     # Perform a a batch search on the index.
     #
     # A Hash of queries is passed, whose keys are used to collate the results in

data/lib/oedipus/version.rb

@@ -8,5 +8,5 @@
 ##
 
 module Oedipus
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/integration/index_spec.rb

@@ -283,53 +283,7 @@ describe Oedipus::Index do
     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
+  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)
@@ -339,7 +293,7 @@ describe Oedipus::Index do
 
     context "with additional attribute filters" do
       let(:results) do
-        index.faceted_search(
+        index.search(
           "badgers",
           facets: {
             popular:  {views: Oedipus.gte(50)},
@@ -369,7 +323,7 @@ describe Oedipus::Index do
 
     context "with overriding attribute filters" do
       let(:results) do
-        index.faceted_search(
+        index.search(
           "badgers",
           user_id: 1,
           facets: {
@@ -387,7 +341,7 @@ describe Oedipus::Index do
 
     context "with overriding overriding fulltext queries" do
       let(:results) do
-        index.faceted_search(
+        index.search(
           "badgers",
           facets: {
             rabbits: "rabbits"
@@ -404,7 +358,7 @@ describe Oedipus::Index do
 
     context "with overriding refined fulltext queries" do
       let(:results) do
-        index.faceted_search(
+        index.search(
           "badgers",
           facets: {
             in_body: "@body (%{query})"
@@ -419,4 +373,50 @@ describe Oedipus::Index do
       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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oedipus
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-28 00:00:00.000000000 Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &18061060 !ruby/object:Gem::Requirement
+  requirement: &12876920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18061060
+  version_requirements: *12876920
 - !ruby/object:Gem::Dependency
   name: rake-compiler
-  requirement: &18156200 !ruby/object:Gem::Requirement
+  requirement: &12831220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *18156200
+  version_requirements: *12831220
 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
@@ -108,7 +108,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3912643508357883661
+      hash: 765099216142211442
 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: -3912643508357883661
+      hash: 765099216142211442
 requirements: []
 rubyforge_project: oedipus
 rubygems_version: 1.8.11