querybuilder 0.9.0 → 0.9.1

data/History.txt

@@ -1,3 +1,8 @@
+== 0.9.1 2010-09-22
+
+* 1 Major enhancement
+  * Key based add_table (used to import key/value based fields).
+
 == 0.9.0 2010-09-14
 
 * 1 Major enhancements

data/lib/query_builder/info.rb

@@ -1,3 +1,3 @@
 module QueryBuilder
-  VERSION = '0.9.0'
+  VERSION = '0.9.1'
 end

data/lib/query_builder/processor.rb

@@ -138,7 +138,8 @@ module QueryBuilder
     def initialize(source, opts = {})
       @default = opts.delete(:default) || {}
       @opts = opts
-      @rubyless_helper = @opts[:rubyless_helper]
+      @rubyless_helper  = @opts[:rubyless_helper]
+
       if source.kind_of?(Processor)
         # experimental: class change
         @context  = source.context
@@ -739,6 +740,7 @@ module QueryBuilder
         end
       end
 
+      # Add a new table and apply scoping when needed
       def add_table(use_name, table_name = nil)
         if use_name == main_table && first?
           # we are now using final table
@@ -773,6 +775,12 @@ module QueryBuilder
         end
       end
 
+      # Add a table to 'import' a key/value based field. This method ensures that
+      # a given field is only included once for each context.
+      def add_key_value_table(use_name, index_table, key = :any, &block)
+        @query.add_key_value_table(use_name, index_table, key, &block)
+      end
+
       # Hook to use dummy scopes (such as 'in site')
       def need_join_scope?(scope_name)
         true

data/lib/query_builder/query.rb

@@ -4,7 +4,7 @@ module QueryBuilder
   class Query
     attr_accessor :processor_class, :distinct, :select, :tables, :table_alias, :where,
                   :limit, :offset, :page_size, :order, :group, :error, :attributes_alias,
-                  :pagination_key, :main_class, :context
+                  :pagination_key, :main_class, :context, :key_value_tables
 
     class << self
       def adapter
@@ -19,6 +19,7 @@ module QueryBuilder
       @join_tables = {}
       @needed_join_tables = {}
       @attributes_alias   = {}
+      @key_value_tables   = {}
       @where = []
     end
 
@@ -119,6 +120,23 @@ module QueryBuilder
       add_alias_to_tables(table_name || use_name, alias_name)
     end
 
+    # Add a table to 'import' a key/value based field. This method ensures that
+    # a given field is only included once for each context.
+    def add_key_value_table(use_name, index_table, key, &block)
+      key_tables = (@key_value_tables[table] ||= {})
+      key_table = (key_tables[use_name] ||= {})
+      if alias_table = key_table[key]
+        # done, the index_table has been used for the given key in the current context
+      else
+        # insert the new table
+        add_table(use_name, index_table, false)
+        alias_table = key_table[key] = table(use_name)
+        # Let caller configure the filter (join).
+        block.call(alias_table)
+      end
+      alias_table
+    end
+
     def add_select(clause)
       @select ||= []
       @select << clause
@@ -130,7 +148,8 @@ module QueryBuilder
     end
 
     # Use this method to add a join to another table (added only once for each join name).
-    # versions LEFT JOIN dyn_attributes ON ...
+    # nodes JOIN idx_nodes_string AS id1 ON ...
+    # FIXME: can we remove this ? It seems buggy (JOIN in or clauses)
     def needs_join_table(table_name1, type, table_name2, clause, join_name = nil)
       join_name ||= "#{table_name1}=#{type}=#{table_name2}"
       @needed_join_tables[join_name] ||= {}
@@ -149,10 +168,10 @@ module QueryBuilder
       end
     end
 
-    # Duplicate query, avoiding mutual
+    # Duplicate query, avoiding sharing some arrays and hash
     def dup
       other = super
-      %w{tables table_alias where}.each do |k|
+      %w{tables table_alias where tables key_value_tables}.each do |k|
         other.send("#{k}=", other.send(k).dup)
       end
       other

data/querybuilder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{querybuilder}
-  s.version = "0.9.0"
+  s.version = "0.9.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Gaspard Bucher"]
-  s.date = %q{2010-09-14}
+  s.date = %q{2010-09-22}
   s.description = %q{QueryBuilder is an interpreter for the "pseudo sql" language. This language
     can be used for two purposes:
 

data/test/mock/dummy_processor.rb

@@ -27,23 +27,27 @@ class DummyProcessor < QueryBuilder::Processor
   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'
+  def process_field(field_name)
+    if ['id', 'parent_id', 'project_id', 'section_id', 'kpath', 'name', 'event_at', 'custom_a'].include?(field_name)
+      "#{table}.#{field_name}"
+    elsif field_name == 'REF_DATE'
       context[:ref_date] ? insert_bind(context[:ref_date]) : 'now()'
-    elsif fld_name == 'index'
-      add_table('index')
-      add_filter "#{table('index')}.node_id = #{field_or_attr('id', table(self.class.main_table))}"
-      "#{table('index')}.value"
+    elsif %w{age size}.include?(field_name)
+      tbl = add_key_value_table('idx', 'idx_nodes', field_name) do |tbl_name|
+        # This block is only executed once
+        add_filter "#{tbl_name}.node_id = #{table}.id"
+        add_filter "#{tbl_name}.key = #{quote(field_name)}"
+      end
+
+      "#{tbl}.value"
     else
       super # raises an error
     end
   end
 
-  def resolve_missing_table(query, table_alias, table_name)
+  def resolve_missing_table(query, table_name, table_alias)
     case table_name
-    when 'index'
+    when 'idx_nodes'
       query.where.insert 0, "#{table_alias}.id = 0"
     when 'links'
       query.where.insert 0, "#{table_alias}.id = 0"

data/test/querybuilder/custom.yml

@@ -59,4 +59,10 @@ it_should_paginate_the_entries:
   context:
     custom_query_group: test
   src: "abc limit 4 paginate foo"
-  res: "[%Q{SELECT a,34 AS number,c FROM test WHERE 3 AND 2 AND 1 ORDER BY a ASC LIMIT 4 OFFSET ?}, ((foo.to_i > 0 ? foo.to_i : 1)-1)*4]"
+  res: "[%Q{SELECT a,34 AS number,c FROM test WHERE 3 AND 2 AND 1 ORDER BY a ASC LIMIT 4 OFFSET ?}, ((foo.to_i > 0 ? foo.to_i : 1)-1)*4]"
+
+it_should_use_alias_in_filter:
+  context:
+    custom_query_group: test
+  src: "abc where number > 10"
+  res: "%Q{SELECT a,34 AS number,c FROM test WHERE (34) > 10 AND 3 AND 2 AND 1 ORDER BY a ASC}"

data/test/querybuilder/filters.yml

@@ -86,12 +86,33 @@ equation_and_or_par:
   res: "[%Q{SELECT objects.* FROM objects WHERE (objects.event_at > '2006-04-01' OR objects.name LIKE 'foo%') AND objects.parent_id = ? GROUP BY id}, id]"
 
 or_with_same_tables:
-  src: "objects where index = 5 or index = 7"
-  res: "[%Q{SELECT objects.* FROM index,objects WHERE ((index.value = 5 AND index.node_id = objects.id) OR (index.value = 7 AND index.node_id = objects.id)) AND objects.parent_id = ? GROUP BY objects.id}, id]"
+  src: "objects where age = 5 or age = 7"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,objects WHERE ((id1.value = 5 AND id1.key = 'age' AND id1.node_id = objects.id) OR (id1.value = 7 AND id1.key = 'age' AND id1.node_id = objects.id)) AND objects.parent_id = ? GROUP BY objects.id}, id]"
 
 or_with_missing_table:
-  src: "objects where index = 5 or 7"
-  res: "[%Q{SELECT objects.* FROM index,objects WHERE ((index.value = 5 AND index.node_id = objects.id) OR (7 AND index.id = 0)) AND objects.parent_id = ? GROUP BY objects.id}, id]"
+  src: "objects where age = 5 or 7"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,objects WHERE ((id1.value = 5 AND id1.key = 'age' AND id1.node_id = objects.id) OR (7 AND id1.id = 0)) AND objects.parent_id = ? GROUP BY objects.id}, id]"
+
+or_different_table:
+  src: "objects where age = 5 or size = 15"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,objects WHERE ((id1.value = 5 AND id1.key = 'age' AND id1.node_id = objects.id) OR (id1.value = 15 AND id1.key = 'size' AND id1.node_id = objects.id)) AND objects.parent_id = ? GROUP BY objects.id}, id]"
+
+and_with_same_tables:
+  src: "objects where age > 5 and age < 7"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,objects WHERE id1.value > 5 AND id1.value < 7 AND id1.key = 'age' AND id1.node_id = objects.id AND objects.parent_id = ?}, id]"
+
+and_with_same_tables_different_key:
+  src: "objects where age > 5 and size = 10"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,idx_nodes AS id2,objects WHERE id1.value > 5 AND id2.value = 10 AND id2.key = 'size' AND id2.node_id = objects.id AND id1.key = 'age' AND id1.node_id = objects.id AND objects.parent_id = ?}, id]"
+
+
+filter_and_order_index:
+  src: "objects where age > 5 order by age asc"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,objects WHERE id1.value > 5 AND id1.key = 'age' AND id1.node_id = objects.id AND objects.parent_id = ? ORDER BY id1.value ASC}, id]"
+
+order_without_idx_filter:
+  src: "objects order by age asc"
+  res: "[%Q{SELECT objects.* FROM idx_nodes AS id1,objects WHERE id1.key = 'age' AND id1.node_id = objects.id AND objects.parent_id = ? ORDER BY id1.value ASC}, id]"
 
 equation_par:
   src: "objects where (1 > 2 or 2 > 3) and 4 = 5 "

data/test/querybuilder/joins.yml

@@ -18,7 +18,7 @@ parent_from_parent:
 
 children_from_objects_in_project:
   res: "[%Q{SELECT objects.* FROM objects,objects AS ob1 WHERE objects.parent_id = ob1.id AND ob1.project_id = ? GROUP BY objects.id}, project_id]"
-  
+
 tags:
   sxp: '[:query, [:relation, "tags"]]'
   res: "%Q{SELECT objects.* FROM objects INNER JOIN tags ON objects.id = tags.node_id}"
@@ -31,7 +31,7 @@ complex_from_with_scopes_and_typed_scope:
   # instead of 'project', we give it a class with 'jobs:project'
   src: "letters where name = 'foo' in jobs:project from letters in section"
   sxp: '[:query, [:from, [:scope, [:filter, [:relation, "letters"], [:"=", [:field, "name"], [:string, "foo"]]], "jobs:project"], [:scope, [:relation, "letters"], "section"]]]'
-  
+
 letters_in_project_from_letters:
   sxp: '[:query, [:from, [:scope, [:relation, "letters"], "project"], [:relation, "letters"]]]'
   res: "[%Q{SELECT objects.* FROM objects,objects AS ob1 WHERE objects.kpath LIKE 'NNL%' AND objects.project_id = ob1.id AND ob1.kpath LIKE 'NNL%' AND ob1.parent_id = ? GROUP BY objects.id}, id]"

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 0
-  version: 0.9.0
+  - 1
+  version: 0.9.1
 platform: ruby
 authors: 
 - Gaspard Bucher
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-14 00:00:00 +02:00
+date: 2010-09-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency