search_qd 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.sqlite3
+db_config.yml

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* initial release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Karsten Gallinowski
+
+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,55 @@
+# SearchQd
+
+## DESCRIPTION
+
+SearchQd extends ActiveRecord and offers a method called search\_qd
+for a simple full text search. Simple because the search functionality is
+executed as SQL LIKE statements for given (text) columns.
+
+## Quick start
+
+
+```ruby
+gem install search_qd
+```
+
+* Rails 3
+
+Add the following line to your Gemfile 
+
+```ruby
+gem 'search_qd'
+```
+
+* ActiveRecord outside of Rails
+
+```ruby
+require 'search_qd'
+ActiveRecord::Base.send(:include, SearchQd)
+```
+
+## Usage
+
+Assuming your model name is Blog and the model has two text columns title and content:
+
+```ruby
+class Blog < ActiveRecord::Base
+  search_qd_columns :title, :content
+end
+
+Blog.search_qd("some text to seach for") # search for 'some text to search for' in title and content column
+Blog.search_qd("some text to search for", "title") # search for 'some text to search for' in title column
+Blog.search_qd("some text to search for", "user_name") # search for 'some text to search for' in user_name column
+```
+
+As shown in the example above the search\_qd method expects the search query as a string and a list of columns. If no list 
+of columns is given, the search\_qd method uses the column list defined by search\_qd\_columns (see class Blog definition).
+
+## REQUIREMENTS
+
+* ActiveRecord
+* Ruby 1.9.\*
+
+## License
+
+This gem is created by Karsten Gallinowski and released under the MIT License.

data/Rakefile

@@ -0,0 +1,52 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'active_record'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default do
+  Rake::Task["db:setup"].invoke      
+  Rake::Task[:spec].invoke
+end
+
+namespace :db do
+  desc 'Create and configure test database'
+  task :setup do
+    spec_dir = File.expand_path(File.dirname(__FILE__) + '/spec')
+    db_config = "#{spec_dir}/db_config.yml"
+
+    unless File.exists?(db_config)
+      STDOUT.puts "Database configuration file #{db_config} could not been found."
+    else
+      STDOUT.puts "Try running migrations"
+      Rake::Task["db:drop"].invoke
+      Rake::Task["db:migrate"].invoke
+    end
+  end
+
+  desc 'Run migrations for test database'
+  task :migrate do
+    spec_dir = File.expand_path(File.dirname(__FILE__) + '/spec')
+    db_config = "#{spec_dir}/db_config.yml"
+
+    ActiveRecord::Base.establish_connection(YAML.load_file(db_config))
+    ActiveRecord::Migration.instance_eval do
+      create_table :blogs do |t|
+        t.string :title
+        t.text :content
+        t.string :user_name
+      end
+    end
+  end
+
+  desc 'Drop tables from test database'
+  task :drop do
+    spec_dir = File.expand_path(File.dirname(__FILE__) + '/spec')
+    db_config = "#{spec_dir}/db_config.yml"
+
+    ActiveRecord::Base.establish_connection(YAML.load_file(db_config))
+    ActiveRecord::Migration.instance_eval do
+      drop_table :blogs if self.table_exists?(:blogs) 
+    end
+  end
+end

data/lib/search_qd.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+require 'search_qd/version'
+require 'active_record' unless defined? Rails
+require 'search_qd/rails' if defined? Rails
+
+module SearchQd
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+    # method which can be used inside class definitions
+    # to define the default search columns of the class
+    # and to extend the class with search_qd singleton method
+    def search_qd_columns(*column_names)
+      @searchable_columns = []
+      [column_names].flatten.each do |column_name|
+        @searchable_columns << column_name
+      end
+      extend SearchQd::SingletonMethods
+    end
+  end
+
+  module SingletonMethods
+    # search method which provides possibility
+    # to define search columns (fields) if default
+    # columns should not be used 
+    def search_qd(query, fields=nil)
+      where(search_qd_conditions(query, fields))
+    end
+
+    private
+
+    # method to create plain SQL LIKE
+    # statements for each search term and search column
+    #
+    # SQL injection should not be an issue because 
+    # query will be converted into LIKE statements word by 
+    # word and special characters will be suppressed
+    def search_qd_conditions(query, fields=nil)
+      return nil if query.blank?
+      fields ||= @searchable_columns
+
+      # suppress special characters  
+      search_qd_rm_special_chars(query)
+
+      # split the search string by spaces
+      words = query.split(' ')
+
+      or_statements = []
+      for word in words
+        like_statements = []
+        for column in fields
+          like_statements << "#{column} LIKE '%#{word.downcase}%'"
+        end
+        or_statements << ' ('+like_statements.join(' OR ')+') '
+      end
+      or_statements.join(' AND ')
+    end
+
+    # German umlauts are the only special characters
+    # which won't be removed from the search query
+    def search_qd_rm_special_chars(query)
+      query.gsub(/[^0-9a-zA-Z\säüöÜÄÖ]/, '')
+    end
+  end
+end

data/lib/search_qd/rails.rb

@@ -0,0 +1,7 @@
+module SearchQd
+  class Railtie < Rails::Railtie
+    initializer "search_qd.include" do
+      ActiveRecord::Base.send(:include, SearchQd)
+    end        
+  end
+end

data/lib/search_qd/version.rb

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

data/search_qd.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "search_qd/version"
+
+Gem::Specification.new do |s|
+  s.name        = "search_qd"
+  s.version     = SearchQd::VERSION
+  s.authors     = ["kgalli"]
+  s.email       = ["mail@kgalli.de"]
+  s.homepage    = "https://github.com/kgalli/search_qd"
+  s.summary     = %q{Quick and dirty fulltext search for an ActiveRecord model.}
+  s.description = %q{SearchQd provides a search method for string/text columns of an ActiveRecord model. The search itself is handled via simple SQL LIKE statements. That is why it is called quick and dirty.}
+ 
+  s.rubyforge_project = "search_qd"
+
+  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"]
+
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "sqlite3"
+
+  s.add_dependency "activerecord"
+end

data/spec/db_config.yml.example

@@ -0,0 +1,4 @@
+adapter: sqlite3
+database: search_qd.sqlite3
+pool: 5
+timeout: 5000

data/spec/search_qd_spec.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+require 'spec_helper.rb'
+
+# blog class represents active record class
+# which should be extended with functionality
+# provided by SearchQd module   
+ActiveRecord::Base.send(:include, SearchQd)
+class Blog < ActiveRecord::Base 
+  search_qd_columns :title, :content
+
+end
+
+describe SearchQd do
+  describe ".search_qd" do
+    before do
+      Blog.all.each do |blog|
+        blog.delete
+      end      
+      @blog1 = Blog.create title: "Find important blog using test as query", content: "This is some test text."
+      @blog2 = Blog.create title: "Do not find me", content: "This blog should not been found."
+      @blog3 = Blog.create title: "Second test", content: "Not very important."
+      @blog4 = Blog.create title: "Not important", content: "This is only some test content."
+
+    end
+
+    it "should find all blogs where title or content include test" do
+      Blog.search_qd("test").should eq([@blog1, @blog3, @blog4])  
+    end
+
+    it "should find all blogs where title or content include blog" do
+      Blog.search_qd("blog").should eq([@blog1, @blog2])      
+    end
+
+    it "should find all blogs where title includes test" do
+      Blog.search_qd("test", ["title"]).should eq([@blog1, @blog3])
+    end
+
+    it "should find all blogs where content includes important" do
+       Blog.search_qd("important", ["content"]).should eq([@blog3]) 
+    end
+    
+    it "should find all blogs where title or content include not important" do
+      Blog.search_qd("not important").should eq([@blog3, @blog4])
+    end
+
+  end
+
+  describe ".search_qd_conditions" do
+    it "creates SQL LIKE statement for search_qd_columns" do
+      search_string = "Test"
+      expected_output = " (title LIKE '%test%' OR content LIKE '%test%') "
+      Blog.send("search_qd_conditions", search_string).should eq expected_output
+    end
+   
+    it "creates SQL LIKE statement for dynamic fields" do
+      search_string = "Test"
+      search_fields = %w{ description title }
+      expected_output = " (description LIKE '%test%' OR title LIKE '%test%') "
+      Blog.send("search_qd_conditions", search_string, search_fields).should eq expected_output
+    end 
+
+    it "creates multiple SQL LIKE statements combined with AND for each word in search string" do
+      search_string = "Test SearchQd"
+      expected_output_word1 = " (title LIKE '%test%' OR content LIKE '%test%') "
+      expected_output_word2 = " (title LIKE '%searchqd%' OR content LIKE '%searchqd%') "
+      expected_output = [ expected_output_word1, expected_output_word2 ].join(" AND ")
+      Blog.send("search_qd_conditions", search_string).should eq expected_output
+    end
+  end  
+
+  describe ".search_qd_rm_special_chars" do
+    it "removes special characters" do
+      special_chars = "§$%&/(){}#.,´`!,;@"
+      Blog.send("search_qd_rm_special_chars", special_chars).should eq('')
+    end
+
+    it "does not remove word characters" do
+      word_character = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz"
+      Blog.send("search_qd_rm_special_chars", word_character).should eq(word_character)
+    end
+
+    it "does not remove numbers" do
+      numbers = "1234567890"
+      Blog.send("search_qd_rm_special_chars", numbers).should eq(numbers)
+    end
+
+    it "does not remove German umlauts" do
+      german_umlauts = "äÄüÜöÖ"
+      Blog.send("search_qd_rm_special_chars", german_umlauts).should eq(german_umlauts)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'yaml'
+require 'search_qd'
+
+config = YAML.load_file File.expand_path(File.dirname(__FILE__)+ '/db_config.yml')
+ActiveRecord::Base.establish_connection config

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: search_qd
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- kgalli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70355747987560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70355747987560
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70355747987140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70355747987140
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70355747986720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70355747986720
+description: SearchQd provides a search method for string/text columns of an ActiveRecord
+  model. The search itself is handled via simple SQL LIKE statements. That is why
+  it is called quick and dirty.
+email:
+- mail@kgalli.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/search_qd.rb
+- lib/search_qd/rails.rb
+- lib/search_qd/version.rb
+- search_qd.gemspec
+- spec/db_config.yml.example
+- spec/search_qd_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/kgalli/search_qd
+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: search_qd
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Quick and dirty fulltext search for an ActiveRecord model.
+test_files:
+- spec/db_config.yml.example
+- spec/search_qd_spec.rb
+- spec/spec_helper.rb