mongomapper_search 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (C) 2011 by Mário Peixoto
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+Based on mongoid_search, Copyright by Mauricio Zaffari, 2009

data/README.md

@@ -0,0 +1,102 @@
+MongoMapper Search
+============
+
+MongoMapper Search is a simple full text search implementation for MongoMapper ODM based on mongoid_search (https://github.com/mauriciozaffari/mongoid_search).
+
+Installation
+--------
+
+In your Gemfile:
+
+    gem 'mongomapper_search'
+
+Then:
+
+    bundle install
+
+Examples
+--------
+
+    class Product
+      include MongoMapper::Document
+      include MongoMapper::Search
+      key :brand, String
+      key :name, String
+
+      many :tags
+      belongs_to :category
+
+      search_in :brand, :name, :tags => :name, :category => :name
+    end
+
+    class Tag
+      include MongoMapper::Document
+      key :name, Stirng
+
+      belongs_to :product
+    end
+
+    class Category
+      include MongoMapper::Document
+      key :name, String
+
+      many :products
+    end
+
+Now when you save a product, you get a _keywords field automatically:
+
+    p = Product.new :brand => "Apple", :name => "iPhone"
+    p.tags << Tag.new(:name => "Amazing")
+    p.tags << Tag.new(:name => "Awesome")
+    p.tags << Tag.new(:name => "Superb")
+    p.save
+    => true
+    p._keywords
+
+Now you can run search, which will look in the _keywords field and return all matching results:
+
+    Product.search("apple iphone").size
+    => 1
+
+Note that the search is case insensitive, and accept partial searching too:
+
+    Product.search("ipho").size
+    => 1
+    
+You can use search in a chainable way:
+
+    Product.where(:brand => "Apple").search('iphone').sort(:price.asc)
+
+
+Options
+-------
+
+match:
+  _:any_ - match any occurrence
+  _:all_ - match all ocurrences
+  Default is _:any_.
+
+    search_in :brand, :name, { :tags => :name }, { :match => :any }
+
+    Product.search("apple motorola").size
+    => 1
+
+    search_in :brand, :name, { :tags => :name }, { :match => :all }
+
+    Product.search("apple motorola").size
+    => 0
+
+allow_empty_search:
+  _true_ - match any occurrence
+  _false_ - match all ocurrences
+  Default is _false_.
+
+    search_in :brand, :name, { :tags => :name }, { :allow_empty_search => true }
+
+    Product.search("").size
+    => 1
+    
+RoadMap
+----
+
+- Create a ignore list so the search can ignore some words

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["-c", "-f progress"]
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/lib/mongomapper_search/query.rb

@@ -0,0 +1,13 @@
+module Plucky
+  class Query
+    def search(query, options={})
+      #Fix class search
+      if first
+        to_merge = first.class.search(query, options)
+        find_each(to_merge.criteria.to_hash).to_a
+      else
+        self
+      end
+    end
+  end
+end

data/lib/mongomapper_search/search.rb

@@ -0,0 +1,75 @@
+module MongoMapper
+  module Search
+    extend ActiveSupport::Concern
+    
+    included do
+      cattr_accessor :search_fields, :allow_empty_search, :stem_keywords, :match
+    end
+    
+    def self.included(base)
+      @classes ||= []
+      @classes << base
+    end
+
+    def self.classes
+      @classes
+    end
+    
+    module ClassMethods
+      
+      def search_in(*args)
+        options = args.last.is_a?(Hash) && [:allow_empty_search, :stem_keywords].include?(args.last.keys.first) ? args.pop : {}
+        self.match              = [:any, :all].include?(options[:match]) ? options[:match] : :any
+        self.allow_empty_search = [true, false].include?(options[:allow_empty_search]) ? options[:allow_empty_search] : false
+        self.stem_keywords      = [true, false].include?(options[:stem_keywords]) ? options[:allow_empty_search] : false
+        self.search_fields      = (self.search_fields || []).concat args
+        
+        key :_keywords, Array
+        ensure_index :_keywords, :background => true
+        
+        before_save :set_keywords
+      end
+      
+      def search(query, options={})
+        return all if query.blank? && allow_empty_search
+        
+        keywords = Util.normalize_keywords(query, stem_keywords)
+        
+        regexed_keywords = []
+                        
+        keywords.each do |keyword|
+          regexed_keywords.concat([/#{keyword}/])
+        end
+         
+        search_match = options[:match]||self.match
+        
+        if search_match == :all 
+          where(:_keywords => { "$all" => regexed_keywords })
+        elsif search_match == :any
+          where(:_keywords => regexed_keywords )
+        end
+      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! }
+      end
+    end
+    
+    module InstanceMethods #:nodoc:
+      # Indexes the document keywords
+      def index_keywords!
+        update_attribute(:_keywords, set_keywords)
+      end
+    end
+    
+    private
+    def set_keywords
+      self._keywords = self.search_fields.map do |field|
+        Util.keywords(self, field, stem_keywords)
+      end.flatten.reject{|k| k.nil? || k.empty?}.uniq.sort
+    end
+    
+  end
+end

data/lib/mongomapper_search/util.rb

@@ -0,0 +1,43 @@
+module Util
+
+  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
+      downcase.
+      split(' ').
+      reject { |word| word.size < 2 }
+    text = text.reject { |word| ignore_list.include?(word) } unless ignore_list.blank?
+    text = text.map(&:stem) if stem_keywords
+    text
+  end
+
+end

data/lib/mongomapper_search.rb

@@ -0,0 +1,3 @@
+require "mongomapper_search/search"
+require "mongomapper_search/util"
+require "mongomapper_search/query"

data/spec/models/category.rb

@@ -0,0 +1,6 @@
+class Category
+  include MongoMapper::Document
+  key :name, String
+
+  many :products
+end

data/spec/models/product.rb

@@ -0,0 +1,13 @@
+class Product
+  include MongoMapper::Document
+  include MongoMapper::Search
+  key :brand, String
+  key :name, String
+  key :attrs, Array
+
+  many :tags
+  many :subproducts
+  belongs_to :category
+  
+  search_in :brand, :name, :outlet, :attrs, :tags => :name, :category => :name, :subproducts => [:brand, :name]
+end

data/spec/models/subproduct.rb

@@ -0,0 +1,7 @@
+class Subproduct
+  include MongoMapper::EmbeddedDocument
+
+  key :brand, String
+  key :name, String
+
+end

data/spec/models/tag.rb

@@ -0,0 +1,6 @@
+class Tag
+  include MongoMapper::Document
+  key :name, String
+
+  belongs_to :product
+end

data/spec/models/variant.rb

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

data/spec/search_spec.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe MongoMapper::Search do
+  
+  before(:each) do
+    Product.stem_keywords = false
+    @product = Product.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")]
+  end
+
+  context "utf-8 characters" do
+    before(:each) {
+      Product.stem_keywords = false
+      @product = Product.create :brand => "Эльбрус",
+                                :name => "Процессор",
+                                :tags => ["Amazing", "Awesome", "Olé"].map { |tag| Tag.new(:name => tag) },
+                                :category => Category.new(:name => "процессоры"),
+                                :subproducts => []
+    }
+
+    it "should leave utf8 characters" do
+      @product._keywords.should == ["amazing", "awesome", "ole", "Процессор", "Эльбрус", "процессоры"]
+    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",
+                              :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 'white'
+    Variant.search("Apple white").to_a.should eq [variant]
+  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", "awesom", "craddl", "iphon", "mobil", "ol"]
+  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
+
+  it "should return results in search for dynamic attribute" do
+    @product[:outlet] = "online shop"
+    @product.save!
+    Product.search("online").size.should == 1
+  end
+
+  it "should return results in search even searching a accented word" do
+    Product.search("Ole").size.should == 1
+    Product.search("Olé").size.should == 1
+  end
+
+  it "should return results in search even if the case doesn't match" do
+    Product.search("oLe").size.should == 1
+  end
+
+  it "should return results in search with a partial word" do
+    Product.search("iph").size.should == 1
+  end
+
+  it "should return results for any matching word with default search" do
+    Product.search("apple motorola").size.should == 1
+  end
+
+  it "should not return results when all words do not match, if using :match => :all" do
+    Product.match = :all
+    Product.search("apple motorola").size.should == 0
+  end
+
+  it "should return results for any matching word, using :match => :all, passing :match => :any to .search" do
+    Product.match = :all
+    Product.search("apple motorola", :match => :any).size.should == 1
+  end
+
+  it "should not return results when all words do not match, passing :match => :all to .search" do
+    Product.search("apple motorola", :match => :all).size.should == 0
+  end
+
+  it "should return no results when a blank search is made" do
+    Product.search("").size.should == 0
+  end
+
+  it "should return results when a blank search is made when :allow_empty_search is true" do
+    Product.allow_empty_search = true
+    Product.search("").size.should == 1
+  end
+
+  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').search('apple').size.should == 1
+    @product.category.products.where(:brand => 'Apple').search('troll').size.should == 0
+    @product.category.products.search('craddle').where(:brand => 'Apple').size.should == 1
+    @product.category.products.search('craddle').where(:brand => 'Dell').size.should == 0
+  end
+
+  it 'should return the classes that include the search module' do
+    MongoMapper::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

@@ -0,0 +1,31 @@
+require 'simplecov'
+SimpleCov.start
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongo_mapper'
+require 'database_cleaner'
+require 'fast_stemmer'
+require 'yaml'
+require 'mongomapper_search'
+
+MongoMapper.connection = Mongo::Connection.new("localhost", 27017)
+MongoMapper.database = "mongomapper_search_test"
+
+Dir["#{File.dirname(__FILE__)}/models/*.rb"].each { |file| require file }
+
+DatabaseCleaner.orm = :mongo_mapper
+
+RSpec.configure do |config|
+  config.before(:all) do
+    DatabaseCleaner.strategy = :truncation
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end

data/spec/util_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+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.normalize_keywords("", false, "").should == []
+  end
+
+  it "should return an array of keywords" do
+    Util.normalize_keywords("keyword", false, "").class.should == Array
+  end
+
+  it "should return an array of strings" do
+    Util.normalize_keywords("keyword", false, "").first.class.should == String
+  end
+
+  it "should remove accents from the text passed" do
+    Util.normalize_keywords("café", false, "").should == ["cafe"]
+  end
+
+  it "should downcase the text passed" do
+    Util.normalize_keywords("CaFé", false, "").should == ["cafe"]
+  end
+
+  it "should split whitespaces, hifens, dots, underlines, etc.." do
+    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.normalize_keywords("A runner running and eating", true, "").should == ["runner", "run", "and", "eat"]
+  end
+
+  it "should ignore keywords with less than two words" do
+    Util.normalize_keywords("A runner running", false, "").should_not include "a"
+  end
+
+   it "should not ignore numbers" do
+      Util.normalize_keywords("Ford T 1908", false, "").should include "1908"
+   end
+   
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: mongomapper_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mário Peixoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-18 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &70143029026220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143029026220
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70143029025740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143029025740
+- !ruby/object:Gem::Dependency
+  name: fast-stemmer
+  requirement: &70143029025260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70143029025260
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: &70143029024780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *70143029024780
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70143029024300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70143029024300
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70143029023820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: *70143029023820
+description: Simple full text search for MongoMapper ODM
+email:
+- mario.peixoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongomapper_search/query.rb
+- lib/mongomapper_search/search.rb
+- lib/mongomapper_search/util.rb
+- lib/mongomapper_search.rb
+- LICENSE
+- README.md
+- Rakefile
+- spec/models/category.rb
+- spec/models/product.rb
+- spec/models/subproduct.rb
+- spec/models/tag.rb
+- spec/models/variant.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+- spec/util_spec.rb
+homepage: http://github.com/mariopeixoto/mongomapper_search
+licenses: []
+post_install_message: 
+rdoc_options: []
+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
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.7
+signing_key: 
+specification_version: 3
+summary: Search implementation for MongoMapper ODM
+test_files:
+- spec/models/category.rb
+- spec/models/product.rb
+- spec/models/subproduct.rb
+- spec/models/tag.rb
+- spec/models/variant.rb
+- spec/search_spec.rb
+- spec/spec_helper.rb
+- spec/util_spec.rb