dossier 2.8.0 → 2.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b964aa00e953df017cd8772cd0ed975301b841bd
-  data.tar.gz: c8faa33c28dec8b77a253918d089eea36d41c06d
+  metadata.gz: 654b5bc958cd0b8226eb0f4048c88540fa3024db
+  data.tar.gz: 4dd0180bd6e67e797fc003342b13c9fbc093d138
 SHA512:
-  metadata.gz: 4557b660e38d7b8a6b8aeb4bd7a7579ae0bc5eeea214bf3a6a02bd45330b95bd120bacb8cf9905cf5c4bf47922f6f37f7d57ba2ffff6bc8e660867556e02653a
-  data.tar.gz: 27c413936b6b22c1c4f977eb7546419b92f8804df1908e6346b82ce3f3f74e0bdcc42b182d7300a799b2f43c0658a25d7d12c8c869455036ef0b0ae6e292c1a4
+  metadata.gz: 5b53a3128c5e0042ee01621f49dc931c1f9cd5480b1b3e7a66517f8fa6b05b97797accded6927604da3e8e28ed7c3b2650b15fbab33ea120ae37c60f166985f6
+  data.tar.gz: a92771615847f0460bdb3fdca9e43730e9d14ccfa440b51fc73379f97964f0cf380a714620da2324a2547e11e77f0c214799397455169722e19a940a90ca3f6b

data/README.md

@@ -272,6 +272,7 @@ See the referenced gems for more documentation on using them.
 Note: when you run the tests, Dossier will **make and/or truncate** some tables in the `dossier_test` database.
 
 - Run `bundle`
+- `RAILS_ENV=test rake db:create`
 - `cp spec/dummy/config/database.yml{.example,}` and edit it so that it can connect to the test database.
 - `cp spec/fixtures/db/mysql2.yml{.example,}`
 - `cp spec/fixtures/db/sqlite3.yml{.example,}`

data/app/controllers/dossier/reports_controller.rb

@@ -4,14 +4,14 @@ module Dossier
 
     self.responder = Dossier::Responder
 
-    respond_to :html, :json, :csv, :xls, only: :show
+    respond_to :html, :json, :csv, :xls
 
     def show
       respond_with(report)
     end
 
     def multi
-      render template: 'dossier/reports/multi', locals: {multi: report}
+      respond_with(report)
     end
 
     private

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

@@ -1,8 +1,8 @@
-%div{id: multi.dom_id}
+%div{id: report.dom_id}
   %h1.dossier-multi-header
-    = multi.formatted_title
+    = report.formatted_title
 
-  = render_options(multi)
+  = render_options(report)
 
-  - multi.reports.each do |report|
-    = report.render layout: false
+  - report.reports.each do |r|
+    = r.render layout: false

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

@@ -8,7 +8,7 @@
   %thead
     %tr
       - report.results.headers.each do |header|
-        %th= report.format_header(header)
+        %th= header
   %tbody
     - report.results.body.each do |row|
       %tr

data/lib/dossier/multi_report.rb

@@ -34,4 +34,20 @@ class Dossier::MultiReport
   def dom_id
     nil
   end
+
+  def template
+    'multi'
+  end
+
+  def renderer
+    @renderer ||= Dossier::Renderer.new(self)
+  end
+
+  delegate :render, to: :renderer
+
+  class UnsupportedFormatError < StandardError
+    def initialize(format)
+      super "Dossier::MultiReport only supports rendering in HTML format (you tried #{format})"
+    end
+  end
 end

data/lib/dossier/report.rb

@@ -55,6 +55,10 @@ module Dossier
       formatter.titleize(header.to_s)
     end
 
+    def format_column(column, value)
+      value
+    end
+
     def dossier_client
       Dossier.client
     end

data/lib/dossier/responder.rb

@@ -20,6 +20,11 @@ module Dossier
       set_content_disposition!
       controller.response_body = Xls.new(report.raw_results.arrays)
     end
+
+    def respond
+      multi_report_html_only!
+      super
+    end
     
     private
 
@@ -30,5 +35,11 @@ module Dossier
     def filename
       "#{report.class.filename}.#{format}"
     end
+
+    def multi_report_html_only!
+      if report.is_a?(Dossier::MultiReport) and format.to_s != 'html'
+        raise Dossier::MultiReport::UnsupportedFormatError.new(format)
+      end
+    end
   end
 end

data/lib/dossier/result.rb

@@ -43,6 +43,13 @@ module Dossier
     end
 
     class Formatted < Result
+
+      alias :raw_headers :headers
+
+      def headers
+        @formatted_headers ||= super.map { |h| report.format_header(h) }
+      end
+
       def each
         adapter_results.rows.each { |row| yield format(row) }
       end
@@ -52,20 +59,17 @@ module Dossier
           raise ArgumentError.new("#{row.inspect} must be a kind of Enumerable") 
         end
 
-        row.each_with_index.map do |field, i|
-          method_name = "format_#{headers[i]}"
-
-          if report.respond_to?(method_name)
-
-           # Provide the row as context if the formatter takes two arguments
-           if report.method(method_name).arity == 2
-             report.public_send(method_name, field, row_hash(row))
-           else
-             report.public_send(method_name, field)
-           end
+        row.each_with_index.map do |value, i|
+          column = raw_headers.at(i)
+          method = "format_#{column}"
 
+          if report.respond_to?(method)
+            args = [method, value]
+            # Provide the row as context if the formatter takes two arguments
+            args << row_hash(row) if report.method(method).arity == 2
+            report.public_send(*args)
           else
-            field
+            report.format_column(column, value)
           end
         end
       end

data/lib/dossier/version.rb

@@ -1,3 +1,3 @@
 module Dossier
-  VERSION = "2.8.0"
+  VERSION = "2.9.0"
 end

data/spec/dossier/responder_spec.rb

@@ -9,7 +9,7 @@ describe Dossier::Responder do
     }
   end
 
-  let(:results)    { mock(arrays: [[]], hashes: [{}]) }
+  let(:results)    { double(arrays: [[]], hashes: [{}]) }
   let(:report)     { EmployeeReport.new }
   let(:reports)    { [stub_out_report_results(report)] }
   let(:controller) { 

data/spec/dossier/result_spec.rb

@@ -56,6 +56,13 @@ describe Dossier::Result do
 
       let(:result) { Dossier::Result::Formatted.new(adapter_result, report) }
 
+      describe "headers" do
+        it "formats the headers by calling format_header" do
+          adapter_result.headers.each { |h| result.report.should_receive(:format_header).with(h) }
+          result.headers
+        end
+      end
+
       describe "each" do
 
         it "calls :each on on its adapter's results" do
@@ -71,11 +78,27 @@ describe Dossier::Result do
       end
 
       describe "format" do
+        let(:report) {
+          Class.new(Dossier::Report) {
+            def format_mascot(value); value.upcase; end
+          }.new
+        }
+
+        let(:row) { result_row.values }
 
-        it "it raises unless its argument responds to :[]" do
+        it "raises unless its argument responds to :[]" do
           expect {result.format(Object.new)}.to raise_error(ArgumentError)
         end
 
+        it "calls a custom formatter method if available" do
+          result.report.should_receive(:format_mascot).with('platapus')
+          result.format(row)
+        end
+
+        it "calls the default format_column method otherwise" do
+          result.report.should_receive(:format_column).with('cheese', 'bleu')
+          result.format(row)
+        end
       end
 
       describe "footer" do

data/spec/dummy/app/reports/employee_with_custom_view_report.rb

@@ -18,7 +18,7 @@ class EmployeeWithCustomViewReport < Dossier::Report
   end
 
   module CustomFormatter
-    include Dossier::Formatter
+    extend Dossier::Formatter
     def margery_butts(word)
       "Margery Butts #{word}"
     end