mongoid_fulltext 0.4.1 → 0.4.2

data/Gemfile

@@ -7,7 +7,6 @@ source "http://rubygems.org"
 # Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "mongoid", "~> 2.0.0"
-  gem 'database_cleaner', '~> 0.6.0'
   gem 'rspec', '~> 2.5.0' 
   gem "jeweler", "~> 1.5.2"
 end

data/README.md

@@ -261,6 +261,17 @@ method:
 The methods on the model level perform bulk removal operations and are therefore faster that 
 updating or removing records individually.
 
+Mongo Database Indexes
+----------------------
+
+Mongoid provides an indexing mechanism on its models triggered by the `create_indexes` method.
+Mongoid_fulltext will hook into that behavior and create appropriate database indexes on its
+collections. These indexes are required for an efficient full text search. 
+
+Creating database indexes is typically done with the `db:mongoid:create_indexes` task.
+
+    rake db:mongoid:create_indexes
+
 Running the specs
 -----------------
 

data/VERSION

@@ -1 +1 @@
-0.4.1
+0.4.2

data/lib/mongoid_fulltext.rb

@@ -1,3 +1,5 @@
+require 'mongoid_indexes'
+
 module Mongoid::FullTextSearch
   extend ActiveSupport::Concern
 
@@ -35,14 +37,18 @@ module Mongoid::FullTextSearch
       config[:alphabet] = Hash[config[:alphabet].split('').map{ |ch| [ch,ch] }]
       config[:word_separators] = Hash[config[:word_separators].split('').map{ |ch| [ch,ch] }]
       self.mongoid_fulltext_config[index_name] = config
-
-      ensure_indexes(index_name, config)
       
       before_save :update_ngram_index
       before_destroy :remove_from_ngram_index
     end
+    
+    def create_fulltext_indexes
+      self.mongoid_fulltext_config.each_pair do |index_name, fulltext_config|
+        fulltext_search_ensure_indexes(index_name, fulltext_config)
+      end
+    end
 
-    def ensure_indexes(index_name, config)
+    def fulltext_search_ensure_indexes(index_name, config)
       db = collection.db
       coll = db.collection(index_name)
 
@@ -62,7 +68,7 @@ module Mongoid::FullTextSearch
         next if !keys.member?('ngram')
         all_filter_keys |= keys.find_all{ |key| key.starts_with?('filter_values.') }
         if keys & correct_keys != correct_keys
-          fulltext_log "Droping #{name} [#{keys & correct_keys} <=> #{correct_keys}]"
+          Mongoid.logger.info "Droping #{name} [#{keys & correct_keys} <=> #{correct_keys}]"
           coll.drop_index(name)
         end
       end
@@ -71,17 +77,13 @@ module Mongoid::FullTextSearch
         filter_indexes = all_filter_keys.map { |key| [key, Mongo::ASCENDING] }.sort_by { |filter_index| filter_index[0] }
         index_definition = [['ngram', Mongo::ASCENDING], ['score', Mongo::DESCENDING]].concat(filter_indexes)        
       end
-
-      fulltext_log "Ensuring fts_index on #{coll.name}: #{index_definition}"
-      coll.ensure_index(index_definition, { :name => 'fts_index', :background => true })
-      fulltext_log "Ensuring document_id index on #{coll.name}"
-      coll.ensure_index([['document_id', Mongo::ASCENDING]], { :background => true }) # to make removes fast
+      
+      Mongoid.logger.info "Ensuring fts_index on #{coll.name}: #{index_definition}"
+      coll.ensure_index(index_definition, { :name => 'fts_index' })
+      Mongoid.logger.info "Ensuring document_id index on #{coll.name}"
+      coll.ensure_index([['document_id', Mongo::ASCENDING]]) # to make removes fast
     end
     
-    def fulltext_log(message)
-      Mongoid.logger.info("[mongoid_fulltext] #{message}") if Mongoid.logger
-    end
-
     def fulltext_search(query_string, options={})
       max_results = options.has_key?(:max_results) ? options.delete(:max_results) : 10
       return_scores = options.has_key?(:return_scores) ? options.delete(:return_scores) : false

data/lib/mongoid_indexes.rb

@@ -0,0 +1,12 @@
+# hook onto model index creation to create related FT indexes
+module Mongoid::Indexes::ClassMethods
+
+    alias_method :create_fulltext_indexes_hook, :create_indexes
+       
+    def create_indexes
+      create_fulltext_indexes if respond_to?(:create_fulltext_indexes)
+      create_fulltext_indexes_hook
+    end
+
+end
+

data/mongoid_fulltext.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{mongoid_fulltext}
-  s.version = "0.4.1"
+  s.version = "0.4.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Windsor"]
-  s.date = %q{2011-07-27}
+  s.date = %q{2011-07-28}
   s.description = %q{Full-text search for the Mongoid ORM, using n-grams extracted from text}
   s.email = %q{aaron.windsor@gmail.com}
   s.extra_rdoc_files = [
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/mongoid_fulltext.rb",
+    "lib/mongoid_indexes.rb",
     "mongoid_fulltext.gemspec",
     "spec/models/advanced_artwork.rb",
     "spec/models/basic_artwork.rb",
@@ -70,18 +71,15 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<mongoid>, ["~> 2.0.0"])
-      s.add_development_dependency(%q<database_cleaner>, ["~> 0.6.0"])
       s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
     else
       s.add_dependency(%q<mongoid>, ["~> 2.0.0"])
-      s.add_dependency(%q<database_cleaner>, ["~> 0.6.0"])
       s.add_dependency(%q<rspec>, ["~> 2.5.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
     end
   else
     s.add_dependency(%q<mongoid>, ["~> 2.0.0"])
-    s.add_dependency(%q<database_cleaner>, ["~> 0.6.0"])
     s.add_dependency(%q<rspec>, ["~> 2.5.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
   end

data/spec/mongoid/fulltext_spec.rb

@@ -16,6 +16,7 @@ module Mongoid
       end
 
     end
+    
     context "with default settings" do
       
       let!(:flower_myth) { BasicArtwork.create(:title => 'Flower Myth') }
@@ -125,6 +126,7 @@ module Mongoid
       end
 
     end
+    
     context "with an index name specified" do
       let!(:pablo_picasso)       { ExternalArtist.create(:full_name => 'Pablo Picasso') }
       let!(:portrait_of_picasso) { ExternalArtwork.create(:title => 'Portrait of Picasso') }
@@ -188,6 +190,7 @@ module Mongoid
       end
 
     end
+    
     context "with an index name specified" do
 
       let!(:andy_warhol)         { ExternalArtist.create(:full_name => 'Andy Warhol') }
@@ -202,6 +205,7 @@ module Mongoid
       end
       
     end
+    
     context "with an index name specified" do
 
       let!(:pop)                { ExternalArtwork.create(:title => 'Pop') }
@@ -237,6 +241,7 @@ module Mongoid
       end
 
     end
+    
     context "with an index name specified" do
 
       it "cleans up item from the index after they're destroyed" do
@@ -250,6 +255,7 @@ module Mongoid
       end
 
     end
+    
     context "with an index name specified and no fields provided to index" do
 
       let!(:big_bang) { ExternalArtworkNoFieldsSupplied.create(:title => 'Big Bang', :artist => 'David Poppie', :year => '2009') }
@@ -261,6 +267,7 @@ module Mongoid
       end
 
     end
+    
     context "with multiple indexes defined" do
       
       let!(:pop)                { MultiExternalArtwork.create(:title => 'Pop', :year => '1970', :artist => 'Joe Schmoe') }
@@ -282,6 +289,7 @@ module Mongoid
       end
 
     end
+    
     context "with multiple fields indexed and the same index used by multiple models" do
       
       let!(:andy_warhol)         { MultiFieldArtist.create(:full_name => 'Andy Warhol', :birth_year => '1928') }
@@ -338,6 +346,9 @@ module Mongoid
       # fields as well as the union of all the filter fields to allow for efficient lookups.
 
       it "creates a proper index for searching efficiently" do
+        [ FilteredArtwork, FilteredArtist, FilteredOther].each do |klass| 
+          klass.create_indexes
+        end
         index_collection = FilteredArtwork.collection.db.collection('mongoid_fulltext.artworks_and_artists')
         ngram_indexes = index_collection.index_information.find_all{ |name, definition| definition['key'].has_key?('ngram') }
         ngram_indexes.length.should == 1
@@ -431,7 +442,37 @@ module Mongoid
         
       end
 
+      context "mongoid indexes" do
+        it "can re-create dropped indexes" do
+          # there're no indexes by default as Mongoid.autocreate_indexes is set to false
+          # but mongo will automatically attempt to index _id in the background
+          Mongoid.master["mongoid_fulltext.index_basicartwork_0"].index_information.size.should <= 1
+          BasicArtwork.create_indexes
+          Mongoid.master["mongoid_fulltext.index_basicartwork_0"].index_information.should == 
+          { 
+            "_id_" => { 
+              "name" => "_id_", 
+              "ns" => "mongoid_fulltext_test.mongoid_fulltext.index_basicartwork_0", 
+              "key" => { "_id" => 1 }, 
+              "v" => 0
+            }, 
+            "fts_index" => { 
+              "name" => "fts_index", 
+              "ns" => "mongoid_fulltext_test.mongoid_fulltext.index_basicartwork_0", 
+              "key" => { "ngram" => 1, "score" => -1 }, 
+              "v" => 0
+            }, 
+            "document_id_1" => {
+              "name" => "document_id_1", 
+              "ns" => "mongoid_fulltext_test.mongoid_fulltext.index_basicartwork_0", 
+              "key" => { "document_id" => 1 }, 
+              "v"=>0 
+            }
+          }
+        end
+        
+      end
+
     end
-    
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require 'bundler/setup'
 require 'rspec'
 
 require 'mongoid'
-require 'database_cleaner'
 
 Mongoid.configure do |config|
   name = "mongoid_fulltext_test"
@@ -15,8 +14,11 @@ require File.expand_path("../../lib/mongoid_fulltext", __FILE__)
 Dir["#{File.dirname(__FILE__)}/models/**/*.rb"].each { |f| require f }
 
 Rspec.configure do |c|
-  c.before(:all)  { DatabaseCleaner.strategy = :truncation }
-  c.before(:each) { DatabaseCleaner.clean }
-  c.after(:all) { Mongoid.master.command({'repairDatabase' => 1}) }
+  c.before(:each) do
+    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+  end
+  c.after(:all) do 
+    Mongoid.master.command({'dropDatabase' => 1})
+  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_fulltext
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-27 00:00:00.000000000 -04:00
+date: 2011-07-28 00:00:00.000000000 -04:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &75050220 !ruby/object:Gem::Requirement
+  requirement: &86604030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,21 +22,10 @@ dependencies:
         version: 2.0.0
   type: :development
   prerelease: false
-  version_requirements: *75050220
-- !ruby/object:Gem::Dependency
-  name: database_cleaner
-  requirement: &75049790 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: *75049790
+  version_requirements: *86604030
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &75049460 !ruby/object:Gem::Requirement
+  requirement: &86603130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +33,10 @@ dependencies:
         version: 2.5.0
   type: :development
   prerelease: false
-  version_requirements: *75049460
+  version_requirements: *86603130
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &75049090 !ruby/object:Gem::Requirement
+  requirement: &86602120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,7 +44,7 @@ dependencies:
         version: 1.5.2
   type: :development
   prerelease: false
-  version_requirements: *75049090
+  version_requirements: *86602120
 description: Full-text search for the Mongoid ORM, using n-grams extracted from text
 email: aaron.windsor@gmail.com
 executables: []
@@ -72,6 +61,7 @@ files:
 - Rakefile
 - VERSION
 - lib/mongoid_fulltext.rb
+- lib/mongoid_indexes.rb
 - mongoid_fulltext.gemspec
 - spec/models/advanced_artwork.rb
 - spec/models/basic_artwork.rb
@@ -104,7 +94,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 871827713
+      hash: 229668173
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: