cql-ruby 0.7.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.7.1 2008-04-08
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 FIXME full name
+
+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/Manifest.txt

@@ -0,0 +1,37 @@
+History.txt
+License.txt
+Manifest.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/cql_ruby.rb
+lib/cql_ruby/version.rb
+lib/cql_ruby/cql_generator.rb
+lib/cql_ruby/cql_lexer.rb
+lib/cql_ruby/cql_nodes.rb
+lib/cql_ruby/cql_parser.rb
+lib/cql_ruby/cql_to_solr.rb
+log/debug.log
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/website.rake
+test/fixtures
+test/fixtures/sample_queries.txt
+test/test_cql_generator.rb
+test/test_cql_lexer.rb
+test/test_cql_nodes.rb
+test/test_cql_parser.rb
+test/test_cql_ruby.rb
+test/test_cql_to_solr.rb
+test/test_helper.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/README.txt

@@ -0,0 +1,191 @@
+= 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.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'cql_ruby/version'
+
+AUTHOR = 'Chick Markley'
+EMAIL = "chick@qrhino.com"
+DESCRIPTION = "CQL parser for Ruby"
+GEM_NAME = 'cql-ruby' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'cql-ruby' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "chickmarkley"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = CqlRuby::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'cql_ruby documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.extra_deps = ['builder']     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+  
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/cql_ruby.rb

@@ -0,0 +1,9 @@
+#$:.unshift(File.dirname(__FILE__)) unless
+#  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+#
+#Dir['map_by_method/**/*.rb'].sort.each { |lib| require lib }
+
+  require File.dirname(__FILE__) + '/cql_ruby/cql_nodes'
+  require File.dirname(__FILE__) + '/cql_ruby/cql_lexer'
+  require File.dirname(__FILE__) + '/cql_ruby/cql_parser'
+  require File.dirname(__FILE__) + '/cql_ruby/cql_to_solr'

data/lib/cql_ruby/cql_generator.rb

@@ -0,0 +1,133 @@
+module CqlRuby
+ 
+ # A generator that produces random CQL queries.
+ # <P>
+ # Why is that useful?  Mainly to produce test-cases for CQL parsers
+ # (including the <TT>CQLParser</TT> class in this package): you can
+ # generate a random search tree, render it to XCQL and remember the
+ # result.  Then decompile the tree to CQL, feed the generated CQL to
+ # the parser of your choice, and check that the XCQL it comes up with
+ # is the same what you got from your initial rendering.
+ # <P>
+ # This code is based on the same grammar as the <TT>CQLParser</TT> class in
+ # this distribution - there is a <TT>generate_<I>x</I>()</TT> method
+ # for each grammar element <I>X</I>.
+ #
+ # @version $Id: CQLGenerator.java,v 1.9 2007/07/03 15:41:35 mike Exp $
+ # @see   <A href="http://zing.z3950.org/cql/index.html"
+ #            >http://zing.z3950.org/cql/index.html</A>
+class CqlGenerator
+  attr_accessor :params, :rnd, :debug_mode
+  
+  def initialize( params )
+    @debug_mode = params[ :debug ] || false
+    @params = params
+    srand( params[ :seed ] ) if params and params[ :seed ]
+  end
+  
+  def debug( s )
+    puts( "DEBUG: #{s}" ) if @debug_mode
+  end
+
+  def generate_cql_query
+    return generate_search_clause  unless maybe( :complex_query )
+    
+    node1 = generate_cql_query
+    node2 = generate_search_clause
+    
+    if maybe( :proxOp ) 
+      # 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" ) )
+      end      
+    end
+    
+    generate_search_clause
+  end
+  
+  def generate_search_clause
+    return generate_cql_query if maybe( :complex_clause )
+    
+    index = generate_index
+    relation = generate_relation
+    term = generate_term
+    
+    CqlTermNode.new( index, relation, term )
+  end
+  
+  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"
+      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"
+      end
+    end
+    index
+  end
+  
+  def generate_relation
+    base = generate_base_relation
+    CqlRelation.new( base )
+  end
+  
+  def generate_base_relation
+    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"
+    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"
+    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 "="
+    end
+  end
+  
+  def maybe( key )
+    probability = @params[ key ] || ".1"
+    
+    dice = rand
+    threshold = probability.to_f
+    res = dice < threshold
+    
+    debug( "dice=#{dice} vs #{threshold} = #{res.to_s}" )
+    res
+  end
+
+end
+end