querybuilder 0.8.3 → 0.9.0

data/History.txt

@@ -1,3 +1,10 @@
+== 0.9.0 2010-09-14
+
+* 1 Major enhancements
+  * Lazy loading of custom queries.
+  * Select keys introspection in Query class.
+  * Using new RubyLess.translate API.
+
 == 0.8.3 2010-08-31
 
 * 2 Major enhancements

data/README.rdoc

@@ -43,7 +43,7 @@ xml/html environments):
 
   '+' | '-' | '<' | '<=' | '=' | '>=' | '>'
   'or' | 'and' | 'lt' | 'le' | 'eq' | 'ne' | 'ge' | 'gt'
-  'like' | 'not like' | 'match'
+  'like' | 'not like' | 'match' | 'in'
 
 This lets you build complex queries like:
 

data/Rakefile

@@ -16,7 +16,7 @@ begin
     gem.email = "gaspard@teti.ch"
     gem.homepage = "http://zenadmin.org/524"
     gem.authors = ["Gaspard Bucher"]
-    gem.add_dependency "rubyless", ">= 0.5.0"
+    gem.add_dependency "rubyless", ">= 0.7.0"
     gem.add_development_dependency "shoulda", ">= 0"
     gem.add_development_dependency "yamltest", ">= 0.5.0"
     gem.extensions << 'lib/extconf.rb'

data/lib/query_builder/info.rb

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

data/lib/query_builder/processor.rb

@@ -6,7 +6,7 @@ module QueryBuilder
 
     class << self
       # class variable
-      attr_accessor :main_table, :main_class, :custom_queries
+      attr_accessor :main_table, :main_class, :custom_queries, :custom_query_files
       attr_accessor :defaults
       attr_accessor :before_process_callbacks, :after_process_callbacks
 
@@ -68,9 +68,16 @@ module QueryBuilder
       # Once loaded, this 'custom query' can be used in a query like:
       #   "images from abc where a > 54"
       def load_custom_queries(directories)
+        # lazy loading (evaluation happens on first query)
+        self.custom_query_files ||= []
+        self.custom_query_files << directories
+      end
+
+      def load_custom_queries!
+        return unless list = self.custom_query_files
         klass = nil
         self.custom_queries ||= {}
-        Dir.glob(directories).each do |dir|
+        Dir.glob(list.flatten).each do |dir|
           if File.directory?(dir)
             Dir.foreach(dir) do |file|
               next unless file =~ /(.+).yml$/
@@ -97,6 +104,7 @@ module QueryBuilder
             end
           end
         end
+        self.custom_query_files = nil
       rescue NameError => err
         raise ArgumentError.new("Invalid Processor class (#{klass})")
       end
@@ -427,7 +435,7 @@ module QueryBuilder
 
       def process_attr(fld_name)
         if @rubyless_helper
-          insert_bind(RubyLess.translate(fld_name, @rubyless_helper))
+          insert_bind(RubyLess.translate(@rubyless_helper, fld_name))
         else
           insert_bind(fld_name)
         end
@@ -449,14 +457,14 @@ module QueryBuilder
 
       def process_dstring(string)
         raise QueryBuilder::SyntaxError.new("Cannot parse rubyless (missing binding context).") unless helper = @rubyless_helper
-        res = RubyLess.translate_string(string, helper)
+        res = RubyLess.translate_string(helper, string)
         res.literal ? quote(res.literal) : insert_bind(res)
       end
 
       def process_rubyless(string)
         # compile RubyLess...
         raise QueryBuilder::SyntaxError.new("Cannot parse rubyless (missing binding context).") unless helper = @rubyless_helper
-        res = RubyLess.translate(string, helper)
+        res = RubyLess.translate(helper, string)
         res.literal ? quote(res.literal) : insert_bind(res)
       end
 
@@ -656,13 +664,13 @@ module QueryBuilder
         end
       end
 
-      def custom_query(relation)
+      def custom_query_without_loading(relation)
         return false unless first? && last?  # current safety net until "from" is correctly implemented and tested
 
         custom_queries = self.class.custom_queries[self.class]
         if custom_queries &&
            custom_queries[@opts[:custom_query_group]] &&
-           custom_query = custom_queries[@opts[:custom_query_group]][relation]
+           custom_query = custom_queries[@opts[:custom_query_group]][relation.singularize]
 
           custom_query.each do |k,v|
             @query.send(:instance_variable_set, "@#{k}", prepare_custom_query_arguments(k.to_sym, v))
@@ -675,6 +683,15 @@ module QueryBuilder
         end
       end
 
+      # Method executed only once, then alias resolves to custom_query_without_loading.
+      def custom_query(*args)
+        self.class.load_custom_queries!
+        self.class.class_eval do
+          alias custom_query custom_query_without_loading
+        end
+        custom_query_without_loading(*args)
+      end
+
     private
 
       %W{filter scope limit offset paginate group order}.each do |context|

data/lib/query_builder/query.rb

@@ -53,6 +53,20 @@ module QueryBuilder
       @where << filter
     end
 
+    # Return all explicit selected keys (currently selection is only available in custom queries)
+    # For example, sql such as "SELECT form.*, MAX(form.date) AS last_date" would provice 'last_date' key.
+    def select_keys
+      @select_keys ||= (@select || []).map do |field|
+        if field =~ %r{AS\s+(.+)$}
+          $1
+        elsif field =~ %r{^(\w+\.|)([^\*]+)$}
+          $2
+        else
+          nil
+        end
+      end.compact
+    end
+
     # Convert query object to a string. This string should then be evaluated.
     #
     # ==== Parameters
@@ -285,4 +299,4 @@ module QueryBuilder
         end
       end
   end
-end
+end

data/querybuilder.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{querybuilder}
-  s.version = "0.8.3"
+  s.version = "0.9.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-31}
+  s.date = %q{2010-09-14}
   s.description = %q{QueryBuilder is an interpreter for the "pseudo sql" language. This language
     can be used for two purposes:
 
@@ -86,16 +86,16 @@ 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_runtime_dependency(%q<rubyless>, [">= 0.7.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<rubyless>, [">= 0.7.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<rubyless>, [">= 0.7.0"])
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<yamltest>, [">= 0.5.0"])
   end

data/test/mock/custom_queries/test.yml

@@ -11,17 +11,32 @@ DummyProcessor:
       - '2'
       - '3'
     order: a ASC
-    
+
+  star:
+    select:
+      - test.*
+      - '*'
+      - a
+      - 34 AS number
+      - c
+    tables:
+      - test
+    where:
+      - '1'
+      - '2'
+      - '3'
+    order: a ASC
+
   two_table:
     main_table: 'table_one'
     select:
       - x AS x
       - IF(table_one.y,table_one.y,table_two.z) AS y
       - table_two.name
-    tables:  
+    tables:
       - table_two
       - table_one
-      
+
   two_table_main:
     main_table: foo
     select:

data/test/querybuilder_test.rb

@@ -67,6 +67,20 @@ class DummyQueryBuilder < Test::Unit::TestCase
     end
   end # Including QueryBuilder
 
+  context 'A query with custom select' do
+    subject do
+      DummyProcessor.new('star where number < 4', :custom_query_group => 'test').query
+    end
+
+    should 'respond to select_keys' do
+      assert_equal %w{a number c}, subject.select_keys
+    end
+    
+    should 'not include star keys' do
+      assert !subject.select_keys.include?('*')
+    end
+  end # A query with custom select
+
 
   def yt_parse(key, source, opts)
     opts = {:rubyless_helper => self}.merge(Hash[*(opts.map{|k,v| [k.to_sym, v]}.flatten)])
@@ -114,4 +128,4 @@ class DummyQueryBuilder < Test::Unit::TestCase
   end
 =end
   yt_make
-end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
-  - 3
-  version: 0.8.3
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Gaspard Bucher
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-31 00:00:00 +02:00
+date: 2010-09-14 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,9 +26,9 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 0
-        - 5
+        - 7
         - 0
-        version: 0.5.0
+        version: 0.7.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency