textquery 0.1.7 → 0.1.8

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# TextQuery
+
+Does it match? When regular expressions are not enough, textquery is the answer. For
+example, regular expressions cannot evaluate recursive rules and often result in
+overly verbose and complicated expressions.
+
+Textquery is a simple PEG grammar with support for:
+
+- AND (spaces are implicit AND's)
+- OR
+- NOT (- is an alias)
+- 'quoted strings'
+- fuzzy matching
+- case (in)sensitive
+- custom delimeters
+
+## Example
+
+```ruby
+TextQuery.new("'to be' OR NOT 'to_be'").match?("to be")   # => true
+
+TextQuery.new("-test").match?("some string of text")      # => true
+TextQuery.new("NOT test").match?("some string of text")   # => true
+
+TextQuery.new("a AND b").match?("b a")                    # => true
+TextQuery.new("a AND b").match?("a c")                    # => false
+
+q = TextQuery.new("a AND (b AND NOT (c OR d))")
+q.match?("d a b")                                         # => false
+q.match?("b")                                             # => false
+q.match?("a b cdefg")                                     # => true
+
+TextQuery.new("a~").match?("adf")                         # => true
+TextQuery.new("~a").match?("dfa")                         # => true
+TextQuery.new("~a~").match?("daf")                        # => true
+TextQuery.new("2~a~1").match?("edaf")                     # => true
+TextQuery.new("2~a~2").match?("edaf")                     # => false
+
+TextQuery.new("a", :ignorecase => true).match?("A b cD")  # => true
+```
+
+## License
+
+The MIT License - Copyright (c) 2011 Ilya Grigorik

data/Rakefile

@@ -1,19 +1,10 @@
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "textquery"
-    gemspec.summary = "Evaluate any text against a collection of match rules"
-    gemspec.description = gemspec.summary
-    gemspec.email = "ilya@igvita.com"
-    gemspec.homepage = "http://github.com/igrigorik/textquery"
-    gemspec.authors = ["Ilya Grigorik"]
-    gemspec.add_dependency("treetop")
-    gemspec.rubyforge_project = "textquery"
-  end
+require 'rspec/core/rake_task'
 
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
-end
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => [:spec]

data/lib/textquery/textquery.rb

@@ -17,7 +17,7 @@ else
   RegExp::IGNORECACASE = Regexp::IGNORECASE
 end
 
-FUZZY = RegExp.new('(\d)*(~)?([^~]+)(~)?(\d)*$')
+FUZZY = RegExp.new('(?:(\d)*(~))?([^~]+)(?:(~)?(\d)*)$')
 
 class WordMatch < Treetop::Runtime::SyntaxNode
 
@@ -52,6 +52,9 @@ class WordMatch < Treetop::Runtime::SyntaxNode
     end
   end
 
+  def accept(&block)
+    block.call(:value, text_value)
+  end
 end
 
 Treetop.load File.dirname(__FILE__) + "/textquery_grammar"
@@ -88,6 +91,16 @@ class TextQuery
   end
   alias :match? :eval
 
+  def accept(options = {}, &block)
+    update_options(options) if not options.empty?
+
+    if @query
+      @query.accept(&block)
+    else
+      raise TextQueryError, 'no query specified'
+    end
+  end
+
   def terminal_failures
     @parser.terminal_failures
   end
@@ -96,6 +109,6 @@ class TextQuery
 
     def update_options(options)
       @options = {:delim => ' '}.merge(options)
-      @options[:delim] = "(#{[@options[:delim]].flatten.map { |opt| RegExp.escape(opt) }.join("|")})"
+      @options[:delim] = "(#{[@options[:delim]].flatten.map { |opt| opt.is_a?(Regexp) ? opt : RegExp.escape(opt) }.join("|")})"
     end
 end

data/lib/textquery/textquery_grammar.treetop

@@ -9,12 +9,20 @@ grammar TextQueryGrammar
       def eval(text, opt)
         operator.eval(op1.eval(text, opt), op2.eval(text, opt))
       end
+
+      def accept(&block)
+        operator.accept(op1.accept(&block), op2.accept(&block), &block)
+      end
     }
     /
     op1:value [\s]+ op2:expression {
         def eval(text, opt)
           op1.eval(text, opt) && op2.eval(text, opt)
         end
+
+        def accept(&block)
+          block.call(:and, op1.accept(&block), op2.accept(&block))
+        end
       }
   end
 
@@ -23,12 +31,20 @@ grammar TextQueryGrammar
       def eval(a,b)
         a && b
       end
+
+      def accept(a, b, &block)
+        block.call(:and, a, b)
+      end
     }
     /
     'OR' {
       def eval(a,b)
         a || b
       end
+
+      def accept(a, b, &block)
+        block.call(:or, a, b)
+      end
     }
   end
 
@@ -37,6 +53,10 @@ grammar TextQueryGrammar
       def eval(a)
         not a
       end
+
+      def accept(a, &block)
+        block.call(:not, a)
+      end
     }
   end
 
@@ -69,24 +89,40 @@ grammar TextQueryGrammar
        def eval(text, opt)
          expression.eval(text, opt)
        end
+
+       def accept(&block)
+         expression.accept(&block)
+       end
     }
     /
     operator:unary space value {
       def eval(text, opt)
         operator.eval(value.eval(text, opt))
       end
+
+      def accept(&block)
+        operator.accept(value.accept(&block), &block)
+      end
     }
     /
     double_quote space double_quote_words space double_quote {
       def eval(text, opt)
         double_quote_words.eval(text, opt)
       end
+
+      def accept(&block)
+        double_quote_words.accept(&block)
+      end
     }
     /
     single_quote space single_quote_words space single_quote {
       def eval(text, opt)
         single_quote_words.eval(text, opt)
       end
+
+      def accept(&block)
+        single_quote_words.accept(&block)
+      end
     }
     /
     word

data/spec/textquery_spec.rb

@@ -1,10 +1,9 @@
 # encoding: UTF-8
 
-require "rubygems"
-require "spec"
+require "rspec"
 require "pp"
 
-require "lib/textquery"
+require "textquery"
 
 # Resources:
 # - http://github.com/nathansobo/treetop
@@ -137,6 +136,13 @@ describe TextQuery do
     parse('"to be" OR NOT "to be"').eval("to be").should be_true
   end
 
+  it "should accept unbalanced quotes" do
+    parse("awesome").eval("M&M's are awesome").should be_true
+    parse("M&M's").eval("M&M's are awesome").should be_true
+    parse("M&M's AND awesome").eval("M&M's are awesome").should be_true
+    parse("M&M's AND fail").eval("M&M's are awesome").should be_false
+  end
+
   it "should accept mixed quotes inside the exact match queries" do
     parse("seattle's best").eval("seattle's best").should be_true
 
@@ -204,6 +210,11 @@ describe TextQuery do
     q.parse("~更は出~ OR ~尽く~").eval(JP).should be_true
   end
 
+  it "should work with queries starting with numbers" do
+    q = TextQuery.new('3827')
+    q.parse('abc 123 3827 9382').should be_true
+  end
+
   it "should be case insensitive" do
     TextQuery.new("a", :ignorecase => true).match?("A b cD").should be_true
     TextQuery.new("a AND CD", :ignorecase => true).match?("A b cD").should be_true
@@ -236,5 +247,28 @@ describe TextQuery do
     it 'should not match just the delimiter' do
       TextQuery.new("a*b", :delim => ["*", "<"]).match?("over<under").should be_false
     end
+
+    it 'should accept a Regexp as a delimiter' do
+      TextQuery.new("a", :delim => [%r{\b}]).match?("a.b").should be_true
+      TextQuery.new("a b", :delim => [%r{\b}]).match?("a.b").should be_true
+      TextQuery.new("a b", :delim => [%r{\b}]).match?("a.c").should be_false
+    end
+
+    it 'should OR multiple Regexp delimiters and match on all words' do
+      TextQuery.new("cd", :delim => [%r{\d}, %r{\.\.}]).match?("ab2cd..ef").should be_true
+      TextQuery.new("ef", :delim => [%r{\d}, %r{\.\.}]).match?("ab2cd..ef").should be_true
+      TextQuery.new("ab2cd", :delim => [%r{\d}, %r{\.\.}]).match?("ab2cd..ef").should be_true
+    end
+
+    it 'should accept mixed Strings and Regexps as delimiters' do
+      TextQuery.new("a", :delim => [%r{a{2,3}}]).match?("aab").should be_false
+      TextQuery.new("a", :delim => [%r{a{2,3}}, 'b']).match?("aab").should be_false
+      TextQuery.new("b", :delim => [%r{a{2,3}}, 'a']).match?("aab").should be_true
+    end
+
+    it 'should allow query to be traversed' do
+      TextQuery.new("a b").accept { |*a| a }.should == [ :and, [ :value, 'a' ], [ :value, 'b' ] ]
+      TextQuery.new("a OR b").accept { |*a| a }.should == [ :or, [ :value, 'a' ], [ :value, 'b' ] ]
+    end
   end
 end

data/textquery.gemspec

@@ -1,56 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
-  s.name = %q{textquery}
-  s.version = "0.1.7"
+  s.name        = "textquery"
+  s.version     = "0.1.8"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Ilya Grigorik"]
-  s.date = %q{2010-09-04}
-  s.description = %q{Evaluate any text against a collection of match rules}
-  s.email = %q{ilya@igvita.com}
-  s.extra_rdoc_files = [
-    "README.rdoc"
-  ]
-  s.files = [
-    ".gitignore",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "benchmark/benchmark.rb",
-     "benchmark/sample.txt",
-     "examples/web.rb",
-     "lib/textquery.rb",
-     "lib/textquery/textquery.rb",
-     "lib/textquery/textquery_grammar.treetop",
-     "spec/textquery_spec.rb",
-     "textquery.gemspec"
-  ]
-  s.homepage = %q{http://github.com/igrigorik/textquery}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubyforge_project = %q{textquery}
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Evaluate any text against a collection of match rules}
-  s.test_files = [
-    "spec/textquery_spec.rb",
-     "examples/web.rb"
-  ]
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ilya Grigorik"]
+  s.email       = ["ilya@igvita.com"]
+  s.homepage    = "http://github.com/igrigorik/textquery"
+  s.summary     = "Evaluate any text against a collection of match rules"
+  s.description = s.summary
+  s.rubyforge_project = "textquery"
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.add_dependency "treetop"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rake"
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<treetop>, [">= 0"])
-    else
-      s.add_dependency(%q<treetop>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<treetop>, [">= 0"])
-  end
+  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"]
 end
-

metadata

@@ -1,48 +1,61 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: textquery
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 7
-  version: 0.1.7
+version: !ruby/object:Gem::Version
+  version: 0.1.8
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Ilya Grigorik
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-09-04 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-06-28 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: treetop
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2152520940 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *2152520940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152520500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152520500
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152520080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152520080
 description: Evaluate any text against a collection of match rules
-email: ilya@igvita.com
+email:
+- ilya@igvita.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
+extra_rdoc_files: []
+files:
 - .gitignore
-- README.rdoc
+- .rspec
+- Gemfile
+- README.md
 - Rakefile
-- VERSION
 - benchmark/benchmark.rb
 - benchmark/sample.txt
 - examples/web.rb
@@ -51,38 +64,29 @@ files:
 - lib/textquery/textquery_grammar.treetop
 - spec/textquery_spec.rb
 - textquery.gemspec
-has_rdoc: true
 homepage: http://github.com/igrigorik/textquery
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: textquery
-rubygems_version: 1.3.7
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Evaluate any text against a collection of match rules
-test_files: 
+test_files:
 - spec/textquery_spec.rb
-- examples/web.rb

data/README.rdoc

@@ -1,62 +0,0 @@
-= TextQuery
-
-Does it match? When regular expressions are not enough, textquery is the answer. For
-example, regular expressions cannot evaluate recursive rules and often result in
-overly verbose and complicated expressions.
-
-Textquery is a simple PEG grammar with support for:
-- AND (spaces are implicit AND's)
-- OR
-- NOT (- is an alias)
-- 'quoted strings'
-- fuzzy matching
-- case (in)sensitive
-- custom delimeters
-
-== Example
-
-  TextQuery.new("'to be' OR NOT 'to_be'").match?("to be")   # => true
-
-  TextQuery.new("-test").match?("some string of text")      # => true
-  TextQuery.new("NOT test").match?("some string of text")   # => true
-
-  TextQuery.new("a AND b").match?("b a")                    # => true
-  TextQuery.new("a AND b").match?("a c")                    # => false
-
-  q = TextQuery.new("a AND (b AND NOT (c OR d))")
-  q.match?("d a b")                                         # => false
-  q.match?("b")                                             # => false
-  q.match?("a b cdefg")                                     # => true
-
-  TextQuery.new("a~").match?("adf")                         # => true
-  TextQuery.new("~a").match?("dfa")                         # => true
-  TextQuery.new("~a~").match?("daf")                        # => true
-  TextQuery.new("2~a~1").match?("edaf")                     # => true
-  TextQuery.new("2~a~2").match?("edaf")                     # => false
-
-  TextQuery.new("a", :ignorecase => true).match?("A b cD")  # => true
-
-== License
-
-(The MIT License)
-
-Copyright (c) 2009 Ilya Grigorik
-
-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/VERSION

@@ -1 +0,0 @@
-0.1.7