qreport 0.0.10 → 0.1.0

data/ChangeLog

@@ -1,3 +1,14 @@
+2013-10-14  Kurt A. Stephens  <ks.github@kurtstephens.com>
+	* v0.1.0: New Features.
+	* Handle Connection#close cleanly.
+	* Handle Rational data.
+	* Preliminary ARRAY[] data.
+	* Trap errors in ReportRun#data SELECT.
+
+2013-10-02  Kurt A. Stephens  <ks.github@kurtstephens.com>
+	* v0.0.11: New Features.
+	* ReportRun#data.columns: avoid pulling in entire report rows.
+
 2013-10-01  Kurt A. Stephens  <ks.github@kurtstephens.com>
 	* v0.0.10: New Features.
 	* Support CTE queries using "FROM (<subselect>) AS" syntax.

data/lib/qreport/connection.rb

@@ -1,5 +1,6 @@
 require 'qreport'
 require 'time' # iso8601
+require 'rational' # Rational
 require 'pp' # dump_result!
 
 module Qreport
@@ -74,17 +75,23 @@ module Qreport
 
     def close
       raise Error, "close during transaction" if in_transaction?
+      _close
+    ensure
+      @invalid = false
+    end
+
+    def _close
       if @conn
         conn = @conn
         @conn = nil
         conn.close if @conn_owned
       end
     ensure
-      @invalid = false
-      @transaction_nesting = 0
       @conn_owned = false
+      @transaction_nesting = 0
     end
 
+
     def in_transaction?; @transaction_nesting > 0; end
 
     def transaction
@@ -181,7 +188,8 @@ module Qreport
       conn.escape_identifier name.to_s
     end
 
-    def escape_value val
+    def escape_value val, example_value = nil
+      example_val ||= val
       case val
       when SQL
         val.to_s
@@ -191,16 +199,30 @@ module Qreport
         T_
       when false
         F_
-      when Integer, Float
+      when Rational
+        val.to_f
+      when Numeric
         val
       when String, Symbol
         "'" << conn.escape_string(val.to_s) << QUOTE
       when Time
-        escape_value(val.iso8601(6)) << "::timestamp"
+        escape_value(val.iso8601(6)) << S_TIMESTAMP
       when Range
         "BETWEEN #{escape_value(val.first)} AND #{escape_value(val.last)}"
-      when Hash, Array
+      when Hash
         escape_value(val.to_json)
+      when Array
+        case
+        when true
+          # PUNT!!!
+          escape_value(val.to_json)
+          # DOES NOT HANDLE EMPTY ARRAY!!!
+        when example_val.all?{|x| Numeric === x || x.nil?} && ! example_val.empty?
+          "ARRAY[#{val.map{|x| escape_value(x, example_val[0])} * ','}]"
+        else
+          # PUNT!!!
+          escape_value(val.to_json)
+        end
       else
         raise TypeError, "cannot escape_value on #{val.class.name}"
       end.to_s
@@ -210,6 +232,7 @@ module Qreport
     T_ = "'t'::boolean".freeze
     F_ = "'f'::boolean".freeze
     T = 't'.freeze
+    S_TIMESTAMP = "::timestamp".freeze
 
     def unescape_value val, type
       case val
@@ -227,6 +250,15 @@ module Qreport
         return func
       end
       case type
+      when /\[\]\Z/
+        et = $`
+        el = unescape_value_func(et)
+        lambda do | val, type |
+#          PP.pp([ val, type, et ])
+          val.gsub(/\A\{|\}\Z/, '').
+            split(',').
+            map{|x| x == 'NULL' ? nil : el.call(x, et)}
+        end
       when /^bool/
         lambda { | val, type | val == T }
       when /^(int|smallint|bigint|oid|tid|xid|cid)/
@@ -286,145 +318,28 @@ module Qreport
     end
 
     def run_query! sql, query, options = nil
+      error = nil
       options ||= EMPTY_Hash
+      # $stderr.puts "  run_query! options = #{options.inspect}"
       result = nil
       begin
         result = conn.async_exec(sql)
       rescue ::PG::Error => exc
-        # $stderr.puts "  ERROR: #{exc.inspect}\n  #{exc.backtrace * "\n  "}"
-        query.error = exc.inspect
-        raise exc unless options[:capture_error]
+        error = exc
       rescue ::StandardError => exc
         @invalid = true
-        query.error = exc.inspect
-        raise exc unless options[:capture_error]
+        error = exc
       end
       result
-    end
-
-    class Query
-      attr_accessor :conn, :sql, :options
-      attr_accessor :sql_prepared
-      attr_accessor :error, :cmd_status_raw, :cmd_status, :cmd_tuples
-      attr_accessor :nfields, :fields, :ftypes, :fmods
-      attr_accessor :type_names
-      attr_accessor :columns, :rows
-
-      def run!
-        @error = nil
-        sql = @sql_prepared = prepare_sql self.sql
-        if conn.verbose || options[:verbose]
-          out = conn.verbose_stream
-          out.puts "\n-- =================================================================== --"
-          out.puts sql
-          out.puts "-- ==== --"
-        end
-        return self if options[:dry_run]
-        if result = conn.run_query!(sql, self, options)
-          extract_results! result
-        end
-        self
-      end
-
-      def prepare_sql sql
-        sql = sql.sub(/[\s\n]*;[\s\n]*\Z/, '')
-        if options.key?(:limit)
-          sql = conn.with_limit sql, options[:limit]
-        end
-        if arguments = options[:arguments]
-          if values = arguments[:names_and_values]
-            n = conn.safe_sql(values.keys * ', ')
-            v = conn.safe_sql(values.keys.map{|k| ":#{k}"} * ', ')
-            sql = sql_replace_arguments(sql,
-                              :NAMES  => n,
-                              :VALUES => v,
-                              :NAMES_AND_VALUES => conn.safe_sql("( #{n} ) VALUES ( #{v} )"),
-                              :SET_VALUES => conn.safe_sql(values.keys.map{|k| "#{conn.escape_identifier(k)} = :#{k}"} * ', '))
-            arguments = arguments.merge(values)
-          end
-          sql = sql_replace_arguments(sql, arguments)
-        end
-        sql
-      end
-
-      def sql_replace_arguments sql, arguments
-        sql = sql.gsub(/(:(\w+)\b([?]?))/) do | m |
-          name = $2.to_sym
-          optional = ! $3.empty?
-          if arguments.key?(name) || optional
-            val = arguments[name]
-            unless optional && val.nil?
-              val = conn.escape_value(val)
-            end
-            conn.verbose_stream.puts "  #{name} => #{val}" if options[:verbose_arguments]
-            val
-          else
-            $1
-          end
-        end
-        sql = sql_replace_match sql
-      end
-
-      def sql_replace_match sql
-        sql = sql.gsub(/:~\s*\{\{([^\}]+?)\}\}\s*\{\{([^\}]+?)\}\}/) do | m |
-          expr = $1
-          val = $2
-          case expr
-          when /\A\s*BETWEEN\b/
-            "(#{val} #{expr})"
-          when "NULL"
-            "(#{val} IS NULL)"
-          else
-            "(#{val} = #{expr})"
-          end
-        end
-        sql
-      end
-
-      def extract_results! result
-        error = result.error_message
-        error &&= ! error.empty? && error
-        @error = error
-        @cmd_status_raw = result.cmd_status
-        @cmd_tuples = result.cmd_tuples
-        @nfields = result.nfields
-        @ntuples = result.ntuples
-        @fields = result.fields
-        @ftypes = (0 ... nfields).map{|i| result.ftype(i) }
-        @fmods  = (0 ... nfields).map{|i| result.fmod(i) }
-        @rows = result.to_a
-        result.clear
-        self
-      end
-
-      def columns
-        @columns ||= @fields.zip(type_names)
-      end
-
-      def type_names
-        @type_names ||= (0 ... nfields).map{|i| conn.type_name(@ftypes[i], @fmods[i])}
-      end
-
-      def cmd_status
-        @cmd_status ||=
-          begin
-            x = @cmd_status_raw.split(/\s+/)
-            [ x[0] ] + x[1 .. -1].map(&:to_i)
-          end.freeze
-      end
-
-      def rows
-        return @rows if @rows_unescaped
-        @rows.each do | r |
-          columns.each do | c, t |
-            r[c] = conn.unescape_value(r[c], t)
-          end
-        end
-        @rows_unescaped = true
-        @rows
+    ensure
+      if error
+        # $stderr.puts "  ERROR: #{exc.inspect}\n  #{exc.backtrace * "\n  "}"
+        query.error = error.inspect
+        raise error unless options[:capture_error]
       end
-
     end
+
   end
 end
 
+require 'qreport/connection/query'

data/lib/qreport/connection/query.rb

@@ -0,0 +1,138 @@
+require 'qreport/connection'
+
+module Qreport
+  class Connection
+    class Query
+      attr_accessor :conn, :sql, :options
+      attr_accessor :sql_prepared
+      attr_accessor :error, :cmd_status_raw, :cmd_status, :cmd_tuples
+      attr_accessor :nfields, :fields, :ftypes, :fmods
+      attr_accessor :type_names
+      attr_accessor :columns, :rows
+
+      def run!
+        @error = nil
+        @fields = @ftypes = @mods = EMPTY_Array
+        @nfields = 0
+        sql = @sql_prepared = prepare_sql self.sql
+        if conn.verbose || options[:verbose]
+          out = conn.verbose_stream
+          out.puts "\n-- =================================================================== --"
+          out.puts sql
+          out.puts "-- ==== --"
+        end
+        return self if options[:dry_run]
+        if result = conn.run_query!(sql, self, options)
+          extract_results! result
+        end
+        self
+      ensure
+        @conn = nil
+      end
+
+      def prepare_sql sql
+        sql = sql.sub(/[\s\n]*;[\s\n]*\Z/, '')
+        if options.key?(:limit)
+          sql = conn.with_limit sql, options[:limit]
+        end
+        if arguments = options[:arguments]
+          if values = arguments[:names_and_values]
+            n = conn.safe_sql(values.keys * ', ')
+            v = conn.safe_sql(values.keys.map{|k| ":#{k}"} * ', ')
+            sql = sql_replace_arguments(sql,
+                              :NAMES  => n,
+                              :VALUES => v,
+                              :NAMES_AND_VALUES => conn.safe_sql("( #{n} ) VALUES ( #{v} )"),
+                              :SET_VALUES => conn.safe_sql(values.keys.map{|k| "#{conn.escape_identifier(k)} = :#{k}"} * ', '))
+            arguments = arguments.merge(values)
+          end
+          sql = sql_replace_arguments(sql, arguments)
+        end
+        sql
+      end
+
+      def sql_replace_arguments sql, arguments
+        sql = sql.gsub(/(:(\w+)\b([?]?))/) do | m |
+          name = $2.to_sym
+          optional = ! $3.empty?
+          if arguments.key?(name) || optional
+            val = arguments[name]
+            unless optional && val.nil?
+              val = conn.escape_value(val)
+            end
+            conn.verbose_stream.puts "  #{name} => #{val}" if options[:verbose_arguments]
+            val
+          else
+            $1
+          end
+        end
+        sql = sql_replace_match sql
+      end
+
+      def sql_replace_match sql
+        sql = sql.gsub(/:~\s*\{\{([^\}]+?)\}\}\s*\{\{([^\}]+?)\}\}/) do | m |
+          expr = $1
+          val = $2
+          case expr
+          when /\A\s*BETWEEN\b/
+            "(#{val} #{expr})"
+          when "NULL"
+            "(#{val} IS NULL)"
+          else
+            "(#{val} = #{expr})"
+          end
+        end
+        sql
+      end
+
+      def extract_results! result
+        error = result.error_message
+        error = nil if error.empty?
+        @error = error
+        @cmd_status_raw = result.cmd_status
+        @cmd_tuples = result.cmd_tuples
+        @nfields = result.nfields
+        @ntuples = result.ntuples
+        @fields = result.fields
+        @ftypes = (0 ... nfields).map{|i| result.ftype(i) }
+        @fmods  = (0 ... nfields).map{|i| result.fmod(i) }
+        @rows = result.to_a
+        type_names
+        rows
+        self
+      ensure
+        result.clear
+        @conn = nil
+      end
+
+      def columns
+        @columns ||= @fields.zip(type_names)
+      end
+
+      def type_names
+        @type_names ||= (0 ... nfields).map{|i| @conn.type_name(@ftypes[i], @fmods[i])}
+      end
+
+      def cmd_status
+        @cmd_status ||=
+          begin
+            x = @cmd_status_raw.split(/\s+/)
+            [ x[0] ] + x[1 .. -1].map(&:to_i)
+          end.freeze
+      end
+
+      def rows
+        return @rows if @rows_unescaped
+        (@rows ||= [ ]).each do | r |
+          columns.each do | c, t |
+            r[c] = @conn.unescape_value(r[c], t)
+          end
+        end
+        @rows_unescaped = true
+        @rows
+      end
+
+    end
+  end
+end
+

data/lib/qreport/report_run.rb

@@ -182,8 +182,7 @@ END
 
     # Return rows from this report run's report table.
     def data
-      @data ||=
-        _select
+      @data ||= ReportRun::Data.new(self)
     end
 
     def select options = nil
@@ -229,3 +228,5 @@ END
     end
   end
 end
+
+require 'qreport/report_run/data'

data/lib/qreport/report_run/data.rb

@@ -0,0 +1,33 @@
+require 'qreport/report_run'
+
+module Qreport
+  class ReportRun
+    # Delays pulling in entire result set to determine columns of report result table.
+    class Data
+      attr_accessor :report_run
+
+      def initialize report_run; @report_run = report_run; end
+
+      def columns;    _select0.columns; end
+      def type_names; _select0.type_names; end
+      def rows;       _select.rows; end
+      def error;      _select0.error; end
+
+      # Delegate all other methods to the Connection::Query object.
+      def method_missing sel, *args, &blk
+        _select.send(sel, *args, &blk)
+      end
+
+private
+
+      def _select
+        @_select ||= report_run._select(:capture_error => true)
+      end
+
+      def _select0
+        @_select0 ||= (@_select || report_run._select(:capture_error => true, :limit => 0))
+      end
+
+    end
+  end
+end

data/lib/qreport/version.rb

@@ -1,3 +1,3 @@
 module Qreport
-  VERSION = "0.0.10"
+  VERSION = "0.1.0"
 end

data/spec/lib/qreport/connection_spec.rb

@@ -2,18 +2,16 @@ require 'spec_helper'
 require 'qreport/connection'
 
 describe Qreport::Connection do
-  QREPORT_TEST_CONN = [ nil ]
-  def conn
-    QREPORT_TEST_CONN[0] ||= Qreport::Connection.new
-  end
+  let(:conn) { Qreport::Connection.new }
+  after(:each) { conn._close }
 
   it "can to connect to a test database." do
     conn.conn.class.should == PG::Connection
   end
 
   it "can manage transaction state." do
-    conn.should_receive(:_transaction_begin).once
-    conn.should_receive(:_transaction_commit).once
+    conn.should_receive(:_transaction_begin).exactly(1).times
+    conn.should_receive(:_transaction_commit).exactly(1).times
     conn.should_receive(:_transaction_abort).exactly(0).times
     conn.in_transaction?.should == false
     conn.transaction do
@@ -23,8 +21,8 @@ describe Qreport::Connection do
   end
 
   it "can manage nested transactions." do
-    conn.should_receive(:_transaction_begin).once
-    conn.should_receive(:_transaction_commit).once
+    conn.should_receive(:_transaction_begin).exactly(1).times
+    conn.should_receive(:_transaction_commit).exactly(1).times
     conn.should_receive(:_transaction_abort).exactly(0).times
     conn.in_transaction?.should == false
     conn.transaction do
@@ -38,9 +36,9 @@ describe Qreport::Connection do
   end
 
   it "can manage transaction state during raised exceptions" do
-    conn.should_receive(:_transaction_begin).once
+    conn.should_receive(:_transaction_begin).exactly(1).times
     conn.should_receive(:_transaction_commit).exactly(0).times
-    conn.should_receive(:_transaction_abort).once
+    conn.should_receive(:_transaction_abort).exactly(1).times
     lambda do
       conn.transaction do
         raise Qreport::Error, "#{__LINE__}"
@@ -49,6 +47,19 @@ describe Qreport::Connection do
     conn.in_transaction?.should == false
   end
 
+
+  it "will error upon #close during transaction" do
+    conn.should_receive(:_transaction_begin).exactly(1).times
+    conn.should_receive(:_transaction_commit).exactly(0).times
+    conn.should_receive(:_transaction_abort).exactly(1).times
+    lambda do
+      conn.transaction do
+        conn.close
+      end
+    end.should raise_error(Qreport::Error)
+    conn.in_transaction?.should == false
+  end
+
   it "can dup to create another connection." do
     conn1 = Qreport::Connection.new
     conn1.fd.should == nil
@@ -130,6 +141,14 @@ describe Qreport::Connection do
     [ Time.parse('2011-04-27 13:23:00 -0500'), "'2011-04-27T13:23:00.000000-05:00'::timestamp", Time.parse('2011-04-27 13:23:00 -0500') ],
     [ :IGNORE, "'13:23'::time", '13:23:00' ],
     [ [ 1, "2", :three ], "'[1,\"2\",\"three\"]'", :IGNORE ],
+=begin
+DOES NOT WORK YET
+      [ [ 1, 2, 3 ], 'ARRAY[1,2,3]', ],
+      [ [ 1, 2, nil, 3 ], 'ARRAY[1,2,NULL,3]', ],
+      [ [ 1, 2.2, 3 ], 'ARRAY[1,2.2,3]', [ 1.0, 2.2, 3.0 ] ],
+      [ [ 1, nil, 2.2, 3 ], 'ARRAY[1,NULL,2.2,3]', [ 1.0, nil, 2.2, 3.0 ] ],
+      [ :IGNORE, 'ARRAY[1,NULL,2.2,3]', [ 1.0, nil, 2.2, 3.0 ] ],
+=end
     [ { :a => 1, "b" => 2 }, "'{\"a\":1,\"b\":2}'", :IGNORE ],
   ].each do | value, sql, return_value, sql_expr, sql_value |
     if value != :IGNORE

data/spec/lib/qreport/report_runner_spec.rb

@@ -56,6 +56,7 @@ describe Qreport::ReportRunner do
       r2.data.columns.should == r.data.columns
       r2.data.rows.should == r.data.rows
       r2.data.rows.size.should == r.nrows
+      r2.data.cmd_status[0].should == "SELECT"
     end
   end
 
@@ -106,7 +107,6 @@ FROM articles
 SELECT total_users.*, total_articles.*
 FROM total_users, total_articles;
 END
-    report_run.verbose = true
     report_run.run! conn
     report_run.columns.should == [["qr_run_id", "bigint"], ["qr_run_row", "bigint"], ["total_users", "bigint"], ["total_articles", "bigint"]]
     rows = report_run.select.rows
@@ -165,7 +165,6 @@ END
 
     [ '1 days', '2 days', '30 days', '60 days' ].each do | interval |
       report_run = Qreport::ReportRun.new(:name => :users_with_articles, :description => interval, :variant => interval)
-      report_run.verbose = verbose
       report_run.arguments = {
         :now => now,
         :interval => interval,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qreport
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -140,10 +140,12 @@ files:
 - Rakefile
 - lib/qreport.rb
 - lib/qreport/connection.rb
+- lib/qreport/connection/query.rb
 - lib/qreport/initialization.rb
 - lib/qreport/main.rb
 - lib/qreport/model.rb
 - lib/qreport/report_run.rb
+- lib/qreport/report_run/data.rb
 - lib/qreport/report_runner.rb
 - lib/qreport/version.rb
 - qreport.gemspec
@@ -164,7 +166,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -862269867070365342
+      hash: 2467578902340912211
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -173,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -862269867070365342
+      hash: 2467578902340912211
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25