mongoid-searchable 0.1.2 → 0.1.3

data/lib/mongoid/searchable/version.rb

@@ -1,5 +1,5 @@
 module Mongoid
   module Searchable
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

data/lib/mongoid/searchable.rb

@@ -12,6 +12,27 @@ module Mongoid
 
     module ClassMethods
 
+      # Defines the environment for searching this document,
+      # typically called from within your model declaration.
+      #
+      # fields - Array, mix of references to the fields
+      #  you would like to index and any *options*.
+      #
+      # options - Hash, list of options for keyword indexing:
+      #
+      #   :as - String, field to store keywords in.
+      #   :index - Boolean, turn indexing on or off.
+      #
+      # Example:
+      #
+      # class Person
+      #   include Mongoid::Document
+      #   include Mongoid::Searchable
+      #   field :name
+      #   searchable :name
+      # end
+      #
+      # Returns nothing.
       def searchable(*fields)
         options = { :as => :keywords, :index => true }.merge(fields.extract_options!)
 
@@ -25,13 +46,26 @@ module Mongoid
 
       end
 
+      # Search for documents matching your query, given the previously
+      # defined keyword fields.
+      #
+      # query - Integer, String, Array, Hash representing the query
+      #  you wish to perform. This will be reduced to a string, sanitized
+      #  and then split into keywords used for matching.
+      #
+      # options - Hash, containing options used for the query:
+      #
+      #   :match - Symbol, :all or :any, how to match results.
+      #   :exact - Boolean, require exact word match (or not).
+      #
+      # Returns Mongoid::Criteria.
       def search(query, options={})
         keywords = clean_keywords(query)
         options[:match] ||= :all
         options[:exact] ||= false
 
         if options[:exact]
-          match = keywords.collect{|k| /^#{Regexp.escape(k)}$/ }
+          match = keywords
         else
           match = keywords.collect{|k| /#{Regexp.escape(k)}/ }
         end
@@ -51,6 +85,12 @@ module Mongoid
         end
       end
 
+      # Takes a String, Numeric, Array or Hash and reduces it to a
+      # sanitized array of keywords, recursively if necessary.
+      #
+      # value - String, Numeric, Array or Hash of data to sanitize.
+      #
+      # Returns Array.
       def clean_keywords(value)
         words = []
 
@@ -73,6 +113,11 @@ module Mongoid
 
     module InstanceMethods
 
+      # Builds a list of keywords contained in the document given the
+      # keyword fields previously declared and stores them in the
+      # keywords field
+      #
+      # Returns nothing.
       def build_keywords
         keywords = []
         self.class.searchable_fields.each do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid-searchable
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-08 00:00:00.000000000Z
+date: 2011-09-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongoid
-  requirement: &70163756265060 !ruby/object:Gem::Requirement
+  requirement: &70275946078720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.1'
   type: :runtime
   prerelease: false
-  version_requirements: *70163756265060
+  version_requirements: *70275946078720
 - !ruby/object:Gem::Dependency
   name: bson_ext
-  requirement: &70163756258280 !ruby/object:Gem::Requirement
+  requirement: &70275946078200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70163756258280
+  version_requirements: *70275946078200
 - !ruby/object:Gem::Dependency
   name: growl
-  requirement: &70163756255180 !ruby/object:Gem::Requirement
+  requirement: &70275946077820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70163756255180
+  version_requirements: *70275946077820
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70163756224580 !ruby/object:Gem::Requirement
+  requirement: &70275946077220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70163756224580
+  version_requirements: *70275946077220
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70163756210720 !ruby/object:Gem::Requirement
+  requirement: &70275946076700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70163756210720
+  version_requirements: *70275946076700
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70163756162720 !ruby/object:Gem::Requirement
+  requirement: &70275946076220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: 0.4.3
   type: :development
   prerelease: false
-  version_requirements: *70163756162720
+  version_requirements: *70275946076220
 description: Mongoid Searchable allows you to easily perform full-text search your
   Mongoid models.
 email: