mongoid_search2 0.3.0.beta.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mauricio Zaffari
+
+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.

data/README.md

@@ -0,0 +1,121 @@
+Mongoid Search
+============
+
+Mongoid Search is a simple full text search implementation for Mongoid ORM.
+
+Installation
+--------
+
+In your Gemfile:
+
+    gem 'mongoid_search'
+
+Then:
+
+    bundle install
+
+Examples
+--------
+
+    class Product
+      include Mongoid::Document
+      include Mongoid::Search
+      field :brand
+      field :name
+
+      references_many :tags
+      refereced_in    :category
+
+      search_in :brand, :name, :tags => :name, :category => :name
+    end
+
+    class Tag
+      include Mongoid::Document
+      field :name
+
+      referenced_in :product
+    end
+
+    class Category
+      include Mongoid::Document
+      field :name
+
+      references_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
+    
+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).csearch('iphone').asc(:price)
+
+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
+-------
+
+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
+    
+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)
+* Rewrite and test relevant search
+* Move all configurations to a configuration file. Maybe /config/mongoid_search.yml.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+
+require "bundler/gem_tasks"
+
+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/VERSION

@@ -0,0 +1 @@
+0.2.2

data/lib/mongoid_search/log.rb

@@ -0,0 +1,22 @@
+module MongoidSearch
+  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
+end

data/lib/mongoid_search/mongoid_search.rb

@@ -0,0 +1,127 @@
+require "mongoid_search/stemmers"
+
+module Mongoid::Search
+  extend ActiveSupport::Concern
+
+  included do
+    cattr_accessor :search_fields, :match, :allow_empty_search, :relevant_search, :stem_keywords, :stemmer_class, :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)
+      options = args.last.is_a?(Hash) && [:match, :allow_empty_search, :relevant_search, :stem_keywords, :ignore_list].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.relevant_search    = [true, false].include?(options[:relevant_search]) ? options[:relevant_search] : false
+      self.stemmer_class      = options[:stemmer_class]
+      self.stem_keywords      = !!stemmer_class || options[:stem_keywords]
+      self.stemmer_class    ||= MongoidSearch::FastStemmer
+      self.ignore_list        = YAML.load(File.open(options[:ignore_list]))["ignorelist"] if options[:ignore_list].present?
+      self.search_fields      = (self.search_fields || []).concat args
+
+      field :_keywords, :type => Array
+      index :_keywords, :background => true
+
+      before_save :set_keywords
+    end
+
+    def search(query, options={})
+      if relevant_search
+        search_relevant(query, options)
+      else
+        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 => MongoidSearch::Util.normalize_keywords(query, keyword_stemmer(options), ignore_list).map { |q| /#{q}/ })
+    end
+
+    def keyword_stemmer(options={})
+      stemmer_class.new(:language => options[:language])
+    end
+
+    def search_relevant(query, options={})
+      return criteria.all if query.blank? && allow_empty_search
+
+      keywords = MongoidSearch::Util.normalize_keywords(query, keyword_stemmer(options), ignore_list)
+
+      map = <<-EOS
+        function() {
+          var entries = 0
+          for(i in keywords)
+            for(j in this._keywords) {
+              if(this._keywords[j] == keywords[i])
+                entries++
+            }
+          if(entries > 0)
+            emit(this._id, entries)
+        }
+      EOS
+      reduce = <<-EOS
+        function(key, values) {
+          return(values[0])
+        }
+      EOS
+
+      #raise [self.class, self.inspect].inspect
+
+      kw_conditions = keywords.map do |kw|
+        {:_keywords => kw}
+      end
+
+      criteria = (criteria || self).any_of(*kw_conditions)
+
+      query = criteria.selector
+
+      options.delete(:limit)
+      options.delete(:skip)
+      options.merge! :scope => {:keywords => keywords}, :query => query
+
+      # res = collection.map_reduce(map, reduce, options)
+      # 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! ? MongoidSearch::Log.green(".") : MongoidSearch::Log.red("F") }
+    end
+  end
+
+  # Indexes the document keywords
+  def index_keywords!
+    update_attribute(:_keywords, set_keywords)
+  end
+
+  def keyword_language
+    super if defined?(super)
+  end
+
+  def keyword_stemmer
+    self.class.stemmer_class.new(:language => keyword_language) if stem_keywords
+  end
+
+  private
+  def set_keywords
+    self._keywords = self.search_fields.map do |field|
+      MongoidSearch::Util.keywords(self, field, keyword_stemmer, 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 MongoidSearch
+  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/stemmers.rb

@@ -0,0 +1,26 @@
+module MongoidSearch
+  class FastStemmer
+    def initialize(*args)
+    end
+
+    def call(word)
+      ::Stemmer.stem_word(word)
+    end
+  end
+
+  class LinguaStemmer
+    def initialize(*args, &block)
+      @stemmer = ::Lingua::Stemmer.new(*args, &block)
+    rescue Lingua::StemmerError => e
+      raise unless e.message.include?("not available")
+    end
+
+    def call(word)
+      if @stemmer
+        @stemmer.stem(word)
+      else
+        word
+      end
+    end
+  end
+end

data/lib/mongoid_search/util.rb

@@ -0,0 +1,45 @@
+module MongoidSearch
+  module Util
+
+    def self.keywords(klass, field, stemmer, 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), stemmer, ignore_list } }
+              else
+                attribute.map(&method).map { |t| Util.normalize_keywords t, stemmer, ignore_list }
+              end
+            else
+              Util.normalize_keywords(attribute.send(method), stemmer, ignore_list)
+            end
+          end
+        end
+      else
+        value = klass[field]
+        value = value.join(' ') if value.respond_to?(:join)
+        Util.normalize_keywords(value, stemmer, ignore_list) if value
+      end
+    end
+
+    def self.normalize_keywords(text, stemmer, ignore_list)
+      return [] if text.blank?
+      text = text.to_s.
+        mb_chars.
+        normalize(:kd).
+        downcase.
+        to_s.
+        gsub(/[._:;'"`,?|+={}()!@#%^&*<>~\$\-\\\/\[\]]/, ' '). # strip punctuation
+        gsub(/[^[:alnum:]\s]/,'').   # strip accents
+        split(' ').
+        reject { |word| word.size < 2 }
+      text = text.reject { |word| ignore_list.include?(word) } unless ignore_list.blank?
+      text = text.map{ |word| stemmer.call(word) } if stemmer
+      text
+    end
+
+  end
+end

data/lib/mongoid_search.rb

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

data/spec/config/ignorelist.yml

@@ -0,0 +1,2 @@
+ignorelist:
+  amazing, awesome

data/spec/coverage/assets/0.4.5/app.js

@@ -0,0 +1,66 @@
+$(document).ready(function() {
+  $('.file_list').dataTable({
+    "aaSorting": [[ 1, "asc" ]],
+    "bPaginate": false,
+    "bJQueryUI": true,
+    "aoColumns": [
+			null,
+		  { "sType": "percent" },
+			null,
+			null,
+			null,
+			null
+		]
+  });
+  
+  $('.source_table tbody tr:odd').addClass('odd');
+  $('.source_table tbody tr:even').addClass('even');
+  
+  $("a.src_link").fancybox({
+		'hideOnContentClick': true
+	});
+	
+	// Hide src files and file list container
+  $('.source_files').hide();
+  $('.file_list_container').hide();
+  
+  // Add tabs based upon existing file_list_containers
+  $('.file_list_container h2').each(function(){
+    $('.group_tabs').append('<li><a href="#' + $(this).parent().attr('id') + '">' + $(this).html() + '</a></li>');
+  });
+
+  $('.group_tabs a').each( function() {
+    $(this).addClass($(this).attr('href').replace('#', ''));
+  });
+  
+  $('.group_tabs a').live('focus', function() {
+    $(this).blur();
+  });
+  
+  var favicon_path = $('link[rel="shortcut icon"]').attr('href')
+  $('.group_tabs a').live('click', function(){
+    if (!$(this).parent().hasClass('active')) {
+      $('.group_tabs a').parent().removeClass('active');
+      $(this).parent().addClass('active');
+      $('.file_list_container').hide();
+      $(".file_list_container" + $(this).attr('href')).show();
+      window.location.href = window.location.href.split('#')[0] + $(this).attr('href').replace('#', '#_');
+      
+      // Force favicon reload - otherwise the location change containing anchor would drop the favicon...
+      // Works only on firefox, but still... - Anyone know a better solution to force favicon?
+      $('link[rel="shortcut icon"]').remove();
+      $('head').append('<link rel="shortcut icon" type="image/png" href="'+ favicon_path +'" />');
+    };
+    return false;
+  });
+  
+  if (jQuery.url.attr('anchor')) {
+    $('.group_tabs a.'+jQuery.url.attr('anchor').replace('_', '')).click();
+  } else {
+    $('.group_tabs a:first').click();
+  };
+  
+  $("abbr.timeago").timeago();
+  $('#loading').fadeOut();
+  $('#wrapper').show();
+});