mongoid_search 0.2.6 → 0.2.7

data/lib/mongoid_search/log.rb

@@ -0,0 +1,20 @@
+class Log
+  cattr_accessor :silent
+
+  def self.log(message)
+    print message unless silent
+  end
+
+  def self.red(text)
+    log(colorize(text, 31))
+  end
+
+  def self.green(text)
+    log(colorize(text, 32))
+  end
+
+  private
+  def self.colorize(text, code)
+    "\033[#{code}m#{text}\033[0m"
+  end
+end

data/lib/mongoid_search/mongoid_search.rb

@@ -5,6 +5,15 @@ module Mongoid::Search
     cattr_accessor :search_fields, :match, :allow_empty_search, :relevant_search, :stem_keywords, :ignore_list
   end
 
+  def self.included(base)
+    @classes ||= []
+    @classes << base
+  end
+
+  def self.classes
+    @classes
+  end
+
   module ClassMethods #:nodoc:
     # Set a field or a number of fields as sources for search
     def search_in(*args)
@@ -17,7 +26,7 @@ module Mongoid::Search
       self.search_fields      = (self.search_fields || []).concat args
 
       field :_keywords, :type => Array
-      index :_keywords, background: true
+      index :_keywords, :background => true
 
       before_save :set_keywords
     end
@@ -29,22 +38,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 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}/ })
+      criteria.send("#{(options[:match]||self.match).to_s}_in", :_keywords => Util.normalize_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 criteria.all if query.blank? && allow_empty_search
 
-      keywords = Util.keywords(query, stem_keywords, ignore_list)
+      keywords = Util.normalize_keywords(query, stem_keywords, ignore_list)
 
       map = <<-EOS
         function() {
@@ -82,32 +89,25 @@ module Mongoid::Search
       # res.find.sort(['value', -1]) # Cursor
       collection.map_reduce(map, reduce, options)
     end
+
+    # Goes through all documents in the class that includes Mongoid::Search
+    # and indexes the keywords.
+    def index_keywords!
+      all.each { |d| d.index_keywords! ? Log.green(".") : Log.red("F") }
+    end
   end
 
-  private
+  module InstanceMethods #:nodoc:
+    # Indexes the document keywords
+    def index_keywords!
+      update_attribute(:_keywords, set_keywords)
+    end
+  end
 
-  # TODO: This need some refactoring..
+  private
   def set_keywords
     self._keywords = self.search_fields.map do |field|
-      if field.is_a?(Hash)
-        field.keys.map do |key|
-          attribute = self.send(key)
-          method = field[key]
-          if attribute.is_a?(Array)
-            if method.is_a?(Array)
-              method.map {|m| attribute.map { |a| Util.keywords a.send(m), stem_keywords, ignore_list } }
-            else
-              attribute.map(&method).map { |t| Util.keywords t, stem_keywords, ignore_list }
-            end
-          else
-            Util.keywords(attribute.send(method), stem_keywords, ignore_list)
-          end
-        end
-      else
-        value = self[field]
-        value = value.join(' ') if value.respond_to?(:join)
-        Util.keywords(value, stem_keywords, ignore_list) if value
-      end
+      Util.keywords(self, field, stem_keywords, ignore_list)
     end.flatten.reject{|k| k.nil? || k.empty?}.uniq.sort
   end
 end

data/lib/mongoid_search/railtie.rb

@@ -0,0 +1,10 @@
+require 'mongoid_search'
+require 'rails'
+
+module Mongoid::Search
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../../tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/mongoid_search/util.rb

@@ -1,13 +1,37 @@
 module Util
 
-  def self.keywords(text, stem_keywords, ignore_list)
+  def self.keywords(klass, field, stem_keywords, ignore_list)
+    if field.is_a?(Hash)
+      field.keys.map do |key|
+        attribute = klass.send(key)
+        unless attribute.blank?
+          method = field[key]
+          if attribute.is_a?(Array)
+            if method.is_a?(Array)
+              method.map {|m| attribute.map { |a| Util.normalize_keywords a.send(m), stem_keywords, ignore_list } }
+            else
+              attribute.map(&method).map { |t| Util.normalize_keywords t, stem_keywords, ignore_list }
+            end
+          else
+            Util.normalize_keywords(attribute.send(method), stem_keywords, ignore_list)
+          end
+        end
+      end
+    else
+      value = klass[field]
+      value = value.join(' ') if value.respond_to?(:join)
+      Util.normalize_keywords(value, stem_keywords, ignore_list) if value
+    end
+  end
+
+  def self.normalize_keywords(text, stem_keywords, ignore_list)
     return [] if text.blank?
     text = text.to_s.
       mb_chars.
       normalize(:kd).
       to_s.
       gsub(/[._:;'"`,?|+={}()!@#%^&*<>~\$\-\\\/\[\]]/, ' '). # strip punctuation
-      gsub(/[^[:alnum:]\s]/,'').   # strip accents     
+      gsub(/[^[:alnum:]\s]/,'').   # strip accents
       downcase.
       split(' ').
       reject { |word| word.size < 2 }

data/lib/mongoid_search.rb

@@ -1,2 +1,4 @@
+require 'mongoid_search/railtie' if defined?(Rails)
 require 'mongoid_search/util'
+require 'mongoid_search/log'
 require 'mongoid_search/mongoid_search'

data/spec/mongoid_search_spec.rb

@@ -30,12 +30,24 @@ describe Mongoid::Search do
     end
   end
 
+  context "when references are nil" do
+    context "when instance is being created" do
+      it "should not complain about method missing" do
+        lambda { Product.create! }.should_not raise_error
+      end
+    end
+    
+    subject { Product.create :brand => "Apple", :name => "iPhone" }
+
+    its(:_keywords) { should == ["apple", "iphone"] }
+  end
+
   it "should set the _keywords field for array fields also" do
     @product.attrs = ['lightweight', 'plastic', :red]
     @product.save!
     @product._keywords.should include 'lightweight', 'plastic', 'red'
   end
-  
+
   it "should inherit _keywords field and build upon" do
     variant = Variant.create :brand => "Apple",
                               :name => "iPhone",
@@ -123,10 +135,23 @@ 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
+
+  it 'should return the classes that include the search module' do
+    Mongoid::Search.classes.should == [Product]
+  end
+
+  it 'should have a method to index keywords' do
+    @product.index_keywords!.should == true
+  end
+
+  it 'should have a class method to index all documents keywords' do
+    Product.index_keywords!.should_not include(false)
+  end
+
   
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'mongoid'

data/spec/util_spec.rb

@@ -3,42 +3,42 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe Util do
   it "should return an empty array if no text is passed" do
-    Util.keywords("", false, "").should == []
+    Util.normalize_keywords("", false, "").should == []
   end
 
   it "should return an array of keywords" do
-    Util.keywords("keyword", false, "").class.should == Array
+    Util.normalize_keywords("keyword", false, "").class.should == Array
   end
 
   it "should return an array of strings" do
-    Util.keywords("keyword", false, "").first.class.should == String
+    Util.normalize_keywords("keyword", false, "").first.class.should == String
   end
 
   it "should remove accents from the text passed" do
-    Util.keywords("café", false, "").should == ["cafe"]
+    Util.normalize_keywords("café", false, "").should == ["cafe"]
   end
 
   it "should downcase the text passed" do
-    Util.keywords("CaFé", false, "").should == ["cafe"]
+    Util.normalize_keywords("CaFé", false, "").should == ["cafe"]
   end
 
   it "should split whitespaces, hifens, dots, underlines, etc.." do
-    Util.keywords("CaFé-express.com delicious;come visit, and 'win' an \"iPad\"", false, "").should == ["cafe", "express", "com", "delicious", "come", "visit", "and", "win", "an", "ipad"]
+    Util.normalize_keywords("CaFé-express.com delicious;come visit, and 'win' an \"iPad\"", false, "").should == ["cafe", "express", "com", "delicious", "come", "visit", "and", "win", "an", "ipad"]
   end
 
   it "should stem keywords" do
-    Util.keywords("A runner running and eating", true, "").should == ["runner", "run", "and", "eat"]
+    Util.normalize_keywords("A runner running and eating", true, "").should == ["runner", "run", "and", "eat"]
   end
 
   it "should ignore keywords from ignore list" do
-    Util.keywords("An amazing awesome runner running and eating", true, YAML.load(File.open(File.dirname(__FILE__) + '/config/ignorelist.yml'))["ignorelist"]).should == ["an", "runner", "run", "and", "eat"]
+    Util.normalize_keywords("An amazing awesome runner running and eating", true, YAML.load(File.open(File.dirname(__FILE__) + '/config/ignorelist.yml'))["ignorelist"]).should == ["an", "runner", "run", "and", "eat"]
   end
 
   it "should ignore keywords with less than two words" do
-    Util.keywords("A runner running", false, "").should_not include "a"
+    Util.normalize_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"
+      Util.normalize_keywords("Ford T 1908", false, "").should include "1908"
    end
 end

metadata

@@ -1,132 +1,156 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: mongoid_search
-version: !ruby/object:Gem::Version
-  version: 0.2.6
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 7
+  version: 0.2.7
 platform: ruby
-authors:
+authors: 
 - Mauricio Zaffari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-31 00:00:00.000000000 -03:00
+
+date: 2011-08-10 00:00:00 -03:00
 default_executable: 
-dependencies:
-- !ruby/object:Gem::Dependency
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: mongoid
-  requirement: &2155959000 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
         version: 2.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2155959000
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: bson_ext
-  requirement: &2155958360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
   prerelease: false
-  version_requirements: *2155958360
-- !ruby/object:Gem::Dependency
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: fast-stemmer
-  requirement: &2155957680 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
         version: 1.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: *2155957680
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: database_cleaner
-  requirement: &2155957100 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 4
         version: 0.6.4
   type: :development
-  prerelease: false
-  version_requirements: *2155957100
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &2155956180 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 7
         version: 0.8.7
   type: :development
-  prerelease: false
-  version_requirements: *2155956180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &2155955460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.4'
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        version: "2.4"
   type: :development
-  prerelease: false
-  version_requirements: *2155955460
+  version_requirements: *id006
 description: Simple full text search implementation.
-email:
+email: 
 - mauricio@papodenerd.net
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
+- lib/mongoid_search/log.rb
 - lib/mongoid_search/mongoid_search.rb
+- lib/mongoid_search/railtie.rb
 - lib/mongoid_search/util.rb
 - lib/mongoid_search.rb
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
-- spec/config/ignorelist.yml
-- spec/models/category.rb
-- 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
 has_rdoc: true
 homepage: http://www.papodenerd.net/mongoid-search-full-text-search-for-your-mongoid-models/
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
       version: 1.3.6
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Search implementation for Mongoid ORM
-test_files:
+test_files: 
 - spec/config/ignorelist.yml
 - spec/models/category.rb
 - spec/models/product.rb