wvanbergen-scoped_search 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Willem van Bergen
+ 
+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.rdoc

@@ -0,0 +1,57 @@
+= scoped_search
+
+This simple plugin will make it easy to search your ActiveRecord models. Searching is performed using a query string, which should be passed to the named_scope +search_for+ that uses SQL %LIKE% conditions for searching.
+
+== Installation
+
+You can enable scoped_search as a Ruby gem. First, you have to install the gem on your system.
+
+  gem sources -a http://gems.github.com
+  sudo gem install wvanbergen-scoped_search
+
+Now, you must enable the gem in your +environment.rb+ configuration:
+  
+  Rails::Initializer.run do |config|
+    ...
+    config.gem 'wvanbergen-scoped_search', :lib => 'scoped_search'
+  end
+
+You can use scoped_search as a Rails plugin as well, but this is deprecated. Simply download or
+clone scoped_search into your +vendor/plugins+ directory of your project.
+
+== Usage
+
+First, you have to specify in what columns should be searched:
+
+  class Project < ActiveRecord::Base
+    searchable_on :name, :description
+  end
+
+Now, the +search_for+ scope is available for queries. You should pass a query string to the scope. This can be empty or nil, in which case all no search conditions are set (and all records will be returned).
+
+  Project.search_for(params[:q]).each { |project| ... }
+
+The search query language is simple. It supports these constructs:
+
+* words: some search keywords
+* phrases: "a single search phrase"
+* negation: "look for this" -"but do not look for this phrase and this" -word
+
+This functionality is build on named_scope. The searchable_on statement creates 
+a named_scope "search_for". Because of this, you can actually chain the call with
+other scopes. For example, this can be very useful if you only want to search in 
+projects that are accessible by a given user.
+
+  class Project < ActiveRecord::Base
+    searchable_on :name, :description
+    named_scope :accessible_by, lambda { |user| ... }
+  end
+  
+  # using chained named_scopes and will_paginate
+  Project.accessible_by(current_user).search_for(params[:q]).paginate(:page => params[:page], :include => :tasks)
+
+== Disclaimer
+
+This Rails plugin is written by Willem van Bergen for the Floorplanner.com website. It is 
+released under the <b>MIT license</b>. Please contact me (willem AT vanbergen DOT org if 
+you have any suggestions or remarks.

data/Rakefile

@@ -0,0 +1,70 @@
+require 'rubygems'
+
+load 'test/tasks.rake'
+ 
+desc 'Default: run unit tests.'
+task :default => :test
+
+namespace :gem do
+
+  desc "Sets the version and date of the scoped_search gem. Requires the VERSION environment variable."
+  task :version => [:manifest] do
+    
+    require 'date'
+    
+    new_version = ENV['VERSION']
+    raise "VERSION is required" unless /\d+(\.\d+)*/ =~ new_version
+    
+    spec_file = Dir['*.gemspec'].first
+    
+    spec = File.read(spec_file)
+    spec.gsub!(/^(\s*s\.version\s*=\s*)('|")(.+)('|")(\s*)$/) { "#{$1}'#{new_version}'#{$5}" }
+    spec.gsub!(/^(\s*s\.date\s*=\s*)('|")(.+)('|")(\s*)$/) { "#{$1}'#{Date.today.strftime('%Y-%m-%d')}'#{$5}" }    
+    File.open(spec_file, 'w') { |f| f << spec }
+  end
+  
+  task :tag => [:version] do
+    
+    new_version = ENV['VERSION']
+    raise "VERSION is required" unless /\d+(\.\d+)*/ =~ new_version
+        
+    sh "git add scoped_search.gemspec .manifest"
+    sh "git commit -m \"Set gem version to #{new_version}\""
+    sh "git push origin"    
+    sh "git tag -a \"scoped_search-#{new_version}\" -m \"Tagged version #{new_version}\""
+    sh "git push --tags"
+  end
+
+  desc "Builds a ruby gem for scoped_search"
+  task :build => [:manifest] do
+    system %[gem build scoped_search.gemspec]
+  end
+
+  desc %{Update ".manifest" with the latest list of project filenames. Respect\
+  .gitignore by excluding everything that git ignores. Update `files` and\
+  `test_files` arrays in "*.gemspec" file if it's present.}
+  task :manifest do
+    list = Dir['**/*'].sort
+    spec_file = Dir['*.gemspec'].first
+    list -= [spec_file] if spec_file
+  
+    File.read('.gitignore').each_line do |glob|
+      glob = glob.chomp.sub(/^\//, '')
+      list -= Dir[glob]
+      list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
+      puts "excluding #{glob}"
+    end
+ 
+    if spec_file
+      spec = File.read spec_file
+      spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+        assignment = $1
+        bunch = $2 ? list.grep(/^test.*_test\.rb$/) : list
+        '%s%%w(%s)' % [assignment, bunch.join(' ')]
+      end
+      
+      File.open(spec_file,   'w') {|f| f << spec }
+    end
+    File.open('.manifest', 'w') {|f| f << list.join("\n") }
+  end
+end

data/TODO

@@ -0,0 +1,14 @@
+TODO items for named_scope
+==========================
+Contact willem AT vanbergen DOT org if you want to help out
+
+
+New functionality:
+- Search model associations as well
+- Allow OR-queries
+
+Refactoring:
+- Better separation of query building and query string parser
+
+Testing:
+- More tests for the query string parser

data/init.rb

@@ -0,0 +1 @@
+require 'scoped_search'

data/lib/scoped_search/query_string_parser.rb

@@ -0,0 +1,70 @@
+module ScopedSearch::QueryStringParser
+  
+  def to_search_query
+    items = lex_for_query_string_parsing
+    search_conditions = []
+    
+    negate = false
+    items.each do |item|
+      case item
+      when :not
+        negate = true
+      else
+        search_conditions << (negate ? [item, :not] : [item])
+        negate = false
+      end
+    end
+    return search_conditions
+  end
+  
+  def lex_for_query_string_parsing
+    terms = []
+    current_term = ""
+    quoted_string_openend = false
+    
+    self.each_char do |char|
+      
+      case char
+      when /\s/
+        if quoted_string_openend
+          current_term << char
+        elsif current_term.length > 0
+          terms << current_term
+          current_term = ""
+        end
+      
+      when '-'
+        if quoted_string_openend || current_term.length > 0
+          current_term << char
+        else
+          terms << :not
+        end
+        
+      when '"'
+        if quoted_string_openend
+          if current_term.length > 0
+            if current_term[-1,1] == "\\"
+              current_term[-1] = char
+            else
+              terms << current_term
+              current_term = ""
+              quoted_string_openend = false
+            end
+          else 
+            quoted_string_openend = false
+          end
+
+        else
+          quoted_string_openend = true
+        end
+        
+      else
+        current_term << char
+      end
+      
+    end
+    terms << current_term if current_term.length > 0
+    return terms
+  end
+  
+end

data/lib/scoped_search.rb

@@ -0,0 +1,53 @@
+
+
+module ScopedSearch
+  
+  module ClassMethods
+  
+    # Creates a named scope in the class it was called upon
+    def searchable_on(*fields)
+      self.cattr_accessor :scoped_search_fields
+      self.scoped_search_fields = fields
+      self.named_scope :search_for, lambda { |keywords| self.build_scoped_search_conditions(keywords) }
+    end
+  
+    # Build a hash that is used for the named_scope search_for.
+    # This function will split the search_string into keywords, and search for all the keywords
+    # in the fields that were provided to searchable_on
+    def build_scoped_search_conditions(search_string)
+      if search_string.nil? || search_string.strip.blank?
+        return { :conditions => nil }
+      else
+        conditions = []
+        query_params = {}
+        class << search_string; include ScopedSearch::QueryStringParser; end # TODO: fix me!
+        
+        search_string.to_search_query.each_with_index do |search_condition, index|
+          keyword_name = "keyword_#{index}".to_sym
+          query_params[keyword_name] = "%#{search_condition.first}%" 
+
+          # a keyword may be found in any of the provided fields, so join the conitions with OR
+          if search_condition.length == 2 && search_condition.last == :not
+            keyword_conditions = self.scoped_search_fields.map do |field| 
+              field_name = connection.quote_table_name(table_name) + "." + connection.quote_column_name(field)
+              "(#{field_name} NOT LIKE :#{keyword_name.to_s} OR #{field_name} IS NULL)"
+            end
+            conditions << "(#{keyword_conditions.join(' AND ')})" 
+          else
+            keyword_conditions = self.scoped_search_fields.map do |field| 
+              field_name = connection.quote_table_name(table_name) + "." + connection.quote_column_name(field)
+              "#{field_name} LIKE :#{keyword_name.to_s}"
+            end
+            conditions << "(#{keyword_conditions.join(' OR ')})"
+          end
+        end
+      
+        # all keywords must be matched, so join the conditions with AND
+        return { :conditions => [conditions.join(' AND '), query_params] } 
+      end
+    end
+  end
+end
+
+require 'scoped_search/query_string_parser'
+ActiveRecord::Base.send(:extend, ScopedSearch::ClassMethods)

data/test/query_building_test.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class ScopedSearchTest < Test::Unit::TestCase
+
+  def setup
+    setup_db
+    SearchTestModel.create_corpus!
+  end
+
+  def teardown
+    teardown_db
+  end
+  
+  def test_enabling
+    assert !SearchTestModel.respond_to?(:search_for)
+    SearchTestModel.searchable_on :string_field, :text_field
+    assert SearchTestModel.respond_to?(:search_for)
+    
+    assert_equal ActiveRecord::NamedScope::Scope, SearchTestModel.search_for('test').class
+    
+  end
+  
+  def test_search
+    SearchTestModel.searchable_on :string_field, :text_field
+    
+    assert_equal 3, SearchTestModel.search_for('123').count
+    assert_equal 3, SearchTestModel.search_for('haLL').count
+    assert_equal 1, SearchTestModel.search_for('456').count    
+    assert_equal 2, SearchTestModel.search_for('ha 23').count        
+    assert_equal 0, SearchTestModel.search_for('wi').count 
+    
+    assert_equal 1, SearchTestModel.search_for('-hallo').count
+    assert_equal 4, SearchTestModel.search_for('-wi').count
+    assert_equal 3, SearchTestModel.search_for('-789').count    
+    assert_equal 2, SearchTestModel.search_for('123 -456').count
+  end
+
+end
+
+

data/test/query_string_parser_test.rb

@@ -0,0 +1,74 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class String
+  include ScopedSearch::QueryStringParser
+end
+
+class QueryStringParserTest < Test::Unit::TestCase
+
+  def test_empty_search_query
+    parsed = ''.lex_for_query_string_parsing
+    assert_equal 0, parsed.length    
+    
+    parsed = "\t  \n".lex_for_query_string_parsing
+    assert_equal 0, parsed.length    
+  end
+  
+  def test_single_keyword
+    
+    parsed = 'hallo'.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal 'hallo', parsed.first
+
+    parsed = '  hallo  '.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal 'hallo', parsed.first
+  end
+   
+  def test_multiple_keywords
+    parsed = '  hallo   willem'.lex_for_query_string_parsing
+    assert_equal 2, parsed.length
+    assert_equal 'willem', parsed.last
+  end
+  
+  def test_quoted_keywords
+    parsed = '  "hallo"'.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal 'hallo', parsed.first
+    
+    parsed = '  "hallo   willem"'.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal 'hallo   willem', parsed.first
+    
+    parsed = '  "hallo   willem'.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal 'hallo   willem', parsed.first
+    
+    parsed = '  "hallo   wi"llem"'.lex_for_query_string_parsing
+    assert_equal 2, parsed.length
+    assert_equal 'hallo   wi', parsed.first
+    assert_equal 'llem', parsed.last
+  end
+  
+  def test_quote_escaping
+    parsed = '  "hallo   wi\\"llem"'.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal 'hallo   wi"llem', parsed.first
+  
+    parsed = '"\\"hallo willem\\""'.lex_for_query_string_parsing
+    assert_equal 1, parsed.length
+    assert_equal '"hallo willem"', parsed.first
+  end
+  
+  def test_negation
+    parsed = '-willem'.lex_for_query_string_parsing
+    assert_equal 2, parsed.length
+    assert_equal :not, parsed.first
+
+    parsed = '123 -"456 789"'.lex_for_query_string_parsing
+    assert_equal 3, parsed.length
+    assert_equal '123', parsed[0] 
+    assert_equal :not, parsed[1] 
+    assert_equal '456 789', parsed[2] 
+  end
+end

data/test/tasks.rake

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+ 
+desc 'Test the scoped_search plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+  t.libs << 'test'
+end

data/test/test_helper.rb

@@ -0,0 +1,30 @@
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+
+require "#{File.dirname(__FILE__)}/../lib/scoped_search"
+
+def setup_db
+  ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :search_test_models do |t|
+      t.string :string_field
+      t.text :text_field
+      t.string :ignored_field
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each { |table| ActiveRecord::Base.connection.drop_table(table) }
+end
+
+class SearchTestModel < ActiveRecord::Base
+  def self.create_corpus!
+    create!(:string_field => "123", :text_field => "Hallo",     :ignored_field => "123 willem")
+    create!(:string_field => "456", :text_field => "Hallo 123", :ignored_field => "123")
+    create!(:string_field => "789", :text_field => "HALLO",     :ignored_field => "123456");
+    create!(:string_field => "123", :text_field => nil,         :ignored_field => "123456");
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: wvanbergen-scoped_search
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Willem van Bergen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-09-04 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Scoped search makes it easy to search your ActiveRecord-based models. It will create a named scope according to a provided query string. The named_scope can be used like any other named_scope, so it can be cchained or combined with will_paginate.
+email: willem@vanbergen.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- init.rb
+- lib
+- lib/scoped_search
+- lib/scoped_search.rb
+- lib/scoped_search/query_string_parser.rb
+- test
+- test/query_building_test.rb
+- test/query_string_parser_test.rb
+- test/tasks.rake
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/wvanbergen/scoped_search/wikis
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A Rails plugin to search your models using a named_scope
+test_files: 
+- test/query_building_test.rb
+- test/query_string_parser_test.rb