dossier 2.7.1 → 2.8.0

data/lib/dossier/responder.rb

@@ -0,0 +1,34 @@
+module Dossier
+  class Responder < ::ActionController::Responder
+    alias :report :resource
+
+    def to_html
+      report.renderer.engine   = controller
+      controller.response_body = report.render
+    end
+
+    def to_json
+      controller.render json: report.results.hashes
+    end
+
+    def to_csv
+      set_content_disposition!
+      controller.response_body = StreamCSV.new(report.raw_results.arrays)
+    end
+
+    def to_xls
+      set_content_disposition!
+      controller.response_body = Xls.new(report.raw_results.arrays)
+    end
+    
+    private
+
+    def set_content_disposition!
+      controller.headers["Content-Disposition"] = %[attachment;filename=#{filename}]
+    end
+
+    def filename
+      "#{report.class.filename}.#{format}"
+    end
+  end
+end

data/lib/dossier/result.rb

@@ -10,15 +10,15 @@ module Dossier
     end
 
     def headers
-      adapter_results.headers
+      @headers ||= adapter_results.headers
     end
 
     def body
-      rows.first(rows.length - report.options[:footer].to_i)
+      @body ||= rows.first(rows.length - report.options[:footer].to_i)
     end
 
     def footers
-      rows.last(report.options[:footer].to_i)
+      @footer ||= rows.last(report.options[:footer].to_i)
     end
 
     def rows
@@ -39,14 +39,12 @@ module Dossier
     end
 
     def each
-      raise NotImplementedError, "Every result class must define `each`"
+      raise NotImplementedError, "#{self.class.name} must define `each`"
     end
 
     class Formatted < Result
       def each
-        adapter_results.rows.each do |row|
-          yield format(row)
-        end
+        adapter_results.rows.each { |row| yield format(row) }
       end
 
       def format(row)

data/lib/dossier/stream_csv.rb

@@ -2,15 +2,16 @@ require 'csv'
 
 module Dossier
   class StreamCSV
+    attr_reader :headers, :collection
 
     def initialize(collection, headers = nil)
-      @headers    = headers || collection.shift
+      @headers    = headers || collection.shift unless false === headers
       @collection = collection
     end
 
     def each
-      yield @headers.map { |header| Dossier::Formatter.titleize(header) }.to_csv
-      @collection.each do |record|
+      yield headers.map { |header| Dossier::Formatter.titleize(header) }.to_csv if headers?
+      collection.each do |record|
         yield record.to_csv
       end
     rescue => e
@@ -24,5 +25,11 @@ module Dossier
       end
     end
 
+    private
+
+    def headers?
+      headers.present?
+    end
+
   end
 end

data/lib/dossier/version.rb

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

data/lib/dossier/view_context_with_report_formatter.rb

@@ -0,0 +1,7 @@
+module Dossier
+  module ViewContextWithReportFormatter
+    def view_context
+      super.extend(report.formatter)
+    end
+  end
+end

data/lib/dossier/xls.rb

@@ -18,12 +18,12 @@ module Dossier
 
     private
 
-    def as_cel(el)
+    def as_cell(el)
       %{<Cell><Data ss:Type="String">#{el}</Data></Cell>}
     end
 
     def as_row(array)
-      my_array = array.map{|a| as_cel(a)}.join("\n")
+      my_array = array.map{|a| as_cell(a)}.join("\n")
       "<Row>\n" + my_array + "\n</Row>\n"
     end
 

data/lib/generators/dossier/views/templates/show.html.haml

@@ -1,12 +1,14 @@
-%h1= report.class.name.titleize
+%h2= report.formatted_title
 
-= link_to 'Download CSV', dossier_report_path(format: 'csv', options: report.options, report: report.class.report_name), class: 'download-csv'
+= link_to 'Download CSV', formatted_dossier_report_path('csv', report), class: 'download-csv'
+
+= render_options(report)
 
 %table
   %thead
     %tr
       - report.results.headers.each do |header|
-        %th= Dossier::Formatter.titleize(header)
+        %th= report.format_header(header)
   %tbody
     - report.results.body.each do |row|
       %tr

data/spec/dossier/adapter/active_record_spec.rb

@@ -29,7 +29,7 @@ describe Dossier::Adapter::ActiveRecord do
     let(:adapter_result_class) { Dossier::Adapter::ActiveRecord::Result}
 
     it "delegates to the connection" do
-      ar_connection.should_receive(:exec_query).with(query)
+      ar_connection.should_receive(:exec_query).with("\n#{query}")
       adapter.execute(query)
     end
 

data/spec/dossier/formatter_spec.rb

@@ -24,15 +24,50 @@ describe Dossier::Formatter do
     let(:route) { {controller: :site, action: :index} }
 
     it "allows URL generation" do
-      expect(formatter.url_for(route)).to eq('/woo')
+      expect(formatter.url_formatter.url_for(route)).to eq('/woo')
     end
 
     it "allows link generation" do
-      expect(formatter.link_to('Woo!', route)).to eq('<a href="/woo">Woo!</a>')
+      expect(formatter.url_formatter.link_to('Woo!', route)).to eq('<a href="/woo">Woo!</a>')
     end
 
     it "allows usage of url helpers" do
-      expect(formatter.url_helpers.woo_path).to eq('/woo')
+      expect(formatter.url_formatter.url_helpers.woo_path).to eq('/woo')
+    end
+  end
+
+  describe "custom formatters" do
+    describe "commafy_number" do
+      formats = {
+        10_000            => '10,000',
+        10_000.01         => '10,000.01',
+        1_000_000_000.001 => '1,000,000,000.001',
+        '12345.6789'      => '12,345.6789'
+      }.each { |base, formatted|
+        it "formats #{base} as #{formatted}" do
+          expect(formatter.commafy_number(base)).to eq formatted
+        end
+      }
+      it "will return the expected precision if too large" do
+        expect(formatter.commafy_number(1_000.23523563, 2)).to eq '1,000.24'
+      end
+
+      it "will return the expected precision if too small" do
+        expect(formatter.commafy_number(1_000, 5)).to eq '1,000.00000'
+      end
+    end
+
+    describe "number_to_dollars" do
+      formats = {
+        10_000            => '$10,000.00',
+        10_000.00         => '$10,000.00',
+        1_000_000_000.000 => '$1,000,000,000.00',
+        '12345.6788'      => '$12,345.68'
+      }.each { |base, formatted|
+        it "formats #{base} as #{formatted}" do
+          expect(formatter.number_to_dollars(base)).to eq formatted
+        end
+      }
     end
   end
 

data/spec/dossier/multi_report_spec.rb

@@ -2,10 +2,27 @@ require 'spec_helper'
 
 describe Dossier::MultiReport do
 
-  let(:combined_report) {CombinationReport}    
+  let(:options)         { {'foo' => 'bar'} }
+  let(:combined_report) { CombinationReport }
+  let(:report)          { combined_report.new(options) }
 
   it 'knows its sub reports' do
     expect(combined_report.reports).to eq([EmployeeReport, EmployeeWithCustomViewReport])
   end
 
+  it "passes options to the sub reports" do
+    combined_report.reports.each do |report|
+      report.should_receive(:new).with(options).and_call_original
+    end
+
+    report.reports
+  end
+
+  it "sets the multi property on its child reports" do
+    expect(report.reports.first.parent).to eq(report)
+  end
+
+  it "never has a parent" do
+    expect(report.parent).to be_nil
+  end
 end

data/spec/dossier/naming_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Dossier::Naming do
+  describe "report naming" do
+    let(:klass) { HelloMyFriendsReport }
+    let(:name)  { 'hello_my_friends' }
+
+    it "converts a report class to a report name" do
+      expect(described_class.class_to_name(klass)).to eq(name)
+    end
+
+    it "converting a report name to a report class" do
+      expect(described_class.name_to_class(name)).to eq(klass)
+    end
+
+    describe "with namespaces" do
+      let(:klass) { Cats::Are::SuperFunReport }
+      let(:name)  { 'cats/are/super_fun' }
+
+      it "converts a report class to a report name" do
+        expect(described_class.class_to_name klass).to eq name
+      end
+
+      it "converts a report name to a report class" do
+        expect(described_class.name_to_class name).to eq klass
+      end
+    end
+  end
+end

data/spec/dossier/renderer_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Dossier::Renderer do
+
+  let(:report)   { EmployeeReport.new }
+  let(:renderer) { described_class.new(report) }
+  let(:engine)   { renderer.engine }
+
+  describe "rendering" do
+    let(:options) { {template: "dossier/reports/#{template}", locals: {report: report}} }
+
+    describe "with custom view" do
+      let(:report)   { EmployeeWithCustomViewReport.new }
+      let(:template) { report.report_name }
+
+      it "renders the custom view" do
+        engine.should_receive(:render).with(options)
+      end
+    end
+
+    describe "without custom view" do
+      let(:template) { 'show' }
+
+      it "renders show" do
+        engine.should_receive(:render).with(options.merge(template: 'dossier/reports/employee')).and_call_original
+        engine.should_receive(:render).with(options)
+      end
+    end
+
+    after(:each) { renderer.render }
+  end
+
+  describe "engine" do
+    describe "view_context" do
+      it "mixes in the dossier/application_helper to that view context" do
+        expect(engine.view_context.class.ancestors).to include(Dossier::ApplicationHelper)
+      end
+    end
+
+    describe "view path" do
+      it "has the same view paths the application would have" do
+        extractor = ->(vp) { vp.paths }
+        expect(extractor.call engine.view_paths).to eq(extractor.call ActionController::Base.view_paths)
+      end
+    end
+
+    describe "layouts" do
+      it "uses a layout" do
+        expect(report.render).to match('<html>')
+      end
+
+      it "makes the report available to the layout" do
+        expect(report.render).to match('<title>Employee Report</title>')
+      end
+    end
+  end
+end

data/spec/dossier/report_spec.rb

@@ -8,6 +8,15 @@ describe Dossier::Report do
     TestReport.report_name.should eq('test')
   end
 
+  it "has a template name that is the report name" do
+    expect(report.template).to eq(report.report_name)
+  end
+
+  it "allows overriding the template" do
+    report = Class.new(described_class) { def template; 'fooo'; end }
+    expect(report.new.template).to eq 'fooo'
+  end
+
   describe "report instances" do
     let(:report_with_custom_header) do
       Class.new(Dossier::Report) do
@@ -20,18 +29,20 @@ describe Dossier::Report do
     end
 
     it "takes options when initializing" do
-      report = TestReport.new(:foo => 'bar')
       report.options.should eq('foo' => 'bar')
     end
 
     it 'generates column headers' do
-      report = TestReport.new(:foo => 'bar')
       report.format_header('Foo').should eq 'Foo'
     end
 
     it 'allows for column header customization' do
       report_with_custom_header.format_header(:generic).should eq 'customized'
     end
+
+    it "has a formatted title" do
+      expect(report.formatted_title).to eq 'Test Report'
+    end
   end
 
   describe "callbacks" do
@@ -81,4 +92,14 @@ describe Dossier::Report do
 
   end
 
+  describe "rendering" do
+    it "has a renderer" do
+      expect(report.renderer).to be_a(Dossier::Renderer)
+    end
+
+    it "delegates render to the renderer" do
+      report.renderer.should_receive(:render)
+      report.render
+    end
+  end
 end

data/spec/dossier/responder_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Dossier::Responder do
+
+  def stub_out_report_results(report)
+    report.tap { |r|
+      r.stub(:results).and_return(results)
+      r.stub(:raw_results).and_return(results)
+    }
+  end
+
+  let(:results)    { mock(arrays: [[]], hashes: [{}]) }
+  let(:report)     { EmployeeReport.new }
+  let(:reports)    { [stub_out_report_results(report)] }
+  let(:controller) { 
+    ActionController::Base.new.tap { |controller| controller.stub(:headers).and_return({}) }
+  }
+  let(:responder)  { described_class.new(controller, reports, {}) }
+
+  describe "to_html" do
+    it "calls render on the report" do
+      report.should_receive(:render)
+      responder.to_html
+    end
+  end
+
+  describe "to_json" do
+    it "renders the report as json" do
+      controller.should_receive(:render).with(json: results.hashes)
+      responder.to_json
+    end
+  end
+
+  describe "to_csv" do
+    it "sets the content disposition" do
+      responder.should_receive(:set_content_disposition!)
+      responder.to_csv
+    end
+
+    it "sets the response body to a new csv streamer instance" do
+      responder.to_csv
+      expect(responder.controller.response_body).to be_a(Dossier::StreamCSV)
+    end
+  end
+
+  describe "to_xls" do
+    it "sets the content disposition" do
+      responder.should_receive(:set_content_disposition!)
+      responder.to_xls
+    end
+
+    it "sets the response body to a new xls instance" do
+      responder.to_xls
+      expect(responder.controller.response_body).to be_a(Dossier::Xls)
+    end
+  end
+
+end
+