cql-ruby 0.8.2 → 0.9.0

data/README.md

@@ -0,0 +1,40 @@
+# What
+
+cql-ruby provides a common querly language (CQL) parser. CQL is a format frequently used in the library world. This parser was translated from the CQL-Java parser written by Mike Taylor available here http://zing.z3950.org/cql/java/
+
+The parser builds a CQL parse tree suitable to serializing to various forms, built in are to_cql, to_xcql and to_solr (build a solr-lucene search query from cql)
+
+# Installing
+
+    sudo gem install cql_ruby
+
+# The basics
+
+You have been asked to provide SRU access to your website, so that the dynamic and exciting library community can find and promote access to and awareness of your rich content. You discover that in order to support SRU, dang! you need a CQL parser. Well now you have one.
+
+# Demonstration of usage
+
+  require 'cql_ruby'
+  parser = CqlRuby::CqlParser.new
+  puts parser.parse( 'dog and cat' ).to_solr
+
+# Listserv
+
+http://groups.google.com/group/cql_ruby
+
+# Project
+
+https://github.com/jrochkind/cql-ruby
+
+
+# License
+
+This code is free to use under the terms of the LGPL license.
+
+# Contact
+
+Comments are welcome. Best way to send them is to via the listserv
+
+Chick Markley, from 9th April 2008
+Jonathan Rochkind, from 14 June 2010
+

data/lib/cql_ruby/cql_generator.rb

@@ -39,9 +39,9 @@ class CqlGenerator
       # TODO: generate proximity nodes
     else
       case rand( 3 )
-      when 0: return CqlAndNode.new( node1, node2, ModifierSet.new( "and" ) )
-      when 1: return CqlOrNode.new( node1, node2, ModifierSet.new( "or" ) )
-      when 2: return CqlNotNode.new( node1, node2, ModifierSet.new( "or" ) )
+      when 0 then return CqlAndNode.new( node1, node2, ModifierSet.new( "and" ) )
+      when 1 then return CqlOrNode.new( node1, node2, ModifierSet.new( "or" ) )
+      when 2 then return CqlNotNode.new( node1, node2, ModifierSet.new( "or" ) )
       end      
     end
     
@@ -61,16 +61,16 @@ class CqlGenerator
   def generate_index
     if rand(2) == 0 
       case rand(3)
-        when 0: index = "dc.author"
-        when 1: index = "dc.title"
-        when 2: index = "dc.subject"
+        when 0 then index = "dc.author"
+        when 1 then index = "dc.title"
+        when 2 then index = "dc.subject"
       end
     else
       case rand(4)
-        when 0: index = "bath.author"
-        when 1: index = "bath.title"
-        when 2: index = "bath.subject"
-        when 3: index = "foo>bar"
+        when 0 then index = "bath.author"
+        when 1 then index = "bath.title"
+        when 2 then index = "bath.subject"
+        when 3 then index = "foo>bar"
       end
     end
     index
@@ -85,36 +85,36 @@ class CqlGenerator
     return "=" if maybe( :equals_relation )
     return generate_numeric_relation if maybe( :numeric_relation )
     case rand(3)
-      when 0: index = "exact"
-      when 1: index = "all"
-      when 2: index = "any"
+      when 0 then index = "exact"
+      when 1 then index = "all"
+      when 2 then index = "any"
     end
     index
   end
   
   def generate_term
     case rand(10)
-      when 0: return "cat"
-      when 1: return "\"cat\""
-      when 2: return "comp.os.linux"
-      when 3: return "xml:element"
-      when 4: return "<xml.element>"
-      when 5: return "prox/word/>=/5"
-      when 6: return ""
-      when 7: return "frog fish"
-      when 8: return "the complete dinosaur"
-      when 9: return "foo*bar"
+      when 0 then return "cat"
+      when 1 then return "\"cat\""
+      when 2 then return "comp.os.linux"
+      when 3 then return "xml:element"
+      when 4 then return "<xml.element>"
+      when 5 then return "prox/word/>=/5"
+      when 6 then return ""
+      when 7 then return "frog fish"
+      when 8 then return "the complete dinosaur"
+      when 9 then return "foo*bar"
     end
   end
   
   def generate_numeric_relation
     case rand(6)
-      when 0: return "<"
-      when 1: return ">"
-      when 2: return "<="
-      when 3: return ">="
-      when 4: return "<>"
-      when 5: return "="
+      when 0 then return "<"
+      when 1 then return ">"
+      when 2 then return "<="
+      when 3 then return ">="
+      when 4 then return "<>"
+      when 5 then return "="
     end
   end
   

data/lib/cql_ruby/cql_lexer.rb

@@ -156,15 +156,15 @@ class CqlLexer
   def render( token=nil, quote_chars=true )
     token = @token_type unless token
     case token
-      when CqlLexer::TT_EOF: "EOF"
-      when CqlLexer::TT_NUMBER: @value
-      when CqlLexer::TT_WORD: "word:#{@value}"
-      when "'": "string:\"#{@value}\""
-      when CqlLexer::TT_LE: "<="
-      when CqlLexer::TT_GE: ">="
-      when CqlLexer::TT_NE: "<>"
-      when CqlLexer::TT_EQEQ: "=="
-      when CqlLexer::TT_EOF: "EOF"
+      when CqlLexer::TT_EOF then "EOF"
+      when CqlLexer::TT_NUMBER then @value
+      when CqlLexer::TT_WORD then "word:#{@value}"
+      when "'" then "string:\"#{@value}\""
+      when CqlLexer::TT_LE then "<="
+      when CqlLexer::TT_GE then ">="
+      when CqlLexer::TT_NE then "<>"
+      when CqlLexer::TT_EQEQ then "=="
+      when CqlLexer::TT_EOF then "EOF"
     else
       if @@keywords.has_value?( @value )
         @value

data/lib/cql_ruby/cql_parser.rb

@@ -68,10 +68,10 @@ class CqlParser
         ms = gather_modifiers( value )
         term2 = parse_term( index, relation )
         term = case token_type
-                when CqlLexer::TT_AND: CqlAndNode.new( term, term2, ms )
-                when CqlLexer::TT_OR: CqlOrNode.new( term, term2, ms )
-                when CqlLexer::TT_NOT: CqlNotNode.new( term, term2, ms )
-                when CqlLexer::TT_PROX: CqlProxNode.new( term, term2, ms )
+                when CqlLexer::TT_AND then CqlAndNode.new( term, term2, ms )
+                when CqlLexer::TT_OR then CqlOrNode.new( term, term2, ms )
+                when CqlLexer::TT_NOT then CqlNotNode.new( term, term2, ms )
+                when CqlLexer::TT_PROX then CqlProxNode.new( term, term2, ms )
               end
         
       else

data/lib/cql_ruby/cql_to_solr.rb

@@ -117,13 +117,13 @@ class CqlTermNode
       when "<>"
         negate = true
         maybe_quote(@term)
-      when "cql.adj", "==":   maybe_quote(@term)                                
-      when "cql.all": '(' + @term.split(/\s/).collect{|a| '+'+a}.join(" ") + ')'          
-      when "cql.any":         '(' + @term.split(/\s/).join(" OR ") + ')'          
-      when ">=":              "[" + maybe_quote(@term) + " TO *]"          
-      when ">":               "{" + maybe_quote(@term) + " TO *}"          
-      when "<=":              "[* TO " + maybe_quote(@term) + "]"          
-      when "<":               "{* TO " + maybe_quote(@term) + "}"
+      when "cql.adj", "==" then   maybe_quote(@term)                                
+      when "cql.all" then '(' + @term.split(/\s/).collect{|a| '+'+a}.join(" ") + ')'          
+      when "cql.any" then         '(' + @term.split(/\s/).join(" OR ") + ')'          
+      when ">=" then              "[" + maybe_quote(@term) + " TO *]"          
+      when ">" then               "{" + maybe_quote(@term) + " TO *}"          
+      when "<=" then              "[* TO " + maybe_quote(@term) + "]"          
+      when "<" then               "{* TO " + maybe_quote(@term) + "}"
       when "cql.within"
         bounds = @term.gsub('"', "").split(/\s/)
         raise CqlException.new("can not extract two bounding values from within relation term: #{@term}") unless bounds.length == 2

data/test/test_cql_parser.rb

@@ -7,6 +7,7 @@ class TestCqlParser < Test::Unit::TestCase
     lines = IO.readlines( File.dirname(__FILE__) + '/fixtures/sample_queries.txt' )
     lines.each do |line|
       next if /^\s*#/ =~ line
+      next if /^(\s|\n)*$/ =~ line
       begin
       tree = parser.parse( line )
       puts "in=#{line} out=#{tree.to_cql}" if tree

metadata

@@ -1,34 +1,25 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: cql-ruby
-version: !ruby/object:Gem::Version 
-  hash: 59
-  prerelease: false
-  segments: 
-  - 0
-  - 8
-  - 2
-  version: 0.8.2
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Jonathan Rochkind
 - Chick Markley
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-07-07 00:00:00 -04:00
-default_executable: 
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies: []
-
-description: " CQL Parser, with serialization from cql node tree to cql, xcql, and solr query"
+description: ! ' CQL Parser, with serialization from cql node tree to cql, xcql, and
+  solr query'
 email: cql_ruby@googlegroups.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.txt
-files: 
+extra_rdoc_files:
+- README.md
+files:
 - lib/cql_ruby.rb
 - lib/cql_ruby/cql_generator.rb
 - lib/cql_ruby/cql_lexer.rb
@@ -36,7 +27,7 @@ files:
 - lib/cql_ruby/cql_parser.rb
 - lib/cql_ruby/cql_to_solr.rb
 - lib/cql_ruby/version.rb
-- README.txt
+- README.md
 - test/test_cql_parser.rb
 - test/test_cql_nodes.rb
 - test/test_cql_generator.rb
@@ -45,41 +36,32 @@ files:
 - test/test_helper.rb
 - test/helper.rb
 - test/test_cql_to_solr.rb
-has_rdoc: true
-homepage: http://cql-ruby.rubyforge.org/
+homepage: https://github.com/jrochkind/cql-ruby
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: cql-ruby
-rubygems_version: 1.3.7
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: CQL Parser
-test_files: 
+test_files:
 - test/test_cql_parser.rb
 - test/test_cql_nodes.rb
 - test/test_cql_generator.rb

data/README.txt

@@ -1,191 +0,0 @@
-= cql_ruby
-
-* FIX (url)
-
-== DESCRIPTION:
-
-FIX (describe your package)
-
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-builder
-
-== INSTALL:
-
-sudo gem install cql-ruby
-
-== LICENSE:
-
-		   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions. 
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version. 
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser 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
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.