mongoid_search 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mauricio Zaffari
+
+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,71 @@
+Mongoid Searh
+============
+
+Mongoid Search is a simple full text search implementation for Mongoid ORM.
+
+Installation
+--------
+
+In your Gemfile:
+
+    gem 'mongoid_search'
+  
+Then:
+  
+    bundle install
+
+Examples
+--------
+
+    class Product
+      include Mongoid::Document
+      include Mongoid::Search
+      field :brand
+      field :name
+
+      references_many :tags
+      
+      search_in :brand, :name, :tags => :name
+    end
+
+    class Tag
+      include Mongoid::Document
+      field :name
+
+      referenced_in :product
+    end
+
+Now when you save a product, you get a _keywords field automatically:
+    
+    p = Product.new :brand => "Apple", :name => "iPhone"
+    p.tags << Tag.new(:name => "Amazing")
+    p.tags << Tag.new(:name => "Awesome")
+    p.tags << Tag.new(:name => "Superb")
+    p.save
+    => true
+    p._keywords
+    
+Now you can run search, which will look in the _keywords field and return all matching results:
+
+    Product.search("apple iphone").size
+    => 1
+    
+Note that the search is case insensitive, and accept partial searching too:
+
+    Product.search("ipho").size
+    => 1
+    
+Options
+-------
+
+:match - :any for match any occurrence, :all to match all ocurrences. Default is :any
+
+    search_in :brand, :name, { :tags => :name }, { :match => :all }
+    
+    Product.search("apple motorola").size
+    => 1
+
+    search_in :brand, :name, { :tags => :name }, { :match => :all }
+    
+    Product.search("apple motorola").size
+    => 0

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongoid_search"
+    gem.summary = "Search implementation for Mongoid ORM"
+    gem.description = "Simple full text search implementation."
+    gem.email = "mauricio@papodenerd.net"
+    gem.homepage = "http://github.com/mauriciozaffari/mongoid_search"
+    gem.authors = ["Mauricio Zaffari"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongoid_search #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongoid_search.rb

@@ -0,0 +1,2 @@
+require 'mongoid_search/keywords_extractor'
+require 'mongoid_search/mongoid_search'

data/lib/mongoid_search/keywords_extractor.rb

@@ -0,0 +1,6 @@
+class KeywordsExtractor
+  def self.extract(text)
+    return if text.blank?
+    text.mb_chars.normalize(:kd).to_s.gsub(/[^\x00-\x7F]/,'').downcase.split(/[\s\.\-_]+/)
+  end
+end

data/lib/mongoid_search/mongoid_search.rb

@@ -0,0 +1,33 @@
+module Mongoid::Search
+  extend ActiveSupport::Concern
+  
+  included do
+    cattr_accessor :search_fields, :match
+  end
+  
+  module ClassMethods #:nodoc:
+    # Set a field or a number of fields as sources for search
+    def search_in(*args)
+      options = args.last.is_a?(Hash) && (args.last.keys.first == :match) ? args.pop : {}
+      self.match = options[:match] || :any
+      self.search_fields = args
+
+      field :_keywords, :type => Array
+      index :_keywords
+      
+      before_save :set_keywords
+    end
+    
+    def search(query)
+      self.send("#{self.match.to_s}_in", :_keywords => KeywordsExtractor.extract(query).map { |q| /#{q}/i })
+    end
+  end
+  
+  private
+  
+  def set_keywords
+    self._keywords = self.search_fields.map do |field|
+      field.is_a?(Hash) ? self.send(field.keys.first).map(&field.values.first).map { |t| KeywordsExtractor.extract t } : KeywordsExtractor.extract(self.send(field))
+    end.flatten.compact.uniq
+  end
+end

data/mongoid_search.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_search}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mauricio Zaffari"]
+  s.date = %q{2010-09-16}
+  s.description = %q{Simple full text search implementation.}
+  s.email = %q{mauricio@papodenerd.net}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "lib/mongoid_search.rb",
+     "lib/mongoid_search/keywords_extractor.rb",
+     "lib/mongoid_search/mongoid_search.rb",
+     "mongoid_search.gemspec",
+     "spec/mongoid_search_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mauriciozaffari/mongoid_search}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Search implementation for Mongoid ORM}
+  s.test_files = [
+    "spec/mongoid_search_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/mongoid_search_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "MongoidSearch" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongoid_search'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_search
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mauricio Zaffari
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-16 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Simple full text search implementation.
+email: mauricio@papodenerd.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- lib/mongoid_search.rb
+- lib/mongoid_search/keywords_extractor.rb
+- lib/mongoid_search/mongoid_search.rb
+- mongoid_search.gemspec
+- spec/mongoid_search_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/mauriciozaffari/mongoid_search
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Search implementation for Mongoid ORM
+test_files: 
+- spec/mongoid_search_spec.rb
+- spec/spec_helper.rb