querybuilder 0.5.5 → 0.5.6

data/History.txt

@@ -1,7 +1,6 @@
-== 0.5.4 2009-06-04
-
-* 1 minor enhancement:
-  * Added 'use_name' to 'add_table' so you can add tables under a different name
+== 0.5.6 2009-10-15
+* 1 minor enhancement
+  * Fixed library name (was not loaded on case sensitive systems)
 
 == 0.5.4 2009-04-09
 
@@ -18,12 +17,12 @@
 * 1 minor enhancement:
   * Added support for main_table option in custom queries
   * More tests for custom queries
-  
+
 == 0.5.1 2009-03-03
 
 * 1 minor enhancement:
   * Added support for glob directories in load_custom_queries
-  
+
 == 0.5.0 2009-01-23
 
 * 1 major enhancement:

data/Manifest.txt

@@ -2,7 +2,8 @@ History.txt
 Manifest.txt
 README.rdoc
 Rakefile
-lib/QueryBuilder.rb
+lib/query_builder.rb
+lib/querybuilder.rb
 script/console
 script/destroy
 script/generate

data/README.rdoc

@@ -1,6 +1,6 @@
 = QueryBuilder
 
-* http://zenadmin.org/524
+* http://github.com/zena/querybuilder/tree/master
 
 == DESCRIPTION:
 

data/Rakefile

@@ -1,5 +1,5 @@
 %w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/QueryBuilder'
+require File.dirname(__FILE__) + '/lib/query_builder'
 
 # Generate all the Rake tasks
 # Run 'rake -T' to see list of generated tasks (from gem root directory)
@@ -13,7 +13,7 @@ $hoe = Hoe.new('querybuilder', QueryBuilder::VERSION) do |p|
   p.extra_dev_deps = [
     ['newgem', ">= #{::Newgem::VERSION}"]
   ]
-  
+
   p.clean_globs |= %w[**/.DS_Store tmp *.log]
   path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
   p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')

data/lib/{QueryBuilder.rb → query_builder.rb}

@@ -10,24 +10,24 @@ Syntax of a query is "RELATION [where ...|] [in ...|from SUB_QUERY|]".
 =end
 class QueryBuilder
   attr_reader :tables, :where, :errors, :join_tables, :distinct, :final_parser, :page_size
-  VERSION = '0.5.5'
-  
+  VERSION = '0.5.6'
+
   @@main_table = {}
   @@main_class = {}
   @@custom_queries = {}
-  
+
   class << self
     # This is the table name of the main class.
     def set_main_table(table_name)
       @@main_table[self] = table_name.to_s
     end
-    
+
     # This is the class of the returned elements if there is no class change in the query. This
     # should correspond to the class used to build call "Foo.find_by_sql(...)" (Foo).
     def set_main_class(main_class)
       @@main_class[self] = main_class.to_s
     end
-    
+
     # Load prepared SQL definitions from a set of directories. If the file does not contain "host" or "hosts" keys,
     # the filename is used as host.
     #
@@ -87,11 +87,11 @@ class QueryBuilder
     rescue NameError => err
       raise ArgumentError.new("invalid class for CustomQueries (#{klass})")
     end
-    
+
     # Return the parser built from the query. The class of the returned object can be different
     # from the class used to call "new". For example: NodeQuery.new("comments from nodes in project") would
     # return a CommentQuery since that is the final fetched objects (final_parser).
-    # 
+    #
     # ==== Parameters
     # query<String>:: Pseudo sql query string.
     # opts<Hash>:: List of options.
@@ -111,7 +111,7 @@ class QueryBuilder
       obj.final_parser
     end
   end
-  
+
   # Build a new query from a pseudo sql string. See QueryBuilder::new for details.
   def initialize(query, opts = {})
     if opts[:pre_query]
@@ -119,10 +119,10 @@ class QueryBuilder
     else
       init_with_query(query, opts)
     end
-    
+
     parse_elements(@elements)
   end
-  
+
   # Convert query object to a string. This string should then be evaluated.
   #
   # ==== Parameters
@@ -147,7 +147,7 @@ class QueryBuilder
     statement, bind_values = build_statement(type)
     bind_values.empty? ? "\"#{statement}\"" : "[#{[["\"#{statement}\""] + bind_values].join(', ')}]"
   end
-  
+
   # Convert the query object into an SQL query.
   #
   # ==== Parameters
@@ -171,8 +171,8 @@ class QueryBuilder
     connection = get_connection(bindings)
     statement.gsub('?') { eval_bound_value(bind_values.shift, connection, bindings) }
   end
-  
-  
+
+
   # Test query validity
   #
   # ==== Returns
@@ -180,7 +180,7 @@ class QueryBuilder
   def valid?
     @errors == []
   end
-  
+
   # Name of the pagination key when 'paginate' is used.
   #
   # ==== Parameters
@@ -195,7 +195,7 @@ class QueryBuilder
   def pagination_key
     @offset_limit_order_group[:paginate]
   end
-  
+
   # Main class for the query (useful when queries move from class to class)
   #
   # ==== Returns
@@ -207,22 +207,22 @@ class QueryBuilder
   def main_class
     Module.const_get(@@main_class[self.class])
   end
-  
+
   protected
-    
+
     def current_table
       @current_table || main_table
     end
-    
+
     def main_table
       @main_table || @@main_table[self.class]
     end
-  
+
     def parse_part(part, is_last)
-      
+
       rest,   context = part.split(' in ')
       clause, filters = rest.split(/\s+where\s+/)
-      
+
       if @just_changed_class
         # just changed class: parse filters && context
         parse_filters(filters) if filters
@@ -243,7 +243,7 @@ class QueryBuilder
         return nil
       end
     end
-    
+
     def parse_filters(clause)
       # TODO: add 'match' parameter (#105)
       rest         = clause.strip
@@ -261,15 +261,15 @@ class QueryBuilder
           res << " "
         elsif rest[0..0] == '('
           unless allowed.include?(:par_open)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           res << '('
           rest = rest[1..-1]
           par_count += 1
-        elsif rest[0..0] == ')'  
+        elsif rest[0..0] == ')'
           unless allowed.include?(:par_close)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           res << ')'
@@ -282,7 +282,7 @@ class QueryBuilder
           allowed = [:op, :bool_op]
         elsif rest =~ /\A((>=|<=|<>|\!=|<|=|>)|((not\s+like|like|lt|le|eq|ne|ge|gt)\s+))/
           unless allowed.include?(:op)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           op = $1.strip
@@ -290,9 +290,9 @@ class QueryBuilder
           op = {'lt' => '<', 'le' => '<=', 'eq' => '=', 'ne' => '<>', '!=' => '<>', 'ge' => '>=', 'gt' => '>', 'like' => 'LIKE', 'not like' => 'NOT LIKE'}[op] || $1
           res << op
           allowed = [:value, :par_open]
-        elsif rest =~ /\A("|')([^\1]*?)\1/  
+        elsif rest =~ /\A("|')([^\1]*?)\1/
           unless allowed.include?(:value)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
@@ -300,7 +300,7 @@ class QueryBuilder
           allowed = after_value
         elsif rest =~ /\A(\d+|[\w:]+)\s+(second|minute|hour|day|week|month|year)s?/
           unless allowed.include?(:value)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
@@ -311,9 +311,9 @@ class QueryBuilder
           end
           res << "INTERVAL #{field} #{type.upcase}"
           allowed = after_value
-        elsif rest =~ /\A(-?\d+)/  
+        elsif rest =~ /\A(-?\d+)/
           unless allowed.include?(:value)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
@@ -321,23 +321,23 @@ class QueryBuilder
           allowed = after_value
         elsif rest =~ /\A(is\s+not\s+null|is\s+null)/
           unless allowed.include?(:bool_op)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
           res << $1.upcase
           allowed = [:par_close, :bool_op]
-        elsif rest[0..7] == 'REF_DATE'  
+        elsif rest[0..7] == 'REF_DATE'
           unless allowed.include?(:value)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[8..-1]
           res << @ref_date
           allowed = after_value
-        elsif rest =~ /\A(\+|\-)/  
+        elsif rest =~ /\A(\+|\-)/
           unless allowed.include?(:op)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
@@ -345,7 +345,7 @@ class QueryBuilder
           allowed = [:value, :par_open]
         elsif rest =~ /\A(and|or)/
           unless allowed.include?(:bool_op)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
@@ -354,7 +354,7 @@ class QueryBuilder
           allowed = [:par_open, :value]
         elsif rest =~ /\A[\w:]+/
           unless allowed.include?(:value)
-            @errors << clause_error(clause, rest, res) 
+            @errors << clause_error(clause, rest, res)
             return
           end
           rest = rest[$&.size..-1]
@@ -365,12 +365,12 @@ class QueryBuilder
           end
           res << field
           allowed = after_value
-        else  
+        else
           @errors << clause_error(clause, rest, res)
           return
         end
       end
-      
+
       if par_count > 0
         @errors << "invalid clause #{clause.inspect}: missing closing ')'"
       elsif allowed.include?(:value)
@@ -379,11 +379,11 @@ class QueryBuilder
         @where << (has_or ? "(#{res})" : res)
       end
     end
-    
+
     def parse_order_clause(order)
       return @order unless order
       res = []
-      
+
       order.split(',').each do |clause|
         if clause == 'random'
           res << "RAND()"
@@ -403,11 +403,11 @@ class QueryBuilder
       end
       res == [] ? nil : " ORDER BY #{res.join(', ')}"
     end
-    
+
     def parse_group_clause(group)
       return @group unless group
       res = []
-      
+
       group.split(',').each do |field|
         if fld = map_field(field, table, :group)
           res << fld
@@ -417,7 +417,7 @@ class QueryBuilder
       end
       res == [] ? nil : " GROUP BY #{res.join(', ')}"
     end
-    
+
     def parse_limit_clause(limit)
       return @limit unless limit
       if limit.kind_of?(Fixnum)
@@ -432,7 +432,7 @@ class QueryBuilder
         nil
       end
     end
-    
+
     def parse_paginate_clause(paginate)
       return @offset unless paginate
       if !@limit
@@ -447,7 +447,7 @@ class QueryBuilder
         nil
       end
     end
-    
+
     def parse_offset_clause(offset)
       return @offset unless offset
       if !@limit
@@ -461,7 +461,7 @@ class QueryBuilder
         nil
       end
     end
-    
+
     def add_table(use_name, table_name = nil)
       table_name ||= use_name
       if !@table_counter[use_name]
@@ -471,12 +471,12 @@ class QueryBuilder
         else
           @tables << table_name
         end
-      else  
+      else
         @table_counter[use_name] += 1
         @tables << "#{table_name} AS #{table(use_name)}"
       end
     end
-    
+
     # return a unique table name for the current sub-query context, adding the table when necessary
     def needs_table(table1, table2, filter)
       @needed_tables[table2] ||= {}
@@ -486,16 +486,16 @@ class QueryBuilder
         table(table2)
       end
     end
-    
+
     # versions LEFT JOIN dyn_attributes ON ...
     def needs_join_table(table1, type, table2, clause, join_name = nil)
       join_name ||= "#{table1}=#{type}=#{table2}"
       @needed_join_tables[join_name] ||= {}
       @needed_join_tables[join_name][table] ||= begin
         # define join for this part ('table' = unique for each part)
-        
+
         first_table = table(table1)
-        
+
         if !@table_counter[table2]
           @table_counter[table2] = 0
           second_table  = table2
@@ -508,22 +508,22 @@ class QueryBuilder
         table(table2)
       end
     end
-    
+
     def table_counter(table_name)
       @table_counter[table_name] || 0
     end
-    
+
     def table_at(table_name, index)
       if index < 0
         return nil # no table at this address
       end
       index == 0 ? table_name : "#{table_name[0..1]}#{index}"
     end
-    
+
     def table(table_name=main_table, index=0)
       table_at(table_name, table_counter(table_name) + index)
     end
-    
+
     def merge_alternate_queries(alt_queries)
       counter = 1
       if valid?
@@ -539,13 +539,13 @@ class QueryBuilder
         end
         counter = 0
       end
-      
+
       if @where.compact == []
         where_list = []
       else
         where_list = [@where.compact.reverse.join(' AND ')]
       end
-      
+
       alt_queries.each do |query|
         next unless query.main_class == self.main_class # no mixed class target !
         @errors += query.errors unless @ignore_warnings
@@ -557,13 +557,13 @@ class QueryBuilder
         @distinct ||= query.distinct
         where_list << query.where.reverse.join(' AND ')
       end
-      
+
       @where_list = where_list
-      
+
       @tables.uniq!
-      
+
       fix_where_list(where_list)
-      
+
       if counter > 1
         @distinct = @tables.size > 1
         @where  = ["((#{where_list.join(') OR (')}))"]
@@ -571,7 +571,7 @@ class QueryBuilder
         @where  = where_list
       end
     end
-    
+
     def merge_tables(sub_query)
       @tables += sub_query.tables
       sub_query.join_tables.each do |k,v|
@@ -579,7 +579,7 @@ class QueryBuilder
         @join_tables[k] << v
       end
     end
-    
+
     def prepare_custom_query_arguments(key, value)
       if value.kind_of?(Array)
         value.map {|e| parse_custom_query_argument(key, e)}
@@ -595,7 +595,7 @@ class QueryBuilder
         parse_custom_query_argument(key, value)
       end
     end
-    
+
     # Map a field to be used inside a query. An attr is a field from table at index 0 = @node attribute.
     def field_or_attr(fld, table_name = table, context = nil)
       if fld =~ /^\d+$/
@@ -612,7 +612,7 @@ class QueryBuilder
         map_attr(fld)
       end
     end
-    
+
     def build_statement(type = :find)
       statement = type == :find ? find_statement : count_statement
 
@@ -624,7 +624,7 @@ class QueryBuilder
       end
       [statement, bind_values]
     end
-    
+
     def find_statement
       table_list = []
       @tables.each do |t|
@@ -644,7 +644,7 @@ class QueryBuilder
 
       "SELECT #{@select.join(',')} FROM #{table_list.flatten.join(',')}" + (@where == [] ? '' : " WHERE #{@where.reverse.join(' AND ')}") + group.to_s + @order.to_s + @limit.to_s + @offset.to_s
     end
-    
+
     def count_statement
       table_list = []
       @tables.each do |t|
@@ -668,7 +668,7 @@ class QueryBuilder
 
       "SELECT #{count_on} FROM #{table_list.flatten.join(',')}" + (@where == [] ? '' : " WHERE #{@where.reverse.join(' AND ')}")
     end
-    
+
     # Adapted from Rail's ActiveRecord code. We need "eval" because
     # QueryBuilder is a compiler and it has absolutely no knowledge
     # of the running context.
@@ -693,47 +693,47 @@ class QueryBuilder
     def class_from_table(table_name)
       Object
     end
-    
+
     def default_context_filter
       raise NameError.new("default_context_filter not defined for class #{self.class}")
     end
-    
+
     # Default sort order
     def default_order_clause
       nil
     end
-    
+
     def after_parse
       # do nothing
     end
-    
+
     def parse_change_class(rel, is_last)
       nil
     end
-    
+
     def parse_relation(clause, context)
       return nil
     end
-    
+
     def context_filter_fields(clause, is_last = false)
       nil
     end
-    
+
     def parse_context(clause, is_last = false)
-      
+
       if fields = context_filter_fields(clause, is_last)
         @where << "#{field_or_attr(fields[0])} = #{field_or_attr(fields[1], table(main_table,-1))}" if fields != :void
       else
         @errors << "invalid context '#{clause}'"
       end
     end
-    
+
     # Map a litteral value to be used inside a query
     def map_literal(value, env = :sql)
       env == :sql ? insert_bind(value.inspect) : value
     end
-    
-    
+
+
     # Overwrite this and take car to check for valid fields.
     def map_field(fld, table_name, context = nil)
       if fld == 'id'
@@ -742,11 +742,11 @@ class QueryBuilder
         # TODO: error, raise / ignore ?
       end
     end
-    
+
     def map_attr(fld)
       insert_bind(fld.to_s)
     end
-    
+
     # ******** And maybe overwrite these **********
     def parse_custom_query_argument(key, value)
       return nil unless value
@@ -760,19 +760,19 @@ class QueryBuilder
         value
       end
     end
-    
+
     def extract_custom_query(list)
       list[-1].split(' ').first
     end
-    
+
   private
-    
+
     def parse_elements(elements)
       # "final_parser" is the parser who will respond to 'to_sql'. It might be a sub-parser for another class.
       @final_parser = self
-      
-      if @@custom_queries[self.class] && 
-         @@custom_queries[self.class][@opts[:custom_query_group]] && 
+
+      if @@custom_queries[self.class] &&
+         @@custom_queries[self.class][@opts[:custom_query_group]] &&
          custom_query = @@custom_queries[self.class][@opts[:custom_query_group]][extract_custom_query(elements)]
         custom_query.each do |k,v|
          instance_variable_set("@#{k}", prepare_custom_query_arguments(k.to_sym, v))
@@ -787,21 +787,21 @@ class QueryBuilder
         clause, filters = elements[-1].split(/\s+where\s+/)
 
         parse_filters(filters) if filters
-        
+
         @limit  = parse_limit_clause(@offset_limit_order_group[:limit])
         if @offset_limit_order_group[:paginate]
           @offset = parse_paginate_clause(@offset_limit_order_group[:paginate])
         else
           @offset = parse_offset_clause(@offset_limit_order_group[:offset])
         end
-        
+
         @order = parse_order_clause(@offset_limit_order_group[:order])
       else
         i, new_class = 0, nil
         elements.each_index do |i|
           break if new_class = parse_part(elements[i], i == 0) # yes, is_last is first (parsing reverse)
         end
-        
+
         if new_class
           # move to another parser class
           @final_parser = new_class.new(nil, :pre_query => self, :elements => elements[i..-1])
@@ -829,10 +829,10 @@ class QueryBuilder
         @where.compact!
       end
     end
-    
+
     def init_with_query(query, opts)
       @opts = opts
-      
+
       if query.kind_of?(Array)
         @query = query[0]
         if query.size > 1
@@ -841,8 +841,8 @@ class QueryBuilder
       else
         @query = query
       end
-      
-      
+
+
       @offset_limit_order_group = {}
       if @query == nil || @query == ''
         elements = [main_table]
@@ -855,11 +855,11 @@ class QueryBuilder
         last_element, @offset_limit_order_group[:order]  = last_element.split(' order by ')
         elements[-1], @offset_limit_order_group[:group]  = last_element.split(' group by ')
       end
-      
+
       @offset_limit_order_group[:limit] = opts[:limit] || @offset_limit_order_group[:limit]
       # In order to know the table names of the dependencies, we need to parse it backwards.
       # We first find the closest elements, then the final ones. For example, "pages from project" we need
-      # project information before getting 'pages'. 
+      # project information before getting 'pages'.
       @elements = elements.reverse
 
       @tables  = []
@@ -888,15 +888,15 @@ class QueryBuilder
       @just_changed_class = true
       @elements = elements
     end
-    
+
     def clause_error(clause, rest, res)
       "invalid clause #{clause.inspect} near \"#{res[-2..-1]}#{rest[0..1]}\""
     end
-    
+
     def insert_bind(str)
       "[[#{str}]]"
     end
-    
+
     # Make sure all clauses are compatible (where_list is a list of strings, not arrays)
     def fix_where_list(where_list)
       # do nothing

data/lib/querybuilder.rb

@@ -0,0 +1 @@
+require 'query_builder'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: querybuilder
 version: !ruby/object:Gem::Version 
-  version: 0.5.5
+  version: 0.5.6
 platform: ruby
 authors: 
 - Gaspard Bucher
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-04 00:00:00 +02:00
+date: 2009-10-15 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,7 +42,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.8.0
     version: 
-description: "QueryBuilder is an interpreter for the \"pseudo sql\" language. This language can be used for two purposes:  1. protect your database from illegal SQL by securing queries 2. ease writing complex relational queries by abstracting table internals"
+description: |-
+  QueryBuilder is an interpreter for the "pseudo sql" language. This language
+  can be used for two purposes:
+  
+   1. protect your database from illegal SQL by securing queries
+   2. ease writing complex relational queries by abstracting table internals
 email: 
 - gaspard@teti.ch
 executables: []
@@ -58,11 +63,11 @@ files:
 - Manifest.txt
 - README.rdoc
 - Rakefile
-- lib/QueryBuilder.rb
+- lib/query_builder.rb
+- lib/querybuilder.rb
 - script/console
 - script/destroy
 - script/generate
-- test/mock/custom_queries
 - test/mock/custom_queries/test.yml
 - test/mock/dummy_query.rb
 - test/mock/user_query.rb
@@ -74,7 +79,9 @@ files:
 - test/test_helper.rb
 - test/test_QueryBuilder.rb
 has_rdoc: true
-homepage: http://zenadmin.org/524
+homepage: http://github.com/zena/querybuilder/tree/master
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -96,9 +103,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: querybuilder
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: QueryBuilder is an interpreter for the "pseudo sql" language
 test_files: 
 - test/test_helper.rb