adamhunter/dossier

View on GitHub
lib/dossier/report.rb

Summary

Maintainability
A
0 mins
Test Coverage
module Dossier
  class Report
    include Dossier::Model
    include ActiveSupport::Callbacks

    define_callbacks :build_query, :execute

    attr_reader :options
    attr_accessor :parent

    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('%Y-%m-%d_%H-%M-%S-%Z')}"
    end
    
    def initialize(options = {})
      @options = options.to_hash.dup.with_indifferent_access
    end

    def sql
      raise NotImplementedError, "`sql` method must be defined by each report"
    end

    def query
      build_query unless defined?(@query)
      @query.to_s
    end

    def results
      execute unless query_results
      @results ||= Result::Formatted.new(query_results, self)
    end

    def raw_results
      execute unless query_results
      @raw_results ||= Result::Unformatted.new(query_results, self)
    end

    def run
      tap { execute }
    end

    def format_header(header)
      formatter.titleize(header.to_s)
    end

    def format_column(column, value)
      value
    end

    def display_column?(column)
      true
    end

    def dossier_client
      Dossier.client
    end

    def renderer
      @renderer ||= Renderer.new(self)
    end
    
    delegate :render, to: :renderer

    private

    def build_query
      run_callbacks(:build_query) { @query = Dossier::Query.new(self) }
    end

    def execute
      build_query
      run_callbacks :execute do
        self.query_results = dossier_client.execute(query, self.class.name)
      end
    end

    def query_results=(query_results)
      @query_results = query_results.freeze
    end
    attr_reader :query_results

  end
end