dossier 2.5.2 → 2.6.0

data/app/controllers/dossier/reports_controller.rb

@@ -1,9 +1,6 @@
 module Dossier
   class ReportsController < ApplicationController
     def show
-      report = report_class.new(params[:options] || {})
-      report.run
-
       respond_to do |format|
         format.html do
           begin
@@ -29,6 +26,18 @@ module Dossier
       end
     end
 
+    def multi
+      respond_to do |format|
+        format.html do
+          begin
+            render template: "dossier/reports/#{report_class.report_name}", locals: {multi: report}
+          rescue ActionView::MissingTemplate => e
+            render template: 'dossier/reports/multi', locals: {multi: report}
+          end
+        end
+      end
+    end
+
     private
 
     def report_class
@@ -39,5 +48,13 @@ module Dossier
       headers["Content-Disposition"] = %[attachment;filename=#{params[:report]}-report_#{Time.now.strftime('%m-%d-%Y_%H-%M-%S')}.#{params[:format]}]
     end
 
+    def report
+      @report ||= report_class.new(options_params)
+    end
+
+    def options_params
+      params[:options].presence || {}
+    end
+
   end
 end

data/app/views/dossier/reports/multi.html.haml

@@ -0,0 +1,3 @@
+%h1= multi.class.report_name
+- multi.reports.each do |report|
+  = render template: 'dossier/reports/show', locals: {report: report}

data/config/routes.rb

@@ -1,5 +1,6 @@
 Rails.application.routes.draw do
 
-  match "reports/:report", :to => 'dossier/reports#show', :as => :dossier_report, via: :get
+  get   "reports/:report",       to: 'dossier/reports#show',  as: :dossier_report
+  get   "multi/reports/:report", to: 'dossier/reports#multi', as: :multi_report
 
 end

data/lib/dossier/adapter/active_record.rb

@@ -14,6 +14,7 @@ module Dossier
       end
 
       def execute(query, report_name = nil)
+        # Ensure that SQL logs show name of report generating query
         Result.new(connection.exec_query(*[query, report_name].compact))
       rescue => e
         raise Dossier::ExecuteError.new "#{e.message}\n\n#{query}"

data/lib/dossier/multi_report.rb

@@ -0,0 +1,29 @@
+class Dossier::MultiReport
+
+  attr_accessor :options
+
+  class << self
+    attr_accessor :reports
+  end
+
+  def self.report_name
+    Dossier.class_to_name(self)
+  end
+
+  def self.combine(*reports)
+    self.reports = reports
+  end
+
+  def self.report=(value)
+    value
+  end
+
+  def initialize(options = {})
+    self.options = options.dup.with_indifferent_access
+  end
+
+  def reports
+    @reports ||= self.class.reports.map(&:new)
+  end
+
+end

data/lib/dossier/version.rb

@@ -1,3 +1,3 @@
 module Dossier
-  VERSION = "2.5.2"
+  VERSION = "2.6.0"
 end

data/lib/dossier.rb

@@ -34,6 +34,7 @@ require "dossier/adapter/active_record/result"
 require "dossier/client"
 require "dossier/configuration"
 require "dossier/formatter"
+require "dossier/multi_report"
 require "dossier/query"
 require "dossier/report"
 require "dossier/result"

data/spec/dossier/multi_report_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe Dossier::MultiReport do
+
+  let(:combined_report) {CombinationReport}    
+
+  it 'knows its sub reports' do
+    expect(combined_report.reports).to eq([EmployeeReport, EmployeeWithCustomViewReport])
+  end
+
+end

data/spec/dummy/log/test.log

@@ -2218,3 +2218,112 @@ Processing by SiteController#report as HTML
 Completed 200 OK in 9ms (Views: 4.6ms | ActiveRecord: 0.4ms)
   EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
  ORDER BY name ASC
+Connecting to database specified by database.yml
+  FACTORY (3.4ms)  CREATE DATABASE IF NOT EXISTS `dossier_test`
+  FACTORY (30.7ms)  DROP TABLE IF EXISTS `employees`
+  FACTORY (18.6ms)   CREATE TABLE `employees` (
+ `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+ `name` varchar(255) NOT NULL,
+ `division` varchar(255) NOT NULL,
+ `salary` int(11) NOT NULL,
+ `suspended` tinyint(1) NOT NULL DEFAULT 0,
+ `hired_on` date NOT NULL,
+ PRIMARY KEY (`id`)
+ ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+
+  FACTORY (1.3ms)  TRUNCATE `employees`
+  FACTORY (0.9ms)   INSERT INTO 
+ `employees` (`name`, `hired_on`, `suspended`, `division`, `salary`) 
+ VALUES ('Moustafa McMann', '2010-10-02', false, 'Zany Inventions', 30000);
+
+  FACTORY (0.6ms)   INSERT INTO 
+ `employees` (`name`, `hired_on`, `suspended`, `division`, `salary`) 
+ VALUES ('Jimmy Jackalope, Jr.', '2013-01-11', true, 'Tedious Toiling', 20000);
+
+  FACTORY (0.7ms)   INSERT INTO 
+ `employees` (`name`, `hired_on`, `suspended`, `division`, `salary`) 
+ VALUES ('Elise Elderberry', '2013-01-11', false, 'Corporate Malfeasance', 99000);
+
+  FACTORY (10.2ms)  DROP TABLE IF EXISTS `employees`
+  FACTORY (2.0ms)   CREATE TABLE `employees` (
+ `id` INTEGER PRIMARY KEY AUTOINCREMENT,
+ `name` TEXT NOT NULL,
+ `division` TEXT NOT NULL,
+ `salary` INTEGER NOT NULL,
+ `suspended` TINYINT NOT NULL DEFAULT 0,
+ `hired_on` DATE NOT NULL
+ );
+
+  FACTORY (0.9ms)  DELETE FROM `employees`
+  FACTORY (0.9ms)   INSERT INTO 
+ `employees` (`name`, `hired_on`, `suspended`, `division`, `salary`) 
+ VALUES ('MOUSTAFA MCMANN', '2010-10-02', 0, 'Zany Inventions', 30000);
+
+  FACTORY (1.0ms)   INSERT INTO 
+ `employees` (`name`, `hired_on`, `suspended`, `division`, `salary`) 
+ VALUES ('JIMMY JACKALOPE, JR.', '2013-01-11', 1, 'Tedious Toiling', 20000);
+
+  FACTORY (0.8ms)   INSERT INTO 
+ `employees` (`name`, `hired_on`, `suspended`, `division`, `salary`) 
+ VALUES ('ELISE ELDERBERRY', '2013-01-11', 0, 'Corporate Malfeasance', 99000);
+
+Started GET "/multi/reports/combination" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#multi as HTML
+  Parameters: {"report"=>"combination"}
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+  Rendered /Users/adamhunter/Studio/adamhunter/dossier/app/views/dossier/reports/show.html.haml (19.7ms)
+  EmployeeWithCustomViewReport (0.3ms)  SELECT * FROM employees WHERE suspended = true
+  Rendered /Users/adamhunter/Studio/adamhunter/dossier/app/views/dossier/reports/show.html.haml (2.5ms)
+  Rendered /Users/adamhunter/Studio/adamhunter/dossier/app/views/dossier/reports/multi.html.haml within layouts/application (29.2ms)
+Completed 200 OK in 90ms (Views: 33.5ms | ActiveRecord: 0.6ms)
+Started GET "/employee_report_custom_controller" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by SiteController#report as HTML
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+  Rendered /Users/adamhunter/Studio/adamhunter/dossier/app/views/dossier/reports/show.html.haml within layouts/application (2.4ms)
+Completed 200 OK in 9ms (Views: 5.2ms | ActiveRecord: 0.3ms)
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+Started GET "/reports/employee.xls" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as XLS
+  Parameters: {"report"=>"employee"}
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+Completed 200 OK in 5ms (ActiveRecord: 0.3ms)
+Started GET "/reports/employee.csv" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as CSV
+  Parameters: {"report"=>"employee"}
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+Completed 200 OK in 3ms (ActiveRecord: 0.3ms)
+Started GET "/reports/employee_with_custom_view" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as HTML
+  Parameters: {"report"=>"employee_with_custom_view"}
+Completed 200 OK in 4ms (Views: 3.5ms | ActiveRecord: 0.0ms)
+Started GET "/reports/employee?options[footer]=1" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as HTML
+  Parameters: {"options"=>{"footer"=>"1"}, "report"=>"employee"}
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+Completed 200 OK in 12ms (Views: 9.0ms | ActiveRecord: 0.3ms)
+Started GET "/reports/employee?options[salary]=true&options[order]=desc&options[names][]=Jimmy+Jackalope&options[names][]=Moustafa+McMann&options[divisions][]=Tedious+Toiling" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as HTML
+  Parameters: {"options"=>{"salary"=>"true", "order"=>"desc", "names"=>["Jimmy Jackalope", "Moustafa McMann"], "divisions"=>["Tedious Toiling"]}, "report"=>"employee"}
+  EmployeeReport (0.4ms)  SELECT * FROM employees WHERE 1=1
+ AND division in (('Tedious Toiling'))
+ AND salary > 10000
+ AND (name like '%Moustafa McMann%' or name like '%Jimmy Jackalope%')
+ ORDER BY name DESC
+Completed 200 OK in 16ms (Views: 15.1ms | ActiveRecord: 0.4ms)
+Started GET "/reports/employee" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as HTML
+  Parameters: {"report"=>"employee"}
+  EmployeeReport (0.3ms)  SELECT * FROM employees WHERE 1=1
+ ORDER BY name ASC
+Completed 200 OK in 11ms (Views: 9.4ms | ActiveRecord: 0.3ms)
+Started GET "/reports/employee_with_custom_client" for 127.0.0.1 at 2013-05-21 13:30:44 -0400
+Processing by Dossier::ReportsController#show as HTML
+  Parameters: {"report"=>"employee_with_custom_client"}
+  EmployeeWithCustomClientReport (0.4ms)  SELECT * FROM `employees`
+Completed 200 OK in 6ms (Views: 4.0ms | ActiveRecord: 0.4ms)

data/spec/features/combination_report_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "combination report" do
+  
+  describe "rendering html" do
+
+    context "when no custom view exists" do
+      
+      it "displays the correct html" do
+        visit '/multi/reports/combination'
+        expect(page).to have_content('Employee Report')
+        expect(page).to have_content('Employee With Custom View Report')
+      end
+
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ require "rails/test_help"
 require 'rspec/rails'
 require 'pry'
 require 'genspec'
+require 'capybara/rspec'
 
 Rails.backtrace_cleaner.remove_silencers!
 

data/spec/support/reports/combination_report.rb

@@ -0,0 +1,8 @@
+require Rails.root.join(*%w[.. support reports employee_report])
+require Rails.root.join(*%w[.. support reports employee_with_custom_view_report])
+
+class CombinationReport < Dossier::MultiReport
+
+  combine EmployeeReport, EmployeeWithCustomViewReport
+
+end

data/spec/support/reports/hello_my_friends_report.rb

@@ -1,5 +1,6 @@
 class HelloMyFriendsReport < Dossier::Report
   def sql
-    "select * from employees where friends = true and me = :self group by this is not a real query"
+    # Doesn't matter; not meant to be run.
+    "select * from employees"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dossier
 version: !ruby/object:Gem::Version
-  version: 2.5.2
+  version: 2.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: arel
@@ -189,6 +189,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.7
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.1.0
 description: Easy SQL based report generation with the ability to accept request parameters
   and render multiple formats.
 email:
@@ -204,6 +220,7 @@ files:
 - app/controllers/dossier/application_controller.rb
 - app/controllers/dossier/reports_controller.rb
 - app/helpers/dossier/application_helper.rb
+- app/views/dossier/reports/multi.html.haml
 - app/views/dossier/reports/show.html.haml
 - config/initializers/mime_types.rb
 - config/routes.rb
@@ -213,6 +230,7 @@ files:
 - lib/dossier/configuration.rb
 - lib/dossier/engine.rb
 - lib/dossier/formatter.rb
+- lib/dossier/multi_report.rb
 - lib/dossier/query.rb
 - lib/dossier/report.rb
 - lib/dossier/result.rb
@@ -231,6 +249,7 @@ files:
 - spec/dossier/client_spec.rb
 - spec/dossier/configuration_spec.rb
 - spec/dossier/formatter_spec.rb
+- spec/dossier/multi_report_spec.rb
 - spec/dossier/query_spec.rb
 - spec/dossier/report_spec.rb
 - spec/dossier/result_spec.rb
@@ -282,6 +301,7 @@ files:
 - spec/dummy/tmp/cache/assets/DCF/420/sprockets%2F9f127ea0ab7236994d1ceaa7bbea86c8
 - spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
 - spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
+- spec/features/combination_report_spec.rb
 - spec/fixtures/db/mysql2.yml
 - spec/fixtures/db/mysql2.yml.example
 - spec/fixtures/db/sqlite3.yml
@@ -300,6 +320,7 @@ files:
 - spec/routing/dossier_routes_spec.rb
 - spec/spec_helper.rb
 - spec/support/factory.rb
+- spec/support/reports/combination_report.rb
 - spec/support/reports/employee_report.rb
 - spec/support/reports/employee_with_custom_client_report.rb
 - spec/support/reports/employee_with_custom_view_report.rb
@@ -319,7 +340,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 573132527792046513
+      hash: -3969565327804791987
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -328,7 +349,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 573132527792046513
+      hash: -3969565327804791987
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -341,6 +362,7 @@ test_files:
 - spec/dossier/client_spec.rb
 - spec/dossier/configuration_spec.rb
 - spec/dossier/formatter_spec.rb
+- spec/dossier/multi_report_spec.rb
 - spec/dossier/query_spec.rb
 - spec/dossier/report_spec.rb
 - spec/dossier/result_spec.rb
@@ -392,6 +414,7 @@ test_files:
 - spec/dummy/tmp/cache/assets/DCF/420/sprockets%2F9f127ea0ab7236994d1ceaa7bbea86c8
 - spec/dummy/tmp/cache/assets/DDC/400/sprockets%2Fcffd775d018f68ce5dba1ee0d951a994
 - spec/dummy/tmp/cache/assets/E04/890/sprockets%2F2f5173deea6c795b8fdde723bb4b63af
+- spec/features/combination_report_spec.rb
 - spec/fixtures/db/mysql2.yml
 - spec/fixtures/db/mysql2.yml.example
 - spec/fixtures/db/sqlite3.yml
@@ -410,6 +433,7 @@ test_files:
 - spec/routing/dossier_routes_spec.rb
 - spec/spec_helper.rb
 - spec/support/factory.rb
+- spec/support/reports/combination_report.rb
 - spec/support/reports/employee_report.rb
 - spec/support/reports/employee_with_custom_client_report.rb
 - spec/support/reports/employee_with_custom_view_report.rb