querybuilder 0.5.9 → 0.7.0

data/querybuilder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{querybuilder}
-  s.version = "0.5.9"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gaspard Bucher"]
-  s.date = %q{2010-08-30}
+  s.date = %q{2010-05-27}
   s.description = %q{QueryBuilder is an interpreter for the "pseudo sql" language. This language
     can be used for two purposes:
 
@@ -25,35 +25,56 @@ Gem::Specification.new do |s|
      "Manifest.txt",
      "README.rdoc",
      "Rakefile",
+     "lib/extconf.rb",
      "lib/query_builder.rb",
+     "lib/query_builder/error.rb",
+     "lib/query_builder/info.rb",
+     "lib/query_builder/parser.rb",
+     "lib/query_builder/processor.rb",
+     "lib/query_builder/query.rb",
      "lib/querybuilder.rb",
+     "lib/querybuilder_ext.c",
+     "lib/querybuilder_ext.rl",
+     "lib/querybuilder_rb.rb",
+     "lib/querybuilder_rb.rl",
+     "lib/querybuilder_syntax.rl",
+     "old_QueryBuilder.rb",
      "querybuilder.gemspec",
      "script/console",
      "script/destroy",
      "script/generate",
+     "tasks/build.rake",
+     "test/dummy_test.rb",
      "test/mock/custom_queries/test.yml",
-     "test/mock/dummy_query.rb",
+     "test/mock/dummy.rb",
+     "test/mock/dummy_processor.rb",
      "test/mock/queries/bar.yml",
      "test/mock/queries/foo.yml",
-     "test/mock/user_query.rb",
-     "test/query_builder/basic.yml",
-     "test/query_builder/custom.yml",
-     "test/query_builder/errors.yml",
-     "test/query_builder/filters.yml",
-     "test/query_builder/joins.yml",
-     "test/query_builder/mixed.yml",
-     "test/query_builder_test.rb",
+     "test/mock/user_processor.rb",
+     "test/query_test.rb",
+     "test/querybuilder/basic.yml",
+     "test/querybuilder/custom.yml",
+     "test/querybuilder/errors.yml",
+     "test/querybuilder/filters.yml",
+     "test/querybuilder/group.yml",
+     "test/querybuilder/joins.yml",
+     "test/querybuilder/mixed.yml",
+     "test/querybuilder/rubyless.yml",
+     "test/querybuilder_test.rb",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://zenadmin.org/524}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.6}
-  s.summary = %q{QueryBuilder is an interpreter for the "pseudo sql" language}
+  s.summary = %q{QueryBuilder is an interpreter for the "pseudo sql" language.}
   s.test_files = [
-    "test/mock/dummy_query.rb",
-     "test/mock/user_query.rb",
-     "test/query_builder_test.rb",
+    "test/dummy_test.rb",
+     "test/mock/dummy.rb",
+     "test/mock/dummy_processor.rb",
+     "test/mock/user_processor.rb",
+     "test/query_test.rb",
+     "test/querybuilder_test.rb",
      "test/test_helper.rb"
   ]
 
@@ -62,11 +83,17 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rubyless>, [">= 0.5.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<yamltest>, [">= 0.5.0"])
     else
+      s.add_dependency(%q<rubyless>, [">= 0.5.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<yamltest>, [">= 0.5.0"])
     end
   else
+    s.add_dependency(%q<rubyless>, [">= 0.5.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<yamltest>, [">= 0.5.0"])
   end
 end

data/tasks/build.rake

@@ -0,0 +1,20 @@
+
+desc "Build native extension"
+task :build => [:build_rb, :build_ext] do
+end
+
+task :build_rb do
+  `cd lib && ragel -R querybuilder_rb.rl`
+end
+
+task :build_ext => [:ragel_ext, :extconf] do
+  `cd lib && make`
+end
+
+task :extconf do
+  `cd lib && ruby extconf.rb`
+end
+
+task :ragel_ext do
+  `cd lib && ragel querybuilder_ext.rl`
+end

data/test/dummy_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+class DummyTest < Test::Unit::TestCase
+  Query = QueryBuilder::Query
+
+  context 'A class with QueryBuilder included' do
+
+    subject do
+      Dummy
+    end
+
+    should 'return compiler class on query_compiler' do
+      assert_equal DummyProcessor, subject.query_compiler
+    end
+
+    should 'return a Query object on build_query' do
+      assert_kind_of Query, subject.build_query(:all, 'objects')
+    end
+
+  end
+end

data/test/mock/custom_queries/test.yml

@@ -1,4 +1,4 @@
-DummyQuery:
+DummyProcessor:
   abc:
     select:
       - a
@@ -13,13 +13,14 @@ DummyQuery:
     order: a ASC
     
   two_table:
+    main_table: 'table_one'
     select:
-      - x
+      - x AS x
       - IF(table_one.y,table_one.y,table_two.z) AS y
       - table_two.name
-    tables:
-      - table_one
+    tables:  
       - table_two
+      - table_one
       
   two_table_main:
     main_table: foo

data/test/mock/dummy.rb

@@ -0,0 +1,9 @@
+require 'mock/dummy_processor'
+
+class Dummy
+  include RubyLess
+  safe_method :id => Number
+
+  include QueryBuilder
+  self.query_compiler = DummyProcessor
+end

data/test/mock/dummy_processor.rb

@@ -0,0 +1,160 @@
+class DummyProcessor < QueryBuilder::Processor
+  set_main_table 'objects'
+  set_main_class 'DummyClass'
+  set_default :scope, 'self'
+  after_process :insert_after_filter
+  load_custom_queries File.join(File.dirname(__FILE__), '*')
+
+  # Scope current context with previous context.
+  # For example:
+  #                          current         previous
+  #  ['parent_id', 'id'] ==> no1.parent_id = nodes.id
+  def scope_fields(scope)
+    case scope
+    when 'self'
+      ['parent_id', 'id']
+    when 'parent'
+      last? ? ['parent_id', 'parent_id'] : ['parent_id', 'id']
+    when 'project'
+      last? ? ['project_id', 'project_id'] : ['project_id', 'id']
+    when 'site', main_table
+      # not an error, but do not scope
+      []
+    else
+      # error
+      nil
+    end
+  end
+
+  # Overwrite this and take care to check for valid fields.
+  def process_field(fld_name)
+    if ['id', 'parent_id', 'project_id', 'section_id', 'kpath', 'name', 'event_at', 'custom_a'].include?(fld_name)
+      "#{table}.#{fld_name}"
+    elsif fld_name == 'REF_DATE'
+      context[:ref_date] ? insert_bind(context[:ref_date]) : 'now()'
+    else
+      super # raises an error
+    end
+  end
+
+  # We do special things with 'class ='
+  def process_equal(left, right)
+    if left == [:field, 'class'] && right[0] == :string
+      case right.last
+      when 'Client'
+        kpath = 'NRCC'
+      else
+        raise QueryBuilder::SyntaxError.new("Unknown class #{right.last.inspect}.")
+      end
+      "#{field_or_attr('kpath')} LIKE #{insert_bind((kpath + '%').inspect)}"
+    else
+      super
+    end
+  end
+
+  # We do special things with 'class ='
+  def process_match(left, right)
+  end
+
+  def process_function(arg, method)
+    method, arg = process(method), process(arg)
+
+    case method
+    when 'year'
+      "strftime('%Y',#{arg})"
+    else
+      super
+    end
+  end
+
+  # ******** And maybe overwrite these **********
+  def parse_custom_query_argument(key, value)
+    return nil unless value
+    super(key, value.gsub('REF_DATE', context[:ref_date] ? insert_bind(context[:ref_date]) : 'now()'))
+  end
+
+  private
+    # Change class
+    def class_relation(relation)
+      case relation
+      when 'users'
+        change_processor 'UserProcessor'
+        add_table('users')
+        add_filter "#{table('users')}.node_id = #{field_or_attr('id', table(self.class.main_table))}"
+        return true
+      else
+        return nil
+      end
+    end
+
+    # Moving to another context without a join table
+    def context_relation(relation)
+      case relation
+      when 'self'
+        fields = ['id', 'id']
+      when 'parent'
+        fields = ['id', 'parent_id']
+      when 'project'
+        fields = ['id', 'project_id']
+      else
+        return nil
+      end
+
+      add_table(main_table)
+      add_filter "#{field_or_attr(fields[0])} = #{field_or_attr(fields[1], table(main_table, -1))}"
+    end
+
+    # Filtering of objects in scope
+    def filter_relation(relation)
+      case relation
+      when 'letters'
+        add_table(main_table)
+        add_filter "#{table}.kpath LIKE #{quote('NNL%')}"
+      when 'clients'
+        add_table(main_table)
+        add_filter "#{table}.kpath LIKE #{quote("NRCC%")}"
+      when main_table, 'children'
+        # no filter
+        add_table(main_table)
+      end
+    end
+
+    # Moving to another context through 'joins'
+    def join_relation(relation)
+      case relation
+      when 'recipients'
+        fields = ['source_id', 4, 'target_id']
+      when 'icons'
+        fields = ['target_id', 5, 'source_id']
+      when 'tags'
+        # just to test joins
+        add_table(main_table)
+        needs_join_table('objects', 'INNER', 'tags', 'TABLE1.id = TABLE2.node_id')
+        return true
+      else
+        return false
+      end
+
+      add_table(main_table)
+      add_table('links')
+      # source --> target
+      add_filter "#{table('links')}.#{fields[0]} = #{field_or_attr('id', table(main_table,-1))}"
+      add_filter "#{table('links')}.relation_id = #{fields[1]}"
+      add_filter "#{field_or_attr('id')} = #{table('links')}.#{fields[2]}"
+    end
+
+    def insert_after_filter
+      if after_filter = context[:after_filter]
+        add_filter after_filter
+      end
+    end
+end
+
+
+class DummyClass
+  # Mock connection and quoting
+  def self.connection; self; end
+  def self.quote(obj)
+    obj.kind_of?(String) ? "'#{obj}'" : obj
+  end
+end

data/test/mock/queries/bar.yml

@@ -1,6 +1,6 @@
 group: test2
 
-DummyQuery:
+DummyProcessor:
   bar:
     select:
       - bar

data/test/mock/queries/foo.yml

@@ -2,10 +2,10 @@ groups:
   - test
   - test2
 
-DummyQuery:
+DummyProcessor:
   foo:
     select:
       - foo
     tables:
-      - foot
+      - objects
     order: f DESC

data/test/mock/user_processor.rb

@@ -0,0 +1,34 @@
+class TestUser
+  def self.connection; self; end
+  def self.quote(obj)
+    obj.kind_of?(String) ? "'#{obj}'" : obj
+  end
+end
+
+class UserProcessor < QueryBuilder::Processor
+  set_main_table 'users'
+  set_main_class 'TestUser'
+  set_default    :order,   'name asc, first_name asc'
+  set_default    :context, 'self'
+
+  def process_relation(relation)
+    case relation
+    when 'objects'
+      this.apply_scope(default[:scope]) if context[:last]
+      add_table('objects')
+      @query.add_filter "#{table('objects')}.id = #{field_or_attr('node_id')}"
+      change_processor 'DummyProcessor'
+    else
+      return nil
+    end
+  end
+
+  # Overwrite this and take car to check for valid fields.
+  def process_field(field_name)
+    if ['id', 'name', 'first_name', 'node_id'].include?(field_name)
+      "#{table}.#{field_name}"
+    else
+      super # raises
+    end
+  end
+end

data/test/query_test.rb

@@ -0,0 +1,38 @@
+require 'test_helper'
+
+class QueryTest < Test::Unit::TestCase
+
+  context 'An empty query object' do
+    subject do
+      QueryBuilder::Query.new(QueryBuilder::Processor)
+    end
+
+    should 'respond to rebuild_tables' do
+      subject.tables = ['foo', 'bar']
+      subject.rebuild_tables!
+      h = {'foo' => ['foo'], 'bar' => ['bar']}
+      assert_equal h, subject.table_alias
+    end
+
+    should 'respond to rebuild_attributes_hash' do
+      subject.select = ['1 as one', 'two', '(20 - (weight / (height * height))) AS bmi_nrm']
+      subject.rebuild_attributes_hash!
+      h = {"bmi_nrm"=>"(20 - (weight / (height * height)))"}
+      assert_equal h, subject.attributes_alias
+    end
+  end
+
+  context 'A query returned from a processor' do
+    subject do
+      DummyProcessor.new('objects').query
+    end
+
+    should 'return a string representing an array with find SQL and parameters string on to_s' do
+      assert_equal "[%Q{SELECT objects.* FROM objects WHERE objects.parent_id = ?}, id]", subject.to_s
+    end
+
+    should 'return a string representing an array with count SQL and parameters string on to_s count' do
+      assert_equal "[%Q{SELECT COUNT(*) FROM objects WHERE objects.parent_id = ?}, id]", subject.to_s(:count)
+    end
+  end
+end

data/test/querybuilder/basic.yml

@@ -0,0 +1,91 @@
+empty:
+  src: ""
+  sxp: "[:query]"
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.parent_id = ?}, id]"
+
+objects:
+  sxp: '[:query, [:relation, "objects"]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.parent_id = ?}, id]"
+
+objects_in_project:
+  sxp: '[:query, [:scope, [:relation, "objects"], "project"]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ?}, project_id]"
+
+objects_in_site:
+  res: "%Q{SELECT objects.* FROM objects}"
+
+recipients:
+  sxp: '[:query, [:relation, "recipients"]]'
+  res: "[%Q{SELECT objects.* FROM links,objects WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ?}, id]"
+  sql: "SELECT objects.* FROM links,objects WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = 123"
+
+letters_in_project:
+  sxp: '[:query, [:scope, [:relation, "letters"], "project"]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.kpath LIKE 'NNL%' AND objects.project_id = ?}, project_id]"
+
+parent:
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.id = ?}, parent_id]"
+
+order_single_table:
+  src: "objects in project order by name ASC"
+  sxp: '[:query, [:order, [:scope, [:relation, "objects"], "project"], [:asc, [:field, "name"]]]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ? ORDER BY objects.name ASC}, project_id]"
+
+order_many_tables:
+  src: "recipients order by name"
+  res: "[%Q{SELECT objects.* FROM links,objects WHERE objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ? ORDER BY objects.name}, id]"
+
+order_many_params:
+  src: "objects in project order by name, id desc"
+  sxp: '[:query, [:order, [:scope, [:relation, "objects"], "project"], [:field, "name"], [:desc, [:field, "id"]]]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ? ORDER BY objects.name, objects.id DESC}, project_id]"
+
+order_without_scope:
+  src: "objects order by name asc"
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.parent_id = ? ORDER BY objects.name ASC}, id]"
+
+limit:
+  src: "objects in project limit 2"
+  sxp: '[:query, [:limit, [:scope, [:relation, "objects"], "project"], [:integer, "2"]]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ? LIMIT 2}, project_id]"
+
+limit_with_order:
+  src: "objects in project order by name desc limit 10"
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ? ORDER BY objects.name DESC LIMIT 10}, project_id]"
+
+offset_in_limit:
+  src: "objects in project limit 3,2"
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ? LIMIT 2 OFFSET 3}, project_id]"
+
+offset:
+  src: "objects in project limit 2 offset 3"
+  sxp: '[:query, [:offset, [:limit, [:scope, [:relation, "objects"], "project"], [:integer, "2"]], [:integer, "3"]]]'
+  res: "[%Q{SELECT objects.* FROM objects WHERE objects.project_id = ? LIMIT 2 OFFSET 3}, project_id]"
+
+paginate:
+  src: "objects in site limit 2 paginate p"
+  sxp: '[:query, [:paginate, [:limit, [:scope, [:relation, "objects"], "site"], [:integer, "2"]], [:param, "p"]]]'
+  res: "[%Q{SELECT objects.* FROM objects LIMIT 2 OFFSET ?}, ((p.to_i > 0 ? p.to_i : 1)-1)*2]"
+
+recipients_or_objects:
+  src: recipients or objects
+  sxp: '[:query, [:clause_or, [:relation, "recipients"], [:relation, "objects"]]]'
+  res: "[%Q{SELECT objects.* FROM links,objects 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]"
+
+recipients_or_objects_or_letters:
+  src: recipients or objects or letters
+  res: "[%Q{SELECT objects.* FROM links,objects WHERE ((objects.id = links.target_id AND links.relation_id = 4 AND links.source_id = ?) OR objects.parent_id = ? OR (objects.kpath LIKE 'NNL%' AND objects.parent_id = ?)) GROUP BY objects.id}, id, id, id]"
+
+or_clause_with_filter:
+  src: "(recipients where name = 'foo') or objects"
+  sxp: '[:query, [:clause_or, [:clause_par, [:filter, [:relation, "recipients"], [:"=", [:field, "name"], [:string, "foo"]]]], [:relation, "objects"]]]'
+
+count_sql:
+  src: "objects in project"
+  count: "[%Q{SELECT COUNT(*) FROM objects WHERE objects.project_id = ?}, project_id]"
+
+after_process_callback:
+  context:
+    after_filter: '(1 = 1)'
+  src: "objects where name like 'a%' or name like 'b%' in site"
+  res: "%Q{SELECT objects.* FROM objects WHERE (1 = 1) AND (objects.name LIKE 'a%' OR objects.name LIKE 'b%')}"