mongoid_fulltext 0.5.8 → 0.6.0

data/.travis.yml

@@ -0,0 +1,4 @@
+rvm:
+  - 1.9.3
+  - ruby-head
+

data/CHANGELOG.md

@@ -0,0 +1,133 @@
+0.6.0 (Next Release)
+--------------------
+
+* [#2](https://github.com/artsy/mongoid_fulltext/pull/2): Upgrade to Mongoid 3.0 - [@volmer](https://github.com/volmer).
+* [#1](https://github.com/artsy/mongoid_fulltext/pull/1): Fix: downcase destroys non-latin strings - [@netoneko](https://github.com/netoneko).
+
+0.5.8 (3/8/2012)
+----------------
+
+* Fix: do not CGI.unescape inside fulltext search - [@dblock](https://github.com/dblock).
+* Refactored array filter API, allowing for overriding filter query method - [@ethul](https://github.com/ethul).
+* Fix: check for the existence of the Mongoid.logger before calling it in case it was configured to false - [@AaronH](https://github.com/AaronH).
+* Added install instructions to Readme - [@Nerian](https://github.com/Nerian).
+
+0.5.7 (1/11/2012)
+-----------------
+
+* Added `reindex_immediately` option to suppress automatic reindexing - [@joeyAghion](https://github.com/joeyAghion).
+* Fix: treatment of word separators, adding newlines, tabs and dashes into the set of default word separators - [@aaw](https://github.com/aaw).
+
+0.5.4 (11/8/2011)
+-----------------
+
+* Made full word and prefix bumps inversely proportional to the length of the string - [@aaw](https://github.com/aaw).
+
+0.5.3 (11/8/2011)
+-----------------
+
+* Added an option to index short prefixes of words - [@aaw](https://github.com/aaw).
+
+0.5.2 (11/5/2011)
+-----------------
+
+* Added the ability to index full words that are less than the ngram length and not stop words - [@aaw](https://github.com/aaw).
+
+0.5.1 (11/2/2011)
+-----------------
+
+* Reducing the score for a full-word match (these used to be counted multiple times for multiple occurrences) and adding a list of stopwords to the config. Stopwords aren't given a score boost when matched as full words - [@aaw](https://github.com/aaw).
+* Added UTF8 downcasing - [@zepplock](https://github.com/zepplock).
+
+0.5.0 (10/11/2011)
+-----------------
+
+* Fix: inconsistet scoring words with the same length as the ngram length - [@aaw](https://github.com/aaw).
+
+0.4.5 (10/5/2011)
+-----------------
+
+* Added `update_if` config option to control when index updates occur - [@nickhoffman](https://github.com/nickhoffman).
+
+0.4.4 (8/31/2011)
+-----------------
+
+* Added `remove_accents` - [@tdp2110](https://github.com/tdp2110).
+
+0.4.3 (8/3/2011)
+----------------
+
+* Fix: including `Mongoid::FulltextSearch` and not using it causes created_indexes to fail - [@dblock](https://github.com/dblock).
+
+0.4.2 (6/28/2011)
+-----------------
+
+* Delay-creating indexes in sync with how Mongoid creates indexes on normal collections - [@dblock](https://github.com/dblock).
+
+0.4.1 (6/27/2011)
+-----------------
+
+* Using `Mongoid.logger` for logging - [@dblock](https://github.com/dblock).
+*	Changed `ensure_index` to index in the background, avoid blocking booting app - [@dblock](https://github.com/dblock).
+
+0.4.0 (6/19/2011)
+-----------------
+
+* Removing all use of map-reduce - [@aaw](https://github.com/aaw).
+* Support class name with module for example (Module::ClassConstantName) - [@steverandy](https://github.com/steverandy).
+
+0.3.7 (6/7/2011)
+----------------
+
+*	Added support for updating model indexes in bulk - [@dblock](https://github.com/dblock).
+
+0.3.6 (5/27/2011)
+-----------------
+
+* Skipping words that are shorter than the n-gram - [@dblock](https://github.com/dblock).
+* Added `index_full_words` - [@dblock](https://github.com/dblock).
+*	Keeping max score of ngram in the ngram hash - [@dblock](https://github.com/dblock).
+
+0.3.5 (5/25/2011)
+-----------------
+
+* Added index on document_id for faster remove - [@dblock](https://github.com/dblock).
+* Addeda way to return scored results - [@dblock](https://github.com/dblock).
+
+0.3.4 (5/16/2011)
+-----------------
+
+* Added support for array filters - [@dblock](https://github.com/dblock).
+* Added support for Ruby 1.8.7 - [@dbussink](https://github.com/dbussink).
+
+0.3.2 (4/19/2011)
+-----------------
+
+Exposing `update_ngram_index` and `remove_from_ngram_index` for fast bulk-updating the index - [@aaw](https://github.com/aaw).
+
+0.3.1 (4/14/2011)
+-----------------
+
+* Support for mongo versions >= 1.7.4 - [@aaw](https://github.com/aaw).
+
+0.3.0 (4/13/2011)
+-----------------
+
+* Adding the ability to define filters on an index - [@aaw](https://github.com/aaw).
+
+0.2.0 (4/13/2011)
+-----------------
+
+* Multiple indexes per model, removing internal indexes entirely - [@aaw](https://github.com/aaw).
+
+0.1.1 (4/11/2011)
+-----------------
+
+* Keep garbage in the index from blowing up `fulltext_search` - [@aaw](https://github.com/aaw).
+* Indexing the results of `to_s` if no fields are provided - [@aaw](https://github.com/aaw).
+* Adding a `before_destroy` callback for external indexes - [@aaw](https://github.com/aaw).
+
+0.1.0 (4/7/2011)
+----------------
+
+* Initial public release - [@aaw](https://github.com/aaw).

data/Gemfile

@@ -1,12 +1,10 @@
 source "http://rubygems.org"
 
+gem "mongoid", "~> 3.0.1"
 gem "unicode_utils", "~> 1.0.0"
 
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "mongoid", "~> 2.0.0"
-  gem "bson_ext", "~> 1.5.2"
-  gem "rspec", "~> 2.5.0" 
-  gem "jeweler", "~> 1.5.2"
+group :development, :test do
+  gem "bundler"
+  gem "rspec", "~> 2.10.0"
+  gem "jeweler", "~> 1.8.3"
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 by Artsy, Inc.
+Copyright (c) 2011-2012 by Artsy, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +16,4 @@ 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.
+THE SOFTWARE.

data/README.md

@@ -1,4 +1,4 @@
-Mongoid Fulltext Search
+Mongoid Fulltext Search [![Build Status](https://secure.travis-ci.org/artsy/mongoid_fulltext.png)](http://travis-ci.org/artsy/mongoid_fulltext)
 =======================
 
 Full-text search using n-gram matching for the Mongoid ODM. Tested on MongoDB 1.6 and above, but
@@ -7,61 +7,78 @@ probably works on earlier versions as well.
 MongoDB currently has no native full-text search capabilities, so this gem is a good fit for cases
 where you want something a little less than a full-blown indexing service like Solr. mongoid_fulltext
 lets you do a fuzzy string search across relatively short strings, which makes it good for populating
-autocomplete boxes based on the display names of your Rails models but not appropriate for, say, 
+autocomplete boxes based on the display names of your Rails models but not appropriate for, say,
 indexing hundreds of thousands of HTML documents.
 
 Install
 --------------
 
-    gem 'mongoid_fulltext'
+Version 0.6.0 or newer of this gem requires Ruby 1.9.3 and Mongoid 3.0. 
+Use version 0.5.x for Mongoid 2.4.x and Ruby 1.8.7, 1.9.2 or 1.9.3.
+
+For Ruby 1.8.7 and/or Mongoid 2.x use [mongoid_fulltext 0.5.x](https://github.com/artsy/mongoid_fulltext/tree/0.5-stable).
+
+``` ruby
+gem 'mongoid_fulltext'
+```
 
 Some examples:
 --------------
-    
+
 Suppose you have an `Artist` model and want to index each artist's name:
 
-    class Artist
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artist
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :first_name
-      field :last_name
+  field :first_name
+  field :last_name
 
-      def name
-        [first_name, last_name].join(' ')
-      end
+  def name
+    [first_name, last_name].join(' ')
+  end
 
-      fulltext_search_in :name
-    end
+  fulltext_search_in :name
+end
+```
 
 The `fulltext_search_in` directive will index the full name of the artist, so now
 you can call:
 
-    Artist.fulltext_search("vince vangogh")
+``` ruby
+Artist.fulltext_search("vince vangogh")
+```
 
 which will return an array of the Artist instances that best match the search string. Most likely,
 Vincent van Gogh will be included in the results. You can index multiple fields with the same
 index, so we can get the same effect of our Artist index above using:
 
-    class Artist
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artist
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :first_name
-      field :last_name
+  field :first_name
+  field :last_name
 
-      fulltext_search_in :first_name, :last_name
-    end
+  fulltext_search_in :first_name, :last_name
+end
+```
 
 To restrict the number of results returned, pass the `:max_results` parameter to `fulltext_search`:
 
-    Artist.fulltext_search("vince vangogh", { :max_results => 5 })
+``` ruby
+Artist.fulltext_search("vince vangogh", { :max_results => 5 })
+```
 
 To return a pair of `[ result, score ]` instead of an array of results, pass the `:return_scores` parameter to `fulltext_search`:
 
-    Artist.fulltext_search("vince vangogh", { :return_scores => true })
+``` ruby
+Artist.fulltext_search("vince vangogh", { :return_scores => true })
+```
 
-The larger a score is, the better mongoid_fulltext thinks the match is. The scores have the following rough 
+The larger a score is, the better mongoid_fulltext thinks the match is. The scores have the following rough
 interpretation that you can use to make decisions about whether the match is good enough:
 
 * If a prefix of your query matches something indexed, or if your query matches a prefix of something
@@ -74,86 +91,98 @@ interpretation that you can use to make decisions about whether the match is goo
 If you don't specify a field to index, the default is the result of `to_s` called on the object.
 The following definition will index the first and last name of an artist:
 
-    class Artist
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artist
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :first_name
-      field :last_name
+  field :first_name
+  field :last_name
 
-      def to_s
-        '%s %s' % [first_name, last_name]
-      end
+  def to_s
+    '%s %s' % [first_name, last_name]
+  end
 
-      fulltext_search_in
-    end 
+  fulltext_search_in
+end
+```
 
 The full-text index is stored in a separate MongoDB collection in the same database as the
 models you're indexing. By default, the name of this collection is generated for you. Above,
 a collection named something like `mongoid_fulltext.index_artist_0` will be created to
-hold the index data. You can override this naming and provide your own collection name with 
+hold the index data. You can override this naming and provide your own collection name with
 the :index_name parameter:
 
-    class Artwork
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artwork
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :title
-      fulltext_search_in :title, :index_name => 'mongoid_fulltext.foobar'
-    end
+  field :title
+  fulltext_search_in :title, :index_name => 'mongoid_fulltext.foobar'
+end
+```
 
 You can also create multiple indexes on a single model, in which case you'll want to
 provide index names:
 
-    class Artwork
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artwork
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :title
-      field :artist_name
-      field :gallery_name
-      filed :gallery_address
+  field :title
+  field :artist_name
+  field :gallery_name
+  filed :gallery_address
 
-      fulltext_search_in :title, :index_name => 'title_index'
-      fulltext_search_in :artist_name, :index_name => 'artist_name_index'
-      fulltext_search_in :gallery_name, :gallery_address, :index_name => 'gallery_index'
-    end
+  fulltext_search_in :title, :index_name => 'title_index'
+  fulltext_search_in :artist_name, :index_name => 'artist_name_index'
+  fulltext_search_in :gallery_name, :gallery_address, :index_name => 'gallery_index'
+end
+```
 
 The index names are helpful now because you'll have to specify which one you want to use when you
 call `fulltext_search`:
 
-    Artwork.fulltext_search('warhol', :index => 'artist_name_index')
+``` ruby
+Artwork.fulltext_search('warhol', :index => 'artist_name_index')
+```
 
 If you have multiple indexes specified and you don't supply a name to `fulltext_search`, the
 method call will raise an exception.
 
 If you're indexing multiple models, you may find that you need to combine results to create
 a single result set. For example, if both the `Artist` model and the `Artwork` model are
-indexed for full-text search, then to get results from both, you'd have to call 
+indexed for full-text search, then to get results from both, you'd have to call
 `Artist.fulltext_search` and `Artwork.fulltext_search` and combine the results yourself. If
 your intention is instead to get the top k results from both Artists and Artworks, you can
 merge both into a single index by using the same `:external_index` parameter:
 
-    class Artwork
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artwork
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :title
-      fulltext_search_in :title, :index_name => 'artwork_and_artists'
-    end
+  field :title
+  fulltext_search_in :title, :index_name => 'artwork_and_artists'
+end
 
-    class Artist
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+class Artist
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :name
-      fulltext_search_in :name, :index_name => 'artwork_and_artists'
-    end
+  field :name
+  fulltext_search_in :name, :index_name => 'artwork_and_artists'
+end
+```
 
 Now that these two models share the same external index collection, we can search them both through
 either model's `fulltext_search` method:
 
-    Artwork.fulltext_search('picasso')  # returns same results as Artist.fulltext_search('picasso')
+``` ruby
+Artwork.fulltext_search('picasso')  # returns same results as Artist.fulltext_search('picasso')
+```
 
 If you want to filter the results from full-text search, you set up filters when the indexes are
 defined. For example, suppose that in addition to wanting to use the `artwork_and_artists` index
@@ -162,59 +191,63 @@ for artists only and for artworks priced above $10,000. Instead of creating two
 attempting to filter the results after the query is run, we can specify the filter predicates
 at the time of index definition:
 
-    class Artwork
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
-
-      field :title
-      field :price
-      fulltext_search_in :title, :index_name => 'artwork_and_artists',
-                         :filters => { :is_expensive => lambda { |x| x.price > 10000 },
-                                       :has_long_name => lambda { |x| x.title.length > 20 }}
-    end
-
-    class Artist
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
-
-      field :name
-      field :birth_year
-      fulltext_search_in :name, :index_name => 'artwork_and_artists',
-                         :filters => { :born_before_1900 => lambda { |x| x.birth_year < 1900 },
-                                       :has_long_name => lambda { |x| x.name.length > 20}}
-    end
+``` ruby
+class Artwork
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
+
+  field :title
+  field :price
+  fulltext_search_in :title, :index_name => 'artwork_and_artists',
+                     :filters => { :is_expensive => lambda { |x| x.price > 10000 },
+                                   :has_long_name => lambda { |x| x.title.length > 20 }}
+end
+
+class Artist
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
+
+  field :name
+  field :birth_year
+  fulltext_search_in :name, :index_name => 'artwork_and_artists',
+                     :filters => { :born_before_1900 => lambda { |x| x.birth_year < 1900 },
+                                   :has_long_name => lambda { |x| x.name.length > 20}}
+end
+```
 
 After defining filters, you can query for results that match particular values of filters:
 
-    # Only return artists born before 1900 that match 'foobar'
-    Artist.fulltext_search('foobar', :born_before_1900 => true)
+``` ruby
+# Only return artists born before 1900 that match 'foobar'
+Artist.fulltext_search('foobar', :born_before_1900 => true)
 
-    # Return artists or artworks that match 'foobar' and have short names
-    Artist.fulltext_search('foobar', :has_long_name => false)
+# Return artists or artworks that match 'foobar' and have short names
+Artist.fulltext_search('foobar', :has_long_name => false)
 
-    # Only return artworks with prices over 10000 that match 'mona lisa'
-    Artwork.fulltext_search('mona lisa', :is_expensive => true)
+# Only return artworks with prices over 10000 that match 'mona lisa'
+Artwork.fulltext_search('mona lisa', :is_expensive => true)
 
-    # Only return artworks with prices less than 10000 that match 'mona lisa'
-    Artwork.fulltext_search('mona lisa', :is_expensive => false)
+# Only return artworks with prices less than 10000 that match 'mona lisa'
+Artwork.fulltext_search('mona lisa', :is_expensive => false)
+```
 
-Note that in all of the example queries above, supplying a filter that is defined on exactly 
+Note that in all of the example queries above, supplying a filter that is defined on exactly
 one of the models will restrict the search to results from that model only. For example,
 since `:is_expensive` is defined only on `Artwork`s, a call to `fulltext_search` with either
 `:is_expensive => true` or `:is_expensive => false` will return only `Artwork` results.
 
-You can specify multiple filters per index and per model. Each filter is a predicate that will 
-be called on objects as they're inserted into the full-text index (any time the model is saved.) 
-Filters are only called on instances of models they're defined on, so in the example above, the 
-`is_expensive` filter is only applied to instances of `Artwork` and the `born_before_1900` filter 
-is only applied to instances of `Artist`, although both filters can be used when querying from 
-either model. The `has_long_name` filter, on the other hand, will return instances of both 
+You can specify multiple filters per index and per model. Each filter is a predicate that will
+be called on objects as they're inserted into the full-text index (any time the model is saved.)
+Filters are only called on instances of models they're defined on, so in the example above, the
+`is_expensive` filter is only applied to instances of `Artwork` and the `born_before_1900` filter
+is only applied to instances of `Artist`, although both filters can be used when querying from
+either model. The `has_long_name` filter, on the other hand, will return instances of both
 `Artwork` and `Artist` since it's defined on each model.
 
 Filters shouldn't ever throw, but if they do, the filter is just ignored. If you apply filters to
 indexes that are on multiple fields, the filter is applied to each field and the filter result is
-the AND of all of the individual results for each of the fields. Finally, if a filter is defined 
-but criteria for that filter aren't passed to `fulltext_search`, the result is as if the filter 
+the AND of all of the individual results for each of the fields. Finally, if a filter is defined
+but criteria for that filter aren't passed to `fulltext_search`, the result is as if the filter
 had never been defined - you see both models that both pass and fail the filter in the results.
 
 Indexing Options
@@ -236,7 +269,7 @@ Additional indexing/query options can be used as parameters to `fulltext_search_
   Defaults to 1000. If you're seeing poor results, you can try increasing this value to consider
   more ngrams per query (changing this parameter does not require a re-index.) The amount of time
   a search takes is directly proportional to this parameter's value.
-* `remove_accents`: remove accents on accented characters, default is `true`. 
+* `remove_accents`: remove accents on accented characters, default is `true`.
   We strip the accents using [NFKD normalization](http://unicode-utils.rubyforge.org/UnicodeUtils.html#method-c-compatibility_decomposition)
   using an external library, `unicode_utils`.
 * `update_if`: controls whether or not the index will be updated. This can be set to a symbol,
@@ -247,46 +280,54 @@ Additional indexing/query options can be used as parameters to `fulltext_search_
     * When set to any other type of object, the document's index will not be updated.
 * `reindex_immediately`: whether models will be reindexed automatically upon saves or updates. Defaults to true. When set to false, the class-level `update_ngram_index` method can be called to perform reindexing.
 
+If you work with Cyrillic texts, use this option: `:alphabet = 'abcdefghijklmnopqrstuvwxyz0123456789абвгдежзиклмнопрстуфхцчшщъыьэюя'`.
+
 Array filters
 -------------
 
 A filter may also return an Array. Consider the following example.
 
-    class Artist
-      include Mongoid::Document
-      include Mongoid::FullTextSearch
+``` ruby
+class Artist
+  include Mongoid::Document
+  include Mongoid::FullTextSearch
 
-      field :name
-      field :exhibitions, as: Array, default: []
+  field :name
+  field :exhibitions, as: Array, default: []
 
-      fulltext_search_in :name, :index_name => 'exhibited_artist',
-        :filters => { 
-          :exhibitions => lambda { |artist| artist.exhibitions }
-        }
-    end
+  fulltext_search_in :name, :index_name => 'exhibited_artist',
+    :filters => {
+      :exhibitions => lambda { |artist| artist.exhibitions }
+    }
+end
+```
 
 You can now find all artists that are at the Art Basel exhibition or all artists that have exhibited
 at both the Art Basel and the New York Armory exhibition.
 
-    # All artists
-    Artist.fulltext_search('foobar')
+``` ruby
+# All artists
+Artist.fulltext_search('foobar')
 
-    # Artists at the Art Basel exhibition only
-    Artist.fulltext_search('foobar', :exhibitions => [ "Art Basel" ])
+# Artists at the Art Basel exhibition only
+Artist.fulltext_search('foobar', :exhibitions => [ "Art Basel" ])
 
-    # Artists at both the Art Basel and the New York Armory exhibition
-    Artist.fulltext_search('foobar', :exhibitions => [ "Art Basel", "New York Armory" ])
+# Artists at both the Art Basel and the New York Armory exhibition
+Artist.fulltext_search('foobar', :exhibitions => [ "Art Basel", "New York Armory" ])
 
-    # Note that the following explicit syntax may be used to achieve the
-    # same result as above
-    Artist.fulltext_search('foobar', :exhibitions => {:all => [ "Art Basel", "New York Armory" ]})
+# Note that the following explicit syntax may be used to achieve the
+# same result as above
+Artist.fulltext_search('foobar', :exhibitions => {:all => [ "Art Basel", "New York Armory" ]})
+```
 
 If you want to find all artists that are at either the Art Basel or the
 New York Armory exhibition, then you may specify the `:any` operator in
 the filter.
 
-    # Artists at either the Art Basel or the New York Armory exhibition
-    Artist.fulltext_search('foobar', :exhibitions => {:any => [ "Art Basel", "New York Armory" ]})
+``` ruby
+# Artists at either the Art Basel or the New York Armory exhibition
+Artist.fulltext_search('foobar', :exhibitions => {:any => [ "Art Basel", "New York Armory" ]})
+```
 
 Note that `:all` and `:any` are currently the only supported operators
 for the array filters.
@@ -294,47 +335,67 @@ for the array filters.
 Building the index
 ------------------
 
-The fulltext index is built and maintained incrementally by hooking into `before_save` and 
+The fulltext index is built and maintained incrementally by hooking into `before_save` and
 `before_destroy` callbacks on each model that's being indexed. If you want to build an index
 on existing models, you can call the `update_ngram_index` method on the class or each instance:
 
-    Artwork.update_ngram_index
-    Artwork.find(id).update_ngram_index
+``` ruby
+Artwork.update_ngram_index
+Artwork.find(id).update_ngram_index
+```
 
 You can remove all or individual instances from the index with the `remove_from_ngram_index`
 method:
 
-    Artwork.remove_from_ngram_index
-    Artwork.find(id).remove_from_ngram_index
+``` ruby
+Artwork.remove_from_ngram_index
+Artwork.find(id).remove_from_ngram_index
+```
 
-The methods on the model level perform bulk removal operations and are therefore faster that 
+The methods on the model level perform bulk removal operations and are therefore faster that
 updating or removing records individually.
 
 If you need to control when the index is updated, provide the `update_if` option to
 `fulltext_search_in`, and set it to a symbol, string, or proc. Eg:
 
-    # Only update the "age" index if the "age" field has changed.
-    fulltext_search_in :age,    :update_if => :age_changed?
+``` ruby
+# Only update the "age" index if the "age" field has changed.
+fulltext_search_in :age,    :update_if => :age_changed?
 
-    # Only update the "names" index if the "firstname" or "lastname" field has changed.
-    fulltext_search_in :names,  :update_if => "firstname_changed? || lastname_changed?"
+# Only update the "names" index if the "firstname" or "lastname" field has changed.
+fulltext_search_in :names,  :update_if => "firstname_changed? || lastname_changed?"
 
-    # Only update the "email" index if the "email" field ends with "gmail.com".
-    fulltext_search_in :email,  :update_if => Proc.new { |doc| doc.email.match /gmail.com\Z/ }
+# Only update the "email" index if the "email" field ends with "gmail.com".
+fulltext_search_in :email,  :update_if => Proc.new { |doc| doc.email.match /gmail.com\Z/ }
+```
 
 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. 
+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
+``` bash
+rake db:mongoid:create_indexes
+```
 
 Running the specs
 -----------------
 
 To run the specs, execute `rake spec`. You need a local MongoDB instance to run the specs.
 
+Contributing
+------------
+
+Fork the project. Make your feature addition or bug fix with tests. Send a pull request. Bonus points for topic branches.
+
+Copyright and License
+---------------------
+
+MIT License, see [LICENSE](https://github.com/aaw/mongoid_fulltext/blob/master/LICENSE) for details.
+
+(c) 2011-2012 [Art.sy Inc.](http://artsy.github.com)
+