querybuilder 0.5.0

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/QueryBuilder.rb'}"
+puts "Loading QueryBuilder gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/QueryBuilder/basic.yml

@@ -0,0 +1,66 @@
+empty:
+  src: ""
+  res: "[\"SELECT objects.* FROM objects WHERE objects.parent_id = ?\", id]"
+
+objects:
+  res: "[\"SELECT objects.* FROM objects WHERE objects.parent_id = ?\", id]"
+
+objects_in_project:
+  res: "[\"SELECT objects.* FROM objects WHERE objects.project_id = ?\", project_id]"
+
+objects_in_site:
+  res: "\"SELECT objects.* FROM objects\""
+  
+recipients:
+  res: "[\"SELECT objects.* FROM objects,links WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ?\", id]"
+  sql: "SELECT objects.* FROM objects,links WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = [[123]]"
+
+letters_in_project:
+  res: "[\"SELECT objects.* FROM objects WHERE objects.kpath LIKE 'NNL%' AND objects.project_id = ?\", project_id]"
+
+parent:
+  res: "[\"SELECT objects.* FROM objects WHERE objects.id = ?\", parent_id]"
+
+order_single_table:
+  src: "objects in project order by name ASC"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.project_id = ? ORDER BY objects.name ASC\", project_id]"
+
+order_many_tables:
+  src: "recipients order by name ASC"
+  res: "[\"SELECT objects.* FROM objects,links WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? ORDER BY objects.name ASC\", id]"
+
+order_many_params:
+  src: "objects in project order by name ASC, id DESC"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.project_id = ? ORDER BY objects.name ASC, objects.id DESC\", project_id]"
+
+limit:
+  src: "objects in project limit 2"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.project_id = ? LIMIT 2\", project_id]"
+  
+offset_in_limit:
+  src: "objects in project limit 3,2"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.project_id = ? LIMIT 2 OFFSET 3\", project_id]"
+
+offset:
+  src: "objects in project limit 2 offset 3"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.project_id = ? LIMIT 2 OFFSET 3\", project_id]"
+
+paginate:
+  src: "objects in site limit 2 paginate p"
+  res: "[\"SELECT objects.* FROM objects LIMIT 2 OFFSET ?\", ((p.to_i > 0 ? p.to_i : 1)-1)*2]"
+
+recipients_or_objects:
+  src:
+    - "recipients"
+    - "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/errors.yml

@@ -0,0 +1,50 @@
+bad_relation:
+  src: "bolobolo"
+  res: "unknown relation 'bolobolo'"
+
+bad_relation_in_alternate_query:
+  src: 
+    - "bolobolo"
+    - "letters in project"
+  res: "unknown relation 'bolobolo'"
+
+order:
+  src: "objects in project order by bad ASC"
+  res: "invalid field 'bad'"
+
+offset_without_limit:
+  src: "objects in project offset 3"
+  res: "invalid offset clause '3' (used without limit)"
+
+ignore_warnings:
+  context:
+    ignore_warnings: yes
+  src:
+    - 'letters'
+    - 'foo'
+  res: "[\"SELECT objects.* FROM objects WHERE objects.kpath LIKE 'NNL%' AND objects.parent_id = ?\", id]"
+
+ignore_warnings_all_bad:
+  context:
+    ignore_warnings: yes
+  src:
+    - 'baz'
+    - 'foo'
+  res: "\"SELECT objects.* FROM objects WHERE 0\""
+
+do_not_ignore_warnings:
+  context:
+    ignore_warnings: no
+  src:
+    - 'letters'
+    - 'foo'
+  res: "unknown relation 'foo'"
+
+bad_equation:
+  src: "objects where event_at > 2006-04-01'"
+  res: "invalid clause \"event_at > 2006-04-01'\" near \"06-0\""
+
+bad_plus_plus:
+  src: "objects where 1 + 3 + + 5 > event_at"
+  res: "invalid clause \"1 + 3 + + 5 > event_at\" near \"+ + \""
+  

data/test/QueryBuilder/filters.yml

@@ -0,0 +1,43 @@
+simple:
+  src: "objects where name = 'foo' in site"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.name = ?\", \"foo\"]"
+
+recipients_that_are_clients:
+  src: "recipients where kpath like 'NRCC%'"
+  res: "[\"SELECT objects.* FROM objects,links WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? AND objects.kpath LIKE ?\", id, \"NRCC%\"]"
+
+pages_in_site_name_like:
+  src: "letters where name like 'a%' in site"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.kpath LIKE 'NNL%' AND objects.name LIKE ?\", \"a%\"]"
+
+pages_in_site_name_not_like:
+  src: "letters where name not like 'a%' in site"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.kpath LIKE 'NNL%' AND objects.name NOT LIKE ?\", \"a%\"]"
+
+letters_group_by_name:
+  res: "[\"SELECT objects.* FROM objects WHERE objects.kpath LIKE 'NNL%' AND objects.parent_id = ? GROUP BY objects.name\", id]"
+
+recipients_group_by_name:
+  res: "[\"SELECT objects.* FROM objects,links WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? GROUP BY objects.name\", id]"
+
+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\""
+
+equation_in_filter:
+  src: "objects where event_at > REF_DATE + custom_a months"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.parent_id = ? AND objects.event_at > now() + INTERVAL objects.custom_a MONTH\", id]"
+
+equation_in_filter_date:
+  src: "objects where event_at > '2006-04-01' + 6 week"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.parent_id = ? AND objects.event_at > ? + INTERVAL 6 WEEK\", id, \"2006-04-01\"]"
+
+equation_and_or_par:
+  src: "objects where event_at > '2006-04-01' or name like 'foo%'"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.parent_id = ? AND (objects.event_at > ? OR objects.name LIKE ?)\", id, \"2006-04-01\", \"foo%\"]"
+
+equation_par:
+  src: "objects where (1 > 2 and 2 > 3) or 4 = 5"
+  res: "[\"SELECT objects.* FROM objects WHERE objects.parent_id = ? AND ((1 > 2 AND 2 > 3) OR 4 = 5)\", id]"

data/test/QueryBuilder/joins.yml

@@ -0,0 +1,25 @@
+
+icons_from_recipients:
+  res: "[\"SELECT ob1.* FROM objects,links,objects AS ob1,links AS li1 WHERE ob1.id = li1.source_id AND li1.relation_id = 5 AND li1.target_id = objects.id AND objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? GROUP BY ob1.id\", id]"
+
+letters_from_recipients:
+  res: "[\"SELECT ob1.* FROM objects,links,objects AS ob1 WHERE ob1.kpath LIKE 'NNL%' AND ob1.parent_id = objects.id AND objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? GROUP BY ob1.id\", id]"
+
+objects_from_recipients:
+  res: "[\"SELECT ob1.* FROM objects,links,objects AS ob1 WHERE ob1.parent_id = objects.id AND objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? GROUP BY ob1.id\", id]"
+
+parent_from_parent:
+  res: "[\"SELECT ob1.* FROM objects,objects AS ob1 WHERE ob1.id = objects.parent_id AND objects.id = ? GROUP BY ob1.id\", parent_id]"
+
+children_from_objects_in_project:
+  res: "[\"SELECT ob1.* FROM objects,objects AS ob1 WHERE ob1.parent_id = objects.id AND objects.project_id = ? GROUP BY ob1.id\", project_id]"
+  
+tags:
+  res: "\"SELECT objects.* FROM objects INNER JOIN tags ON objects.id = tags.node_id\""
+
+letters_in_project_from_letters:
+  res: "[\"SELECT ob1.* FROM objects,objects AS ob1 WHERE ob1.kpath LIKE 'NNL%' AND ob1.project_id = objects.id AND objects.kpath LIKE 'NNL%' AND objects.parent_id = ? GROUP BY ob1.id\", id]"
+
+letters_in_project_from_letters_group_by:
+  src: "letters in project from letters group by name,id"
+  res: "[\"SELECT ob1.* FROM objects,objects AS ob1 WHERE ob1.kpath LIKE 'NNL%' AND ob1.project_id = objects.id AND objects.kpath LIKE 'NNL%' AND objects.parent_id = ? GROUP BY ob1.name, ob1.id\", id]"

data/test/QueryBuilder/mixed.yml

@@ -0,0 +1,12 @@
+users_from_objects:
+  res: "TestUser: [\"SELECT users.* FROM objects,users WHERE users.node_id = objects.id AND objects.parent_id = ? ORDER BY users.name ASC, users.first_name ASC\", id]"
+
+users_where_name_from_objects:
+  src: "users where name eq 'bob' from objects"
+  res: "TestUser: [\"SELECT users.* FROM objects,users WHERE users.name = ? AND users.node_id = objects.id AND objects.parent_id = ? ORDER BY users.name ASC, users.first_name ASC\", \"bob\", id]"
+  
+objects_from_users_from_objects:
+  res: "TestUser: [\"SELECT users.* FROM objects,users,objects AS ob1 WHERE ob1.id = users.node_id AND users.node_id = objects.id AND objects.parent_id = ? ORDER BY users.name ASC, users.first_name ASC\", id]"
+
+users:
+  res: "TestUser: [\"SELECT users.* FROM users WHERE users.node_id = objects.id AND objects.parent_id = ? ORDER BY users.name ASC, users.first_name ASC\", id]"

data/test/mock/custom_queries/test.yml

@@ -0,0 +1,14 @@
+DummyQuery:
+  # form_dates
+  abc:
+    select:
+      - 'a'
+      - '34 AS number'
+      - 'c'
+    tables:
+      - 'test'
+    where:
+      - '1'
+      - '2'
+      - '3'
+    order:  'a'

data/test/mock/dummy_query.rb

@@ -0,0 +1,114 @@
+class DummyQuery < QueryBuilder
+  set_main_table 'objects'
+  set_main_class 'DummyQueryClass'
+  
+  load_custom_queries File.join(File.dirname(__FILE__), 'custom_queries')
+  
+  # Build joins and filters from a relation.
+  def parse_relation(rel, context)
+    unless context_relation(rel, context) || direct_filter(rel, context) || join_relation(rel, context)
+      @errors << "unknown relation '#{rel}'"
+    end
+  end
+  
+  # default context filter is to search in the current node's children (in self)
+  def default_context_filter
+    'self'
+  end
+  
+  private
+    
+    # Root filters (relations that can be solved without a join). Think 'in clause' (in self, in parent).
+    def context_filter_fields(clause, is_last = false)
+      case clause
+      when 'self'
+        ['parent_id', 'id']
+      when 'parent'
+        is_last ? ['parent_id', 'parent_id'] : ['parent_id', 'id']
+      when 'project'
+        is_last ? ['project_id', 'project_id'] : ['project_id', 'id']
+      when 'site', main_table
+        :void
+      else
+        nil
+      end
+    end
+    
+    def context_relation(clause, context)
+      case clause
+      when 'self'
+        fields = ['id', 'id']
+      when 'parent'
+        fields = ['id', 'parent_id']
+      when 'project'
+        fields = ['id', 'project_id']
+      when main_table, 'children'
+        parse_context(default_context_filter) unless context
+        return true # dummy clause: does nothing
+      else
+        return false
+      end
+      
+      @where << "#{field_or_attr(fields[0])} = #{field_or_attr(fields[1], table(main_table,-1))}"
+    end
+
+    # Direct filter
+    def direct_filter(rel, context)
+      case rel
+      when 'letters'
+        parse_context(default_context_filter) unless context
+        @where << "#{table}.kpath LIKE 'NNL%'"
+      when 'clients'
+        parse_context(default_context_filter) unless context
+        @where << "#{table}.kpath LIKE 'NRCC%'"
+      else
+        return false
+      end
+    end
+
+    def parse_change_class(rel, is_last)
+      case rel
+      when 'users'
+        parse_context(default_context_filter, true) if is_last
+        add_table('users')
+        @where << "#{table('users')}.node_id = #{field_or_attr('id')}"
+        return TestUserQuery # class change
+      else
+        return nil
+      end
+    end
+    
+    # Filters that need a join
+    def join_relation(rel, context)
+      case rel
+      when 'recipients'
+        fields = ['source_id', 4, 'target_id']
+      when 'icons'
+        fields = ['target_id', 5, 'source_id']
+      when 'tags'
+        # just to test joins
+        needs_join_table('objects', 'INNER', 'tags', 'TABLE1.id = TABLE2.node_id')
+        return true
+      else
+        return false
+      end
+      
+      add_table('links')
+      # source --> target
+      @where << "#{field_or_attr('id')} = #{table('links')}.#{fields[2]} AND #{table('links')}.relation_id = #{fields[1]} AND #{table('links')}.#{fields[0]} = #{field_or_attr('id', table(main_table,-1))}"
+    end
+    
+    # Overwrite this and take car to check for valid fields.
+    def map_field(fld, table_name, is_null = false)
+      if ['id', 'parent_id', 'project_id', 'section_id', 'kpath', 'name', 'event_at', 'custom_a'].include?(fld)
+        "#{table_name}.#{fld}"
+      else
+        # error, raise
+      end
+    end
+end
+
+class DummyQueryClass
+  def self.connection; self; end
+  def self.quote(obj); "[[#{obj}]]"; end
+end

data/test/mock/user_query.rb

@@ -0,0 +1,55 @@
+
+class TestUser
+end
+
+class TestUserQuery < QueryBuilder
+  set_main_table 'users'
+  set_main_class 'TestUser'
+  
+  # Default sort order
+  def default_order_clause
+    "name ASC, first_name ASC"
+  end
+  
+  def default_context_filter
+    'self'
+  end
+  
+  def parse_change_class(rel, is_last)
+    case rel
+    when 'objects'
+      parse_context(default_context_filter, true) if is_last
+      add_table('objects')
+      @where << "#{table('objects')}.id = #{field_or_attr('node_id')}"
+      return TestUserQuery # class change
+    else
+      return nil
+    end
+  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
+  
+  # Overwrite this and take car to check for valid fields.
+  def map_field(fld, table_name, context = nil)
+    if ['id', 'name', 'first_name', 'node_id'].include?(fld)
+      "#{table_name}.#{fld}"
+    else
+      # TODO: error, raise / ignore ?
+    end
+  end
+end

data/test/test_QueryBuilder.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+
+class DummyQueryBuilder < Test::Unit::TestCase
+  yamltest
+  
+  def id;         123;  end
+  def parent_id;  333;  end
+  def project_id; 9999; end
+  def connection; self; end
+  
+  
+  def yt_parse(key, source, opts)
+    opts = Hash[*(opts.map{|k,v| [k.to_sym, v]}.flatten)]
+    query = DummyQuery.new(source, opts)
+    
+    case key
+    when 'res'
+      (query.main_class != DummyQueryClass ? "#{query.main_class.to_s}: " : '') + if res = query.to_s
+        res
+      else
+        query.errors.join(", ")
+      end
+    when 'sql'
+      query.sql(binding)
+    when 'count'
+      query.to_s(:count)
+    when 'count_sql'
+      query.sql(binding, :count)
+    else
+      "parse not implemented for '#{key}' in query_builder_test.rb"
+    end
+  end
+  
+  yt_make
+end