Contents

module Dossier
  class Report
    include ActiveSupport::Callbacks
    extend ActiveModel::Naming

    define_callbacks :build_query, :execute

    attr_reader :options

    def self.report_name
      Dossier.class_to_name(self)
    end

    def initialize(options = {})
      @options = options.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 defined?(@results)
      @results
    end

    def raw_results
      execute unless defined?(@raw_results)
      @raw_results
    end

    def run
      tap { execute }
    end

    def formatter
      Dossier::Formatter
    end

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

    def dossier_client
      Dossier.client
    end

    private

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

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

    def results=(results)
      results.freeze
      @raw_results = Result::Unformatted.new(results, self)
      @results     = Result::Formatted.new(results, self)
    end

  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version	Path
dossier-2.7.1	lib/dossier/report.rb
dossier-2.7.0	lib/dossier/report.rb
dossier-2.6.0	lib/dossier/report.rb
dossier-2.5.2	lib/dossier/report.rb
dossier-2.5.1	lib/dossier/report.rb
dossier-2.5.0	lib/dossier/report.rb