queryparser 1.0.0

data/COPYING

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/COPYRIGHT

@@ -0,0 +1,18 @@
+
+ QueryParser - Parse a plain language query into Lucene syntax
+ Copyright (C) 2008 Peter Hickman
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+

data/README

@@ -0,0 +1,14 @@
+
+QueryParser - Parse a plain language query into Lucene syntax
+Copyright (C) 2008 Peter Hickman
+
+Parse a plain language query in the format
+
+  apple not banana
+
+  apple or banana and fig or date
+
+and change them into a format suitable for use with Lucene or Solr.
+The plain text query can include braces to group things and the Lucene
+query can include both a similarity value and field boosting
+

data/Rakefile

@@ -0,0 +1,33 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rake/gempackagetask'
+
+$:.push 'lib'
+require 'queryparser'
+
+PKG_NAME    = 'queryparser'
+PKG_VERSION = QueryParser::VERSION
+
+spec = Gem::Specification.new do |s|
+  s.name              = PKG_NAME
+  s.version           = PKG_VERSION
+  s.summary           = 'Parse a natural language query into lucene query syntax'
+
+  s.files             = FileList['README', 'COPY*', 'Rakefile', 'lib/**/*.rb']
+  s.test_files        = FileList['test/*.rb']
+
+  s.has_rdoc          = true
+  s.rdoc_options     << '--title' << 'QueryParser' << '--charset' << 'utf-8'
+  s.extra_rdoc_files  = FileList['README', 'COPYING']
+
+  s.author            = 'Peter Hickman'
+  s.email             = 'peterhi@ntlworld.com'
+
+  s.homepage          = 'queryparser.rubyforge.org'
+  s.rubyforge_project = 'queryparser'
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.need_tar = true
+end

data/lib/queryparser.rb

@@ -0,0 +1,714 @@
+# Takes a query in plain english and turns it into a string 
+# suitable to passing to Lucene or Solr.
+#
+# Assuming a Lucene / Solr database that has the body of the
+# data in the +content+ field with the entry heading in a
+# +title+ field, sub headings in a +subheading+ field
+#
+#  p = QueryParser.new('content')
+#  l = p->parse("apple")            
+#    => "content:apple"
+#
+#  l = p->parse("apple and banana")          
+#    => "+(+content:apple +content:banana)"
+#
+#  l = p.parse('apple not banana or cherry') 
+#    => "+((+content:apple -content:banana) content:cherry)"
+#
+# Here we boost the score of those queries that also match the
+# title field of the document
+#
+#  p = QueryParser.new("content", nil, 'title' => '^10')
+#  l = p.parse("apple")
+#    => "content:apple title:apple^10"
+#
+# Now with an extra boosting for subheadings
+#
+#  p = QueryParser.new("content", nil, 'title' => '^10', 'subheading' => '^5')
+#  l = p.parse("apple")
+#    => "content:apple title:apple^10 subheading:apple^5"
+#
+# We can also change the similarity of the match. In Lucene terms
+# a similarity of 1.0 will mean that 'banana' will only match 'banana'.
+# However a similarity of 0.6 (entered as ~0.6) will allow 'banana' to 
+# match 'canada' which is only two letters different. The default similarity
+# in Lucene is 0.6 (if I remember correctly).
+#
+#  p = QueryParser.new("content", '~0.6', 'title' => '^10')
+#  l = p.parse("apple not banana")
+#    => "+(+content:apple~0.6 -content:banana~0.6) title:apple~0.6^10"
+
+class QueryParser
+  VERSION = '1.0.0'
+
+  def initialize(field, similarity = nil, boosts = {})
+    @field = field
+    @similarity = similarity
+    @boosts = boosts
+  end
+
+  # Takes a plain english query and converts it into a string
+  # that can be fed into Lucene or Solr. It will apply the 
+  # similarity and boostings set in the constructor.  
+  def parse(text)
+    a = tokenise(text)
+    b = expand(a)
+    check_braces(b)
+    has_content(b)
+
+    c = add_implicit_and(b)
+
+    d = maketree(c)
+    if d.class != Array then
+      d = [d]
+    end
+
+    f = process_not(d)
+    g = process_and_or(f, 'and')
+    h = process_and_or(g, 'or')
+
+    # Wrap everything in an and
+    s = QueryParser::And.new
+    s.add(h)
+
+    t = reduce(s)
+
+    b = QueryParser::Or.new
+    b.add(t.boostable())
+
+    a = Array.new
+    x = t.lucene(@field, @similarity)
+    if x[0].chr == '(' then
+      x = "+#{x}"
+    end
+    a << x
+      
+    @boosts.each_pair do |k, v|
+      x = [@similarity, v].join('')
+      a << b.lucene(k,x)
+    end
+
+    return a.join(' ')
+  end
+
+  private
+
+  # Split the string into tokens based on whitespace unless it is 
+  # enclosed in ' or ". Initially we classify everything as either
+  # a term or quoted.
+  #
+  # The input is a text string and the output a flat list of terms
+  def tokenise(text)
+    r = Array.new()
+
+    delimiter = ''
+    token = ''
+
+    text.split("").each do |char|
+      if delimiter == '' then
+        if char == '"' or char == "'" then
+          token = remove_punctuation(token)
+          r << QueryParser::Term.new(token) if token != ''
+          delimiter = char.dup
+          token = char.dup
+        elsif char == " " then
+          token = remove_punctuation(token)
+          r << QueryParser::Term.new(token) if token != ''
+          token = ''
+        else
+          token << char.dup
+        end
+      elsif delimiter == char then
+        token << char.dup
+        token = remove_punctuation(token)
+        r << QueryParser::Term.new(token) if token != ''
+        token = ''
+        delimiter = ''
+      else
+        token << char.dup
+      end
+    end
+
+    token = remove_punctuation(token)
+    r << QueryParser::Term.new(token) if token != ''
+
+    return r
+  end
+
+  # All our terms will be a-Z0-9 and ( and ). The rest is lost
+  def remove_punctuation(a)
+    if a == '' then
+      return a
+    end
+    
+    first = a[0].chr
+    last = a[-1].chr
+
+    quoted = false
+    if first == '"' or first == "'" then
+      if first == last then
+        quoted = true
+      end
+    end
+
+    b = a.gsub(/[^[:alnum:]()]/,' ')
+    c = b.gsub(/\s+/, ' ').strip
+
+    if quoted then
+      return ['"', c, '"'].join('')
+    else
+      return c
+    end
+  end
+
+  # If any terms have '(' or ')' in them then expand them up and tokenise
+  #
+  # The input is a list of terms, the output is a (possibly longer) list of terms
+  def expand(a)
+    r = Array.new
+
+    a.each do |i|
+      if i.type == 'term' and (i.data.index("(") or i.data.index(")")) then
+        x = i.data.gsub("(", " ( ").gsub(")", " ) ")
+        r << tokenise(x)
+      else
+        r << i
+      end
+    end
+
+    return r.flatten
+  end
+
+  # Create nested lists around the 'open' and 'close' ops
+  #
+  # The input is a list of terms, the output is a list of terms and lists of the same
+  def maketree(a)
+    r = Array.new
+
+    while x = a.shift do
+      case x.type
+      when "open"
+        y = maketree(a)
+        if y.size == 1 then
+          r << y[0]
+        elsif y.size > 1 then
+          r << y
+        end
+      when "close"
+        return r
+      else
+        r << x
+      end
+    end
+
+    if r.size == 1 then
+      return r[0]
+    else
+      return r
+    end
+  end
+
+  # Add the implicit 'and' after a term that is not itself an op
+  #
+  # The input is a list of terms and lists of same, the output is a (possibly longer) list of terms
+  def add_implicit_and(a)
+    r = Array.new
+
+    a.each do |i|
+      if r.size > 0 then
+        if previous_type(r.last) then
+          if current_type(i) then
+            r << QueryParser::Term.new('and')
+          end
+        else
+          if not current_type(i) then
+            raise QueryParser::Exceptions::MalformedQuery
+          end
+        end
+      end
+
+      r << i
+    end
+
+    if r.last.type == 'op' then
+      raise QueryParser::Exceptions::MalformedQuery
+    end
+
+    return r
+  end
+
+  # All these behave the same for adding an 'and'
+  def previous_type(i)
+    return (i.type == 'term' or i.type == 'close')
+  end
+  
+  def current_type(i)
+    return (i.type == 'term' or i.type == 'open' or i.data == 'not')
+  end
+
+  # The not picks up the term to it's right
+  #
+  # The 'Not' op terms in the list are converted into Not objects
+  def process_not(a)
+    r = Array.new
+    
+    # So we can handle a 'not not not apple' and the like
+    b = a.reverse
+
+    b.each do |i|
+      if i.class == Array then
+        i = process_not(i)
+      end
+      
+      if i.class == QueryParser::Term and i.type == 'op' and i.data == 'not' then
+        if r.size == 0 then
+          raise QueryParser::Exceptions::MalformedQuery
+        else
+          x = QueryParser::Not.new(r.pop)
+          r << x
+        end
+      else
+        r << i
+      end
+    end
+    
+    return r.reverse
+  end
+  
+  # Find all the 'and' and 'or' op terms and convert them into And and Or objects
+  def process_and_or(a, type)
+    # make sure that it is in an array
+    if a.class != Array then
+      a = [a]
+    end
+
+    r = Array.new
+    
+    has_op = false
+    s = nil
+
+    a.each do |i|
+      # First recurse into each element
+      if i.class == Array then
+        x = process_and_or(i, type)
+        if x.class == Array and x.size == 1 then
+          i = x.first
+        else
+          i = x
+        end
+      elsif i.class == QueryParser::Not then
+        x = process_and_or(i.contents, type)
+        if x.class == Array and x.size == 1 then
+          x = x.first
+        end
+        i = QueryParser::Not.new(x)
+      elsif i.class == QueryParser::And then
+        x = process_and_or(i.contents, type)
+        i = QueryParser::And.new()
+        i.add(x)
+      elsif i.class == QueryParser::Or then
+        x = process_and_or(i.contents, type)
+        i = QueryParser::Or.new()
+        i.add(x)
+      end
+      
+      if has_op == true then
+        s.add(i)
+        r << s
+        s = nil
+        has_op = false
+      elsif i.class == QueryParser::Term and i.type == 'op' and i.data == type then
+        has_op = true
+        if i.data == 'and' then
+          s = QueryParser::And.new
+        else
+          s = QueryParser::Or.new
+        end
+        
+        if r.size == 0 then
+          raise QueryParser::Exceptions::MalformedQuery
+        else
+          s.add(r.pop)
+        end
+      else
+        r << i
+      end
+    end
+  
+    if r.size == 1 then
+      return r[0]
+    else
+      return r
+    end
+  end
+
+  # Reduce the sets down
+  def reduce(a)
+    process = true
+
+    while process do
+      a = a.reduce
+      if a.reduced? == false then
+        process = false
+      end
+    end
+    
+    return a
+  end
+
+  # Check that the "(" and ")" are balanced
+  def check_braces(a)
+    counter = 0
+    
+    a.each do |i|
+      if i.type == 'open' then
+        counter += 1
+      elsif i.type == 'close' then
+        counter -= 1
+        if counter < 0 then
+          raise QueryParser::Exceptions::UnbalancedBraces
+        end
+      end
+    end
+    
+    if counter != 0 then
+      raise QueryParser::Exceptions::UnbalancedBraces
+    end
+  end
+
+  def has_content(a)
+    counter = 0
+    
+    a.each do |i|
+      if i.type == 'term' then
+        counter += 1
+      end
+    end
+    
+    if counter == 0 then
+      raise QueryParser::Exceptions::EmptyQuery
+    end
+  end
+end
+
+# The custom exceptions that may be thrown if there is some 
+# problem with the query.
+module QueryParser::Exceptions
+  # This exception will be thrown if the query is generally 
+  # malformed such as <tt>"apple and and banana"</tt> (too many
+  # <tt>and</tt>s), <tt>"apple not"</tt> (no term after the +not+)
+  # or <tt>"and apple"</tt> (no term before the +and+) and the like
+	class MalformedQuery < Exception
+	end
+
+  # This exception will be thrown if the query contains 
+  # unbalanaced braces
+	class UnbalancedBraces < Exception
+	end
+
+  # This exception will be thrown if the supplied query string is
+  # empty after removing the +and+, +or+, +not+, ( and )
+	class EmptyQuery < Exception
+	end
+end
+
+# A basic search term. The input query is tokenised into
+# terms which then cat manipulated to create the query tree.
+#
+# Generally you should not need to handle this class unless
+# you are changing the parser works.
+class QueryParser::Term
+  # Takes the token from the user's query and classify it:
+  #
+  # open:: The opening ( used to indicate the start of a parentisised part of the query.
+  # close:: The closing ) used to indicate the end of a parentisised part of the query.
+  # and:: The term indicating conjunction
+  # or:: The term indicating disjunction
+  # not:: The term indicating negation
+  # term:: None of the above. A term to find.
+  def initialize(data)
+    @type = 'term'
+    @data = data
+    @was_reduced = false
+
+    if @data == nil then
+      @data = ''
+    else
+      case @data.downcase
+        when "("
+          @type = "open"
+        when ")"
+          @type = "close"
+        when "and", "or", "not"
+          @type = 'op'
+          @data = @data.downcase
+      end
+    end
+  end
+  
+  attr_reader :type, :data
+
+  # Display the Term, useful for debugging and testing 
+  # the Term class in isolation
+  def inspect
+    "#{@type}:#{@data}"
+  end
+
+  # Convert a term into string usable in a Lucene query
+  # with an optional similarity
+  def lucene(field, suffix = nil)
+    "#{field}:#{@data}#{suffix}"
+  end
+
+  # Even though a term cannot, itself, be reduced the
+  # process will call this method on everything that
+  # is in the query. So we need to have this.
+  def reduce
+    @was_reduced = false
+    return self
+  end
+
+  # Return true if the previous call to #reduce did
+  # actually reduce the term. Again this is a method 
+  # universal to all parts of the query and so we 
+  # have to have it. But see #set_reduced to see why
+  # it can actually return true.
+  def reduced?
+    @was_reduced
+  end
+
+  # If the term was the only member of an +and+, +or+ or
+  # double (or any multiple of two) +not+ then it will replace
+  # the +and+, +or+ or +not+ in the query and therefore 
+  # the original term has reduced and this, the replacement
+  # term, needs to indicate that fact. This allows us to
+  # flag that.  
+  def set_reduced
+    @was_reduced = true
+  end
+
+  # The query can be traversed to return the terms
+  # that are considered *boostable*. In the following
+  # +apple+ will be considered positive and returned
+  # but +banana+ will not:
+  #
+  #   apple not banana
+  #
+  # Terms that are boostable can be used to improve
+  # the documents relavance / position in the results list.
+  def boostable(negative = false)
+    if negative == true then
+      return nil
+    else
+      return self
+    end
+  end
+end
+
+# The base class for the +and+ and +or+ sets.
+#
+# Generally you should not need to handle this class unless
+# you are changing the parser works.
+class QueryParser::Set
+  def initialize
+    @data = Array.new
+    @was_reduced = false
+  end
+
+  # Add a list of +terms+, +nots+ and other +sets+
+  # to the list of things that are in this part
+  # of the query.
+  #
+  # Can handle a list of items or just a single one.  
+  def add(*data)
+    data.each do |i|
+      if i.class == Array then
+        i.each {|j| add(j)}
+      else
+        @data << i
+      end
+    end
+  end
+
+  # Returns all the data held by this set
+  def contents
+    @data
+  end
+
+  # Display the set, useful for debugging and testing 
+  def inspect
+    r = Array.new
+    @data.each {|i|r << i.inspect}
+    "<#{self.inspect_class} #{r.join(' ')}>"
+  end
+
+  # Convert a set into string usable in a Lucene query
+  # with an optional similarity that needs to be passed
+  # to the Terms  
+  def lucene(field, similarity = nil)
+    r = Array.new
+    @data.each do |i|
+      x = ''
+      if self.class == QueryParser::And and i.class != QueryParser::Not then
+        x = '+'
+      end
+      x << i.lucene(field, similarity)
+      r << x
+    end
+
+    if r.size == 1 then
+      "#{r[0]}"
+    else
+      "(#{r.join(' ')})"
+    end
+  end
+
+  # A Set contained within a Set should fold the contents of the inner set
+  # into itself. Otherwise reduce the contents of the Set individually and 
+  # set the flag if the contents reduced
+  def reduce
+    r = Array.new
+    @was_reduced = false
+
+    @data.each do |i|
+      if self.class == i.class then
+        @was_reduced = true
+        i.contents.each do |c|
+          r << c.reduce
+        end
+      else
+        x = i.reduce
+        if x.reduced? then
+          @was_reduced = true
+        end
+        r << x
+      end
+    end
+
+    if r.size == 1 then
+      @was_reduced = true
+      r[0].set_reduced
+      return r.first
+    else
+      @data = r
+      return self
+    end
+  end
+
+  # Did calling #reduce on this set actually reduce it
+  def reduced?
+    @was_reduced
+  end
+
+  # Force the reduced flag to true
+  def set_reduced
+    @was_reduced = true
+  end
+
+  # Return all the boostable terms that are held
+  # in the set. Thus for
+  #
+  #  tom and dick and harry
+  #
+  # The terms +tom+, +dick+ and +harry+ are all considered
+  # boostable. However in
+  #
+  #  tom and dick and not harry
+  #
+  # Only the terms +tom+ and +dick+ are considered boostable
+  def boostable(negative = false)
+    r = Array.new
+    
+    @data.each do |i|
+      x = i.boostable(negative)
+      if x != nil then
+        r << x
+      end
+    end
+    
+    return r.flatten
+  end
+end
+
+# A subclass just to distinguish the +and+ from the +or+
+class QueryParser::And < QueryParser::Set
+	def inspect_class
+		"AND"
+	end
+end
+
+# A subclass just to distinguish the +and+ from the +or+
+class QueryParser::Or < QueryParser::Set
+	def inspect_class
+		"OR"
+	end
+end
+
+# Something to handle the +not+ term in a query
+#
+# Generally you should not need to handle this class unless
+# you are changing the parser works.
+class QueryParser::Not
+  # +not+ handles a single term and so it is added in
+  # initialisation rather than with an add method.
+  def initialize(data)
+    @data = data
+    @was_reduced = false
+  end
+
+  # Returns the data held by the +not+  
+  def contents
+    @data
+  end
+
+  # Display the +not+, useful for debugging
+  def inspect
+    "<NOT #{@data.inspect}>"
+  end
+  
+  # Convert a +not+ into string usable in a Lucene query
+  # passing the similarity on to the term contained by
+  # the +not+
+  def lucene(field, similarity = nil)
+    "-#{@data.lucene(field, similarity)}"
+  end
+
+  # Double negatives should be eliminated otherwise
+  def reduce
+    if @data.class == QueryParser::Not then
+      @was_reduced = true
+      x = @data.contents.reduce
+      x.set_reduced
+      return x
+    else
+      @data = @data.reduce
+      @was_reduced = @data.reduced?
+      return self
+    end
+  end
+
+  # Were the contents reduced?  
+  def reduced?
+    @was_reduced
+  end
+
+  # Sets the reduced flag to true  
+  def set_reduced
+    @was_reduced = true
+  end
+
+  # Return all the boostable terms that are held
+  # in the +not+. Thus for
+  #
+  #  tom and dick and harry
+  #
+  # The terms +tom+, +dick+ and +harry+ are all considered
+  # boostable. However in
+  #
+  #  tom and dick and not harry
+  #
+  # Only the terms +tom+ and +dick+ are considered boostable
+  def boostable(negative = false)
+    @data.boostable(!negative)
+  end
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: queryparser
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Peter Hickman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-21 00:00:00 +00:00
+default_executable: 
+dependencies: []
+
+description: 
+email: peterhi@ntlworld.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- COPYING
+files: 
+- README
+- COPYING
+- COPYRIGHT
+- Rakefile
+- lib/queryparser.rb
+has_rdoc: true
+homepage: queryparser.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --title
+- QueryParser
+- --charset
+- utf-8
+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: queryparser
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Parse a natural language query into lucene query syntax
+test_files: []
+