querybuilder 0.5.0 → 0.5.2

data/History.txt

@@ -1,4 +1,15 @@
+== 0.5.2 2009-04-03
+
+* 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:
-  * Initial release (extraction from zena: http://zenadmin.org)
+  * Initial release (extraction from zena: http://zenadmin.org)

data/README.rdoc

@@ -1,4 +1,4 @@
-= querybuilder
+= QueryBuilder
 
 * http://github.com/zena/querybuilder/tree/master
 

data/lib/QueryBuilder.rb

@@ -10,7 +10,7 @@ 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.0'
+  VERSION = '0.5.2'
   
   @@main_table = {}
   @@main_class = {}
@@ -28,24 +28,30 @@ class QueryBuilder
       @@main_class[self] = main_class.to_s
     end
     
-    # Load prepared SQL definitions from a directory.
+    # 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.
     #
     # ==== Parameters
     # query<String>:: Path to list of custom queries yaml files.
     #
     # ==== Examples
-    #   DummyQuery.load_custom_queries("/path/to/directory")
+    #   DummyQuery.load_custom_queries("/path/to/some/*/directory")
     #
     # The format of a custom query definition is:
     #
-    #   DummyQuery:    # QueryBuilder class
-    #     abc:        # query's relation name
-    #       select:   # selected fields
+    #   hosts:
+    #     - test.host
+    #   DummyQuery:      # QueryBuilder class
+    #     abc:           # query's relation name
+    #       select:      # selected fields
     #         - 'a'
     #         - '34 AS number'
     #         - 'c'
-    #       tables:   # tables used
+    #       tables:      # tables used
     #         - 'test'
+    #       join_tables: # joins
+    #         test:
+    #           - LEFT JOIN other ON other.test_id = test.id
     #       where:    # filters
     #         - '1'
     #         - '2'
@@ -54,21 +60,26 @@ class QueryBuilder
     #
     # Once loaded, this 'custom query' can be used in a query like:
     #   "images from abc where a > 54"
-    def load_custom_queries(dir)
+    def load_custom_queries(directories)
       klass = nil
-      if File.directory?(dir)
-        Dir.foreach(dir) do |file|
-          next unless file =~ /(.+).yml$/
-          custom_query_group = $1
-          definitions = YAML::load(File.read(File.join(dir,file)))
-          definitions.each do |klass,v|
-            klass = Module.const_get(klass)
-            raise ArgumentError.new("invalid class for CustomQueries (#{klass})") unless klass.ancestors.include?(QueryBuilder)
-            @@custom_queries[klass] ||= {}
-            @@custom_queries[klass][custom_query_group] ||= {}
-            klass_queries = @@custom_queries[klass][custom_query_group]
-            v.each do |k,v|
-              klass_queries[k] = v
+      Dir.glob(directories).each do |dir|
+        if File.directory?(dir)
+          Dir.foreach(dir) do |file|
+            next unless file =~ /(.+).yml$/
+            custom_query_groups = $1
+            definitions = YAML::load(File.read(File.join(dir,file)))
+            custom_query_groups = [definitions.delete('groups') || definitions.delete('group') || custom_query_groups].flatten
+            definitions.each do |klass,v|
+              klass = Module.const_get(klass)
+              raise ArgumentError.new("invalid class for CustomQueries (#{klass})") unless klass.ancestors.include?(QueryBuilder)
+              @@custom_queries[klass] ||= {}
+              custom_query_groups.each do |custom_query_group|
+                @@custom_queries[klass][custom_query_group] ||= {}
+                klass_queries = @@custom_queries[klass][custom_query_group]
+                v.each do |k,v|
+                  klass_queries[k] = v
+                end
+              end
             end
           end
         end
@@ -132,7 +143,7 @@ class QueryBuilder
   # => "[\"SELECT COUNT(*) FROM objects WHERE objects.project_id = ?\", project_id]"
   def to_s(type = :find)
     return nil if !valid?
-    return "\"SELECT #{@main_table}.* FROM #{@main_table} WHERE 0\"" if @tables.empty? # all alternate queries invalid and 'ignore_warnings' set.
+    return "\"SELECT #{main_table}.* FROM #{main_table} WHERE 0\"" if @tables.empty? # all alternate queries invalid and 'ignore_warnings' set.
     statement, bind_values = build_statement(type)
     bind_values.empty? ? "\"#{statement}\"" : "[#{[["\"#{statement}\""] + bind_values].join(', ')}]"
   end
@@ -155,7 +166,7 @@ class QueryBuilder
   # => "SELECT COUNT(*) FROM objects WHERE objects.project_id = 12489"
   def sql(bindings, type = :find)
     return nil if !valid?
-    return "SELECT #{@main_table}.* FROM #{@main_table} WHERE 0" if @tables.empty? # all alternate queries invalid and 'ignore_warnings' set.
+    return "SELECT #{main_table}.* FROM #{main_table} WHERE 0" if @tables.empty? # all alternate queries invalid and 'ignore_warnings' set.
     statement, bind_values = build_statement(type)
     connection = get_connection(bindings)
     statement.gsub('?') { eval_bound_value(bind_values.shift, connection, bindings) }
@@ -204,7 +215,7 @@ class QueryBuilder
     end
     
     def main_table
-      @@main_table[self.class]
+      @main_table || @@main_table[self.class]
     end
   
     def parse_part(part, is_last)
@@ -584,12 +595,12 @@ class QueryBuilder
     def field_or_attr(fld, table_name = table, context = nil)
       if fld =~ /^\d+$/
         return fld
-      elsif @select.join =~ / AS #{fld}/
-        @select.each do |s|
-          if s =~ /\A(.*) AS #{fld}\Z/
-            return context == :filter ? "(#{$1})" : fld
-          end
+      elsif !(list = @select.select {|e| e =~ /\A#{fld}\Z|AS #{fld}|\.#{fld}\Z/}).empty?
+        res = list.first
+        if res =~ /\A(.*) AS #{fld}\Z/
+          res = $1
         end
+        return context == :filter ? "(#{res})" : res
       elsif table_name
         map_field(fld, table_name, context)
       else
@@ -848,8 +859,6 @@ class QueryBuilder
 
       @errors  = []
 
-      @main_table ||= 'objects'
-
       @select  = []
 
       @ignore_warnings = opts[:ignore_warnings]

data/test/QueryBuilder/basic.yml

@@ -55,12 +55,6 @@ recipients_or_objects:
     - "objects"
   res: "[\"SELECT objects.* FROM objects,links WHERE ((objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ?) OR (objects.parent_id = ?)) GROUP BY objects.id\", id, id]"
 
-custom_query:
-  context:
-    custom_query_group: test
-  src: "abc"
-  res: "\"SELECT a,34 AS number,c FROM test WHERE 3 AND 2 AND 1 ORDER BY a\""
-
 count_sql:
   src: "objects in project"
   count: "[\"SELECT COUNT(*) FROM objects WHERE objects.project_id = ?\", project_id]"

data/test/QueryBuilder/filters.yml

@@ -24,7 +24,7 @@ custom_query_having:
   context:
     custom_query_group: test
   src: "abc where number > 12"
-  res: "\"SELECT a,34 AS number,c FROM test WHERE (34) > 12 AND 3 AND 2 AND 1 ORDER BY a\""
+  res: "\"SELECT a,34 AS number,c FROM test WHERE (34) > 12 AND 3 AND 2 AND 1 ORDER BY a ASC\""
 
 equation_in_filter:
   src: "objects where event_at > REF_DATE + custom_a months"

data/test/mock/custom_queries/test.yml

@@ -1,14 +1,31 @@
 DummyQuery:
-  # form_dates
   abc:
     select:
-      - 'a'
-      - '34 AS number'
-      - 'c'
+      - a
+      - 34 AS number
+      - c
     tables:
-      - 'test'
+      - test
     where:
       - '1'
       - '2'
       - '3'
-    order:  'a'
+    order: a ASC
+    
+  two_table:
+    select:
+      - x
+      - IF(table_one.y,table_one.y,table_two.z) AS y
+      - table_two.name
+    tables:
+      - table_one
+      - table_two
+      
+  two_table_main:
+    main_table: foo
+    select:
+      - x
+    tables:
+      - table_one
+      - foo
+      - table_two

data/test/mock/dummy_query.rb

@@ -2,7 +2,7 @@ class DummyQuery < QueryBuilder
   set_main_table 'objects'
   set_main_class 'DummyQueryClass'
   
-  load_custom_queries File.join(File.dirname(__FILE__), 'custom_queries')
+  load_custom_queries File.join(File.dirname(__FILE__), '*')
   
   # Build joins and filters from a relation.
   def parse_relation(rel, context)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: querybuilder
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors: 
 - Gaspard Bucher
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-26 00:00:00 +01:00
+date: 2009-04-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.3
+        version: 1.3.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe