rock_books 0.6.0 → 0.9.0

data/lib/rock_books/reports/data/multidoc_txn_report_data.rb

@@ -0,0 +1,39 @@
+require_relative '../../documents/journal'
+require_relative '../../documents/journal_entry'
+
+module RockBooks
+class MultidocTxnReportData
+
+  attr_reader :context, :entries, :totals
+
+  def initialize(context, sort_by, filter = nil)
+    @context = context
+    @entries = fetch_entries(sort_by, filter)
+    @totals = fetch_totals(filter)
+  end
+
+  def fetch
+    {
+      journals: context.journals,
+      entries: entries,
+      totals: totals,
+      grand_total: totals.values.sum.round(2),
+    }
+  end
+
+  private def fetch_entries(sort_by, filter)
+    entries = Journal.entries_in_documents(context.journals, filter)
+    if sort_by == :amount
+      JournalEntry.sort_entries_by_amount_descending!(entries)
+    else
+      JournalEntry.sort_entries_by_date!(entries)
+    end
+    entries
+  end
+
+  private def fetch_totals(filter)
+    acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
+    AcctAmount.aggregate_amounts_by_account(acct_amounts)
+  end
+end
+end

data/lib/rock_books/reports/data/receipts_report_data.rb

@@ -0,0 +1,47 @@
+module RockBooks
+class ReceiptsReportData
+
+  attr_reader :all_entries, :receipt_dir
+
+  def initialize(all_entries, receipt_dir)
+    @all_entries = all_entries
+    @receipt_dir = receipt_dir
+  end
+
+
+  def fetch
+    missing_receipts = []
+    existing_receipts = []
+
+    # We will start out putting all filespecs in the unused array, and delete them as they are found in the transactions.
+    unused_receipt_filespecs = all_receipt_filespecs
+
+    all_entries.each do |entry|
+      entry.receipts.each do |receipt|
+        filespec = receipt_full_filespec(receipt)
+        unused_receipt_filespecs.delete(filespec)
+        list = (File.file?(filespec) ? existing_receipts : missing_receipts)
+        list << { receipt: receipt, journal: entry.doc_short_name }
+      end
+    end
+
+    {
+        missing: missing_receipts,
+        unused: unused_receipt_filespecs,
+        existing: existing_receipts
+    }
+  end
+
+
+  private def all_receipt_filespecs
+    Dir['receipts/**/*'].select { |s| File.file?(s) } \
+        .sort \
+        .map { |s| "./" +  s }  # Prepend './' to match the data
+  end
+
+
+  private def receipt_full_filespec(receipt_filespec)
+    File.join(receipt_dir, receipt_filespec)
+  end
+end
+end

data/lib/rock_books/reports/data/tx_one_account_data.rb

@@ -0,0 +1,37 @@
+module RockBooks
+  class TxOneAccountData
+
+    include TextReportHelper
+
+    attr_reader :context, :account_code, :account, :entries, :account_total, :totals
+
+
+    def initialize(report_context, account_code)
+      @context = report_context
+      @account_code = account_code
+    end
+
+    def fetch
+
+      account = context.chart_of_accounts.account_for_code(account_code)
+      account_string = "#{account.code} -- #{account.name}  (#{account.type.to_s.capitalize})"
+      entries = Journal.entries_in_documents(context.journals, JournalEntryFilters.account_code(account_code))
+      account_total = JournalEntry.total_for_code(entries, account_code)
+      totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
+
+
+      {
+        account_string: account_string,
+        entries: entries,
+        total: account_total,
+        totals: AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries)),
+        grand_total: totals.values.sum.round(2)
+      }
+    end
+
+    private def fetch_totals(filter)
+      acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
+      AcctAmount.aggregate_amounts_by_account(acct_amounts)
+    end
+  end
+end

data/lib/rock_books/reports/helpers/erb_helper.rb

@@ -0,0 +1,21 @@
+module ErbHelper
+
+  def self.erb_template(erb_relative_filespec)
+    erb_filespec = File.absolute_path(File.join(File.dirname(__FILE__), '..', 'templates', erb_relative_filespec))
+    eoutvar = "@outvar_#{erb_relative_filespec.split('.').first.split('/').last}" # dots will be evaulated by `eval`, must remove them
+    ERB.new(File.read(erb_filespec), eoutvar: eoutvar, trim_mode: '-')
+  end
+
+
+  def self.render_binding(erb_relative_filespec, template_binding)
+    result = erb_template(erb_relative_filespec).result(template_binding)
+    result
+  end
+
+  # Takes 2 hashes, one with data, and the other with presentation functions/lambdas, and passes their union to ERB
+  # for rendering.
+  def self.render_hashes(erb_relative_filespec, data_hash, presentation_hash)
+    combined_hash = (data_hash || {}).merge(presentation_hash || {})
+    erb_template(erb_relative_filespec).result_with_hash(combined_hash)
+  end
+end

data/lib/rock_books/reports/helpers/receipts_hyperlink_converter.rb

@@ -0,0 +1,47 @@
+module RockBooks
+class ReceiptsHyperlinkConverter
+
+  def self.convert(html_string, html_filespec)
+    ReceiptsHyperlinkConverter.new(html_string, html_filespec).convert
+  end
+
+  RECEIPT_REGEX = /Receipt:\s*(\S*)/
+
+  attr_reader :html_string, :num_dirs_up
+
+  def initialize(html_string, html_filespec)
+    @html_string = html_string
+    @num_dirs_up = html_filespec.include?('/single-account/') ? 3 : 2
+  end
+
+
+  def convert
+    html_string.split("\n").map do |line|
+      matches = RECEIPT_REGEX.match(line)
+      if matches
+        listed_receipt_filespec = matches[1]
+        receipt_anchor_line(line, listed_receipt_filespec)
+      else
+        line
+      end
+    end.join("\n")
+  end
+
+
+  # If the HTML file being created is in DATA_DIR/rockbooks-reports/html/single-account, then
+  #   the processed link should be '../../../receipts/[receipt_filespec]'
+  # else it's in DATA_DIR/rockbooks-reports/html, and
+  #   the processed link should be '../../receipts/[receipt_filespec]'
+  private def processed_receipt_filespec(listed_receipt_filespec)
+    File.join(('../' * num_dirs_up), 'receipts', listed_receipt_filespec)
+  end
+
+  private def receipt_anchor_line(line, listed_receipt_filespec)
+    line.gsub( \
+          /Receipt:\s*#{listed_receipt_filespec}/, \
+          %Q{Receipt: <a href="#{processed_receipt_filespec(listed_receipt_filespec)}">#{listed_receipt_filespec}</a>})
+  end
+
+end
+end
+

data/lib/rock_books/reports/helpers/text_report_helper.rb

@@ -0,0 +1,144 @@
+require_relative '../../documents/journal_entry'
+require_relative 'erb_helper'
+
+module RockBooks
+module TextReportHelper
+
+  SHORT_NAME_MAX_LENGTH = 16
+
+  SHORT_NAME_FORMAT_STRING = "%#{SHORT_NAME_MAX_LENGTH}.#{SHORT_NAME_MAX_LENGTH}s"
+
+
+  def page_width
+    context.page_width || 80
+  end
+
+
+  def account_code_format
+    @account_code_format ||= "%#{max_account_code_length}.#{max_account_code_length}s"
+  end
+
+
+  def account_code_name_type_string(account)
+    "#{account.code} -- #{account.name}  (#{account.type.to_s.capitalize})"
+  end
+
+
+  def account_code_name_type_string_for_code(account_code)
+    account = context.chart_of_accounts.account_for_code(account_code)
+    raise "Account for code #{account_code} not found" unless account
+    account_code_name_type_string(account)
+  end
+
+
+  # e.g. "    117.70     tr.mileage  Travel - Mileage Allowance"
+  def format_acct_amount(acct_amount)
+    sprintf("%s  %s  %s",
+        sprintf("%9.2f", acct_amount.amount),
+        sprintf(account_code_format, acct_amount.code),
+        context.chart_of_accounts.name_for_code(acct_amount.code))
+  end
+
+
+  def banner_line
+    @banner_line ||= '-' * page_width
+  end
+
+
+  def center(string)
+    indent = [(page_width - string.length) / 2, 0].max
+    (' ' * indent) + string
+  end
+
+
+  def max_account_code_length
+    @max_account_code_length ||= context.chart_of_accounts.max_account_code_length
+  end
+
+
+  def total_with_ok_or_discrepancy(amount)
+    status_message = (amount == 0.0)  ? '(Ok)' : '(Discrepancy)'
+    sprintf(line_item_format_string, amount, status_message, '')
+  end
+
+
+  def format_multidoc_entry(entry)
+    acct_amounts = entry.acct_amounts
+
+    # "2017-10-29  hsbc_visa":
+    output = entry.date.to_s << '  ' << (SHORT_NAME_FORMAT_STRING % entry.doc_short_name) << '  '
+
+    indent = ' ' * output.length
+
+    output << format_acct_amount(acct_amounts.first) << "\n"
+
+    acct_amounts[1..-1].each do |acct_amount|
+      output << indent << format_acct_amount(acct_amount) << "\n"
+    end
+
+    if entry.description && entry.description.length > 0
+      output << entry.description
+    end
+
+    output
+  end
+
+  def line_item_format_string
+    @line_item_format_string ||= "%12.2f   %-#{context.chart_of_accounts.max_account_code_length}s   %s"
+  end
+
+
+  # :asset => "Assets\n------"
+  def section_heading(section_type)
+    title = AccountType.symbol_to_type(section_type).plural_name
+    "\n\n" + title + "\n" + ('-' * title.length)
+  end
+
+
+  def acct_name(code)
+    context.chart_of_accounts.name_for_code(code)
+  end
+
+
+  def start_date
+    context.chart_of_accounts.start_date
+  end
+
+
+  def end_date
+    context.chart_of_accounts.end_date
+  end
+
+
+  # e.g. "Generated at 2021-01-09 18:22:18 by RockBooks version 0.7.1"
+  def generation_info_display_string
+    now = Time.now
+    timestamp = "#{now} (#{now.utc})"
+    center("Generated at #{timestamp}") + "\n" + center("by RockBooks version #{RockBooks::VERSION}")
+  end
+
+
+  def template_presentation_context
+    {
+      accounting_period: "#{start_date} to #{end_date}",
+      banner_line: banner_line,
+      end_date: end_date,
+      entity: context.entity,
+      fn_acct_name:  method(:acct_name),
+      fn_account_code_name_type_string_for_code: method(:account_code_name_type_string_for_code),
+      fn_center: method(:center),
+      fn_erb_render_binding: ErbHelper.method(:render_binding),
+      fn_erb_render_hashes: ErbHelper.method(:render_hashes),
+      fn_format_multidoc_entry: method(:format_multidoc_entry),
+      fn_section_heading: method(:section_heading),
+      fn_total_with_ok_or_discrepancy: method(:total_with_ok_or_discrepancy),
+      generated: generation_info_display_string,
+      line_item_format_string: line_item_format_string,
+      short_name_format_string: SHORT_NAME_FORMAT_STRING,
+      start_date: start_date,
+    }
+  end
+end
+end
+
+

data/lib/rock_books/reports/income_statement.rb

@@ -1,63 +1,25 @@
-require_relative '../documents/journal'
-require_relative 'report_context'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/text_report_helper'
 
 module RockBooks
 
 
   class IncomeStatement
 
-  include Reporter
+  include TextReportHelper
+  include ErbHelper
 
-  attr_accessor :context
+  attr_reader :data, :context
 
 
-  def initialize(report_context)
+  def initialize(report_context, data)
     @context = report_context
+    @data = data
   end
 
 
-  def start_date
-    context.chart_of_accounts.start_date
+  def generate
+    ErbHelper.render_hashes('text/income_statement.txt.erb', data, template_presentation_context)
   end
-
-
-  def end_date
-    context.chart_of_accounts.end_date
-  end
-
-
-  def generate_header
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << "#{center("Income Statement -- #{start_date} to #{end_date}")}"
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-
-
-  def generate_report
-    filter = RockBooks::JournalEntryFilters.date_in_range(start_date, end_date)
-    acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
-    totals = AcctAmount.aggregate_amounts_by_account(acct_amounts)
-    totals.each { |aa| aa[1] = -aa[1] } # income statement shows credits as positive, debits as negative
-    output = generate_header
-
-    income_output,  income_total  = generate_account_type_section('Income',   totals, :income,  true)
-    expense_output, expense_total = generate_account_type_section('Expenses', totals, :expense, false)
-
-    grand_total = income_total - expense_total
-
-    output << [income_output, expense_output].join("\n\n")
-    output << "\n#{"%12.2f    Net Income" % grand_total}\n============\n"
-    output
-  end
-
-alias_method :to_s, :generate_report
-alias_method :call, :generate_report
-
-
 end
 end

data/lib/rock_books/reports/index_html_page.rb

@@ -0,0 +1,27 @@
+require_relative 'report_context'
+
+
+module RockBooks
+  class IndexHtmlPage
+
+    include TextReportHelper
+
+    attr_reader :context, :data
+
+    def initialize(report_context, metadata, run_options)
+      @context = report_context
+      @data = {
+        metadata: metadata,
+        journals: context.journals,
+        chart_of_accounts: context.chart_of_accounts,
+        run_options: run_options,
+      }
+    end
+
+    def generate
+      webized_generate_message_lines = template_presentation_context[:generated].split("\n")
+      presentation_context = template_presentation_context.merge( { generated: webized_generate_message_lines})
+      ErbHelper.render_hashes('html/index.html.erb', data, presentation_context)
+    end
+  end
+end

data/lib/rock_books/reports/journal_report.rb

@@ -0,0 +1,82 @@
+require_relative 'data/journal_data'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/text_report_helper'
+
+module RockBooks
+
+class JournalReport
+
+  include TextReportHelper
+  include ErbHelper
+
+  attr_accessor :context, :report_data
+
+
+  def initialize(report_data, report_context, filter = nil)
+    @report_data = report_data
+    @context = report_context
+  end
+
+
+  def generate
+    presentation_context = template_presentation_context.merge(fn_format_entry: method(:format_entry))
+    ErbHelper.render_hashes('text/journal.txt.erb', report_data, presentation_context)
+  end
+
+
+  private def format_date_and_account_amount(date, acct_amount)
+    "#{date}  #{format_acct_amount(acct_amount)}\n"
+  end
+
+
+  private def format_entry_first_acct_amount(entry)
+    format_date_and_account_amount(entry.date, entry.acct_amounts.first)
+  end
+
+
+  private def format_entry_last_acct_amount(entry)
+    format_date_and_account_amount(entry.date, entry.acct_amounts.last)
+  end
+
+
+  # Formats an entry like this, with entry description added on additional line(s) if it exists:
+  # 2018-05-21   $120.00   701  Office Supplies
+  private def format_entry_no_split(entry)
+    output = format_entry_last_acct_amount(entry)
+
+    if entry.description && entry.description.length > 0
+      output += entry.description
+    end
+    output
+  end
+
+
+  # Formats an entry like this, with entry description added on additional line(s) if it exists::
+  # 2018-05-21   $120.00   95.00     701  Office Supplies
+  #                        25.00     751  Gift to Customer
+  private def format_entry_with_split(entry)
+    output = StringIO.new
+    output << format_entry_first_acct_amount(entry)
+    indent = ' ' * 12
+
+    entry.acct_amounts[1..-1].each do |acct_amount|
+      output << indent << format_acct_amount(acct_amount) << "\n"
+    end
+
+    if entry.description && entry.description.length > 0
+      output << entry.description
+    end
+
+    output.string
+  end
+
+
+  private def format_entry(entry)
+    if entry.acct_amounts.size > 2
+      format_entry_with_split(entry)
+    else
+      format_entry_no_split(entry)
+    end
+  end
+end
+end