qreport 0.0.7 → 0.0.8

data/ChangeLog

@@ -1,3 +1,14 @@
+2013-09-24  Kurt A. Stephens  <ks.github@kurtstephens.com>
+	* v0.0.8: Bug fixes, performance improvements, new features.
+	* Correctly handle other Float column types.
+	* User-defined unescape_value functions.
+	* User-defined verbose output stream.
+	* Ephermeral ReportRun#error_object.
+
+2013-07-10  Kurt A. Stephens  <ks.github@kurtstephens.com>
+	* v0.0.7: Bug fix.
+	* Do whatever it takes to DROP SEQUENCE IF EXISTS qr_row_seq for pooled connections.
+
 2013-07-08  Kurt A. Stephens  <ks.github@kurtstephens.com>
 
 	* v0.0.6: New Version: New Functionality.

data/README.md

@@ -108,7 +108,7 @@ Example: a Range of Time values matching a.created_on:
       :interval => (t - 86400) ... t,
     }
     report_run.run! <<"END"
-    SELECT * FROM articles a WHERe :~ {{:interval}} {{a.created_on}}
+    SELECT * FROM articles a WHERE :~ {{:interval}} {{a.created_on}}
     END
 
 ## Batch Processing
@@ -123,7 +123,7 @@ Example setup:
    postgres=# create database test owner test;
    CREATE DATABASE
    postgres=# \q
-   $ PGHOST=localhost PGUSER=test PGDATABSE=test PGPASSWORD=... rake
+   $ PGHOST=localhost PGUSER=test PGDATABASE=test PGPASSWORD=... rake
 
 ## Contributing
 

data/lib/qreport/connection.rb

@@ -1,11 +1,14 @@
 require 'qreport'
 require 'time' # iso8601
+require 'pp' # dump_result!
 
 module Qreport
   class Connection
-    attr_accessor :arguments, :verbose, :verbose_result, :env
+    attr_accessor :arguments, :env
+    attr_accessor :verbose, :verbose_result, :verbose_stream
     attr_accessor :schemaname
     attr_accessor :conn, :conn_owned
+    attr_accessor :unescape_value_funcs
 
     class << self
       attr_accessor :current
@@ -22,6 +25,7 @@ module Qreport
     def initialize_copy src
       @conn = @conn_owned = nil
       @abort_transaction = @invalid = nil
+      @unescape_value_funcs_cache = nil
       @transaction_nesting = 0
     end
 
@@ -158,7 +162,7 @@ module Qreport
       result.options = options
       result.conn = self
       result.run!
-      dump_result result if @verbose_result || options[:verbose_result]
+      dump_result! result if @verbose_result || options[:verbose_result]
       result
     end
 
@@ -198,7 +202,7 @@ module Qreport
       when Hash, Array
         escape_value(val.to_json)
       else
-        raise TypeError
+        raise TypeError, "cannot escape_value on #{val.class.name}"
       end.to_s
     end
     NULL = 'NULL'.freeze
@@ -209,35 +213,62 @@ module Qreport
 
     def unescape_value val, type
       case val
+      when nil
       when String
         return nil if val == NULL
-        case type
-        when "boolean"
-          val = val == T
-        when /int/
-          val = val.to_i
-        when "numeric"
-          val = val.to_f
-        when /timestamp/
-          val = Time.parse(val)
-        else
-          val
-        end
+        func = (@unescape_value_funcs_cache ||= { })[type] ||= unescape_value_func(type)
+        val = func.call(val, type)
+      end
+      val
+    end
+
+    def unescape_value_func type
+      if @unescape_value_funcs and func = @unescape_value_funcs[type]
+        return func
+      end
+      case type
+      when /^bool/
+        lambda { | val, type | val == T }
+      when /^(int|smallint|bigint|oid|tid|xid|cid)/
+        lambda { | val, type | val.to_i }
+      when /^(float|real|double|numeric)/
+        lambda { | val, type | val.to_f }
+      when /^timestamp/
+        lambda { | val, type | Time.parse(val) }
       else
-        val
+        IDENTITY
       end
     end
+    IDENTITY = lambda { | val, type | val }
 
-    def dump_result result
-      pp result if result
+    def verbose_stream
+      @verbose_stream || $stderr
+    end
+
+    def dump_result! result, stream = nil
+      PP.pp(result, stream || verbose_stream) if result
       result
     end
 
-    def type_name type, mod
-      @type_names ||= { }
-      @type_names[[type, mod]] ||=
-        conn.exec("SELECT format_type($1,$2)", [type, mod]).
-        getvalue(0, 0).to_s.dup.freeze
+    # Returns a frozen String representing a column type.
+    # The String also responds to #pg_ftype and #pg_fmod.
+    def type_name *args
+      (@type_names ||= { })[args] ||=
+        _type_name(args)
+    end
+
+    module TypeName
+      attr_accessor :pg_ftype, :pg_fmod
+    end
+
+    def _type_name args
+      x = conn.exec("SELECT pg_catalog.format_type($1,$2)", args).
+        getvalue(0, 0).to_s.dup
+      # x = ":#{args * ','}" if x.empty? or x == "unknown"
+      x.extend(TypeName)
+      x.pg_ftype, x.pg_fmod = args
+      x.freeze
+      x
     end
 
     def with_limit sql, limit = nil
@@ -283,9 +314,10 @@ module Qreport
         @error = nil
         sql = @sql_prepared = prepare_sql self.sql
         if conn.verbose || options[:verbose]
-          $stderr.puts "\n-- =================================================================== --"
-          $stderr.puts sql
-          $stderr.puts "-- ==== --"
+          out = 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)
@@ -324,7 +356,7 @@ module Qreport
             unless optional && val.nil?
               val = conn.escape_value(val)
             end
-            $stderr.puts "  #{name} => #{val}" if options[:verbose_arguments]
+            verbose_stream.puts "  #{name} => #{val}" if options[:verbose_arguments]
             val
           else
             $1

data/lib/qreport/report_run.rb

@@ -80,12 +80,15 @@ module Qreport
       when String
         @error = JSON.parse(x)
       when Exception
+        @error_object = x
         @error = { :error_class => x.class.name, :error_message => x.message }
       else
         raise TypeError
       end
     end
 
+    def error_object; @error_object || @error; end
+
     def self.schema! conn, options = { }
       result = conn.run <<"END", options.merge(:capture_error => true) # , :verbose => true
 CREATE SEQUENCE qr_report_runs_pkey;

data/lib/qreport/version.rb

@@ -1,3 +1,3 @@
 module Qreport
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/lib/qreport/connection_spec.rb

@@ -86,7 +86,34 @@ describe Qreport::Connection do
     conn.instance_variable_get('@conn').should == nil
   end
 
-  describe "#escape_value, #unescape_value" do
+  describe "#unescape_value" do
+    it "should not alter undefined types" do
+      conn.unescape_value(123, :UNDEFINED1).should == 123
+      conn.unescape_value("str", :UNDEFINED1).should == "str"
+      conn.unescape_value(:sym, :UNDEFINED1).should == :sym
+    end
+
+    it "should handle boolean" do
+      conn.unescape_value("t", 'boolean').should == true
+      conn.unescape_value("f", 'boolean').should == false
+      conn.unescape_value(true, 'boolean').should == true
+      conn.unescape_value(false, 'boolean').should == false
+    end
+
+    it "should handle floats" do
+      conn.unescape_value(123, 'float').should == 123
+      conn.unescape_value("123.45", 'float').should == 123.45
+      conn.unescape_value(123.45, 'float').should == 123.45
+      conn.unescape_value("123.45", 'double precision').should == 123.45
+    end
+
+    it "should handle defined types" do
+      conn.unescape_value_funcs = { 'money' => lambda { | val, type | [ val ] } }
+      conn.unescape_value("123.00", 'money').should == [ "123.00" ]
+    end
+  end
+
+  describe "#escape_value/#unescape_value" do
   [
     [ nil, 'NULL' ],
     [ true, "'t'::boolean" ],
@@ -94,22 +121,37 @@ describe Qreport::Connection do
     [ 1234, '1234' ],
     [ -1234, '-1234' ],
     [ 1234.45, '1234.45' ],
+    [ :IGNORE, '1234.56::float', 1234.56 ],
+    [ :IGNORE, '1234.56::float4', 1234.56 ],
+    [ :IGNORE, '1234.56::float8', 1234.56 ],
     [ "string with \", \\, and \'", "'string with \", \\, and '''" ],
     [ :a_symbol!, "'a_symbol!'", :a_symbol!.to_s ],
     [ Time.parse('2011-04-27T13:23:00.000000Z'), "'2011-04-27T13:23:00.000000Z'::timestamp", Time.parse('2011-04-27T13:23:00.000000') ],
     [ 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 ],
     [ { :a => 1, "b" => 2 }, "'{\"a\":1,\"b\":2}'", :IGNORE ],
-  ].each do | value, sql, return_value |
+  ].each do | value, sql, return_value, sql_expr, sql_value |
+    if value != :IGNORE
     it "can handle encoding #{value.class.name} value #{value.inspect} as #{sql.inspect}." do
       conn.escape_value(value).should == sql
     end
-    it "can handle decoding #{value.class.name} value #{value.inspect}." do
-      pending :if => return_value == :IGNORE
-      sql_x = conn.escape_value(value)
-      r = conn.run "SELECT #{sql_x}"
+    end
+
+    sql_value = return_value
+    sql_value = nil if sql_value == :IGNORE
+    sql_value ||= value
+    if return_value != :IGNORE
+    it "can handle decoding #{sql.inspect} as #{sql_value.inspect}." do
+      sql_x = sql # conn.escape_value(sql)
+      r = conn.run %Q{SELECT #{sql_x} AS "value"}
+      # PP.pp r.columns
+      # PP.pp r.ftypes
+      # PP.pp r.fmods
       r = r.rows.first.values.first
-      r.should == (return_value || value)
+      r.should == sql_value
+      r.class.should == sql_value.class
+    end
     end
   end
     it "raises TypeError for other values." do

data/spec/lib/qreport/report_runner_spec.rb

@@ -21,7 +21,11 @@ describe Qreport::ReportRunner do
     r.select(:limit => [ 4, 2 ]).rows.map{|x| x["user_id"]}.should == [ 3, 4, 5, 6 ]
 
     r = reports['60 days']
-    r.select.rows.map{|x| x["user_id"]}.should == (1..10).to_a
+    rows = r.select.rows
+    rows.map{|x| x["user_id"]}.should == (1..10).to_a
+
+    r.columns.should == [["qr_run_id", "bigint"], ["qr_run_row", "bigint"], ["user_id", "integer"], ["user_rank", "double precision"]]
+    rows.map{|x| x["user_rank"].class}.should == [ Float ] * 10
 
     reports.values.each do | r |
       r.delete!
@@ -76,8 +80,9 @@ describe Qreport::ReportRunner do
       EXISTS(SELECT * FROM articles a WHERE a.user_id = u.id AND a.created_on >= :now - INTERVAL :interval)
 END
     report_run.run! conn
+    report_run.error_object.should be_a PG::Error
     report_run.error.class.should == Hash
-    report_run.error[:error_class].should == 'PG::Error'
+    report_run.error[:error_class].should =~ /^PG::/
     report_run.error[:error_message].should =~ /column "unknown_column" does not exist/
 
     report_run.delete!
@@ -105,7 +110,9 @@ END
     @reports = { }
 
     sql = <<"END"
-    SELECT u.id AS "user_id"
+    SELECT
+        u.id AS "user_id"
+      , u.id / (SELECT MAX(id) FROM users)::float as "user_rank"
     FROM   users u
     WHERE
       EXISTS(SELECT * FROM articles a WHERE a.user_id = u.id AND a.created_on >= :now - INTERVAL :interval)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qreport
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-11 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -164,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2296611255217817535
+      hash: 3423526995074197651
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -173,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2296611255217817535
+      hash: 3423526995074197651
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25