RubyGems - rock_books - Versions diffs - 0.6.0 → 0.9.0 - Mend

rock_books 0.6.0 → 0.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (54) hide show

checksums.yaml +4 -4
data/README.md +1 -3
data/RELEASE_NOTES.md +49 -10
data/assets/fonts/JetBrainsMono-Medium.ttf +0 -0
data/lib/rock_books/cmd_line/command_line_interface.rb +6 -6
data/lib/rock_books/cmd_line/main.rb +1 -9
data/lib/rock_books/documents/book_set.rb +1 -2
data/lib/rock_books/documents/chart_of_accounts.rb +29 -12
data/lib/rock_books/documents/journal.rb +3 -8
data/lib/rock_books/documents/journal_entry.rb +7 -2
data/lib/rock_books/documents/journal_entry_builder.rb +4 -0
data/lib/rock_books/helpers/book_set_loader.rb +3 -3
data/lib/rock_books/reports/balance_sheet.rb +9 -43
data/lib/rock_books/reports/book_set_reporter.rb +115 -98
data/lib/rock_books/reports/data/bs_is_data.rb +61 -0
data/lib/rock_books/reports/data/bs_is_section_data.rb +30 -0
data/lib/rock_books/reports/data/journal_data.rb +38 -0
data/lib/rock_books/reports/data/multidoc_txn_by_account_data.rb +40 -0
data/lib/rock_books/reports/data/multidoc_txn_report_data.rb +39 -0
data/lib/rock_books/reports/data/receipts_report_data.rb +47 -0
data/lib/rock_books/reports/data/tx_one_account_data.rb +37 -0
data/lib/rock_books/reports/helpers/erb_helper.rb +21 -0
data/lib/rock_books/reports/helpers/receipts_hyperlink_converter.rb +47 -0
data/lib/rock_books/reports/helpers/text_report_helper.rb +144 -0
data/lib/rock_books/reports/income_statement.rb +9 -47
data/lib/rock_books/reports/index_html_page.rb +27 -0
data/lib/rock_books/reports/journal_report.rb +82 -0
data/lib/rock_books/reports/multidoc_txn_by_account_report.rb +32 -0
data/lib/rock_books/reports/multidoc_txn_report.rb +25 -0
data/lib/rock_books/reports/receipts_report.rb +6 -55
data/lib/rock_books/reports/templates/html/index.html.erb +158 -0
data/lib/rock_books/reports/templates/html/report_page.html.erb +13 -0
data/lib/rock_books/reports/templates/text/_receipt_section.txt.erb +17 -0
data/lib/rock_books/reports/templates/text/_totals.txt.erb +8 -0
data/lib/rock_books/reports/templates/text/balance_sheet.txt.erb +23 -0
data/lib/rock_books/reports/templates/text/income_statement.txt.erb +23 -0
data/lib/rock_books/reports/templates/text/journal.txt.erb +23 -0
data/lib/rock_books/reports/templates/text/multidoc_txn_by_account_report.txt.erb +31 -0
data/lib/rock_books/reports/templates/text/multidoc_txn_report.txt.erb +25 -0
data/lib/rock_books/reports/templates/text/receipts_report.txt.erb +16 -0
data/lib/rock_books/reports/templates/text/tx_one_account.txt.erb +21 -0
data/lib/rock_books/reports/tx_one_account.rb +10 -45
data/lib/rock_books/types/account.rb +13 -1
data/lib/rock_books/types/account_type.rb +18 -7
data/lib/rock_books/version.rb +2 -1
data/rock_books.gemspec +1 -0
metadata +43 -10
data/lib/rock_books/helpers/html_helper.rb +0 -29
data/lib/rock_books/reports/index.html.erb +0 -156
data/lib/rock_books/reports/multidoc_transaction_report.rb +0 -66
data/lib/rock_books/reports/receipts.html.erb +0 -54
data/lib/rock_books/reports/reporter.rb +0 -118
data/lib/rock_books/reports/transaction_report.rb +0 -105
data/lib/rock_books/reports/tx_by_account.rb +0 -82

data/lib/rock_books/reports/multidoc_transaction_report.rb DELETED

@@ -1,66 +0,0 @@
-require_relative '../documents/journal'
-require_relative 'reporter'
-require_relative 'report_context'
-module RockBooks
-class MultidocTransactionReport
-  include Reporter
-  attr_accessor :context
-  SORT_BY_VALID_OPTIONS = %i(date_and_account  amount)
-  def initialize(report_context)
-    @context = report_context
-  end
-  def generate_header(sort_by)
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << center('Multi Document Transaction Report')
-    lines << center('Sorted by Amount Descending') if sort_by == :amount
-    lines << ''
-    lines << center('Source Documents:')
-    lines << ''
-    context.journals.each do |document|
-      short_name = SHORT_NAME_FORMAT_STRING % document.short_name
-      lines << center("#{short_name} -- #{document.title}")
-    end
-    lines << banner_line
-    lines << ''
-    lines << '   Date     Document           Amount      Account'
-    lines << '   ----     --------           ------      -------'
-    lines.join("\n") << "\n\n"
-  end
-  def generate_report(filter = nil, sort_by = :date_and_account)
-    unless SORT_BY_VALID_OPTIONS.include?(sort_by)
-      raise Error.new("sort_by option '#{sort_by}' not in valid choices of #{SORT_BY_VALID_OPTIONS}.")
-    end
-    entries = Journal.entries_in_documents(context.journals, filter)
-    if sort_by == :amount
-      JournalEntry.sort_entries_by_amount_descending!(entries)
-    end
-    sio = StringIO.new
-    sio << generate_header(sort_by)
-    entries.each { |entry| sio << format_multidoc_entry(entry) << "\n" }
-    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
-    sio << generate_and_format_totals('Totals', totals)
-    sio << "\n"
-    sio.string
-  end
-  alias_method :to_s, :generate_report
-  alias_method :call, :generate_report
-end
-end

data/lib/rock_books/reports/receipts.html.erb DELETED

@@ -1,54 +0,0 @@
-<!DOCTYPE html>
-<html>
-<body>
-<h1><%= chart_of_accounts.entity %> -- Receipts</h1>
-<p>Reports Generated at <%= DateTime.now.strftime('%Y-%m-%d_%H-%M-%S') %> by RockBooks version <%=RockBooks::VERSION %></p>
-<br />
-<% receipts.each  %>
-<h2>Financial Statements</h2>
-<ul>
-  <li><a href='balance_sheet.html'>Balance Sheet</a></li>
-  <li><a href='income_statement.html'>Income Statement</a></li>
-</ul>
-<h2>All Transactions</h2>
-<ul>
-  <li><a href="all_txns_by_acct.html">By Account</a></li>
-  <li><a href="all_txns_by_amount.html">By Amount</a></li>
-  <li><a href="all_txns_by_date.html">By Date</a></li>
-</ul>
-<h2>Journals</h2>
-<ul>
-  <% journals.each do |journal|
-    filespec = journal.short_name + '.html'
-    caption = "#{journal.title} -- #{journal.short_name} -- #{journal.account_code}"
-%>
-    <li><a href="<%= filespec %>"><%= caption %></a></li>
-  <% end %>
-</ul>
-<h2>Individual Accounts</h2>
-<ul>
-  <%
-    chart_of_accounts.accounts.each do |account|
-      filespec = File.join('single-account', "acct_#{account.code}.html")
-      caption = "#{account.name} (#{account.code})"
-  %>
-    <li><a href="<%= filespec %>"><%= caption %></a></li>
-  <% end %>
-</ul>
-  <h2>Receipts</h2>
-  <ul>
-    <% if run_options.do_receipts  %>
-      <li><a href="receipts.html">Missing and Existing Receipts</a></li>
-    <% end %>
-  </ul>
-</body>
-</html>

data/lib/rock_books/reports/reporter.rb DELETED

@@ -1,118 +0,0 @@
-require_relative '../documents/journal_entry'
-module RockBooks
-module Reporter
-  module_function
-  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 format_account_code(code)
-    "%*.*s" % [max_account_code_length, max_account_code_length, code]
-  end
-  def account_code_name_type_string(account)
-    "#{account.code} -- #{account.name}  (#{account.type.to_s.capitalize})"
-  end
-  def format_amount(amount)
-    "%9.2f" % amount
-  end
-  # e.g. "    117.70     tr.mileage  Travel - Mileage Allowance"
-  def format_acct_amount(acct_amount)
-    "%s  %s  %s" % [
-        format_amount(acct_amount.amount),
-        format_account_code(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
-    indent = 0 if indent < 0
-    (' ' * indent) + string
-  end
-  def max_account_code_length
-    @max_account_code_length ||= context.chart_of_accounts.max_account_code_length
-  end
-  def generate_and_format_totals(section_caption, totals)
-    output = section_caption
-    output << "\n#{'-' * section_caption.length}\n\n"
-    format_string = "%12.2f   %-#{context.chart_of_accounts.max_account_code_length}s   %s\n"
-    totals.keys.sort.each do |account_code|
-      account_name = context.chart_of_accounts.name_for_code(account_code)
-      account_total = totals[account_code]
-      output << format_string % [account_total, account_code, account_name]
-    end
-    output << "------------\n"
-    output << "%12.2f\n" % totals.values.sum.round(2)
-    output
-  end
-  def generate_account_type_section(section_caption, totals, section_type, need_to_reverse_sign)
-    account_codes_this_section = context.chart_of_accounts.account_codes_of_type(section_type)
-    totals_this_section = totals.select do |account_code, _amount|
-      account_codes_this_section.include?(account_code)
-    end
-    if need_to_reverse_sign
-      totals_this_section.each { |code, amount| totals_this_section[code] = -amount }
-    end
-    section_total_amount = totals_this_section.map { |aa| aa.last }.sum
-    output = generate_and_format_totals(section_caption, totals_this_section)
-    [ output, section_total_amount ]
-  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
-end
-end

data/lib/rock_books/reports/transaction_report.rb DELETED

@@ -1,105 +0,0 @@
-require_relative 'reporter'
-require_relative 'report_context'
-module RockBooks
-class TransactionReport
-  include Reporter
-  attr_accessor :journal, :context
-  def initialize(journal, report_context)
-    @journal = journal
-    @context = report_context
-  end
-  def generate_header
-    code = journal.account_code
-    name = journal.chart_of_accounts.name_for_code(code)
-    title = "Transactions for Account ##{code} -- #{name}"
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << center(journal.title) if journal.title && journal.title.length > 0
-    lines << center(title)
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-  def format_entry_first_acct_amount(entry)
-    entry.date.to_s \
-        << '  ' \
-        << format_acct_amount(entry.acct_amounts.last) \
-        << "\n"
-  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
-  def format_entry_no_split(entry)
-    output = format_entry_first_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
-  def format_entry_with_split(entry)
-    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
-  end
-  def format_entry(entry)
-    if entry.acct_amounts.size > 2
-      format_entry_with_split(entry)
-    else
-      format_entry_no_split(entry)
-    end
-  end
-  def generate_report(filter = nil)
-    sio = StringIO.new
-    sio << generate_header
-    entries = journal.entries
-    if filter
-      entries = entries.select { |entry| filter.(entry) }
-    end
-    entries.each do |entry|
-      sio << format_entry(entry) << "\n"
-    end
-    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
-    sio << generate_and_format_totals('Totals', totals)
-    sio.string
-  end
-  alias_method :to_s, :generate_report
-  alias_method :call, :generate_report
-end
-end

data/lib/rock_books/reports/tx_by_account.rb DELETED

@@ -1,82 +0,0 @@
-require_relative '../documents/chart_of_accounts'
-require_relative '../documents/journal'
-require_relative 'reporter'
-require_relative 'report_context'
-module RockBooks
-class TxByAccount
-  include Reporter
-  attr_accessor :context
-  def initialize(report_context)
-    @context = report_context
-  end
-  def generate_header
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << center("Transactions by Account")
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-  def account_header(account, account_total)
-    total_string = "%.2f" % account_total
-    title =  "Total: #{total_string} -- #{account_code_name_type_string(account)}"
-    <<~HEREDOC
-    #{banner_line}
-    #{center(title)}
-    #{banner_line}
-    HEREDOC
-  end
-  def account_total_line(account_code, account_total)
-    account_name = context.chart_of_accounts.name_for_code(account_code)
-    "%.2f  Total for account: %s - %s" % [account_total, account_code, account_name]
-  end
-  def generate_report
-    output = generate_header
-    all_entries = Journal.entries_in_documents(context.journals)
-    context.chart_of_accounts.accounts.each do |account|
-      code = account.code
-      account_entries = JournalEntry.entries_containing_account_code(all_entries, code)
-      account_total = JournalEntry.total_for_code(account_entries, code)
-      output << account_header(account, account_total)
-      account_entries.each do |entry|
-        output << format_multidoc_entry(entry) << "\n"
-        output << "\n" if entry.description && entry.description.length > 0
-      end
-      output << account_total_line(code, account_total) << "\n"
-      output  << "\n\n\n"
-    end
-    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(all_entries))
-    output << generate_and_format_totals('Totals', totals)
-    output
-  end
-  alias_method :to_s, :generate_report
-  alias_method :call, :generate_report
-end
-end