mongodb_fulltext_search_er 0.0.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c5c193692d9add9fc4b9faa7f5d212b3007e3279
+  data.tar.gz: 20382936bcc690b7de6ddafcbd0bf2069beb42d1
+SHA512:
+  metadata.gz: e919d05ebe300c5a467763c9ef2a6a029d08019af77575ee5cfac57c1ee4e34db07a1de72f2d7ed049866da4a7087116af6a2767a84ae68dbadea8f2f04813ec
+  data.tar.gz: 30e36fdcbcc829f1e50c9883df3327c764b8de6e841a8eb903a8aae1b1a18172b91c4068ff07940fb390e014a4fec4ff1f5459e4faa75cf091a84fc3ec71de82

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Christopher Fuller
+
+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.rdoc

@@ -0,0 +1,164 @@
+== same as chrisfuller's mongodb_fulltext_search, but excludes rails as a dependency
+
+This was done to allow use of mongodb_fulltext_search with any version/branch of rails
+
+= mongodb_fulltext_search
+
+A gem that adds fulltext search capability to Mongoid[http://mongoid.org/] or MongoMapper[http://mongomapper.com/] documents. The MongoDB[http://mongodb.org/] aggregation framework is utilized to perform searches quickly and efficiently.
+
+== Prerequisites
+
+Rails must be configured to use either Mongoid or MongoMapper and MongoDB[http://mongodb.org/] version 2.1.0 (or higher) is required.
+
+Please get in touch if you’d like to see added support for another MongoDB object mapper (ODM).
+
+== Installation
+
+  $ gem install mongodb_fulltext_search
+
+== Rails Configuration
+
+Add to Gemfile:
+
+  gem 'mongodb_fulltext_search'
+
+== Indexes
+
+This gem implements indexes specifically for the fulltext search.
+
+The fulltext indexes are maintained automatically via the +before_save+ and +before_destroy+ callbacks on models, however you MUST run the rake task (below) to rebuild the indexes any time your models change.
+
+The indexes are implemented as MongoDB collections (since MongoDB's built-in indexes do not currently support fulltext search), therefore the fulltext indexes are actually "index collections". The "index collections" are stored in the same database that the models are persisted to.
+
+The "index collections" benefit from using MongoDB indexes themselves and have MongoDB indexes defined via the underlying ODM, therefore be sure to create the indexes following the instructions for the ODM you are using.
+
+With Mongoid for example, use the normal rake command <tt>rake db:mongoid:create_indexes</tt>. With MongoMapper for example, the indexes should be created automatically by default.
+
+For the remainder of the documentation, the "index collections" will now simply be referred to as "indexes".
+
+== Examples
+
+Mongoid example:
+
+  class Widget
+
+    include Mongoid::Document
+    include Mongoid::FullTextSearch
+
+    field :desc, :type => String
+    field :tags, :type => Array
+
+    fulltext_search_in :desc
+
+  end
+
+MongoMapper example:
+
+  class Widget
+
+    include MongoMapper::Document
+    include MongoMapper::FullTextSearch
+
+    key :desc, String
+    key :tags, Array
+
+    fulltext_search_in :desc
+
+  end
+
+Or index multiple attributes together:
+
+  fulltext_search_in :desc, :tags
+
+Or index virtual attributes:
+
+  fulltext_search_in :desc_and_tags
+
+  def desc_and_tags
+    [ desc ] + tags
+  end
+
+NOTE: All attributes (and virtual attributes) supplied to +fulltext_search_in+ must return either a string or an array of strings.
+
+== Performing Searches
+
+In controllers, perform searches with:
+
+  @widgets = Widget.fulltext_search params[:search_query]
+
+After fulltext searches are performed, access scores via a +fulltext_search_score+ attribute on models:
+
+  @widgets.each { |widget| widget.fulltext_search_score }
+
+== Multiple Indexes
+
+It is possible to create more than one index on a model:
+
+  fulltext_search_in :desc, :index => 'desc_index'
+  fulltext_search_in :tags, :index => 'tags_index'
+
+In this case, you MUST specify an index when performing a search:
+
+  @widgets = Widget.fulltext_search params[:search_query], :index => 'desc_index'
+
+or
+
+  @widgets = Widget.fulltext_search params[:search_query], :index => 'tags_index'
+
+NOTE: An +ArgumentError+ exception will be raised if multiple indexes exist but an index is not specified.
+
+== Options
+
+To match partial words, turn off exact matching:
+
+  @widgets = Widget.fulltext_search params[:search_query], :exact => false
+
+By default, results are limited to 20 models but you can specify a limit when searching:
+
+  @widgets = Widget.fulltext_search params[:search_query], :limit => 10
+
+And you can also specify an offset:
+
+  @widgets = Widget.fulltext_search params[:search_query], :offset => 20
+
+To return document identifiers and search scores as a +Hash+ (instead of the returning the model objects):
+
+  @scores = Widget.fulltext_search params[:search_query], :return_scores => true
+  @scores.each { |id, score| id + ': ' + score }
+
+== Normalization
+
+Strings are normalized using <tt>normalize(:kd)</tt> (for queries and also indexes), so for example +resumé+ and +resume+ would match.
+
+== Stop Words
+
+Stop words (i.e. blacklisted words) can be specified in a YAML config file.
+
+To generate a config file with a default set of stop words:
+
+  $ rails g mongodb_fulltext_search:config
+
+The default stop words are:
+
+  a, an, and, are, as, at, be, but, by, for, if, in, into, is, it, no, not, of, on, or, such, that, the, their, then, there, these, they, this, to, was, will, with
+
+== Rake Tasks
+
+To rebuild indexes for all models:
+
+  $ rake db:mongo:rebuild_fulltext_search_indexes
+
+To rebuild indexes for one model:
+
+  $ rake db:mongo:rebuild_fulltext_search_indexes[Widget]
+
+NOTE: The indexes are maintained automatically via the +before_save+ and +before_destroy+ callbacks on models, however you MUST run this rake task any time your models change.
+
+== To Do
+
+* Filtered indexes
+* Shared indexes
+
+== Copyright
+
+Copyright (c) 2012 Christopher Fuller. See MIT-LICENSE[http://github.com/chrisfuller/mongodb_fulltext_search/blob/master/MIT-LICENSE] for details.

data/Rakefile

@@ -0,0 +1,26 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MongodbFulltextSearch'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/generators/mongodb_fulltext_search/config_generator.rb

@@ -0,0 +1,9 @@
+module MongodbFulltextSearch::Generators
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path('../templates', __FILE__)
+    desc 'Creates a MongodbFulltextSearch configuration file at config/fulltext_search.yml'
+    def create_config_file
+      template 'fulltext_search.yml', File.join('config', 'fulltext_search.yml')
+    end
+  end
+end

data/lib/generators/mongodb_fulltext_search/templates/fulltext_search.yml

@@ -0,0 +1 @@
+stop_words: a, an, and, are, as, at, be, but, by, for, if, in, into, is, it, no, not, of, on, or, such, that, the, their, then, there, these, they, this, to, was, will, with

data/lib/mongodb_fulltext_search.rb

@@ -0,0 +1,12 @@
+module MongodbFulltextSearch
+end
+
+require 'mongodb_fulltext_search/mongodb_fulltext_search'
+
+module MongodbFulltextSearch
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'tasks/mongodb_fulltext_search_tasks.rake'
+    end
+  end
+end

data/lib/mongodb_fulltext_search/helpers.rb

@@ -0,0 +1,51 @@
+module MongodbFulltextSearch::Helpers
+
+  def mongo_session(model)
+    if mongoid?
+      mongo_session = model.mongo_session
+    elsif mongomapper?
+      mongo_session = MongoMapper.database
+    end
+    mongo_session
+  end
+
+  def words_for(text)
+    words = []
+    if text.is_a? String
+      text.mb_chars.normalize(:kd).to_s.downcase.gsub(/[^a-z0-9\s]/, '').split(/\s/).each do |word|
+        words << word unless word.blank? or stop_words.include? word
+      end
+    end
+    words
+  end
+
+  def mongoid?
+    if @mongoid.nil?
+      @mongoid = Object.const_defined?('Mongoid')
+    end
+    @mongoid
+  end
+
+  def mongomapper?
+    if @mongomapper.nil?
+      @mongomapper = Object.const_defined?('MongoMapper')
+    end
+    @mongomapper
+  end
+
+  private
+
+  def stop_words
+    if @stop_words.nil?
+      file = "#{Rails.root}/config/fulltext_search.yml"
+      config = YAML.load(ERB.new(File.read(file)).result) if File.exists? file
+      if not config.nil? and config.include? 'stop_words'
+        @stop_words = config['stop_words'].gsub(/\s/, '').split ','
+      else
+        @stop_words = []
+      end
+    end
+    @stop_words
+  end
+
+end

data/lib/mongodb_fulltext_search/mixins.rb

@@ -0,0 +1,221 @@
+module MongodbFulltextSearch::Mixins
+
+  extend ActiveSupport::Concern
+
+  included do
+
+    cattr_accessor :fulltext_search_options
+
+    self.fulltext_search_options = {}
+
+    if MongodbFulltextSearch.mongoid?
+      (class << self; self; end).class_eval do
+        create_indexes = instance_method :create_indexes
+        define_method :create_indexes do
+          create_indexes.bind(self).call
+          fulltext_search_options.values.each do |options|
+            if options[:model].respond_to? :create_indexes
+              options[:model].send :create_indexes
+            end
+          end
+        end
+      end
+    end
+
+  end
+
+  module ClassMethods
+
+    def fulltext_search_in(*args)
+
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      if options.has_key? :index
+        collection_name = (options.delete :index).to_sym
+      else
+        count = fulltext_search_options.count
+        collection_name = "fulltext_search_index_#{collection.name}_#{count}".to_sym
+      end
+
+      if args.empty?
+        options[:attributes] = [:to_s]
+      else
+        options[:attributes] = args
+      end
+
+      if MongodbFulltextSearch.mongoid?
+        options[:model] = Class.new {
+          include Mongoid::Document
+          store_in collection: collection_name
+          index({
+            :source       => 1,
+            'counts.word' => 1
+          })
+          field :source , :type => String
+          field :counts , :type => Array
+        }
+      elsif MongodbFulltextSearch.mongomapper?
+        options[:model] = Class.new {
+          include MongoMapper::Document
+          set_collection_name collection_name
+          ensure_index([
+            [ :source       , 1 ],
+            [ 'counts.word' , 1 ]
+          ])
+          key :source , String
+          key :counts , Array
+        }
+      end
+
+      fulltext_search_options[collection_name] = options
+
+      attr_accessor :fulltext_search_score
+
+      before_save :update_in_fulltext_search_indexes
+
+      before_destroy :remove_from_fulltext_search_indexes
+
+    end
+
+    def fulltext_search(query, options = {})
+
+      options = {
+        :exact         => true,
+        :limit         => 20,
+        :offset        => 0,
+        :return_scores => false
+      }.merge options
+
+      results = []
+
+      if query.is_a? String
+
+        words = MongodbFulltextSearch.words_for query
+
+        unless words.empty?
+
+          queries = []; words.each do |word|
+            if !!options[:exact]
+              queries << { 'counts.word' => word }
+            else
+              queries << { 'counts.word' => { '$regex' => Regexp.escape(word) } }
+            end
+          end
+
+          limit = options[:limit].to_i
+
+          pipeline = [
+            { '$match'   => { '$and' => queries } },
+            { '$unwind'  => '$counts' },
+            { '$match'   => { '$or' => queries } },
+            { '$sort'    => { 'source' => 1 } },
+            { '$group'   => {
+                '_id'    => { 'source' => 1 },
+                'score'  => { '$sum' => '$counts.count' }
+            } },
+            { '$sort'    => { 'score' => -1 } },
+            { '$limit'   => limit }
+          ]
+
+          skip = options[:offset].to_i * limit
+
+          pipeline << { '$skip' => skip } if skip > 0
+          pipeline << { '$project' => { 'score' => 1 } }
+
+          if options.has_key? :index
+            collection_name = options[:index]
+          else
+            if fulltext_search_options.count == 1
+              collection_name = fulltext_search_options.keys.first
+            else
+              raise ArgumentError, 'index not specified', caller
+            end
+          end
+
+          aggregate = MongodbFulltextSearch.mongo_session(self).command(
+            :aggregate => collection_name.to_s,
+            :pipeline  => pipeline
+          )
+
+          scores = {}; aggregate['result'].each do |result|
+            scores[result['_id']['source']] = result['score']
+          end
+
+          unless scores.empty?
+            if options[:return_scores]
+              results = scores
+            else
+              find(scores.keys).each do |result|
+                result.fulltext_search_score = scores[result._id.to_s]
+                results << result
+              end
+              results.sort_by! { |result| -result.fulltext_search_score }
+            end
+          end
+
+        end
+
+      end
+
+      results
+
+    end
+
+  end
+
+  private
+
+  def update_in_fulltext_search_indexes
+
+    fulltext_search_options.each do |collection_name, options|
+
+      if MongodbFulltextSearch.mongoid?
+        index = options[:model].find_or_initialize_by :source => _id.to_s
+      elsif MongodbFulltextSearch.mongomapper?
+        index = options[:model].find_or_initialize_by_source _id.to_s
+      end
+
+      index.counts = []
+
+      values = []; options[:attributes].each do |attribute|
+        if respond_to? attribute.to_sym
+          value_array = send(attribute.to_sym)
+          value_array = [value_array] if value_array.is_a? String
+          if value_array.is_a? Array
+            value_array.each do |value|
+              values << value if value.is_a? String
+            end
+          end
+        end
+      end
+
+      unless values.nil?
+        temp = {}; values.each do |value|
+          MongodbFulltextSearch.words_for(value).each do |word|
+            temp[word]  = 0 if temp[word].nil?
+            temp[word] += 1
+          end
+        end
+        temp.sort.each do |word, count|
+          index.counts << { :word => word, :count => count }
+        end
+      end
+
+      index.save
+
+    end
+
+  end
+
+  def remove_from_fulltext_search_indexes
+    fulltext_search_options.values.each do |options|
+      if MongodbFulltextSearch.mongoid?
+        index = options[:model].where :source => _id.to_s
+      elsif MongodbFulltextSearch.mongomapper?
+        index = options[:model].find_by_source _id.to_s
+      end
+      index.destroy unless index.nil?
+    end
+  end
+
+end

data/lib/mongodb_fulltext_search/mongodb_fulltext_search.rb

@@ -0,0 +1,12 @@
+require 'mongodb_fulltext_search/helpers'
+require 'mongodb_fulltext_search/mixins'
+
+module MongodbFulltextSearch
+  extend MongodbFulltextSearch::Helpers
+end
+
+if MongodbFulltextSearch.mongoid?
+  Mongoid.const_set :FullTextSearch, MongodbFulltextSearch::Mixins
+elsif MongodbFulltextSearch.mongomapper?
+  MongoMapper.const_set :FullTextSearch, MongodbFulltextSearch::Mixins
+end

data/lib/mongodb_fulltext_search/version.rb

@@ -0,0 +1,3 @@
+module MongodbFulltextSearch
+  VERSION = "0.0.14"
+end

data/lib/tasks/mongodb_fulltext_search_tasks.rake

@@ -0,0 +1,45 @@
+namespace :db do
+  namespace :mongo do
+    desc "Rebuild the fulltext search indexes"
+    task :rebuild_fulltext_search_indexes, [:model] => [:environment] do |t, args|
+      args.with_defaults(:model => false)
+      models = []; Dir[Rails.root.to_s + '/app/models/**/*.rb'].each do |path|
+        model_name = File.basename(path, '.rb').camelize
+        begin
+          model_class = model_name.constantize
+          if model_class.respond_to? :fulltext_search_options
+            models << model_name if model_class.send(:fulltext_search_options).is_a? Hash
+          end
+        rescue
+        end
+      end
+      error = false
+      if args.model
+        if models.include? args.model
+          models = [args.model]
+        else
+          models = []
+          puts "[Aborted] Unable to load model '#{args.model}'"
+          error = true
+        end
+      end
+      if models.empty?
+        unless error
+          puts "[Aborted] Unable to locate any models with fulltext search implemented"
+        end
+      else
+        models.each do |model_name|
+          puts "Recreating fulltext search index for model '#{model_name}' ..."
+          model_class = model_name.constantize
+          model_class.fulltext_search_options.keys.each do |collection_name|
+            MongodbFulltextSearch.mongo_session(model_class)[collection_name.to_s].drop
+          end
+          model_class.all.each do |model|
+            model.send :update_in_fulltext_search_indexes
+          end
+        end
+        puts "Operation completed"
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: mongodb_fulltext_search_er
+version: !ruby/object:Gem::Version
+  version: 0.0.14
+platform: ruby
+authors:
+- Ryan T Hosford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-18 00:00:00.000000000 Z
+dependencies: []
+description: Same as mongodb_fulltext_search, except excludes rails as a dependency
+email:
+- tad.hosford@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongodb_fulltext_search.rb
+- lib/mongodb_fulltext_search/version.rb
+- lib/mongodb_fulltext_search/mongodb_fulltext_search.rb
+- lib/mongodb_fulltext_search/helpers.rb
+- lib/mongodb_fulltext_search/mixins.rb
+- lib/generators/mongodb_fulltext_search/templates/fulltext_search.yml
+- lib/generators/mongodb_fulltext_search/config_generator.rb
+- lib/tasks/mongodb_fulltext_search_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/chrisfuller/mongodb_fulltext_search
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Same as mongodb_fulltext_search, except excludes rails as a dependency
+test_files: []