oedipus 0.0.2 → 0.0.3

data/README.md

@@ -5,7 +5,8 @@ real-time indexes and multi and/or faceted searches.
 
 It is not a clone of the PHP API, rather it is written from the ground up,
 wrapping the SphinxQL API offered by searchd.  Nor is it a plugin for
-ActiveRecord or DataMapper... though this will follow in separate gems.
+ActiveRecord or DataMapper... though this will follow in separate gems (see
+[oedipus-dm](https://github.com/d11wtq/oedipus-dm)).
 
 Oedipus provides a level of abstraction in terms of the ease with which faceted
 search may be implemented, while remaining light and simple.
@@ -344,11 +345,12 @@ You may also compile the C extension and run the specs separately, if you prefer
 ## Future Plans
 
   * Integration with DataMapper and ActiveRecord (DataMapper first)
+  * Support for re-indexing non-realtime indexes from ruby code
   * Distributed index support (sharding writes between indexes)
   * Make C extension optional and provide an implementation in pure-ruby
   * N-dimensional faceted search (facets inside of facets)
-  * Query translation layer for Google-style AND/OR/NOT interpretation
-  * Fulltext query sanitization for unsafe user input (e.g. @missing field)
+  * Query translation layer for Lucene-style AND/OR/NOT and attribute:value interpretation
+  * Fulltext query sanitization for unsafe user input (e.g. @@missing field)
 
 ## Copyright and Licensing
 

data/lib/oedipus/index.rb

@@ -76,6 +76,20 @@ module Oedipus
       @conn.execute(@builder.replace(id, hash))
     end
 
+    # Delete the record with the ID +id+.
+    #
+    # @example
+    #   index.delete(42)
+    #
+    # @param [Integer] id
+    #   the unique ID of the document in the index
+    #
+    # @return [Fixnum]
+    #   the number of rows deleted (currently always 1 or 0)
+    def delete(id)
+      @conn.execute(@builder.delete(id))
+    end
+
     # Fetch a single document by its ID.
     #
     # Returns the Hash of attributes if found, otherwise nil.

data/lib/oedipus/query_builder.rb

@@ -83,7 +83,16 @@ module Oedipus
       into("REPLACE", id, attributes)
     end
 
-    private
+    # Build a SphinxQL query to delete the record identified by +id+.
+    #
+    # @param [Fixnum] id
+    #   the unique ID of the document to delete
+    #
+    # @return [String]
+    #   the SphinxQL to delete the record
+    def delete(id)
+      "DELETE FROM #{@index_name} WHERE id = #{Connection.quote(id)}"
+    end
 
     private
 

data/lib/oedipus/version.rb

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

data/spec/integration/index_spec.rb

@@ -147,6 +147,25 @@ describe Oedipus::Index do
     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)
@@ -180,6 +199,18 @@ describe Oedipus::Index do
           { id: 3, views: 41,   user_id: 0, status: "" }
         ]
       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, status: "new")
+          end
+
+          it "filters by the string attribute" do
+            index.search(status: "new")[:records].should == [{ id: 5, views: 0, user_id: 0, status: "new" }]
+          end
+        end
+      end
     end
 
     context "by fulltext with attribute filtering" do

data/spec/unit/query_builder_spec.rb

@@ -159,4 +159,10 @@ describe Oedipus::QueryBuilder do
       builder.replace(3, title: "example", views: 9).should == "REPLACE INTO posts (id, title, views) VALUES (3, 'example', 9)"
     end
   end
+
+  describe "#delete" do
+    it "includes the ID" do
+      builder.delete(3).should == "DELETE FROM posts WHERE id = 3"
+    end
+  end
 end

metadata

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