rock_books 0.4.0 → 0.7.1

data/lib/rock_books/documents/journal_entry_builder.rb

@@ -14,6 +14,10 @@ class JournalEntryBuilder < Struct.new(:journal_entry_context)
   def chart_of_accounts; journal_entry_context.chart_of_accounts;  end
 
 
+  # A "token" in this context means an account name and account amount pair, e.g. "pnc.checking 1234.56".
+  # @param tokens the account name/amount pairs found in the source text
+  # @date transaction date
+  # @return array of AcctAmount instances
   def acct_amounts_from_tokens(tokens, date)
     acct_amounts = []
 

data/lib/rock_books/helpers/book_set_loader.rb

@@ -7,6 +7,7 @@ module RockBooks
 
     module_function
 
+    # @return a hash whose keys are the filespecs and values are the document types
     def get_files_with_types(directory)
       files = Dir[File.join(directory, '*.txt')]
       files.each_with_object({}) do |filespec, files_with_types|
@@ -42,7 +43,7 @@ module RockBooks
 
     # Uses all *.txt files in the specified directory; uses @doc_type to determine which
     # is the chart of accounts and which are journals.
-    # To exclude a file, make the extension other than .rdt.
+    # To exclude a file, make the extension something other than .txt.
     def load(run_options)
 
       files_with_types = get_files_with_types(run_options.input_dir)
@@ -54,9 +55,8 @@ module RockBooks
       validate_journal_file_count(journal_files)
 
       chart_of_accounts = ChartOfAccounts.from_file(chart_of_account_files.first)
-      journals = journal_files.map { |fs| Journal.from_file(chart_of_accounts, fs) }
+      journals = journal_files.map { |filespec| Journal.from_file(chart_of_accounts, filespec) }
       BookSet.new(run_options, chart_of_accounts, journals)
     end
-
   end
 end

data/lib/rock_books/reports/balance_sheet.rb

@@ -1,6 +1,5 @@
-require_relative '../filters/journal_entry_filters'
-require_relative '../documents/journal'
-require_relative 'report_context'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/text_report_helper'
 
 module RockBooks
 
@@ -9,52 +8,19 @@ module RockBooks
 # in order to calculate the correct balances, so we ignore the global $filter.
 class BalanceSheet
 
-  include Reporter
+  include TextReportHelper
+  include ErbHelper
 
-  attr_accessor :context
+  attr_accessor :context, :data
 
-  def initialize(report_context)
+  def initialize(report_context, data)
     @context = report_context
+    @data = data
   end
 
 
-  def end_date
-    context.chart_of_accounts.end_date
+  def generate
+    ErbHelper.render_hashes('text/balance_sheet.txt.erb', data, template_presentation_context)
   end
-
-
-  def generate_header
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << center("Balance Sheet for Period Ending #{end_date}")
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-
-
- def generate_report
-    filter = RockBooks::JournalEntryFilters.date_on_or_before(end_date)
-    acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
-    totals = AcctAmount.aggregate_amounts_by_account(acct_amounts)
-    output = generate_header
-
-    asset_output,  asset_total  = generate_account_type_section('Assets',      totals, :asset,     false)
-    liab_output,   liab_total   = generate_account_type_section('Liabilities', totals, :liability, true)
-    equity_output, equity_total = generate_account_type_section('Equity',      totals, :equity,    true)
-
-    output << [asset_output, liab_output, equity_output].join("\n\n")
-
-    grand_total = asset_total - (liab_total + equity_total)
-
-    output << "\n#{"%12.2f    Assets - (Liabilities + Equity)" % grand_total}\n============\n"
-    output
-  end
-
-  alias_method :to_s, :generate_report
-  alias_method :call, :generate_report
-
 end
 end

data/lib/rock_books/reports/book_set_reporter.rb

@@ -0,0 +1,207 @@
+require_relative '../documents/book_set'
+
+require_relative 'balance_sheet'
+require_relative 'data/bs_is_data'
+require_relative 'data/receipts_report_data'
+require_relative 'income_statement'
+require_relative 'multidoc_txn_report'
+require_relative 'receipts_report'
+require_relative 'report_context'
+require_relative 'journal_report'
+require_relative 'multidoc_txn_by_account_report'
+require_relative 'tx_one_account'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/text_report_helper'
+require_relative 'helpers/html_report_helper'
+
+require 'prawn'
+
+module RockBooks
+class BookSetReporter
+
+  extend Forwardable
+
+  attr_reader :book_set, :output_dir, :filter, :context
+
+  def_delegator :book_set, :all_entries
+  def_delegator :book_set, :journals
+  def_delegator :book_set, :chart_of_accounts
+  def_delegator :book_set, :run_options
+
+  FONT_FILESPEC = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'assets', 'fonts', 'JetBrainsMono-Medium.ttf'))
+
+
+  def initialize(book_set, output_dir, filter = nil)
+    @book_set = book_set
+    @output_dir = output_dir
+    @filter = filter
+    @context = ReportContext.new(book_set.chart_of_accounts, book_set.journals, 80)
+  end
+
+
+  def generate
+    create_directories
+    create_index_html
+
+    do_statements
+    do_journals
+    do_transaction_reports
+    do_single_account_reports
+    do_receipts_report
+  end
+
+
+  # All methods after this point are private.
+
+  private def do_statements
+    bs_is_data = BsIsData.new(context)
+
+    bal_sheet_text_report = BalanceSheet.new(context, bs_is_data.bal_sheet_data).generate
+    write_report(:balance_sheet, bal_sheet_text_report)
+
+    inc_stat_text_report = IncomeStatement.new(context, bs_is_data.inc_stat_data).generate
+    write_report(:income_statement, inc_stat_text_report)
+  end
+
+
+  private def do_journals
+    journals.each do |journal|
+      report_data = JournalData.new(journal, context, filter).fetch
+      text_report = JournalReport.new(report_data, context, filter).generate
+      write_report(journal.short_name, text_report)
+    end
+  end
+
+
+  private def do_transaction_reports
+
+    do_date_or_amount_report = ->(sort_field, short_name) do
+      data = MultidocTxnReportData.new(context, sort_field, filter).fetch
+      text_report = MultidocTransactionReport.new(data, context).generate
+      write_report(short_name, text_report)
+    end
+
+    do_acct_report = -> do
+      data = MultidocTxnByAccountData.new(context).fetch
+      text_report = MultidocTransactionByAccountReport.new(data, context).generate
+      write_report(:all_txns_by_acct, text_report)
+    end
+
+    do_date_or_amount_report.(:date,   :all_txns_by_date)
+    do_date_or_amount_report.(:amount, :all_txns_by_amount)
+    do_acct_report.()
+  end
+
+
+  private def do_single_account_reports
+    chart_of_accounts.accounts.each do |account|
+      short_name = ('acct_' + account.code).to_sym
+      data = TxOneAccountData.new(context, account.code).fetch
+      text_report = TxOneAccount.new(data, context).generate
+      write_report(short_name, text_report)
+    end
+  end
+
+
+  private def do_receipts_report
+    data = ReceiptsReportData.new(book_set.all_entries, run_options.receipt_dir).fetch
+    text_report = ReceiptsReport.new(context, data).generate
+    write_report(:receipts, text_report)
+  end
+
+
+  private def create_directories
+    %w(txt pdf html).each do |format|
+      dir = File.join(output_dir, format, SINGLE_ACCT_SUBDIR)
+      FileUtils.mkdir_p(dir)
+    end
+  end
+
+
+  # "./pdf/short_name.pdf" or "./pdf/single_account/short_name.pdf"
+  private def build_filespec(directory, short_name, file_format)
+    fragments = [directory, file_format, "#{short_name}.#{file_format}"]
+    is_acct_report = /^acct_/.match(short_name)
+    if is_acct_report
+      fragments.insert(2, SINGLE_ACCT_SUBDIR)
+    end
+    File.join(*fragments)
+  end
+
+
+  private def create_index_html
+    filespec = build_filespec(output_dir, 'index', 'html')
+    File.write(filespec, index_html_content)
+    puts "Created index.html"
+  end
+
+
+  private def prawn_create_document(pdf_filespec, text)
+    Prawn::Document.generate(pdf_filespec) do
+      font(FONT_FILESPEC, size: 10)
+
+      utf8_nonbreaking_space = "\uC2A0"
+      unicode_nonbreaking_space = "\u00A0"
+      text(text.gsub(' ', unicode_nonbreaking_space))
+    end
+  end
+
+
+  private def write_report(short_name, text_report)
+
+    txt_filespec = build_filespec(output_dir, short_name, 'txt')
+    html_filespec = build_filespec(output_dir, short_name, 'html')
+    pdf_filespec = build_filespec(output_dir, short_name, 'pdf')
+
+    create_text_report = -> { File.write(txt_filespec, text_report) }
+
+    create_pdf_report = -> { prawn_create_document(pdf_filespec, text_report) }
+
+    create_html_report = -> do
+      data = { report_body: text_report, title: "#{short_name} Report -- RockBooks" }
+      html_raw_report = ErbHelper.render_hashes("html/report_page.html.erb", data, {})
+      html_report = HtmlReportHelper.convert_receipts_to_hyperlinks(html_raw_report, html_filespec)
+      File.write(html_filespec, html_report)
+    end
+
+    create_text_report.()
+    create_pdf_report.()
+    create_html_report.()
+
+    puts "Created text, PDF, and HTML reports for #{short_name}."
+  end
+
+
+  private def missing_existing_unused_receipts
+    missing_receipts = []
+    existing_receipts = []
+    receipt_full_filespec = ->(receipt_filespec) { File.join(run_options.receipt_dir, receipt_filespec) }
+
+    # We will start out putting all filespecs in the unused array, and delete them as they are found in the transactions.
+    unused_receipt_filespecs = Dir['receipts/**/*'].select { |s| File.file?(s) } \
+        .sort \
+        .map { |s| "./" +  s }  # Prepend './' to match the data
+
+    all_entries.each do |entry|
+      entry.receipts.each do |receipt|
+        filespec = receipt_full_filespec.(receipt)
+        unused_receipt_filespecs.delete(filespec)
+        file_exists = File.file?(filespec)
+        list = (file_exists ? existing_receipts : missing_receipts)
+        list << { receipt: receipt, journal: entry.doc_short_name }
+      end
+    end
+    [missing_receipts, existing_receipts, unused_receipt_filespecs]
+  end
+
+
+  private def index_html_content
+    erb_filespec = File.join(File.dirname(__FILE__), 'templates', 'html', 'index.html.erb')
+    erb = ERB.new(File.read(erb_filespec))
+    erb.result_with_hash(
+        journals: journals,
+        chart_of_accounts: chart_of_accounts,
+        run_options: run_options)
+  end
+end
+end

data/lib/rock_books/reports/data/bs_is_data.rb

@@ -0,0 +1,61 @@
+require_relative 'bs_is_section_data'
+require_relative '../../filters/journal_entry_filters'
+require_relative '../../documents/journal'
+require_relative '../report_context'
+
+module RockBooks
+
+class BsIsData
+
+    attr_reader :journals_acct_totals, :context, :start_date, :end_date, :totals
+
+    def initialize(context)
+      @context = context
+      @start_date = context.chart_of_accounts.start_date
+      @end_date = context.chart_of_accounts.end_date
+      filter = JournalEntryFilters.date_on_or_before(end_date)
+      acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
+      @journals_acct_totals = AcctAmount.aggregate_amounts_by_account(acct_amounts)
+    end
+
+
+    def section_data(type)
+      BsIsSectionData.new(type, context, journals_acct_totals).fetch
+    end
+
+
+    def bal_sheet_data
+      {
+          end_date:    end_date,
+          entity:      context.entity,
+          sections: {
+            asset:       section_data(:asset),
+            liability:   section_data(:liability),
+            equity:      section_data(:equity),
+          },
+          grand_total: journals_acct_totals.values.sum.round(2)
+      }
+    end
+
+
+    def inc_stat_data
+      income_section_data = section_data(:income)
+      expense_section_data = section_data(:expense)
+      net_income = (income_section_data[:acct_totals].values.sum.round(2) -
+          expense_section_data[:acct_totals].values.sum.round(2)
+          ).round(2)
+
+      {
+          start_date: start_date,
+          end_date:   end_date,
+          entity:     context.entity,
+          sections: {
+            income:     income_section_data,
+            expense:    expense_section_data,
+          },
+          net_income: net_income
+      }
+    end
+
+end
+end

data/lib/rock_books/reports/data/bs_is_section_data.rb

@@ -0,0 +1,28 @@
+module RockBooks
+
+BsIsSectionData = Struct.new(:type, :context, :journals_acct_totals)
+class BsIsSectionData
+
+  def fetch
+    {
+      acct_totals: totals,
+      total: totals.map(&:last).sum.round(2)
+    }
+  end
+
+  private def totals
+    @totals ||= calc_section_acct_totals
+  end
+
+  private def calc_section_acct_totals
+    codes  = context.chart_of_accounts.account_codes_of_type(type)
+    totals = journals_acct_totals.select { |code, _amount| codes.include?(code) }
+    need_to_reverse_sign = %i{liability equity income}.include?(type)
+    if need_to_reverse_sign
+      totals.keys.each { |code| totals[code] = -totals[code] }
+    end
+    totals
+  end
+
+end
+end

data/lib/rock_books/reports/data/journal_data.rb

@@ -0,0 +1,37 @@
+require_relative '../../types/acct_amount'
+
+module RockBooks
+class JournalData
+
+  attr_reader :journal, :context, :filter
+
+  def initialize(journal, report_context, filter = nil)
+    @journal = journal
+    @context = report_context
+    @filter = filter
+  end
+
+  def entries
+    return @entries if @entries
+    @entries = journal.entries
+    @entries = @entries.select { |entry| filter.(entry) } if filter
+    @entries
+  end
+
+  def fetch
+    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
+    {
+      code: journal.account_code,
+      name: journal.chart_of_accounts.name_for_code(journal.account_code),
+      title: journal.title,
+      short_name: journal.short_name,
+      start_date: context.chart_of_accounts.start_date,
+      end_date: context.chart_of_accounts.end_date,
+      entries: entries,
+      totals: totals,
+      grand_total: totals.values.sum.round(2),
+      max_acct_code_len: context.chart_of_accounts.max_account_code_length
+    }
+  end
+end
+end

data/lib/rock_books/reports/data/multidoc_txn_by_account_data.rb

@@ -0,0 +1,40 @@
+module RockBooks
+class MultidocTxnByAccountData
+
+  include TextReportHelper
+
+  attr_reader :context, :account_code
+
+
+  def initialize(report_context)
+    @context = report_context
+  end
+
+
+  def fetch
+    all_journal_entries = Journal.entries_in_documents(context.journals)
+    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(all_journal_entries))
+    {
+      journals: context.journals,
+      entries: all_journal_entries,
+      totals: totals,
+      grand_total: totals.values.sum.round(2),
+      acct_sections: fetch_acct_sections(all_journal_entries),
+    }
+  end
+
+
+  private def fetch_acct_sections(all_journal_entries)
+    context.chart_of_accounts.accounts.map do |account|
+      code = account.code
+      acct_entries = JournalEntry.entries_containing_account_code(all_journal_entries, code)
+      total = JournalEntry.total_for_code(acct_entries, code)
+      {
+        code: code,
+        entries: acct_entries,
+        total: total
+      }
+    end
+  end
+end
+end