wvanbergen-scoped_search 0.1.2 → 0.1.3

data/README.rdoc

@@ -1,21 +1,18 @@
 = 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.
+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 <tt>search_for</tt> that uses SQL %LIKE% conditions for searching. You can specify what fields should be used 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:
+You can enable <tt>scoped_search</tt> as a Ruby gem. You must enable the gem in your <tt>environment.rb</tt> configuration:
   
   Rails::Initializer.run do |config|
     ...
-    config.gem 'wvanbergen-scoped_search', :lib => 'scoped_search'
+    config.gem 'wvanbergen-scoped_search', :lib => 'scoped_search', :source => 'http://gems.github.com/'
   end
 
+Make sure the gem is installed by running <tt>rake gems:install</tt> in you project root. You can also install the gem by running <tt>sudo gem install wvanbergen-scoped_search -s http://gems.github.com</tt>
+
 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.
 

data/lib/scoped_search.rb

@@ -1,9 +1,11 @@
-
-
 module ScopedSearch
   
   module ClassMethods
   
+    def self.extended(base)
+      require 'scoped_search/query_language_parser'
+    end
+  
     # Creates a named scope in the class it was called upon
     def searchable_on(*fields)
       self.cattr_accessor :scoped_search_fields
@@ -20,9 +22,8 @@ module ScopedSearch
       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|
+      
+        QueryLanguageParser.parse(search_string).each_with_index do |search_condition, index|
           keyword_name = "keyword_#{index}".to_sym
           query_params[keyword_name] = "%#{search_condition.first}%" 
 
@@ -49,5 +50,4 @@ module ScopedSearch
   end
 end
 
-require 'scoped_search/query_string_parser'
 ActiveRecord::Base.send(:extend, ScopedSearch::ClassMethods)

data/lib/scoped_search/query_language_parser.rb

@@ -0,0 +1,81 @@
+module ScopedSearch
+  
+  class QueryLanguageParser
+    
+    def parse_query(query = nil)
+      return build_conditions_tree(tokenize(query))
+    end
+    
+    def self.parse(query)
+      self.new.parse_query(query)
+    end
+    
+    protected
+  
+    def build_conditions_tree(tokens)
+      conditions_tree = []
+    
+      negate = false
+      tokens.each do |item|
+        case item
+        when :not
+          negate = true
+        else
+          conditions_tree << (negate ? [item, :not] : [item, :like])
+          negate = false
+        end
+      end
+      return conditions_tree
+    end
+  
+    def tokenize(query)
+      tokens = []
+      current_token = ""
+      quoted_string_openend = false
+    
+      query.each_char do |char|
+      
+        case char
+        when /\s/
+          if quoted_string_openend
+            current_token << char
+          elsif current_token.length > 0
+            tokens << current_token
+            current_token = ""
+          end
+      
+        when '-'
+          if quoted_string_openend || current_token.length > 0
+            current_token << char
+          else
+            tokens << :not
+          end
+        
+        when '"'
+          if quoted_string_openend
+            if current_token.length > 0
+              if current_token[-1,1] == "\\"
+                current_token[-1] = char
+              else
+                tokens << current_token
+                current_token = ""
+                quoted_string_openend = false
+              end
+            else 
+              quoted_string_openend = false
+            end
+
+          else
+            quoted_string_openend = true
+          end
+        
+        else
+          current_token << char
+        end
+      
+      end
+      tokens << current_token if current_token.length > 0
+      return tokens
+    end
+  end
+end

data/test/query_language_test.rb

@@ -0,0 +1,84 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class QueryLanguageTest < Test::Unit::TestCase
+
+  # change this function if you switch to another query language parser
+  def parse_query(query)
+    ScopedSearch::QueryLanguageParser.parse(query)
+  end
+  
+  def test_empty_search_query
+    parsed = parse_query('')
+    assert_equal 0, parsed.length    
+    
+    parsed = parse_query("\t  \n")
+    assert_equal 0, parsed.length    
+  end
+  
+  def test_single_keyword
+    parsed = parse_query('hallo')
+    assert_equal 1, parsed.length
+    assert_equal 'hallo', parsed.first.first
+
+    parsed = parse_query('  hallo  ')
+    assert_equal 1, parsed.length
+    assert_equal 'hallo', parsed.first.first
+  end
+   
+  def test_multiple_keywords
+    parsed = parse_query('  hallo  willem')
+    assert_equal 2, parsed.length
+    assert_equal 'willem', parsed.last.first
+    
+    parsed = parse_query("  hallo  willem   van\tbergen ")
+    assert_equal 4, parsed.length    
+    assert_equal 'hallo',  parsed[0].first
+    assert_equal 'willem', parsed[1].first
+    assert_equal 'van',    parsed[2].first
+    assert_equal 'bergen', parsed[3].first      
+  end
+  
+  def test_quoted_keywords
+    parsed = parse_query('  "hallo"')    
+    assert_equal 1, parsed.length
+    assert_equal 'hallo', parsed.first.first
+    
+    parsed = parse_query('  "hallo   willem"')
+    assert_equal 1, parsed.length
+    assert_equal 'hallo   willem', parsed.first.first
+    
+    parsed = parse_query('  "hallo   willem')
+    assert_equal 1, parsed.length
+    assert_equal 'hallo   willem', parsed.first.first
+    
+    parsed = parse_query('  "hallo   wi"llem"')
+    assert_equal 2, parsed.length
+    assert_equal 'hallo   wi', parsed.first.first
+    assert_equal 'llem', parsed.last.first
+  end
+  
+  def test_quote_escaping
+    parsed = parse_query('  "hallo   wi\\"llem"')
+    assert_equal 1, parsed.length
+    assert_equal 'hallo   wi"llem', parsed.first.first
+  
+    parsed = parse_query('"\\"hallo willem\\""')
+    assert_equal 1, parsed.length
+    assert_equal '"hallo willem"', parsed.first.first
+  end
+
+  def test_negation
+    parsed = parse_query('-willem')
+    assert_equal 1, parsed.length
+    assert_equal 'willem', parsed.first.first
+    assert_equal :not, parsed.first.last
+  
+    parsed = parse_query('123 -"456 789"')
+    assert_equal 2, parsed.length
+    assert_equal '123', parsed.first.first
+    assert_equal :like, parsed.first.last    
+    
+    assert_equal '456 789', parsed.last.first
+    assert_equal :not, parsed.last.last
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wvanbergen-scoped_search
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Willem van Bergen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-04 00:00:00 -07:00
+date: 2008-09-06 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -30,10 +30,10 @@ files:
 - lib
 - lib/scoped_search
 - lib/scoped_search.rb
-- lib/scoped_search/query_string_parser.rb
+- lib/scoped_search/query_language_parser.rb
 - test
-- test/query_building_test.rb
-- test/query_string_parser_test.rb
+- test/query_language_test.rb
+- test/search_for_test.rb
 - test/tasks.rake
 - test/test_helper.rb
 has_rdoc: false
@@ -63,5 +63,5 @@ 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
+- test/query_language_test.rb
+- test/search_for_test.rb

data/lib/scoped_search/query_string_parser.rb

@@ -1,70 +0,0 @@
-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/test/query_string_parser_test.rb

@@ -1,74 +0,0 @@
-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