clortho 0.0.1

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,16 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "mongo_mapper", "~> 0.9.0"
+  gem "taggregator"
+  gem "pry"
+end

data/Gemfile.lock

@@ -0,0 +1,52 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.9)
+      activesupport (= 3.0.9)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.9)
+    bson (1.3.1)
+    builder (2.1.2)
+    coderay (0.9.8)
+    git (1.2.5)
+    i18n (0.5.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    method_source (0.6.0)
+      ruby_parser (>= 2.0.5)
+    mongo (1.3.1)
+      bson (>= 1.3.1)
+    mongo_mapper (0.9.1)
+      activemodel (~> 3.0)
+      activesupport (~> 3.0)
+      plucky (~> 0.3.8)
+    plucky (0.3.8)
+      mongo (~> 1.3)
+    pry (0.9.3)
+      coderay (>= 0.9.8)
+      method_source (>= 0.6.0)
+      ruby_parser (>= 2.0.5)
+      slop (~> 1.9.0)
+    rake (0.9.2)
+    rcov (0.9.9)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.5)
+    shoulda (2.11.3)
+    slop (1.9.1)
+    taggregator (0.0.2.dev)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  mongo_mapper (~> 0.9.0)
+  pry
+  rcov
+  shoulda
+  taggregator

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mark Coates
+
+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.md

@@ -0,0 +1,19 @@
+# Clortho
+
+![Vince Clortho, The Keymaster](http://i51.tinypic.com/1685svm.jpg)
+
+**The Keywordmaster** (for MongoMapper)
+
+## Contributing to *clortho*
+ 
+* Check out the latest `master` to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Mark Coates. Released under the MIT license. See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "clortho"
+  gem.homepage = "http://github.com/oddlyzen/clortho"
+  gem.license = "MIT"
+  gem.summary = %Q{Clortho: the Key(word) Master adds search to your MongoMapper classes.}
+  gem.description = %Q{Clortho makes keyword and full-text search a breeze for MongoMapper users.}
+  gem.email = "mark.coates@gmail.com"
+  gem.authors = ["Mark Coates"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "clortho #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/clortho.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{clortho}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mark Coates"]
+  s.date = %q{2011-08-02}
+  s.description = %q{Clortho makes keyword and full-text search a breeze for MongoMapper users.}
+  s.email = %q{mark.coates@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "clortho.gemspec",
+    "lib/clortho.rb",
+    "test/helper.rb",
+    "test/models/post.rb",
+    "test/test_clortho.rb"
+  ]
+  s.homepage = %q{http://github.com/oddlyzen/clortho}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Clortho: the Key(word) Master adds search to your MongoMapper classes.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+      s.add_development_dependency(%q<taggregator>, [">= 0"])
+      s.add_development_dependency(%q<pry>, [">= 0"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+      s.add_dependency(%q<taggregator>, [">= 0"])
+      s.add_dependency(%q<pry>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<mongo_mapper>, ["~> 0.9.0"])
+    s.add_dependency(%q<taggregator>, [">= 0"])
+    s.add_dependency(%q<pry>, [">= 0"])
+  end
+end
+

data/lib/clortho.rb

@@ -0,0 +1,100 @@
+module MongoMapper
+  module Plugins
+    
+    module Clortho
+      extend ActiveSupport::Concern
+      
+      included do
+        class_inheritable_accessor  :searchable_with_options
+        write_inheritable_attribute :searchable_with_options, []
+        set_callback :create, :before, :inject_default_keywords
+        extend ClassMethods
+      end
+      
+      module ExclusionConstants
+        # Helper verbs, sometimes referred to as "forms of the verb (to) 'be'", usually offer no added meaning
+        VERBS       = %w(have has had do does did be am is are was were having
+                         been can could shall should will would may might must being)
+        # Article adjectives are normally fluff and offer no additional context or meaning
+        ADJECTIVES  = %w(a an the)
+      end
+      
+      module ClassMethods
+        
+        def searchable(*args)
+          options = args.extract_options!
+          
+          args.each do |arg|
+            key :"#{arg}_keywords", String, default: ""
+            key :"#{arg}_keywords_array", Array, default: []
+            
+            searchable_with_options << [arg.to_sym, options]
+            
+            class_eval <<-CODE
+              class << self
+                def search_#{arg}_keywords_for(*keywords)
+                  records = []
+                  keywords.each do |word|
+                    records << self.all.select{ |record| record[:'#{arg}_keywords_array'].include?(word.downcase) }
+                  end
+                  records.flatten.uniq
+                end
+              end
+            CODE
+          end
+        end
+        
+      end
+      
+      module InstanceMethods
+        
+        @defaults_set = false
+        
+        def inject_default_keywords
+          searchable_with_options.each do |field|
+            if !self.send(field[0]).nil?
+              keywords = !field[1][:exclude].nil? ? filter_on_exclusions(field, self.send(field[0])) : self.send(field[0])
+              keywords = filter_and_normalize(keywords)
+              self.send("#{field[0].to_s}_keywords=".to_sym, keywords) if keywords
+              self.send("#{field[0].to_s}_keywords_array=".to_sym, keywords.split.each{ |kw| kw.downcase }) if keywords
+            end
+          end
+        end
+        
+        def filter_on_exclusions(field_and_options, keywords)
+          field, options = field_and_options
+          if options[:exclude]
+            
+            options[:exclude].each do |exclusion|
+              if exclusion.is_a? String
+                keywords.gsub!(exclusion.to_s, '')
+              elsif exclusion.is_a? Symbol
+                klass = self.class
+                ex = exclusion.to_s.upcase.to_sym
+                if Clortho::ExclusionConstants::const_get(ex)
+                  Clortho::ExclusionConstants::const_get(ex).each do |e|
+                    keywords.gsub!(e, '')
+                  end
+                end
+              end
+            end
+          end
+          # strip punctuation and extra spaces
+          unless keywords.nil?
+            filter_out_punctuation(keywords)
+          end
+        end
+        
+        def filter_out_punctuation(text)
+          text.gsub(/\b\W/, ' ').strip.gsub(/\s+/, ' ')
+        end
+        
+        def filter_and_normalize(text)
+          filter_out_punctuation(text).downcase
+        end
+        
+      end
+      
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler'
+require 'active_support'
+require 'pry'
+require 'mongo_mapper'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'clortho'
+
+MongoMapper.database = 'testing_clortho'
+
+require 'models/post'
+
+class Test::Unit::TestCase
+end

data/test/models/post.rb

@@ -0,0 +1,20 @@
+class Post
+  include MongoMapper::Document
+  include MongoMapper::Plugins::Clortho
+  
+  key :title,   String
+  key :body,    String
+  key :summary, String
+  key :authors, Array
+  key :about,   String
+  
+  searchable :summary       # works with one...
+  searchable :body, :title  # ...or multiple arguments...
+  searchable :about, :exclude => [:verbs, :adjectives, 'lipsum'] # or options like :exclude.
+  
+  LIPSUM  = "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus porttitor, ipsum a commodo aliquet, 
+             velit ligula porttitor eros, sit amet consequat purus massa sit amet quam. Aliquam: tempus magna faucibus 
+             lacus ultricies rhoncus. In ut metus purus, at venenatis est. Donec vel--elementum turpis. Nullam feugiat 
+             massa quis elit egestas."
+  
+end

data/test/test_clortho.rb

@@ -0,0 +1,98 @@
+require 'helper'
+
+class TestClortho < Test::Unit::TestCase
+  def setup
+    @fields = ['about', 'summary', 'body', 'title']
+    @posts = [
+    (@fridge = Post.new( title: 'Is your refrigerator running? Better catch it',
+                                    body: Post::LIPSUM,
+                                    about: 'Hello were having the lipsum a world',
+                                    authors: ['Thomas Mann', 'Jim Byrd'])),
+    (@colonial =    Post.new(  title: 'The Colonial: In Full Swing',
+                                    body: Post::LIPSUM,
+                                    about: 'Hello were having the lipsum a world',
+                                    authors: ['Rebecca Simmons']))
+                ]
+    save_posts
+  end
+  
+  should 'have a all searchable fields, both as a string and array' do
+    @posts.each do |post|
+      @fields.each do |word|
+        assert post.respond_to? :"#{word}_keywords"
+        assert post.respond_to? :"#{word}_keywords_array"
+      end
+    end
+  end
+  
+  should 'have fields that never evaluate to nil unless supplied field is nil' do
+    @posts.each do |post|
+      @fields.each do |word|
+        assert !(post.send :"#{word}_keywords").nil?
+        assert !(post.send :"#{word}_keywords_array").nil?
+      end
+    end
+  end
+  
+  should 'have body_keywords equal to LIPSUM' do
+    stripsum = Post::LIPSUM.downcase.gsub(/\b\W/, ' ').strip.gsub(/\s+/, ' ')
+    assert_equal stripsum, @colonial.body_keywords
+    assert_equal stripsum, @fridge.body_keywords
+  end
+  
+  should 'have about_keywords equal to "Hello world"' do
+    assert_equal "hello world", @colonial.about_keywords
+    assert_equal "hello world", @fridge.about_keywords
+  end
+  
+  should 'allow searches for specific keywords' do
+    assert_equal Post.search_body_keywords_for('ipsum').count, 2
+    assert_equal Post.search_about_keywords_for('ipsum').count, 0
+    assert_equal Post.search_title_keywords_for('refrigerator').count, 1
+  end
+  
+  # need to strip out punctuation in keywords
+  should 'strip out punctuation from array entries' do
+    @colonial.body_keywords_array.each do |keyword|
+      flunk if keyword =~ /^A-Za-z0-9\s/
+    end
+    @fridge.body_keywords_array.each do |keyword|
+      flunk if keyword =~ /^A-Za-z0-9\s/
+    end
+    assert true
+  end
+  
+  should 'strip out helper verbs and article adjectives from the about keywords' do
+    MongoMapper::Plugins::Clortho::ExclusionConstants::VERBS.each do |v|
+      flunk if /v.to_s/ =~ @colonial.about_keywords
+      flunk if /v.to_s/ =~ @fridge.about_keywords
+    end
+    assert true
+  end
+  
+  should 'allow searching for multiple keywords' do
+    assert_equal Post.search_body_keywords_for('ipsum', 'sit').count, 2
+    assert_equal Post.search_about_keywords_for('ipsum', 'sit').count, 0
+    assert_equal Post.search_title_keywords_for('refrigerator', 'Colonial').count, 2
+  end
+  
+  should 'allow case-insensitive searching for keywords' do
+    assert_equal Post.search_title_keywords_for('ReFrIgErAtOr', 'ColoniaL').count, 2
+    assert_equal Post.search_about_keywords_for('IpSuM', 'SIT').count, 0
+    assert_equal Post.search_body_keywords_for('ipsUM', 'sIT').count, 2
+  end
+  
+  should 'strip out -- from between two words (i.e., word--again)' do
+    assert @fridge.body_keywords !=~ /\-\-/
+    assert @colonial.body_keywords !=~ /\-\-/
+  end
+  
+  def teardown
+    Post.destroy_all
+  end
+  
+  private
+  def save_posts
+    @posts.each{ |post| post.save }
+  end
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: clortho
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mark Coates
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-08-02 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2168779100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168779100
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2168778160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2168778160
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2168776700 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2168776700
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &2168775020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168775020
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: &2168773200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *2168773200
+- !ruby/object:Gem::Dependency
+  name: taggregator
+  requirement: &2168771100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168771100
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: &2168769420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2168769420
+description: Clortho makes keyword and full-text search a breeze for MongoMapper users.
+email: mark.coates@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- clortho.gemspec
+- lib/clortho.rb
+- test/helper.rb
+- test/models/post.rb
+- test/test_clortho.rb
+has_rdoc: true
+homepage: http://github.com/oddlyzen/clortho
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3180382170967961300
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: ! 'Clortho: the Key(word) Master adds search to your MongoMapper classes.'
+test_files: []