qreport 0.0.3 → 0.0.6

data/ChangeLog

@@ -1,3 +1,11 @@
+2013-07-08  Kurt A. Stephens  <ks.github@kurtstephens.com>
+
+	* v0.0.6: New Version: New Functionality.
+	* ReportRun#variant additional key.
+	* ReportRun#data returns all rows of from its report table.
+	* ReportRun.find(id) returns a ReportRun object.
+	* ReportRun#reload! reloads a ReportRun object.
+
 2013-06-26  Kurt A. Stephens  <ks.github@kurtstephens.com>
 
 	* v0.0.3: New Version: New Functionality.

data/Guardfile

@@ -0,0 +1,8 @@
+# -*- ruby -*-
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^lib/.*/connection.rb$}) { "spec" }
+end
+

data/README.md

@@ -86,8 +86,45 @@ Subsequent queries with the same column signature will use "INSERT INTO users_wi
 
 ## Parameterizing Reports
 
+Report queries can be parameterized using embedded ":word" tags.
+Parameter arguments are saved in the report run table.
+
+    report_run.arguments = {
+      :interval => '30 days',
+    }
+    report_run.run! <<"END"
+    SELECT u.id AS "user_id"
+    FROM   users u
+    WHERE
+      EXISTS(SELECT * FROM articles a
+             WHERE a.user_id = u.id AND a.created_on >= NOW() - INTERVAL :interval)
+    END
+
+Arguments can also represent "matching" patterns using a ":~" tag.
+Example: a Range of Time values matching a.created_on:
+
+    t = Time.now
+    report_run.arguments = {
+      :interval => (t - 86400) ... t,
+    }
+    report_run.run! <<"END"
+    SELECT * FROM articles a WHERe :~ {{:interval}} {{a.created_on}}
+    END
+
 ## Batch Processing
 
+## Running Tests
+
+Example setup:
+
+   $ sudo -u postgresql psql
+   postgres=# create role test login password 'test';
+   CREATE ROLE
+   postgres=# create database test owner test;
+   CREATE DATABASE
+   postgres=# \q
+   $ PGHOST=localhost PGUSER=test PGDATABSE=test PGPASSWORD=... rake
+
 ## Contributing
 
 1. Fork it

data/lib/qreport.rb

@@ -4,5 +4,5 @@ module Qreport
   EMPTY_Hash = {}.freeze
   EMPTY_Array = [].freeze
   EMPTY_String = ''.freeze
-  class Error < ::Exception; end
+  class Error < ::StandardError; end
 end

data/lib/qreport/connection.rb

@@ -89,7 +89,7 @@ module Qreport
       begin
         transaction_begin
         yield
-      rescue ::Exception => exc
+      rescue ::StandardError => exc
         abort = @abort_transaction = exc
         raise exc
       ensure
@@ -135,10 +135,13 @@ module Qreport
     end
 
     def table_exists? name, schemaname = nil
-      schemaname ||= self.schemaname
+      schema_name = name.split('.', 2)
+      schema = schema_name.shift if schema_name.size > 1
+      name = schema_name.first
+      schema ||= schemaname || self.schemaname || 'public'
       result =
       run "SELECT EXISTS(SELECT * FROM pg_catalog.pg_tables WHERE tablename = :tablename AND schemaname = :schemaname) as \"exists\"",
-      :arguments => { :tablename => name, :schemaname => schemaname }
+      :arguments => { :tablename => name, :schemaname => schema }
       # result.rows; pp result
       result.rows[0]["exists"]
     end
@@ -190,6 +193,8 @@ module Qreport
         "'" << conn.escape_string(val.to_s) << QUOTE
       when Time
         escape_value(val.iso8601(6)) << "::timestamp"
+      when Range
+        "BETWEEN #{escape_value(val.first)} AND #{escape_value(val.last)}"
       when Hash, Array
         escape_value(val.to_json)
       else
@@ -258,7 +263,7 @@ module Qreport
         # $stderr.puts "  ERROR: #{exc.inspect}\n  #{exc.backtrace * "\n  "}"
         query.error = exc.inspect
         raise exc unless options[:capture_error]
-      rescue ::Exception => exc
+      rescue ::StandardError => exc
         @invalid = true
         query.error = exc.inspect
         raise exc unless options[:capture_error]
@@ -268,6 +273,7 @@ module Qreport
 
     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
@@ -324,6 +330,22 @@ module Qreport
             $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
 

data/lib/qreport/initialization.rb

@@ -5,10 +5,17 @@ module Qreport
     def initialize opts = nil
       opts ||= EMPTY_Hash
       initialize_before_opts if respond_to? :initialize_before_opts
-      opts.each do | k, v |
-        send(:"#{k}=", v)
-      end
+      initialize_from_hash! opts
       initialize_after_opts if respond_to? :initialize_after_opts
     end
+
+    def initialize_from_hash! opts
+      if opts
+        opts.each do | k, v |
+          send(:"#{k}=", v)
+        end
+      end
+      self
+    end
   end
 end

data/lib/qreport/report_run.rb

@@ -7,15 +7,16 @@ module Qreport
     include Model, Initialization
 
     attr_accessor :id
-    attr_accessor :name, :sql, :additional_columns
+    attr_accessor :name, :variant, :sql, :additional_columns
     attr_accessor :description
     attr_accessor :arguments
     attr_accessor :report_id
-    attr_accessor :report_sql
+    attr_accessor :report_sql, :raw_sql
     attr_accessor :columns, :base_columns, :column_signature
     attr_accessor :report_table
     attr_accessor :nrows
     attr_accessor :created_at, :started_at, :finished_at
+    attr_accessor :verbose
 
     # Construct report_table name from column names and types.
     def report_table
@@ -41,10 +42,18 @@ module Qreport
     def base_columns
       @base_columns ||= EMPTY_Array
     end
+    def base_columns= x
+      @base_columns = x
+      @columns = nil
+    end
 
     def additional_columns
       @additional_columns ||= EMPTY_Array
     end
+    def additional_columns= x
+      @additional_columns ||= EMPTY_Array
+      @columns = nil
+    end
 
     def columns
       @columns ||=
@@ -84,6 +93,7 @@ CREATE TABLE -- IF NOT EXISTS
 qr_report_runs (
     id           INTEGER PRIMARY KEY DEFAULT nextval('qr_report_runs_pkey')
   , name         VARCHAR(255) NOT NULL
+  , variant      VARCHAR(255)
   , sql          TEXT NOT NULL
   , description  TEXT NOT NULL
   , arguments    TEXT NOT NULL
@@ -97,6 +107,7 @@ qr_report_runs (
   , nrows        INTEGER
 );
 CREATE INDEX qr_report_runs__name ON qr_report_runs (name);
+CREATE INDEX qr_report_runs__variant ON qr_report_runs (variant);
 CREATE INDEX qr_report_runs__report_table ON qr_report_runs (report_table);
 CREATE INDEX qr_report_runs__created_at ON qr_report_runs (created_at);
 END
@@ -105,6 +116,7 @@ END
     def insert!
       values = {
         :name => name,
+        :variant => variant,
         :sql => sql,
         :description => description,
         :arguments => (arguments || { }),
@@ -150,6 +162,27 @@ WHERE id = :qr_run_id
 END
     end
 
+    def self.find id
+      obj = new
+      obj.id = id
+      obj.reload!
+    end
+
+    def reload!
+      result = conn.run("SELECT * FROM qr_report_runs WHERE id = :id LIMIT 1", :arguments => { :id => id })
+      result = result.rows.first
+      initialize_from_hash! result
+      @base_columns = JSON.parse(@base_columns)
+      @data = nil
+      self
+    end
+
+    # Return rows from this report run's report table.
+    def data
+      @data ||=
+        _select
+    end
+
     def select options = nil
       options = _options options
       _select({:order_by => 'ORDER BY qr_run_row'}.merge(options))
@@ -176,10 +209,14 @@ END
       conn.run "SELECT COUNT(*) AS \"count\" from qr_report_runs WHERE report_table = :report_table",
       :arguments => { :report_table => report_table }, :capture_error => true # , :verbose => true
       if result.rows[0]["count"] <= 0
-        conn.run "-- DROP TABLE #{report_table}", :capture_error => true  # , :verbose => true
+        # drop_table!
       end
     end
 
+    def drop_table! options = nil
+      conn.run "DROP TABLE #{report_table}", :capture_error => true  # , :verbose => true
+    end
+
     # Deletes the actual rows for this report run.
     def truncate! options = nil
       options = _options options

data/lib/qreport/report_runner.rb

@@ -8,53 +8,53 @@ require 'pp'
 module Qreport
   class ReportRunner
     attr_accessor :connection, :verbose
+    attr_accessor :report_run, :sql, :arguments
+    attr_accessor :error, :error_1, :error_2
 
     def run! report_run
+      @verbose ||= report_run.verbose
+      @report_run = report_run
       report_run.created_at ||=
         report_run.started_at = Time.now.utc
       name = report_run.name
-      sql  = report_run.sql.strip
+      @sql = report_run.sql.strip
 
-      arguments = report_run.arguments || { }
-      error = error_1 = error_2 = nrows = nil
+      @arguments = report_run.arguments || { }
+      @error = @error_1 = @error_2 = nrows = nil
 
       Connection.current = connection
 
-      begin
-        conn.transaction do
-
-          # Create a report row sequence:
-          run "CREATE TEMPORARY SEQUENCE qr_row_seq"
+      conn.transaction do
+        # Create a report row sequence:
+        run "CREATE TEMPORARY SEQUENCE qr_row_seq"
+      end
 
-          # Rewrite query to create result table rows:
-          arguments = arguments.merge(:qr_run_id => conn.safe_sql("nextval('qr_row_seq')"))
-          report_run.report_sql = report_sql(sql)
+      # Rewrite query to create result table rows:
+      self.arguments = arguments.merge(:qr_run_id => conn.safe_sql("nextval('qr_row_seq')"))
+      report_run.report_sql = report_sql(sql)
 
-          # Proof query to infer base columns:
-          result = run report_run.report_sql, :limit => 0, :arguments => arguments, :verbose => @verbose
-          report_run.base_columns = result.columns
-          result = nil
-        end # transaction
-      rescue ::Exception => exc
-        error = error_1 = exc
+      # Infer base columns, if not specified.
+      if report_run.base_columns.empty?
+        infer_base_columns!
       end
 
       # Construct report_table name from column names and types:
       report_table = report_run.report_table
 
-      conn.transaction do
-        # Create new ReportRun row:
-        report_run.insert!
-        report_run_id = report_run.id
-        arguments[:qr_run_id] = report_run_id
-        report_run.report_sql = report_sql(sql)
-      end # transaction
+      unless report_run.id
+        conn.transaction do
+          # Create new ReportRun row:
+          report_run.insert!
+        end # transaction
+      end
+      arguments[:qr_run_id] = report_run.id
 
       unless error
         # Run query into report table:
         begin
           conn.transaction do
             unless conn.table_exists? report_table
+              result =
               run "CREATE TABLE #{report_table} AS #{report_run.report_sql}", :arguments => arguments, :verbose => @verbose
               run "CREATE INDEX #{report_table}_i1 ON #{report_table} (qr_run_id)"
               run "CREATE INDEX #{report_table}_i2 ON #{report_table} (qr_run_row)"
@@ -65,12 +65,13 @@ module Qreport
             else
               result =
               run "INSERT INTO #{report_table} #{report_run.report_sql}", :arguments => arguments, :verbose => @verbose
-
               # Get the number of report run rows from cmd_status:
               unless cs = result.cmd_status and cs[0] == 'INSERT' and cs[1] == 0 and nrows = cs[2]
                 raise Error, "cannot determine nrows"
               end
             end
+            report_run.raw_sql = result.sql_prepared
+            # $stderr.puts ">>>>>>>>>>>>>>>>>>> #{result.sql_prepared}"
             # Get the number of report run rows:
             unless nrows || error
               result = report_run._select :COLUMNS => 'COUNT(*) AS "nrows"' #, :verbose => true
@@ -79,8 +80,8 @@ module Qreport
             # pp result
             result = nil
           end # transaction
-        rescue ::Exception => exc
-          error = error_2 = exc
+        rescue ::StandardError => exc
+          @error = @error_2 = exc
         end # transaction
       end
 
@@ -97,8 +98,22 @@ module Qreport
       report_run
     end
 
+    def infer_base_columns!
+      base_columns = nil
+      begin
+        conn.transaction do
+          # Proof query to infer base columns:
+          result = run report_run.report_sql, :limit => 0, :arguments => arguments, :verbose => @verbose
+          base_columns = report_run.base_columns = result.columns
+        end # transaction
+      rescue ::StandardError => exc
+        @error = @error_1 = exc
+      end
+      base_columns
+    end
+
     def report_sql sql
-      sql = sql.sub(/\ASELECT\s+/im, <<"END"
+      sql = sql.sub(/\A\s*SELECT\s+/im, <<"END"
 SELECT
     :qr_run_id
        AS "qr_run_id"

data/lib/qreport/version.rb

@@ -1,3 +1,3 @@
 module Qreport
-  VERSION = "0.0.3"
+  VERSION = "0.0.6"
 end

data/qreport.gemspec

@@ -18,8 +18,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency 'rake', '>= 0.9.0'
-  gem.add_development_dependency 'rspec', '~> 2.12.0'
+  gem.add_development_dependency 'rspec', '~> 2.12'
   gem.add_development_dependency 'simplecov', '~> 0.7.1'
+  gem.add_development_dependency "guard", "~> 1.8.0"
+  gem.add_development_dependency "guard-rspec", "~> 3.0.2"
+  gem.add_development_dependency "cassava", "~> 0.0.1"
 
   gem.add_dependency 'pg', '~> 0.14'
 end

data/spec/{connection_spec.rb → lib/qreport/connection_spec.rb}

@@ -97,6 +97,7 @@ describe Qreport::Connection do
     [ "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') ],
   ].each do | value, sql, return_value |
     it "can handle encoding #{value.class.name} value #{value.inspect} as #{sql.inspect}." do
       conn.escape_value(value).should == sql

data/spec/{report_runner_spec.rb → lib/qreport/report_runner_spec.rb}

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Qreport::ReportRunner do
   attr :reports, :now
 
-  it "should generate two reports" do
+  it "should generate reports" do
     # conn.verbose = conn.verbose_result = true
     run_reports!
     reports.size.should == 4
@@ -28,6 +28,32 @@ describe Qreport::ReportRunner do
     end
   end
 
+  it "should store relevant data in qr_report_runs table" do
+    run_reports!
+    reports.values.each do | r |
+      r2 = r.class.find(r.id)
+      r2.name.should == r.name.to_s
+      r2.description.should == r.description
+      r2.variant.should == r.variant
+      r2.sql.should == r.sql
+      r2.report_table.should == r.report_table
+      r2.base_columns.should == r.base_columns
+      r2.additional_columns.should == r.additional_columns
+      r2.columns.should == r.columns
+      r2.column_signature == r.column_signature
+      r2.error.should == r.error
+      #pending "Time/timestamp timezones" do
+        #r2.created_at.should == r.created_at
+        #r2.started_at.should == r.started_at
+        #r2.finished_at.should == r.finished_at
+      #end
+      r2.nrows.should == r.nrows
+      r2.data.columns.should == r.data.columns
+      r2.data.rows.should == r.data.rows
+      r2.data.rows.size.should == r.nrows
+    end
+  end
+
   it "should DROP TABLE after all report runs are deleted." do
     run_reports!
     reports.values.each do | r |
@@ -38,7 +64,7 @@ describe Qreport::ReportRunner do
 
   it "should capture errors into ReportRun#error." do
     # conn.verbose = true
-    report_run = Qreport::ReportRun.new(:name => :users_with_articles, :description => '10 days')
+    report_run = Qreport::ReportRun.new(:name => :users_with_articles, :variant => '10 days', :description => '10 days')
     report_run.arguments = {
       :now => conn.safe_sql("unknown_column"),
       :interval => '10 days',
@@ -57,6 +83,24 @@ END
     report_run.delete!
   end
 
+  it "should support :~ {{PATTERN}} {{EXPR}}." do
+    report_run = Qreport::ReportRun.new(:name => :users_with_articles, :description => 'last 24 hours')
+    now = Time.now
+    report_run.arguments = {
+      :interval => (now - 86400 ... now),
+    }
+    report_run.sql = <<"END"
+    SELECT u.id AS "user_id"
+    FROM   users u
+    WHERE
+      EXISTS(SELECT * FROM articles a WHERE a.user_id = u.id AND :~ {{:interval}} {{a.created_on}});
+END
+    # report_run.verbose = true
+    report_run.run! conn
+    # report_run.raw_sql.should == ''
+    report_run.error.should == nil
+  end
+
   def run_reports!
     @reports = { }
 
@@ -69,7 +113,7 @@ END
 END
 
     [ '1 days', '2 days', '30 days', '60 days' ].each do | interval |
-      report_run = Qreport::ReportRun.new(:name => :users_with_articles, :description => interval)
+      report_run = Qreport::ReportRun.new(:name => :users_with_articles, :description => interval, :variant => interval)
       report_run.arguments = {
         :now => now,
         :interval => interval,
@@ -156,4 +200,12 @@ END
         } }
     end
   end
+
+  after :each do
+    if reports
+      reports.values.each do | r |
+        r.drop_table!
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: qreport
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2013-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +59,54 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+- !ruby/object:Gem::Dependency
+  name: cassava
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +134,7 @@ files:
 - .rspec
 - ChangeLog
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -98,8 +147,8 @@ files:
 - lib/qreport/report_runner.rb
 - lib/qreport/version.rb
 - qreport.gemspec
-- spec/connection_spec.rb
-- spec/report_runner_spec.rb
+- spec/lib/qreport/connection_spec.rb
+- spec/lib/qreport/report_runner_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kstephens/qreport
 licenses: []
@@ -113,18 +162,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1042479240824554319
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 1042479240824554319
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -132,6 +175,6 @@ signing_key:
 specification_version: 3
 summary: Automatically creates materialized report tables from a SQL query.
 test_files:
-- spec/connection_spec.rb
-- spec/report_runner_spec.rb
+- spec/lib/qreport/connection_spec.rb
+- spec/lib/qreport/report_runner_spec.rb
 - spec/spec_helper.rb