mongoid_fulltext 0.4.4 → 0.4.5

data/README.md

@@ -217,6 +217,12 @@ Additional indexing/query options can be used as parameters to `fulltext_search_
   URL, for instance we might have "%C3%A9" which is how an "e-accute" ("é") gets passed
   through a web-browser. These are then changed to their UTF-8 equivalents (via the `CGI` gem) 
   and then finally stripped, as before.
+* `update_if`: controls whether or not the index will be updated. This can be set to a symbol,
+  string, or proc. If the result of evaluating the value is true, the index will be updated.
+** When set to a symbol, the symbol is sent to the document.
+** When set to a string, the string is evaluated within the document's instance.
+** When set to a proc, the proc is called, and the document is given to the proc as the first arg.
+** When set to any other type of object, the document's index will not be updated.
 
 Array filters
 -------------
@@ -267,6 +273,18 @@ method:
 The methods on the model level perform bulk removal operations and are therefore faster that 
 updating or removing records individually.
 
+If you need to control when the index is updated, provide the `update_if` option to
+`fulltext_search_in`, and set it to a symbol, string, or proc. Eg:
+
+    # Only update the "age" index if the "age" field has changed.
+    fulltext_search_in :age,    :update_if => :age_changed?
+
+    # Only update the "names" index if the "firstname" or "lastname" field has changed.
+    fulltext_search_in :names,  :update_if => "firstname_changed? || lastname_changed?"
+
+    # Only update the "email" index if the "email" field ends with "gmail.com".
+    fulltext_search_in :email,  :update_if => Proc.new { |doc| doc.email.match /gmail.com\Z/ }
+
 Mongo Database Indexes
 ----------------------
 

data/VERSION

@@ -1 +1 @@
-0.4.4
+0.4.5

data/lib/mongoid_fulltext.rb

@@ -235,6 +235,15 @@ module Mongoid::FullTextSearch
 
   def update_ngram_index
     self.mongoid_fulltext_config.each_pair do |index_name, fulltext_config|
+      if condition = fulltext_config[:update_if]
+        case condition
+        when Symbol;  next unless self.send condition
+        when String;  next unless instance_eval condition
+        when Proc;    next unless condition.call self
+        else;         next
+        end
+      end
+
       # remove existing ngrams from external index
       coll = collection.db.collection(index_name)
       coll.remove({'document_id' => self._id})

data/mongoid_fulltext.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_fulltext}
-  s.version = "0.4.4"
+  s.version = "0.4.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Windsor"]
-  s.date = %q{2011-08-31}
+  s.date = %q{2011-10-05}
   s.description = %q{Full-text search for the Mongoid ORM, using n-grams extracted from text}
   s.email = %q{aaron.windsor@gmail.com}
   s.extra_rdoc_files = [

data/spec/mongoid/fulltext_spec.rb

@@ -429,6 +429,84 @@ module Mongoid
       let!(:flowers1)     { BasicArtwork.create(:title => 'Flowers 1') }
       let!(:flowers2)     { BasicArtwork.create(:title => 'Flowers 2') }
 
+      context "when config[:update_if] exists" do
+
+        let(:painting)          { BasicArtwork.new :title => 'Painting' }
+        let(:conditional_index) { BasicArtwork.mongoid_fulltext_config["mongoid_fulltext.index_conditional"] }
+
+        before(:all) do
+          BasicArtwork.class_eval do
+            fulltext_search_in :title, :index_name => "mongoid_fulltext.index_conditional"
+          end
+        end
+
+        after(:all) do
+          Mongoid.master["mongoid_fulltext.index_conditional"].remove
+          BasicArtwork.mongoid_fulltext_config.delete "mongoid_fulltext.index_conditional"
+        end
+
+        context "and is a symbol" do
+
+          before(:all) do
+            conditional_index[:update_if] = :persisted?
+          end
+
+          context "when sending the symbol to the document evaluates to false" do
+
+            it "doesn't update the index for the document" do
+              painting.update_ngram_index
+              BasicArtwork.fulltext_search('painting', :index => "mongoid_fulltext.index_conditional").length.should be 0
+            end
+
+          end
+        end
+
+        context "and is a string" do
+
+          before(:all) do
+            conditional_index[:update_if] = 'false'
+          end
+
+          context "when evaluating the string within the document's instance evaluates to false" do
+
+            it "doesn't update the index for the document" do
+              painting.update_ngram_index
+              BasicArtwork.fulltext_search('painting', :index => "mongoid_fulltext.index_conditional").length.should be 0
+            end
+
+          end
+        end
+
+        context "and is a proc" do
+
+          before(:all) do
+            conditional_index[:update_if] = Proc.new { false }
+          end
+
+          context "when evaluating the string within the document's instance evaluates to false" do
+
+            it "doesn't update the index for the document" do
+              painting.update_ngram_index
+              BasicArtwork.fulltext_search('painting', :index => "mongoid_fulltext.index_conditional").length.should be 0
+            end
+
+          end
+        end
+
+        context "and is not a symbol, string, or proc" do
+
+          before(:all) do
+            conditional_index[:update_if] = %w(this isn't a symbol, string, or proc)
+          end
+
+          it "doesn't update the index for the document" do
+            painting.update_ngram_index
+            BasicArtwork.fulltext_search('painting', :index => "mongoid_fulltext.index_conditional").length.should be 0
+          end
+
+        end
+      end
+
       context "from scratch" do
 
         before(:each) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_fulltext
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-31 00:00:00.000000000 -04:00
+date: 2011-10-05 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unicode_utils
-  requirement: &82521100 !ruby/object:Gem::Requirement
+  requirement: &83773400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *82521100
+  version_requirements: *83773400
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &82510440 !ruby/object:Gem::Requirement
+  requirement: &83773150 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *82510440
+  version_requirements: *83773150
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &82510030 !ruby/object:Gem::Requirement
+  requirement: &83772860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 1.3.0
   type: :development
   prerelease: false
-  version_requirements: *82510030
+  version_requirements: *83772860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &82509570 !ruby/object:Gem::Requirement
+  requirement: &83772590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +55,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *82509570
+  version_requirements: *83772590
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &82509170 !ruby/object:Gem::Requirement
+  requirement: &83772310 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,7 +66,7 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *82509170
+  version_requirements: *83772310
 description: Full-text search for the Mongoid ORM, using n-grams extracted from text
 email: aaron.windsor@gmail.com
 executables: []
@@ -118,7 +118,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 518227181
+      hash: 700135439
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: