rock_books 0.6.1 → 0.10.0

data/rock_books.gemspec

@@ -33,6 +33,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'amazing_print', '> 0'
   spec.add_dependency 'os', '> 1.0.0'
   spec.add_dependency 'pry', '> 0.0.0'
+  spec.add_dependency 'prawn', '>= 2.1'
+  spec.add_dependency 'tty-progressbar'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", ">= 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_books
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-16 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -52,6 +52,34 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +139,7 @@ files:
 - README.md
 - RELEASE_NOTES.md
 - Rakefile
+- assets/fonts/JetBrainsMono-Medium.ttf
 - bin/console
 - bin/setup
 - exe/rock_books
@@ -130,19 +159,37 @@ files:
 - lib/rock_books/filters/acct_amount_filters.rb
 - lib/rock_books/filters/journal_entry_filters.rb
 - lib/rock_books/helpers/book_set_loader.rb
-- lib/rock_books/helpers/html_helper.rb
 - lib/rock_books/helpers/parse_helper.rb
 - lib/rock_books/reports/balance_sheet.rb
 - lib/rock_books/reports/book_set_reporter.rb
+- lib/rock_books/reports/data/bs_is_data.rb
+- lib/rock_books/reports/data/bs_is_section_data.rb
+- lib/rock_books/reports/data/journal_data.rb
+- lib/rock_books/reports/data/multidoc_txn_by_account_data.rb
+- lib/rock_books/reports/data/multidoc_txn_report_data.rb
+- lib/rock_books/reports/data/receipts_report_data.rb
+- lib/rock_books/reports/data/tx_one_account_data.rb
+- lib/rock_books/reports/helpers/erb_helper.rb
+- lib/rock_books/reports/helpers/receipts_hyperlink_converter.rb
+- lib/rock_books/reports/helpers/text_report_helper.rb
 - lib/rock_books/reports/income_statement.rb
-- lib/rock_books/reports/index.html.erb
-- lib/rock_books/reports/multidoc_transaction_report.rb
-- lib/rock_books/reports/receipts.html.erb
+- lib/rock_books/reports/index_html_page.rb
+- lib/rock_books/reports/journal_report.rb
+- lib/rock_books/reports/multidoc_txn_by_account_report.rb
+- lib/rock_books/reports/multidoc_txn_report.rb
 - lib/rock_books/reports/receipts_report.rb
 - lib/rock_books/reports/report_context.rb
-- lib/rock_books/reports/reporter.rb
-- lib/rock_books/reports/transaction_report.rb
-- lib/rock_books/reports/tx_by_account.rb
+- lib/rock_books/reports/templates/html/index.html.erb
+- lib/rock_books/reports/templates/html/report_page.html.erb
+- lib/rock_books/reports/templates/text/_receipt_section.txt.erb
+- lib/rock_books/reports/templates/text/_totals.txt.erb
+- lib/rock_books/reports/templates/text/balance_sheet.txt.erb
+- lib/rock_books/reports/templates/text/income_statement.txt.erb
+- lib/rock_books/reports/templates/text/journal.txt.erb
+- lib/rock_books/reports/templates/text/multidoc_txn_by_account_report.txt.erb
+- lib/rock_books/reports/templates/text/multidoc_txn_report.txt.erb
+- lib/rock_books/reports/templates/text/receipts_report.txt.erb
+- lib/rock_books/reports/templates/text/tx_one_account.txt.erb
 - lib/rock_books/reports/tx_one_account.rb
 - lib/rock_books/types/account.rb
 - lib/rock_books/types/account_type.rb
@@ -431,7 +478,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Very basic accounting package.

data/lib/rock_books/helpers/html_helper.rb

@@ -1,29 +0,0 @@
-module RockBooks
-module HtmlHelper
-
-  module_function
-
-  def self.convert_receipts_to_hyperlinks(html_text)
-    html_lines = html_text.split("\n")
-    replacements_made = false
-
-    html_lines.each_with_index do |line, index|
-      matches = /Receipt:\s*(.*?)</.match(line)
-      if matches
-        receipt_filespec = matches[1]
-        line_with_hyperlink = line.gsub( \
-            /Receipt:\s*#{receipt_filespec}/, \
-            %Q{Receipt: <a href="../../../receipts/#{receipt_filespec}">#{receipt_filespec}</a>})
-        html_lines[index] = line_with_hyperlink
-        replacements_made = true
-      end
-    end
-
-    if replacements_made
-      html_text = html_lines.join("\n")
-    end
-
-    [html_text, replacements_made]
-  end
-end
-end

data/lib/rock_books/reports/index.html.erb

@@ -1,156 +0,0 @@
-<!DOCTYPE html>
-
-
-<html>
-
-<head>
-
-<!--Bootstrap:-->
-<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/css/bootstrap.min.css" integrity="sha384-GJzZqFGwb1QTTN6wy59ffF1BuGJpLSa9DkKMp0DgiMDm4iYMj70gZWKYbI706tWS" crossorigin="anonymous">
-
-<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
-<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js" integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k" crossorigin="anonymous"></script>
-
-  <style>
-    body {
-      padding: 18px;
-      background-color: #e7f7cd;
-      color: darkgreen;
-    }
-
-    h2 {
-      margin-top: 32px;
-      margin-bottom: 12px;
-    }
-
-    .this_page_style {
-      background-color: #e7f7cd;
-      color: darkgreen;
-      border: 0px;
-    }
-
-
-
-  </style>
-
-</head>
-
-<body>
-
-<h1><%= chart_of_accounts.entity %></h1>
-<p class="muted">Reports Generated at <%= DateTime.now.strftime('%Y-%m-%d %H:%M:%S') %> by RockBooks version <%=RockBooks::VERSION %></p>
-
-
-<h2>Financial Statements</h2>
-<div id="financial-statements">
-<a href='balance_sheet.html' class="btn btn-success">Balance Sheet</a>
-<a href='income_statement.html' class="btn btn-success">Income Statement</a>
-</div>
-
-
-<h2>Supporting Documents</h2>
-<div id="supporting-documents" style="display: inline ">
-  <%
-    subdir_link = ->(name, caption) do
-      dir_name = File.expand_path(File.join(Dir.pwd, name))
-      if Dir.exist?(dir_name)
-        %Q{<a href=#{dir_name} class="btn btn-success">#{caption}</a>}
-      end
-    end
-  %>
-  <%= subdir_link.('invoices',   'Invoices')   %>
-  <%= subdir_link.('receipts',   'Receipts')   %>
-  <%= subdir_link.('statements', 'Statements') %>
-  <%= subdir_link.('worksheets', 'Worksheets') %>
-</div>
-
-
-<h2>All Transactions Reports</h2>
-<div id="all-transactions">
-<a href="all_txns_by_acct.html" class="btn btn-success">By Account</a>
-<a href="all_txns_by_amount.html" class="btn btn-success">By Amount</a>
-<a href="all_txns_by_date.html" class="btn btn-success">By Date</a>
-</div>
-
-<% collapsible_heading = ->(caption, href) do
-  %Q{<br /><br />
-  <div class="collapsible-heading">
-    <div class="container-fluid">
-      <div class="row">
-
-        <div class="col-sm2" style="margin-right: 12px;">
-          <a class="btn btn-success" data-toggle="collapse" href="#{href}" role="button" aria-expanded="false" aria-controls="collapseExample">
-            +/-
-          </a>
-        </div>
-
-        <div class="col-sm10">
-          <h2 style="margin: 0px;">#{caption}</h2>
-        </div>
-      </div>
-    </div>
-  </div>
-  }
-  end
-%>
-
-<%= collapsible_heading.('Journal Reports', '#journal-reports') %>
-
-</div>
-<div class="collapse" id="journal-reports">
-  <div class="card card-body this_page_style">
-    <ul>
-      <% journals.each do |journal|
-        filespec = journal.short_name + '.html'
-        caption = "#{journal.title} -- #{journal.short_name} -- #{journal.account_code}"%>
-        <li><a href="<%= filespec %>" class="this_page_style" target="_blank"><%= caption %></a></li>
-      <% end %>
-    </ul>
-  </div>
-</div>
-
-
-<%= collapsible_heading.('Individual Accounts', '#individual-accounts') %>
-
-<div class="collapse" id="individual-accounts">
-  <div class="card card-body  this_page_style">
-    <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 %>" class="this_page_style"><%= caption %></a></li>
-    <% end %>
-    </ul>
-</div>
-</div>
-</div>
-
-
-<%= collapsible_heading.('Other', '#other') %>
-
-<div class="collapse" id="other">
-  <div class="card card-body this_page_style">
-    <ul>
-      <% if run_options.do_receipts  %>
-        <li><a href="receipts.html" class="this_page_style">Missing and Existing Receipts</a></li>
-      <% end %>
-    </ul>
-  </div>
-</div>
-
-<%= collapsible_heading.('Reports in PDF and Text Formats', '#other-formats') %>
-
-<div class="collapse" id="other-formats">
-  <div class="card card-body this_page_style">
-    <ul>
-        <li><a href="../pdf" class="this_page_style" target="_blank">PDF Format</a></li>
-        <li><a href="../txt" class="this_page_style" target="_blank">Text Format</a></li>
-    </ul>
-  </div>
-</div>
-
-</body>
-</html>

data/lib/rock_books/reports/multidoc_transaction_report.rb

@@ -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

@@ -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

@@ -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
-
-