hunt 0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+gem 'bson_ext', '1.1.5', :require => false
+
+gemspec
+
+gem 'i18n'

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    hunt (0.1)
+      fast-stemmer (~> 1.0)
+      mongo_mapper (~> 0.8.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.0.3)
+    bson (1.1.5)
+    bson_ext (1.1.5)
+    diff-lcs (1.1.2)
+    fast-stemmer (1.0.0)
+    i18n (0.4.2)
+    jnunemaker-validatable (1.8.4)
+      activesupport (>= 2.3.4)
+    mongo (1.1.5)
+      bson (>= 1.1.5)
+    mongo_mapper (0.8.6)
+      activesupport (>= 2.3.4)
+      jnunemaker-validatable (~> 1.8.4)
+      plucky (~> 0.3.6)
+    plucky (0.3.6)
+      mongo (~> 1.1)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson_ext (= 1.1.5)
+  fast-stemmer (~> 1.0)
+  hunt!
+  i18n
+  mongo_mapper (~> 0.8.6)
+  rspec (~> 2.3)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Nunemaker
+
+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,57 @@
+= Hunt
+
+Insanely stupid and basic indexed search for MongoMapper. Probably pointless, but something I am playing around with on side projects.
+
+== Usage
+
+Declare the plugin.
+
+  class Note
+    include MongoMapper::Document
+    plugin Hunt
+
+    key :title, String
+    key :body, String
+    key :tags, Array
+    timestamps!
+
+    searches :title, :body, :tags
+  end
+
+This creates a key named searches that is a Hash. Title, body, and tags get mashed together before save into a unique array of stemmed words and stored in searches.default.
+
+You can index the terms individually or with any other combination of keys.
+
+  Note.ensure_index :'searches.default' # or ...
+  Note.ensure_index [[:user_id, Mongo::Ascending], [:'searches.default', Mongo::Ascending]]
+
+You also get a search class method that returns a scope.
+
+  # Returns Plucky::Query (MM Scope), no query actually fired
+  Note.search('mongodb')
+
+  # Gets everything matching mongodb
+  Note.search('mongodb').all
+
+  # Gets first page of everything matching mongodb
+  Note.search('mongodb').paginate(:page => 1)
+
+  # Counts everything matching mongodb
+  Note.search('mongodb').count
+
+  # Matches everything with any of the terms
+  Note.search('mongodb is awesome')
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 John Nunemaker. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/hunt.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hunt/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hunt"
+  s.version     = Hunt::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Nunemaker"]
+  s.email       = ["nunemaker@gmail.com"]
+  s.homepage    = "http://github.com/jnunemaker/hunt"
+  s.summary     = %q{Really basic search for MongoMapper models.}
+  s.description = %q{Really basic search for MongoMapper models.}
+
+  s.add_dependency 'fast-stemmer', '~> 1.0'
+  s.add_dependency 'mongo_mapper',  '~> 0.8.6'
+
+  s.add_development_dependency 'rspec', '~> 2.3'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/hunt.rb

@@ -0,0 +1,36 @@
+require 'fast_stemmer'
+require 'hunt/util'
+
+module Hunt
+  def self.configure(model)
+    model.before_save(:index_search_terms)
+  end
+
+  module ClassMethods
+    def search_keys
+      @search_keys ||= []
+    end
+
+    def searches(*keys)
+      # Using a hash to support multiple indexes per document at some point
+      key(:searches, Hash)
+      @search_keys = keys
+    end
+
+    def search(value)
+      terms = Util.to_stemmed_words(value)
+      return [] if terms.blank?
+      where('searches.default' => terms)
+    end
+  end
+
+  module InstanceMethods
+    def concatted_search_values
+      self.class.search_keys.map { |key| send(key) }.flatten.join(' ')
+    end
+
+    def index_search_terms
+      self.searches['default'] = Util.to_stemmed_words(concatted_search_values)
+    end
+  end
+end

data/lib/hunt/util.rb

@@ -0,0 +1,57 @@
+module Hunt
+  module Util
+    Separator = ' '
+    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",
+      "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",
+      "out", "over", "own", "same", "shan't", "she", "she'd", "she'll", "she's",
+      "should", "shouldn't", "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",
+      "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",
+      "you'll", "your", "you're", "yours", "yourself", "yourselves", "you've",
+      "the", "how"
+    ]
+
+    def strip_puncuation(value)
+      value.to_s.gsub(StripPunctuationRegex, PunctuationReplacement)
+    end
+
+    def stem(word)
+      Stemmer.stem_word(word)
+    end
+
+    def to_words(value)
+      value.
+        to_s.
+        squeeze(Separator).
+        split(Separator).
+        map     { |word| word.downcase }.
+        reject  { |word| word.size < 3 }.
+        reject  { |word| WordsToIgnore.include?(word) }.
+        map     { |word| strip_puncuation(word) }.
+        reject  { |word| word.blank? }.
+        uniq
+    end
+
+    def to_stemmed_words(value)
+      to_words(value).map { |word| stem(word) }
+    end
+
+    extend self
+  end
+end

data/lib/hunt/version.rb

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

data/spec/helper.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require(:default, :development)
+
+require 'hunt'
+
+MongoMapper.connection = Mongo::Connection.new
+MongoMapper.database   = 'hunt-test'
+
+Rspec.configure do |c|
+  c.before(:each) do
+    MongoMapper.database.collections.each(&:remove)
+  end
+end

data/spec/hunt/util_spec.rb

@@ -0,0 +1,62 @@
+require 'helper'
+
+describe Hunt::Util do
+  describe ".strip_puncuation" do
+    it "removes punctuation" do
+      Hunt::Util.strip_puncuation('woot!').should == 'woot'
+    end
+  end
+
+  describe ".stem" do
+    it "stems word" do
+      Hunt::Util.stem('kissing').should == 'kiss'
+      Hunt::Util.stem('hello').should   == 'hello'
+      Hunt::Util.stem('barfing').should == 'barf'
+    end
+  end
+
+  describe ".to_words" do
+    it "does not fail with nil" do
+      Hunt::Util.to_words(nil).should == []
+    end
+
+    it "converts string to array of words" do
+      Hunt::Util.to_words('first sentence').should == %w(first sentence)
+    end
+
+    it "squeezes multiple spaces" do
+      Hunt::Util.to_words('first    sentence').should == %w(first sentence)
+    end
+
+    it "removes punctuation" do
+      Hunt::Util.to_words('woot!').should == %w(woot)
+    end
+
+    it "removes blanks from removed punctuation" do
+      Hunt::Util.to_words('first sentence & second').should == %w(first sentence second)
+    end
+
+    it "lowercases each word" 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)
+    end
+
+    it "removes words that should be ignored" do
+      Hunt::Util.to_words('how was your day').should == %w(day)
+      Hunt::Util.to_words("didn't you see that").should == %w(see)
+    end
+
+    it "removes duplicates" do
+      Hunt::Util.to_words('boom boom').should == %w(boom)
+    end
+  end
+
+  describe ".to_stemmed_words" do
+    it "converts value to array of stemmed words" do
+      Hunt::Util.to_stemmed_words('I just Caught you kissing.').should == %w(just caught kiss)
+    end
+  end
+end

data/spec/hunt_spec.rb

@@ -0,0 +1,150 @@
+require 'helper'
+
+class Note
+  include MongoMapper::Document
+
+  plugin Hunt
+
+  key :title, String
+  key :body,  String
+  key :tags,  Array
+end
+
+describe Hunt do
+  it "adds searches key to model to store search terms" do
+    Note.searches(:title)
+    Note.new.should respond_to(:searches)
+    Note.new.should respond_to(:searches=)
+  end
+
+  describe ".search" do
+    before(:each) do
+      Note.searches(:title)
+    end
+
+    it "returns empty array if nil" do
+      Note.search(nil).should == []
+    end
+
+    it "returns empty array if blank" do
+      Note.search('').should == []
+    end
+
+    context "with one search term" do
+      before(:each) do
+        @note = Note.create(:title => 'MongoDB is awesome!')
+        @result = Note.search('mongodb')
+      end
+
+      let(:note)    { @note }
+      let(:result)  { @result }
+
+      it "returns plucky query" do
+        result.should be_instance_of(Plucky::Query)
+      end
+
+      it "scopes query to searches.default in stemmed terms" do
+        result['searches.default'].should == {'$in' => %w(mongodb)}
+      end
+
+      it "does return matched documents" do
+        result.all.should include(note)
+      end
+
+      it "does not query unmatched documents" do
+        not_found = Note.create(:title => 'Something different')
+        result.all.should_not include(not_found)
+      end
+    end
+
+    context "with multiple search terms" do
+      before(:each) do
+        @note = Note.create(:title => 'MongoDB is awesome!')
+        @result = Note.search('mongodb is awesome')
+      end
+
+      let(:note)    { @note }
+      let(:result)  { @result }
+
+      it "returns plucky query" do
+        result.should be_instance_of(Plucky::Query)
+      end
+
+      it "scopes query to searches.default in stemmed terms" do
+        result['searches.default'].should == {'$in' => Hunt::Util.to_stemmed_words(note.concatted_search_values)}
+      end
+
+      it "returns documents that match both terms" do
+        result.all.should include(note)
+      end
+
+      it "returns documents that match any of the terms" do
+        awesome = Note.create(:title => 'Something awesome')
+        mongodb = Note.create(:title => 'Something MongoDB')
+        result.all.should include(awesome)
+        result.all.should include(mongodb)
+      end
+
+      it "does not query unmatched documents" do
+        not_found = Note.create(:title => 'Something different')
+        result.all.should_not include(not_found)
+      end
+    end
+  end
+
+  context "Search indexing" do
+    context "on one field" do
+      before(:each) do
+        Note.searches(:title)
+        @note = Note.create(:title => 'Woot for MongoDB!')
+      end
+
+      let(:note) { @note }
+
+      it "indexes terms on create" do
+        note.searches['default'].should == Hunt::Util.to_stemmed_words(note.concatted_search_values)
+      end
+
+      it "indexes terms on update" do
+        note.update_attributes(:title => 'Another woot')
+        note.searches['default'].should == Hunt::Util.to_stemmed_words(note.concatted_search_values)
+      end
+    end
+
+    context "on multiple fields" do
+      before(:each) do
+        Note.searches(:title, :body)
+        @note = Note.create(:title => 'Woot for MongoDB!', :body => 'This is my body.')
+      end
+
+      let(:note) { @note }
+
+      it "indexes merged terms on create" do
+        note.searches['default'].should == Hunt::Util.to_stemmed_words(note.concatted_search_values)
+      end
+
+      it "indexes merged terms on update" do
+        note.update_attributes(:title => 'Another woot', :body => 'An updated body.')
+        note.searches['default'].should == Hunt::Util.to_stemmed_words(note.concatted_search_values)
+      end
+    end
+
+    context "on multiple fields one of which is array key" do
+      before(:each) do
+        Note.searches(:title, :tags)
+        @note = Note.create(:title => 'Woot for MongoDB!', :tags => %w(mongo nosql))
+      end
+
+      let(:note) { @note }
+
+      it "indexes merged terms on create" do
+        note.searches['default'].should == Hunt::Util.to_stemmed_words(note.concatted_search_values)
+      end
+
+      it "indexes merged terms on update" do
+        note.update_attributes(:title => 'Another woot', :tags => %w(mongo))
+        note.searches['default'].should == Hunt::Util.to_stemmed_words(note.concatted_search_values)
+      end
+    end
+  end
+end

data/specs.watchr

@@ -0,0 +1,45 @@
+def growl(title, msg, img)
+  %x{growlnotify -m #{ msg.inspect} -t #{title.inspect} --image ~/.watchr/#{img}.png}
+end
+
+def form_growl_message(str)
+  msg = str.split("\n").last
+  if msg =~ /(\d)\sfailure/
+    img = $1.to_i > 0 ? 'fail' : 'pass'
+  end
+  growl 'Results', msg, img
+end
+
+def run(cmd)
+  puts cmd
+  output = ""
+  IO.popen(cmd) do |com|
+    com.each_char do |c|
+      print c
+      output << c
+      $stdout.flush
+    end
+  end
+  form_growl_message output
+end
+
+def run_spec(path)
+  path.gsub!('lib/', 'spec/')
+  path.gsub!('_spec', '')
+  file_name = File.basename(path, '.rb')
+  path.gsub!(file_name, file_name + "_spec")
+  run %Q(bundle exec rspec #{path})
+end
+
+watch('spec/helper\.rb')  { system('clear'); run('rake') }
+watch('lib/.*\.rb')       { |m| system('clear'); run_spec(m[0]) }
+watch('spec/.*_spec\.rb') { |m| system('clear'); run_spec(m[0]) }
+
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run('rake')
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification 
+name: hunt
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- John Nunemaker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-19 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fast-stemmer
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 51
+        segments: 
+        - 0
+        - 8
+        - 6
+        version: 0.8.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
+  version_requirements: *id003
+description: Really basic search for MongoMapper models.
+email: 
+- nunemaker@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- hunt.gemspec
+- lib/hunt.rb
+- lib/hunt/util.rb
+- lib/hunt/version.rb
+- spec/helper.rb
+- spec/hunt/util_spec.rb
+- spec/hunt_spec.rb
+- specs.watchr
+has_rdoc: true
+homepage: http://github.com/jnunemaker/hunt
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Really basic search for MongoMapper models.
+test_files: 
+- spec/helper.rb
+- spec/hunt/util_spec.rb
+- spec/hunt_spec.rb