mongoid-searchable 0.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Jason Coene
+
+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,97 @@
+# Mongoid Searchable
+
+Mongoid Searchable provides simple field search for your Mongoid models using the full-text search technique described in the [MongoDB documentation](http://www.mongodb.org/display/DOCS/Full+Text+Search+in+Mongo).
+
+## Getting Started
+
+First, add mongoid-searchable to your Gemfile:
+
+```ruby
+gem 'mongoid-searchable'
+```
+
+Next, include the module and tell it how to search your model:
+
+```ruby
+class City
+  include Mongoid::Document
+  include Mongoid::Searchable
+
+  field :name, :type => String
+  field :population, :type => Integer
+  field :boroughs, :type => Array
+  field :officials, :type => Hash
+
+  searchable :name, :population, :boroughs, :officials
+end
+```
+
+You can now use the *search* method on your model to find what you're looking for:
+
+```ruby
+# Create a few example cities
+City.create :name => 'New York, NY', :population => 18_897_109,
+            :boroughs => ['Manhattan', 'Brooklyn', 'Queens', 'The Bronx', 'Staten Island'],
+            :officials => { 'Mayor' => 'Michael Bloomberg', 'Governor' => 'Andrew Cuomo' }
+City.create :name => 'Rochester, NY', :population => 1_098_201,
+            :officials => { 'Mayor' => 'Thomas Richards', 'Governor' => 'Andrew Cuomo' }
+City.create :name => 'Rochester, MN', :population => 186_011,
+            :officials => { 'Mayor' => 'Ardell Brede', 'Governor' => 'Mark Dayton' }
+
+City.search('ny')        # => 2 records
+City.search('rochester') # => 2 records
+City.search('manhattan') # => 1 record
+```
+
+You can also choose to match all or any tokens. The default is to match **all** terms:
+
+```ruby
+City.search('rochester ny')                 # => 1 record (defaults to all)
+City.search('rochester ny', :match => :any) # => 3 records
+```
+
+We can match partial or exact words as well. The default is to match **partial** words:
+
+```ruby
+City.search('roch')                 # => 2 records
+City.search('roch', :exact => true) # => 0 records
+```
+
+You can chain other criteria on to your search, as per Mongoid convention:
+
+```ruby
+City.search('ny').where(:population.gt => 2_000_000)      # => 1 record
+City.search('rochester').where(:population.lt => 500_000) # => 1 record
+```
+
+## Customization
+
+You can also pass additional arguments to *searchable* to provide more control over the behavior.
+
+**Changing the field name:** You can specify the field to use for keyword storage using **as**. The default is to use the *keywords* field:
+
+```ruby
+class Person
+  ...
+  searchable :name, :as => :search_fields
+  ...
+end
+```
+
+**Turning off indexing:** You can also turn off indexing on your keyword field using **index**. This isn't recommended and defaults to *on*:
+
+```ruby
+class Person
+  ...
+  searchable :name, :index => false
+  ...
+end
+```
+
+## Enhancements and Pull Requests
+
+If you find the project useful but it doesn't meet all of your needs, feel free to fork it and send a pull request.
+
+## License
+
+MIT license, go wild.

data/Rakefile

@@ -0,0 +1,11 @@
+# encoding: UTF-8
+
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run all specs in the spec directory'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/mongoid/searchable/version.rb

@@ -0,0 +1,5 @@
+module Mongoid
+  module Searchable
+    VERSION = '0.1.0'
+  end
+end

data/lib/mongoid/searchable.rb

@@ -0,0 +1,88 @@
+require 'mongoid'
+
+module Mongoid
+
+  module Searchable
+
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_accessor :keywords_field, :searchable_fields
+    end
+
+    module ClassMethods
+
+      def searchable(*fields)
+        options = { :as => :keywords, :index => true }.merge(fields.extract_options!)
+
+        self.keywords_field = options[:as].to_sym
+        self.searchable_fields = fields.map(&:to_s)
+
+        field keywords_field
+        index :keywords if options[:index]
+
+        before_save :build_keywords
+
+      end
+
+      def search(query, options={})
+        keywords = query.to_s.split(' ').map { |s| s.downcase.gsub(/[^a-z0-9]/, '') }.select { |s| s.length >= 2 }.uniq
+        options[:match] ||= :all
+        options[:exact] ||= false
+
+        if options[:exact]
+          match = keywords.collect{|k| /^#{Regexp.escape(k)}$/ }
+        else
+          match = keywords.collect{|k| /#{Regexp.escape(k)}/ }
+        end
+
+        raise "Please define one or more fields as searchable before attempting to search." if keywords_field.nil? or searchable_fields.nil?
+
+        if keywords.any?
+          if options[:match].to_sym == :all
+            all_in(keywords_field.to_sym => match)
+          elsif options[:match].to_sym == :any
+            any_in(keywords_field.to_sym => match)
+          else
+            where()
+          end
+        else
+          where()
+        end
+      end
+
+    end
+
+    module InstanceMethods
+
+      def clean_keywords(value)
+        words = []
+
+        if value.is_a?(String) or value.is_a?(Numeric)
+          words << value.to_s.split(' ').map { |s| s.downcase.gsub(/[^a-z0-9]/, '') }.select { |s| s.length >= 2 }
+        elsif value.is_a?(Array) && value.any?
+          value.each do |v|
+            words << clean_keywords(v)
+          end
+        elsif value.is_a?(Hash) && value.any?
+          value.each do |k,v|
+            words << clean_keywords(v)
+          end
+        end
+
+        words.flatten.uniq
+      end
+
+      def build_keywords
+        keywords = []
+        self.class.searchable_fields.each do |f|
+          keywords << clean_keywords(send("#{f}"))
+        end
+        write_attribute(self.class.keywords_field, keywords.flatten.uniq)
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: mongoid-searchable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jason Coene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-08 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70209780623120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70209780623120
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70209780602240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70209780602240
+- !ruby/object:Gem::Dependency
+  name: growl
+  requirement: &70209780588960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70209780588960
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70209780575180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: *70209780575180
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70209780540880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *70209780540880
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70209780534900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3
+  type: :development
+  prerelease: false
+  version_requirements: *70209780534900
+description: Mongoid Searchable allows you to easily perform full-text search your
+  Mongoid models.
+email:
+- jcoene@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongoid/searchable/version.rb
+- lib/mongoid/searchable.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+homepage: http://github.com/jcoene/mongoid-searchable
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Simple keyword search for your Mongoid models.
+test_files: []