dossier 2.7.1 → 2.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b964aa00e953df017cd8772cd0ed975301b841bd
+  data.tar.gz: c8faa33c28dec8b77a253918d089eea36d41c06d
+SHA512:
+  metadata.gz: 4557b660e38d7b8a6b8aeb4bd7a7579ae0bc5eeea214bf3a6a02bd45330b95bd120bacb8cf9905cf5c4bf47922f6f37f7d57ba2ffff6bc8e660867556e02653a
+  data.tar.gz: 27c413936b6b22c1c4f977eb7546419b92f8804df1908e6346b82ce3f3f74e0bdcc42b182d7300a799b2f43c0658a25d7d12c8c869455036ef0b0ae6e292c1a4

data/{README.markdown → README.md}

@@ -5,7 +5,11 @@ Dossier is a Rails engine that turns SQL into reports. Reports can be easily ren
 - If you **hate** SQL, you can use whatever tool you like to generate it; for example, ActiveRecord's `to_sql`.
 - If you **love** SQL, you can use every feature your database supports.
 
+[![Gem Version](https://badge.fury.io/rb/dossier.png)](https://rubygems.org/gems/dossier)
 [![Code Climate](https://codeclimate.com/github/adamhunter/dossier.png)](https://codeclimate.com/github/adamhunter/dossier)
+[![Build Status](https://travis-ci.org/adamhunter/dossier.png?branch=master)](https://travis-ci.org/adamhunter/dossier)
+[![Coverage Status](https://coveralls.io/repos/adamhunter/dossier/badge.png?branch=master)](https://coveralls.io/r/adamhunter/dossier?branch=master)
+[![Dependency Status](https://gemnasium.com/adamhunter/dossier.png)](https://gemnasium.com/adamhunter/dossier)
 
 ## Setup
 
@@ -75,10 +79,11 @@ By default, headers are generated by calling `titleize` on the column name from
 class ProductMarginReport < Dossier::Report
   # ...
   def format_header(column_name)
-    {
-      'margin_percentage' => 'Margin %',
-      'absolute_margin' => 'Margin $'
-    }[column_name.to_s] || super
+    custom_headers = {
+      margin_percentage: 'Margin %',
+      absolute_margin:   'Margin $'
+    }
+    custom_headers.fetch(column_name.to_sym) { super }
   end
 end
 ```
@@ -206,7 +211,7 @@ end
 ### Dossier for APIs
 
 ```ruby
-class API::ProjectsController < Api::ApplicationController
+class Api::ProjectsController < Api::ApplicationController
 
   def snapshot
     render json: ProjectStatusReport.new(project: @project).results.hashes

data/Rakefile

@@ -1,4 +1,5 @@
 #!/usr/bin/env rake
+
 begin
   require 'bundler/setup'
 rescue LoadError

data/app/controllers/dossier/reports_controller.rb

@@ -1,51 +1,23 @@
 module Dossier
   class ReportsController < ApplicationController
+    include ViewContextWithReportFormatter
+
+    self.responder = Dossier::Responder
+
+    respond_to :html, :json, :csv, :xls, only: :show
+
     def show
-      respond_to do |format|
-        format.html do
-          begin
-            render template: "dossier/reports/#{report_class.report_name}", locals: {report: report}
-          rescue ActionView::MissingTemplate => e
-            render template: 'dossier/reports/show', locals: {report: report}
-          end
-        end
-
-        format.json do
-          render :json => report.results.hashes
-        end
-
-        format.csv do
-          set_content_disposition!
-          self.response_body = StreamCSV.new(report.raw_results.arrays)
-        end
-
-        format.xls do
-          set_content_disposition!
-          self.response_body = Xls.new(report.raw_results.arrays)
-        end
-      end
+      respond_with(report)
     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
+      render template: 'dossier/reports/multi', locals: {multi: report}
     end
 
     private
 
     def report_class
-      Dossier.name_to_class(params[:report])
-    end
-
-    def set_content_disposition!
-      headers["Content-Disposition"] = %[attachment;filename=#{params[:report]}-report_#{Time.now.strftime('%m-%d-%Y_%H-%M-%S')}.#{params[:format]}]
+      Dossier::Naming.name_to_class(params[:report])
     end
 
     def report
@@ -55,6 +27,5 @@ module Dossier
     def options_params
       params[:options].presence || {}
     end
-
   end
 end

data/app/helpers/dossier/application_helper.rb

@@ -2,7 +2,13 @@ module Dossier
   module ApplicationHelper
 
     def formatted_dossier_report_path(format, report)
-      dossier_report_path(format: format, options: report.options, report: report.class.report_name)
+      dossier_report_path(format: format, options: report.options, report: report.report_name)
+    end
+
+    def render_options(report)
+      return if report.parent
+      render "dossier/reports/#{report.report_name}/options", report: report
+    rescue ActionView::MissingTemplate
     end
 
   end

data/app/views/dossier/layouts/application.html.haml

@@ -0,0 +1,6 @@
+!!!5
+%html
+  %head
+    %title #{report.formatted_title}
+  %body
+    = yield

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

@@ -1,3 +1,8 @@
-%h1= multi.class.report_name
-- multi.reports.each do |report|
-  = render template: 'dossier/reports/show', locals: {report: report}
+%div{id: multi.dom_id}
+  %h1.dossier-multi-header
+    = multi.formatted_title
+
+  = render_options(multi)
+
+  - multi.reports.each do |report|
+    = report.render layout: false

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

@@ -1,6 +1,8 @@
-%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

data/config/routes.rb

@@ -1,6 +1,6 @@
 Rails.application.routes.draw do
 
-  get   "reports/:report",       to: 'dossier/reports#show',  as: :dossier_report
-  get   "multi/reports/:report", to: 'dossier/reports#multi', as: :dossier_multi_report
+  get   "reports/*report",       to: 'dossier/reports#show',  as: :dossier_report
+  get   "multi/reports/*report", to: 'dossier/reports#multi', as: :dossier_multi_report
 
 end

data/lib/dossier.rb

@@ -1,4 +1,6 @@
 require "dossier/engine"
+require "dossier/naming"
+require "dossier/view_context_with_report_formatter"
 require "dossier/version"
 
 module Dossier
@@ -18,14 +20,6 @@ module Dossier
     configuration.client
   end
 
-  def class_to_name(klass)
-    klass.name.underscore[0..-8]
-  end
-
-  def name_to_class(name)
-    "#{name.split('_').map(&:capitalize).join}Report".constantize
-  end
-
   class ExecuteError < StandardError; end
 end
 
@@ -36,7 +30,9 @@ require "dossier/configuration"
 require "dossier/formatter"
 require "dossier/multi_report"
 require "dossier/query"
+require "dossier/renderer"
 require "dossier/report"
+require "dossier/responder"
 require "dossier/result"
 require "dossier/stream_csv"
 require "dossier/xls"

data/lib/dossier/adapter/active_record.rb

@@ -15,7 +15,7 @@ module Dossier
 
       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))
+        Result.new(connection.exec_query(*["\n#{query}", report_name].compact))
       rescue => e
         raise Dossier::ExecuteError.new "#{e.message}\n\n#{query}"
       end

data/lib/dossier/formatter.rb

@@ -1,18 +1,35 @@
 module Dossier
   module Formatter
+    include ActiveSupport::Inflector
+    include ActionView::Helpers::NumberHelper
     extend self
-    extend ActiveSupport::Inflector
-    extend ActionView::Helpers::NumberHelper
 
     def number_to_currency_from_cents(value)
       number_to_currency(value /= 100.0)
     end
 
+    def number_to_dollars(value)
+      "$#{commafy_number(value, 2)}"
+    end
+
+    def commafy_number(value, precision = nil)
+      whole, fraction = value.to_s.split('.')
+      fraction = "%.#{precision}d" % ("0.#{fraction}".to_f.round(precision) * 10**precision).to_i if precision
+      [whole.to_i.to_s.gsub(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1,"), fraction].compact.join('.')
+    end
+
     def url_formatter
       @url_formatter ||= UrlFormatter.new
     end
 
-    delegate :url_for, :link_to, :url_helpers, to: :url_formatter
+    def report_name(report)
+      titleize("#{report.report_name.split('/').last} Report")
+    end
+
+    # TODO figure out how to handle this better
+    # reports rendered with a system layout use this link_to instead of the
+    # correct one
+    # delegate :url_for, :link_to, :url_helpers, to: :url_formatter
 
     class UrlFormatter
       include ActionView::Helpers::UrlHelper

data/lib/dossier/multi_report.rb

@@ -1,4 +1,5 @@
 class Dossier::MultiReport
+  include Dossier::Naming
 
   attr_accessor :options
 
@@ -6,24 +7,31 @@ class Dossier::MultiReport
     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)
+    @reports ||= self.class.reports.map { |report| 
+      report.new(options).tap { |r|
+        r.parent = self
+      }
+    }
   end
 
+  def parent
+    nil
+  end
+
+  def formatter
+    Module.new
+  end
+  
+  def dom_id
+    nil
+  end
 end

data/lib/dossier/naming.rb

@@ -0,0 +1,51 @@
+module Dossier
+  module Naming
+
+    # not using ActiveSupport::Concern because ClassMethods
+    # must be extended after ActiveModel::Naming
+    def self.included(base)
+      base.extend ActiveModel::Naming
+      base.extend ClassMethods
+    end
+
+    def self.class_to_name(klass)
+      (klass.name || anonymous_report).underscore[0..-8]
+    end
+
+    def self.name_to_class(name)
+      "#{name}_report".classify.constantize
+    end
+
+    def self.anonymous_report
+      'AnonymousReport'
+    end
+
+    def to_key
+      [report_name]
+    end
+
+    def to_s
+      report_name
+    end
+
+    delegate :report_name, :formatted_title, to: "self.class"
+
+    module ClassMethods
+      def report_name
+        Dossier::Naming.class_to_name(self)
+      end
+
+      def formatted_title
+        Dossier::Formatter.report_name(self)
+      end
+
+      def model_name
+        @model_name ||= ActiveModel::Name.new(self, nil, superclass.name).tap do |name|
+          name.instance_variable_set(:@param_key, 'options')
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dossier/renderer.rb

@@ -0,0 +1,63 @@
+module Dossier
+  class Renderer
+    attr_reader :report
+    attr_writer :engine
+
+    def initialize(report)
+      @report = report
+    end
+
+    def render(options = {})
+      render_template :custom, options
+    rescue ActionView::MissingTemplate => e
+      render_template :default, options
+    end
+
+    def engine
+      @engine ||= Engine.new(report)
+    end
+
+    private
+
+    def render_template(template, options)
+      template = send("#{template}_template_path")
+      engine.render options.merge(template: template, locals: {report: report})
+    end
+
+    def template_path(template)
+      "dossier/reports/#{template}"
+    end
+
+    def custom_template_path
+      template_path(report.template)
+    end
+
+    def default_template_path
+      template_path('show')
+    end
+
+    class Engine < AbstractController::Base
+      include AbstractController::Layouts
+      include ViewContextWithReportFormatter
+      attr_reader :report
+
+      layout 'dossier/layouts/application'
+
+      def self._helpers
+        Module.new do
+          include Rails.application.helpers
+          include Rails.application.routes_url_helpers
+        end
+      end
+
+      def self._view_paths
+        ActionController::Base.view_paths
+      end
+
+      def initialize(report)
+        @report = report
+        super()
+      end
+    end
+  end
+end

data/lib/dossier/report.rb

@@ -1,16 +1,29 @@
 module Dossier
   class Report
+    include Dossier::Naming
     include ActiveSupport::Callbacks
-    extend ActiveModel::Naming
 
     define_callbacks :build_query, :execute
 
     attr_reader :options
+    attr_accessor :parent
 
-    def self.report_name
-      Dossier.class_to_name(self)
+    class_attribute :formatter
+    class_attribute :template
+
+    self.formatter = Dossier::Formatter
+
+    delegate :formatter, :template, to: "self.class"
+
+    def self.inherited(base)
+      super
+      base.template = base.report_name
     end
 
+    def self.filename
+      "#{report_name.parameterize}-report_#{Time.now.strftime('%m-%d-%Y_%H-%M-%S')}"
+    end
+    
     def initialize(options = {})
       @options = options.dup.with_indifferent_access
     end
@@ -38,10 +51,6 @@ module Dossier
       tap { execute }
     end
 
-    def formatter
-      Dossier::Formatter
-    end
-
     def format_header(header)
       formatter.titleize(header.to_s)
     end
@@ -50,6 +59,12 @@ module Dossier
       Dossier.client
     end
 
+    def renderer
+      @renderer ||= Renderer.new(self)
+    end
+    
+    delegate :render, to: :renderer
+
     private
 
     def build_query