quest_search 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in quest.gemspec
+gemspec

data/README

@@ -0,0 +1,33 @@
+= Quest
+
+Extremely naive full text search implementation for ActiveRecord based on naive-search by Tomas Jogin (http://github.com/tjogin/naive-search). Orders results by relevance and gives you detailed info on the search results. Works like this:
+
+* Every word in a search query is matched against each text field in your database using +like+.
+* The returned results are then re-ordered based on how well they match the query and the words the query is made up of.
+* As opposed to naive-search quest doesn't re-organize your fields into an index column in your database. Instead it searches after each word in each field that you specify. This may result in huge overhead when searching big databases.
+
+== Installation
+
+  gem install quest
+
+== Usage
+
+  class Person < ActiveRecord::Base
+    quest_on :name, :surname, :description
+  end
+
+This makes the specified fields searchable like so:
+
+  Person.quest_for 'my query'
+
+Optionally, you can specify the order and limit of results to return from the database:
+
+  class Person < ActiveRecord::Base
+    quest_on :name, :surname, :description, :order => "id desc", :limit => 20
+  end
+
+Note that the search results will still be re-ordered based on fuzzy "relevance", this simply specifies how many results to retrieve from the database, and in which order. Also note that small limits combined with broad searches yields terrible results. The default limit is 1 000.
+
+== License
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/quest/quest_on.rb

@@ -0,0 +1,79 @@
+module Quest
+	module QuestOn
+		extend ActiveSupport::Concern
+    
+		module ClassMethods
+			def quest_on(*fields)
+				if fields.size.zero?
+					raise "No arguments given, please specify which fields should be indexed and searched."
+				end
+
+				options = fields.extract_options!
+
+				@order = options[:order] || "id desc"
+				@limit = options[:limit] || 1000
+
+				cattr_accessor :quest_fields
+
+				self.quest_fields = fields
+			end
+
+			def quest_for(query, page_no = 1, page_size = nil)
+				words = query.to_s.split " "
+				conditions = words.map do |w|
+					self.quest_fields.map do |f|
+						replace_bind_variables("#{f} like ?", ["%#{w}%"])
+					end.join " OR "
+				end.join " OR "
+
+				self.where(conditions).order(@order).limit(@limit).sort do |a, b|
+					b.points_for(query) <=> a.points_for(query)
+				end
+			end
+		end
+
+		def points_for(query)
+			query = query.to_s.downcase
+			@quest_relevance ||= {}
+			return @quest_relevance[query] if @quest_relevance[query]
+			words = query.split " "
+
+			self.search_word_matches = []
+			self.search_word_matches_count = 0
+			self.search_word_total_matches_count = 0
+
+			points = words.map do |w|
+				matches = 0
+
+				points = self.quest_fields.map do |field|
+					content = self.send(field).to_s.downcase
+
+					matches = content.scan(w).size
+
+					# one point for partial word matches
+					(content.scan(w).size +
+					# one point for partial query matches
+					content.scan(query).size +
+					# two points for exact word match
+					(content == w ? 2 : 0) +
+					# two points for exact query match
+					(content == query ? 2 : 0))
+				end.sum
+
+				if matches != 0
+					self.search_word_matches.push [ 'word' => w, 'count' => matches ]
+					self.search_word_matches_count += 1
+					self.search_word_total_matches_count += matches
+				end
+
+				points
+			end.sum
+
+			self.relevance = points
+
+			@quest_relevance[query] = points
+		end
+	end
+end
+
+ActiveRecord::Base.send :include, Quest::QuestOn

data/lib/quest/version.rb

@@ -0,0 +1,3 @@
+module Quest
+  VERSION = "0.0.1"
+end

data/lib/quest.rb

@@ -0,0 +1,5 @@
+require 'quest/quest_on'
+
+module Quest
+  # Your code goes here...
+end

data/quest.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "quest/version"
+
+Gem::Specification.new do |s|
+  s.name        = "quest_search"
+  s.version     = Quest::VERSION
+  s.authors     = ["Fredrik Sundström"]
+  s.email       = ["fredrik.sundstrom@gmail.com"]
+  s.homepage    = "http://github.com/fredriksundstrom/quest"
+  s.summary     = "Extremely naive full text search implementation for ActiveRecord based on naive-search by Tomas Jogin (http://github.com/tjogin/naive-search). Orders results by relevance and gives you detailed info on the search results."
+  s.description = "Quest is a gem that lets you search your model in a simple and intuitive way."
+
+  s.rubyforge_project = "quest"
+
+  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"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: quest_search
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fredrik Sundström
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-22 00:00:00.000000000 Z
+dependencies: []
+description: Quest is a gem that lets you search your model in a simple and intuitive
+  way.
+email:
+- fredrik.sundstrom@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- lib/quest.rb
+- lib/quest/quest_on.rb
+- lib/quest/version.rb
+- quest.gemspec
+homepage: http://github.com/fredriksundstrom/quest
+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: quest
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Extremely naive full text search implementation for ActiveRecord based on
+  naive-search by Tomas Jogin (http://github.com/tjogin/naive-search). Orders results
+  by relevance and gives you detailed info on the search results.
+test_files: []