mongoid_search 0.2.3 → 0.2.4

data/README.md

@@ -62,6 +62,15 @@ Note that the search is case insensitive, and accept partial searching too:
 
     Product.search("ipho").size
     => 1
+    
+Assuming you have a category with multiple products you can now use the following
+code to search for 'iphone' in products cheaper than $499
+
+    @category.products.where(:price.lt => 499).asc(:price).csearch('iphone')
+
+In this case we have to use csearch, an alias for search, because since v2.0.0
+Mongoid defines it's own Criteria.search method.
+
 
 Options
 -------
@@ -90,11 +99,23 @@ allow_empty_search:
 
     Product.search("").size
     => 1
+    
+ignore_list:
+  Pass in an ignore list location. Keywords in that list will be ignored.
+  
+    search_in :brand, :name, { :tags => :name }, { :ignore_list => Rails.root.join("config", "ignorelist.yml") }
+
+  The list should look like:
+    
+    ignorelist:
+      a, an, to, from, as
+      
+  You can include how many keywords you like.
 
 TODO
 ----
 
 * Strip html with sanitize (https://github.com/rgrove/sanitize)
-* Test relevant search
+* Rewrite and test relevant search
 * Move all configurations to a configuration file. Maybe /config/mongoid_search.yml.
 

data/lib/mongoid_search/mongoid_search.rb

@@ -14,7 +14,7 @@ module Mongoid::Search
       self.relevant_search    = [true, false].include?(options[:relevant_search]) ? options[:allow_empty_search] : false
       self.stem_keywords      = [true, false].include?(options[:stem_keywords]) ? options[:allow_empty_search] : false
       self.ignore_list        = YAML.load(File.open(options[:ignore_list]))["ignorelist"] if options[:ignore_list].present?
-      self.search_fields      = args
+      self.search_fields      = (self.search_fields || []).concat args
 
       field :_keywords, :type => Array
       index :_keywords
@@ -29,14 +29,20 @@ module Mongoid::Search
         search_without_relevance(query, options)
       end
     end
+    
+    # Mongoid 2.0.0 introduces Criteria.seach so we need to provide
+    # alternate method
+    alias csearch search
 
     def search_without_relevance(query, options={})
-      return self.all if query.blank? && allow_empty_search
-      self.send("#{(options[:match]||self.match).to_s}_in", :_keywords => Util.keywords(query, stem_keywords, ignore_list).map { |q| /#{q}/ })
+      return criteria.all if query.blank? && allow_empty_search
+      criteria.send("#{(options[:match]||self.match).to_s}_in", :_keywords => Util.keywords(query, stem_keywords, ignore_list).map { |q| /#{q}/ })
     end
-
+    
+    # I know what this method should do, but I don't really know what it does.
+    # It was a pull from another fork, with no tests on it. Proably should be rewrited (and tested).
     def search_relevant(query, options={})
-      return self.all if query.blank? && allow_empty_search
+      return criteria.all if query.blank? && allow_empty_search
 
       keywords = Util.keywords(query, stem_keywords, ignore_list)
 
@@ -64,7 +70,7 @@ module Mongoid::Search
         {:_keywords => kw}
       end
 
-      criteria = self.any_of(*kw_conditions)
+      criteria = (criteria || self).any_of(*kw_conditions)
 
       query = criteria.selector
 
@@ -72,15 +78,15 @@ module Mongoid::Search
       options.delete(:skip)
       options.merge! :scope => {:keywords => keywords}, :query => query
 
-      res = collection.map_reduce(map, reduce, options)
-
-      res.find.sort(['value', -1]) # Cursor
+      # res = collection.map_reduce(map, reduce, options)
+      # res.find.sort(['value', -1]) # Cursor
+      collection.map_reduce(map, reduce, options)
     end
   end
 
   private
 
-  # TODO: This need some refatoring..
+  # TODO: This need some refactoring..
   def set_keywords
     self._keywords = self.search_fields.map do |field|
       if field.is_a?(Hash)
@@ -98,9 +104,13 @@ module Mongoid::Search
           end
         end
       else
-        text = self[field]
-        Util.keywords(text, stem_keywords, ignore_list) unless text.nil?
+        value = self[field]
+        if value.is_a?(Array)
+          value.each {|v| Util.keywords(v, stem_keywords, ignore_list) if v}
+        else
+          Util.keywords(value, stem_keywords, ignore_list) if value
+        end
       end
-    end.flatten.compact.sort
+    end.flatten.map(&:to_s).select{|f| not f.empty? }.uniq.sort
   end
 end

data/lib/mongoid_search/util.rb

@@ -2,12 +2,12 @@ module Util
 
   def self.keywords(text, stem_keywords, ignore_list)
     return [] if text.blank?
-    text = text.
+    text = text.to_s.
       mb_chars.
       normalize(:kd).
       to_s.
       gsub(/[._:;'"`,?|+={}()!@#%^&*<>~\$\-\\\/\[\]]/, ' '). # strip punctuation
-      gsub(/[^[:alpha:]\s]/,'').  # strip accents
+      gsub(/[^[:alnum:]\s]/,'').   # strip accents     
       downcase.
       split(' ').
       reject { |word| word.size < 2 }

data/spec/models/product.rb

@@ -3,10 +3,11 @@ class Product
   include Mongoid::Search
   field :brand
   field :name
+  field :attrs, :type => Array
 
   references_many :tags
   referenced_in   :category
   embeds_many     :subproducts
 
-  search_in :brand, :name, :outlet, :tags => :name, :category => :name, :subproducts => [:brand, :name]
+  search_in :brand, :name, :outlet, :attrs, :tags => :name, :category => :name, :subproducts => [:brand, :name]
 end

data/spec/models/variant.rb

@@ -0,0 +1,4 @@
+class Variant < Product
+  field :color
+  search_in :color
+end

data/spec/mongoid_search_spec.rb

@@ -31,21 +31,45 @@ describe Mongoid::Search do
   end
 
   it "should set the _keywords field" do
-    @product._keywords.should == ["amazing", "apple", "apple", "awesome", "craddle", "iphone", "mobile", "ole"]
+    @product.attrs = ['lightweight', 'rugged', :red]
+    @product.save!
+    @product._keywords.should include "amazing", "apple", "awesome", "craddle", "iphone", "mobile", "ole", "lightweight", "rugged", "red"
+  end
+  
+  it "should inherit _keywords field and build upon" do
+    variant = Variant.create :brand => "Apple",
+                              :name => "iPhone",
+                              :tags => ["Amazing", "Awesome", "Olé"].map { |tag| Tag.new(:name => tag) },
+                              :category => Category.new(:name => "Mobile"),
+                              :subproducts => [Subproduct.new(:brand => "Apple", :name => "Craddle")],
+                              :color => :white
+    variant._keywords.should include "amazing", "apple", "awesome", "craddle", "iphone", "mobile", "ole", "white"
+    Variant.search(:name => 'Apple', :color => :white).size.should == 1
   end
 
   it "should set the _keywords field with stemmed words if stem is enabled" do
     Product.stem_keywords = true
     @product.save!
-    @product._keywords.should == ["amaz", "appl", "appl", "awesom", "craddl", "iphon", "mobil", "ol"]
+    @product._keywords.should == ["amaz", "appl", "awesom", "craddl", "iphon", "mobil", "ol"]
   end
 
   it "should ignore keywords in an ignore list" do
     Product.ignore_list = YAML.load(File.open(File.dirname(__FILE__) + '/config/ignorelist.yml'))["ignorelist"]
     @product.save!
-    @product._keywords.should == ["apple", "apple", "craddle", "iphone", "mobile", "ole"]
+    @product._keywords.should == ["apple", "craddle", "iphone", "mobile", "ole"]
   end
 
+   it "should incorporate numbers as keywords" do
+        @product = Product.create :brand => "Ford",
+                              :name => "T 1908",
+                              :tags => ["Amazing", "First", "Car"].map { |tag| Tag.new(:name => tag) },
+                              :category => Category.new(:name => "Vehicle")
+
+      @product.save!
+      @product._keywords.should == ["1908","amazing", "car", "first", "ford",  "vehicle"]
+   end
+
+
   it "should return results in search" do
     Product.search("apple").size.should == 1
   end
@@ -99,4 +123,10 @@ describe Mongoid::Search do
   it "should search for embedded documents" do
     Product.search("craddle").size.should == 1
   end
+  
+  it 'should work in a chainable fashion' do
+    @product.category.products.where(:brand => 'Apple').csearch('apple').size.should == 1
+    @product.category.products.csearch('craddle').where(:brand => 'Apple').size.should == 1
+  end
+  
 end

data/spec/util_spec.rb

@@ -37,4 +37,8 @@ describe Util do
   it "should ignore keywords with less than two words" do
     Util.keywords("A runner running", false, "").should_not include "a"
   end
+
+   it "should not ignore numbers" do
+      Util.keywords("Ford T 1908", false, "").should include "1908"
+   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 3
-  version: 0.2.3
+  - 4
+  version: 0.2.4
 platform: ruby
 authors: 
 - Mauricio Zaffari
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-07 00:00:00 -03:00
+date: 2011-04-14 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -127,6 +127,7 @@ files:
 - spec/models/product.rb
 - spec/models/subproduct.rb
 - spec/models/tag.rb
+- spec/models/variant.rb
 - spec/mongoid_search_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb
@@ -170,6 +171,7 @@ test_files:
 - spec/models/product.rb
 - spec/models/subproduct.rb
 - spec/models/tag.rb
+- spec/models/variant.rb
 - spec/mongoid_search_spec.rb
 - spec/spec_helper.rb
 - spec/util_spec.rb