Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Evaluate any text against a collection of match rules
Ruby
Branch: master
Pull request Compare This branch is 42 commits behind igrigorik:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
benchmark
examples
lib
spec
.gitignore
README.rdoc
Rakefile
VERSION
textquery.gemspec

README.rdoc

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 © 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.

Something went wrong with that request. Please try again.