hunt 0.1 → 0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hunt (0.1)
+    hunt (0.2)
       fast-stemmer (~> 1.0)
       mongo_mapper (~> 0.8.6)
 

data/examples/multiple.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'pp'
+require 'hunt'
+
+MongoMapper.database = 'testing'
+
+class Note
+  include MongoMapper::Document
+  plugin Hunt
+
+  key :title, String
+  key :tags,  Array
+
+  # Declare which fields to search on.
+  # No problem declaring an array key.
+  searches :title, :tags
+end
+Note.delete_all # clean the slate
+
+# Note that the search terms are stored in a searches hash in the key default.
+# This is so that future versions can allow different combinations of search
+# fields and use different keys in searches.
+
+# Also, meaningless words are stripped out and all words less than 3 characters
+# long. The words are then stemmed (http://en.wikipedia.org/wiki/Stemming) so
+# exact matches when searching are not necessary.
+
+pp Note.create(:title => 'I am lost without Mongo!', :tags => %w(mongo database nosql))
+#<Note searches: {"default"=>["test", "mongo", "databas", "nosql"]}, title: "This is a test", _id: BSON::ObjectId('...'), tags: ["mongo", "database", "nosql"]>
+
+pp Note.create(:title => 'Lost is a tv show', :tags => %w(lost tv))
+#<Note searches: {"default"=>["lost", "tv", "show"]}, title: "Lost is a tv show", _id: BSON::ObjectId('...'), tags: ["lost", "tv"]>
+
+pp Note.search('lost').count      # 2
+pp Note.search('tv').count        # 1
+
+# Multiple words work
+pp Note.search('mongo tv').count  # 2

data/examples/single.rb

@@ -0,0 +1,41 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'pp'
+require 'hunt'
+
+MongoMapper.database = 'testing'
+
+class Note
+  include MongoMapper::Document
+  plugin Hunt
+
+  key :title, String
+
+  # Declare which fields to search on.
+  searches :title
+end
+Note.delete_all # clean the slate
+
+# Note that the search terms are stored in a searches hash in the key default.
+# This is so that future versions can allow different combinations of search
+# fields and use different keys in searches.
+#
+# Also, meaningless words are stripped out and all words less than 3 characters
+# long. The words are then stemmed (http://en.wikipedia.org/wiki/Stemming) so
+# exact matches when searching are not necessary.
+
+note = Note.create(:title => 'This is a test')
+pp note
+# #<Note searches: {"default"=>["test"]}, title: "This is a test", _id: BSON::ObjectId('...')>
+
+note.update_attributes(:title => 'A different test')
+pp note
+# #<Note searches: {"default"=>["differ", "test"]}, title: "A different test", _id: BSON::ObjectId('...')>
+
+# Also, you get a handy
+pp Note.search('test').count    # 1
+pp Note.search('testing').count # 1
+pp Note.search('testing').all
+# [#<Note searches: {"default"=>["differ", "test"]}, title: "A different test", _id: BSON::ObjectId('...')>]
+
+pp Note.search('test').paginate(:page => 1)
+# [#<Note searches: {"default"=>["differ", "test"]}, title: "A different test", _id: BSON::ObjectId('...')>]

data/lib/hunt.rb

@@ -1,4 +1,5 @@
 require 'fast_stemmer'
+require 'mongo_mapper'
 require 'hunt/util'
 
 module Hunt

data/lib/hunt/util.rb

@@ -4,22 +4,22 @@ module Hunt
     StripPunctuationRegex = /[^a-zA-Z0-9]/
     PunctuationReplacement = ''
     WordsToIgnore = [
-      "about", "above", "after", "again", "against", "all",
-      "and", "any", "are", "aren't", "because", "been",
-      "before", "being", "below", "between", "both", "but", "cannot",
-      "can't", "could", "couldn't", "did", "didn't", "does", "doesn't",
+      "a", "about", "above", "after", "again", "against", "all", "am", "an",
+      "and", "any", "are", "aren't", "as", "at", "be", "because", "been",
+      "before", "being", "below", "between", "both", "but", "by", "cannot",
+      "can't", "could", "couldn't", "did", "didn't", "do", "does", "doesn't",
       "doing", "don't", "down", "during", "each", "few", "for", "from",
       "further", "had", "hadn't", "has", "hasn't", "have", "haven't", "having",
-      "he'd", "he'll", "her", "here", "here's", "hers", "herself", "he's",
-      "him", "himself", "his", "how", "how's", "i'd", "if", "i'll", "i'm",
-      "into", "isn't", "its", "it's", "itself", "i've", "let's",
-      "more", "most", "mustn't", "myself", "nor", "not",
-      "off", "once", "only", "other", "ought", "our", "ours", "ourselves",
+      "he", "he'd", "he'll", "her", "here", "here's", "hers", "herself", "he's",
+      "him", "himself", "his", "how", "how's", "i", "i'd", "if", "i'll", "i'm",
+      "in", "into", "is", "isn't", "it", "its", "it's", "itself", "i've", "let's",
+      "me", "more", "most", "mustn't", "my", "myself", "no", "nor", "not", "of",
+      "off", "on", "once", "only", "or", "other", "ought", "our", "ours", "ourselves",
       "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's",
-      "should", "shouldn't", "some", "such", "than", "that", "that's", "the",
+      "should", "shouldn't", "so", "some", "such", "than", "that", "that's", "the",
       "their", "theirs", "them", "themselves", "then", "there", "there's", "these",
       "they", "they'd", "they'll", "they're", "they've", "this", "those", "through",
-      "too", "under", "until", "up", "very", "was", "wasn't", "we'd",
+      "to", "too", "under", "until", "up", "very", "was", "wasn't", "we", "we'd",
       "we'll", "were", "we're", "weren't", "we've", "what", "what's", "when",
       "when's", "where", "where's",  "which", "while", "who", "whom", "who's",
       "why", "why's", "with", "won't", "would", "wouldn't", "you", "you'd",
@@ -41,7 +41,7 @@ module Hunt
         squeeze(Separator).
         split(Separator).
         map     { |word| word.downcase }.
-        reject  { |word| word.size < 3 }.
+        reject  { |word| word.size < 2 }.
         reject  { |word| WordsToIgnore.include?(word) }.
         map     { |word| strip_puncuation(word) }.
         reject  { |word| word.blank? }.

data/lib/hunt/version.rb

@@ -1,3 +1,3 @@
 module Hunt
-  VERSION = "0.1"
+  VERSION = "0.2"
 end

data/spec/hunt/util_spec.rb

@@ -40,8 +40,8 @@ describe Hunt::Util do
       Hunt::Util.to_words('Sweet First Sentence').should == %w(sweet first sentence)
     end
 
-    it "removes any words under 3 characters" do
-      Hunt::Util.to_words('my first sentence').should == %w(first sentence)
+    it "removes any words under 2 characters" do
+      Hunt::Util.to_words('a tv show').should == %w(tv show)
     end
 
     it "removes words that should be ignored" do

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: hunt
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 1
-  version: "0.1"
+  - 2
+  version: "0.2"
 platform: ruby
 authors: 
 - John Nunemaker
@@ -79,6 +79,8 @@ files:
 - LICENSE
 - README.rdoc
 - Rakefile
+- examples/multiple.rb
+- examples/single.rb
 - hunt.gemspec
 - lib/hunt.rb
 - lib/hunt/util.rb