oedipus-dm 0.0.1 → 0.0.2

data/README.md

@@ -1,15 +1,41 @@
 # Oedipus Sphinx Integration for DataMapper
 
-This gem is a work in progress, binding [Oedipus](https://github.com/d11wtq/oedipus)
-with [DataMapper](https://github.com/datamapper/dm-core), in order to support
+This gem provides a binding between
+[Oedipus](https://github.com/d11wtq/oedipus) and
+[DataMapper](https://github.com/datamapper/dm-core), in order to support
 the querying and updating of Sphinx indexes through DataMapper models.
 
-The gem is not yet published, as it is still in development.
+Oedipus provides a clean interface with Sphinx 2, allowing the use of
+realtime indexes and multi-dimensional faceted search via ruby.
+
+  - [Requirements](#requirements)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Configure oedipus](#configure-oedipus)
+    - [Defining an index](#defining-an-index)
+    - [Fulltext search](#fulltext-search-for-resources-via-the-index)
+    - [Faceted search](#faceted-search)
+    - [Parallel search](#performing-multiple-searches-in-parallel)
+    - [Realtime index management](#realtime-index-management)
+    - [Integration with dm-pager](#integration-with-dm-pager-aka-dm-pagination)
+    - [Talking direcly to Oedipus](#talking-directly-to-oedipus)
+
+## Requirements
+
+  - Sphinx >= 2.0.2
+  - Ruby >= 1.9
+  - Mysql client development libraries
+
+## Installation
+
+Via rubygems
+
+    gem install oedipus-dm
 
 ## Usage
 
-All features of Oedipus will ultimately be supported, but I'm documenting as
-I complete wrapping the features.
+All features of the main oedipus gem are supported, with some allowance for
+the use of DataMapper's operators etc.
 
 ### Configure Oedipus
 
@@ -218,12 +244,16 @@ loaded.  This is on my radar, however.
 ### Faceted Search
 
 Oedipus makes faceted searches really easy.  Pass in a `:facets` option, as a
-Hash, where each key names the facet and the value lists the arguments, then
-Oedipus provides the results for each facet nested inside the collection.
+Hash, where each key identifies the facet and the value lists the arguments,
+then Oedipus provides the results for each facet nested inside the collection.
 
 Each facet inherits the base search, which it may override in some way, such as
 filtering by an attribute, or modifying the fulltext query itself.
 
+The key used to identify the facet can be any arbitrary object, which may be
+useful in some application-specific contexts, where the key can carry associated
+domain-specific data.
+
 ``` ruby
 posts = Post.index.search(
   "badgers",
@@ -262,6 +292,29 @@ Oedipus replaces `%{query}` in your facets with whatever the base query was,
 which is useful if you want to amend the search, rather than completely
 overwrite it (which is also possible).
 
+#### Faceted search with N dimensions
+
+Each facet in a faceted search can in turn contain facets of its own.  This
+allows you to perform multi-dimensional faceted searches, where each level
+deeper adds a new dimension to the search.  The equivalent tree is returned in
+the results.
+
+``` ruby
+posts = Post.index.search(
+  "badgers",
+  facets: {
+    popular: {
+      :views.gte => 1000,
+      :facets    => {
+        in_title: "@title (%{query})",
+      }
+    }
+  }
+)
+
+puts "Found #{posts.facets[:popular].facets[:in_title].total_found} popular posts with 'badgers' in title"
+```
+
 #### Performance tip
 
 A common use of faceted search is to provide links to the full listing for

data/lib/oedipus/data_mapper/index.rb

@@ -45,7 +45,7 @@ module Oedipus
 
         map(:id, with: @key)
 
-        yield self
+        yield self if block_given?
       end
 
       # Returns the underlying Index, for carrying out low-level operations.

data/lib/oedipus/data_mapper/version.rb

@@ -9,6 +9,6 @@
 
 module Oedipus
   module DataMapper
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/spec/integration/index_spec.rb

@@ -351,6 +351,23 @@ describe Oedipus::DataMapper::Index do
           }
         ).facets[:popular].total_found.should == 2
       end
+
+      context "in n-dimensions" do
+        it "returns the nested facets inside the child collection" do
+          index.search(
+            "badgers",
+            order: :id,
+            facets: {
+              popular: {
+                :views.gte => 7,
+                :facets    => {
+                  running: "%{query} & run"
+                }
+              }
+            }
+          ).facets[:popular].facets[:running].total_found.should == 1
+        end
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oedipus-dm
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-29 00:00:00.000000000 Z
+date: 2012-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oedipus
-  requirement: &14446500 !ruby/object:Gem::Requirement
+  requirement: &13409800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *14446500
+  version_requirements: *13409800
 - !ruby/object:Gem::Dependency
   name: dm-core
-  requirement: &14445360 !ruby/object:Gem::Requirement
+  requirement: &13409180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '1.2'
   type: :runtime
   prerelease: false
-  version_requirements: *14445360
+  version_requirements: *13409180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14444580 !ruby/object:Gem::Requirement
+  requirement: &13408800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14444580
+  version_requirements: *13408800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14443860 !ruby/object:Gem::Requirement
+  requirement: &13408340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14443860
+  version_requirements: *13408340
 - !ruby/object:Gem::Dependency
   name: dm-pager
-  requirement: &14431500 !ruby/object:Gem::Requirement
+  requirement: &13407860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14431500
+  version_requirements: *13407860
 description: ! '== DataMapper Integration for Oedipus
 
 
@@ -114,12 +114,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2073315662830389544
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 2073315662830389544
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11