rock_books 0.7.0 → 0.11.0

data/lib/rock_books/reports/helpers/{reporter.rb → text_report_helper.rb}

@@ -2,7 +2,7 @@ require_relative '../../documents/journal_entry'
 require_relative 'erb_helper'
 
 module RockBooks
-module Reporter
+module TextReportHelper
 
   SHORT_NAME_MAX_LENGTH = 16
 
@@ -110,8 +110,17 @@ module Reporter
   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,
@@ -123,6 +132,7 @@ module Reporter
       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,

data/lib/rock_books/reports/income_statement.rb

@@ -1,12 +1,12 @@
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
 
 module RockBooks
 
 
   class IncomeStatement
 
-  include Reporter
+  include TextReportHelper
   include ErbHelper
 
   attr_reader :data, :context

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

@@ -1,12 +1,12 @@
 require_relative 'data/journal_data'
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
 
 module RockBooks
 
 class JournalReport
 
-  include Reporter
+  include TextReportHelper
   include ErbHelper
 
   attr_accessor :context, :report_data
@@ -24,18 +24,25 @@ class JournalReport
   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)
-    entry.date.to_s \
-         + '  ' \
-         + format_acct_amount(entry.acct_amounts.last) \
-         + "\n"
+    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_first_acct_amount(entry)
+    output = format_entry_last_acct_amount(entry)
 
     if entry.description && entry.description.length > 0
       output += entry.description
@@ -48,7 +55,8 @@ class JournalReport
   # 2018-05-21   $120.00   95.00     701  Office Supplies
   #                        25.00     751  Gift to Customer
   private def format_entry_with_split(entry)
-    output = format_entry_first_acct_amount(entry)
+    output = StringIO.new
+    output << format_entry_first_acct_amount(entry)
     indent = ' ' * 12
 
     entry.acct_amounts[1..-1].each do |acct_amount|
@@ -58,6 +66,8 @@ class JournalReport
     if entry.description && entry.description.length > 0
       output << entry.description
     end
+
+    output.string
   end
 
 

data/lib/rock_books/reports/multidoc_txn_by_account_report.rb

@@ -1,6 +1,6 @@
 require_relative '../documents/chart_of_accounts'
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
 require_relative 'report_context'
 require_relative 'data/multidoc_txn_by_account_data'
 
@@ -8,7 +8,7 @@ module RockBooks
 
 class MultidocTransactionByAccountReport
 
-  include Reporter
+  include TextReportHelper
   include ErbHelper
 
   attr_reader :context, :data

data/lib/rock_books/reports/multidoc_txn_report.rb

@@ -1,14 +1,14 @@
 require_relative 'data/multidoc_txn_report_data'
 require_relative '../documents/journal'
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
 require_relative 'report_context'
 
 module RockBooks
 
 class MultidocTransactionReport
 
-  include Reporter
+  include TextReportHelper
   include ErbHelper
 
   attr_reader :context, :data

data/lib/rock_books/reports/receipts_report.rb

@@ -4,7 +4,7 @@ require_relative 'report_context'
 module RockBooks
 class ReceiptsReport
 
-  include Reporter
+  include TextReportHelper
 
   attr_reader :context, :data
 

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

@@ -1,5 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
+  <!-- <%= metadata %> -->
   <head>
 
     <meta charset="utf-8">
@@ -14,6 +15,13 @@
         padding: 36px;
         background-color: #88c1f7;
         color: #01182d;
+        max-width: 1024px;
+        float: none !important;
+        margin: 0 auto !important;
+      }
+
+      .top_heading {
+          text-align: center;
       }
 
       h2 {
@@ -26,13 +34,25 @@
         color: #01182d;
         border: 0px;
       }
+
+      .lower_button_width {
+          min-width: 100px;
+      }
     </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>
+    <h1 class="top_heading"><%= entity %></h1>
+    <h1 class="top_heading">Financial Statements, Reports, and Source Data</h1>
+    <h1 class="top_heading"><%= accounting_period %></h1>
+    <br />
+    <br />
+    <h4 class="top_heading"><%= generated[0] %></h4>
+    <h4 class="top_heading"><%= generated[1] %> (<a href="https://github.com/keithrbennett/rock_books">https://github.com/keithrbennett/rock_books</a>)</h4>
+    <h4 class="top_heading">Open Source Software Provided by <a href="https://www.bbs-software.com/">Bennett Business Solutions, Inc.</a></h4>
+    <br />
+    <br />
 
     <h2>Financial Statements</h2>
     <div id="financial-statements">
@@ -45,9 +65,10 @@
     <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-primary">#{caption}</a>}
+          link_dir_name = File.join('..', '..', name)
+          test_dir_name = name
+          if Dir.exist?(test_dir_name)
+            %Q{<a href=#{link_dir_name} class="btn btn-primary">#{caption}</a>}
           end
         end
       %>
@@ -55,6 +76,7 @@
       <%= subdir_link.('receipts',   'Receipts')   %>
       <%= subdir_link.('statements', 'Statements') %>
       <%= subdir_link.('worksheets', 'Worksheets') %>
+      <%= subdir_link.('rockbooks-inputs', 'Original Input Documents') %>
     </div>
 
 
@@ -72,7 +94,7 @@
         <div class="row">
 
           <div class="col-sm2" style="margin-right: 12px;">
-            <a class="btn btn-primary" data-toggle="collapse" href="#{href}" role="button" aria-expanded="false" aria-controls="collapseExample">
+            <a class="btn btn-primary lower_button_width" data-toggle="collapse" href="#{href}" role="button" aria-expanded="false" aria-controls="collapseExample">
               +/-
             </a>
           </div>
@@ -137,5 +159,22 @@
       </div>
     </div>
 
+
+    <br /><br />
+
+    <div class="container-fluid">
+      <div class="row">
+
+        <div class="col-sm2" style="margin-right: 12px;">
+          <a class="btn btn-primary lower_button_width" href="../..">
+            Browse
+          </a>
+        </div>
+
+        <div class="col-sm10">
+          <h2 style="margin: 0px;">Browse All Data Files</h2>
+        </div>
+      </div>
+    </div>
   </body>
 </html>

data/lib/rock_books/reports/templates/html/report_page.html.erb

@@ -1,8 +1,21 @@
 <!DOCTYPE html>
 <html lang="en">
+  <!-- <%= metadata_comment %> -->
   <head>
-    <title></title>
+    <title><%= title %></title>
     <meta name="generator" content="RockBooks Accounting"/>
+    <style>
+        body {
+            padding: 36px;
+            background-color: #d5f3fb;
+            color: #01182d;
+            max-width: 1024px;
+            float: none !important;
+            margin: 0 auto !important;
+            border: 0px;
+            font-size: 15px !important;
+        }
+    </style>
   </head>
   <body>
     <pre>

data/lib/rock_books/reports/templates/text/balance_sheet.txt.erb

@@ -1,6 +1,8 @@
 <%= banner_line %>
 <%= fn_center.(entity || 'Unspecified Entity') %>
 <%= fn_center.("Balance Sheet for Period Ending #{end_date}") %>
+
+<%= fn_center.(generated) %>
 <%= banner_line %>
 
 <% %i(asset liability equity).each do |section_type| -%>

data/lib/rock_books/reports/templates/text/income_statement.txt.erb

@@ -1,6 +1,8 @@
 <%= banner_line %>
 <%= fn_center.(entity || 'Unspecified Entity') %>
-<%= fn_center.("Income Statement -- #{start_date} to #{end_date}") %>
+<%= fn_center.("Income Statement -- #{accounting_period}") %>
+
+<%= fn_center.(generated) %>
 <%= banner_line %>
 
 <% %i(income expense).each do |section_type| -%>

data/lib/rock_books/reports/templates/text/journal.txt.erb

@@ -1,14 +1,17 @@
 <%= banner_line %>
 <%= fn_center.(entity || 'Unspecified Entity') %>
 <%= fn_center.(title) %>
+<%= fn_center.(accounting_period) %>
+
 <% if code && name -%>
 <%= fn_center.("Account: #{name} (#{code})") %>
 <% end -%>
 <% if short_name -%>
 <%= fn_center.("Journal Short Name: #{short_name}") %>
+<%= fn_center.("Amounts shown are #{debit_or_credit}s to specified accounts (negate for #{short_name})") %>
 <% end -%>
-<%= fn_center.("#{start_date} to #{end_date}"
-) %>
+
+<%= fn_center.(generated) %>
 <%= banner_line %>
 
 

data/lib/rock_books/reports/templates/text/multidoc_txn_by_account_report.txt.erb

@@ -1,6 +1,9 @@
 <%= banner_line %>
 <%= fn_center.(entity || 'Unspecified Entity') %>
 <%= fn_center.('Multi Document Transaction Report by Account') %>
+<%= fn_center.(accounting_period) %>
+
+<%= fn_center.(generated) %>
 
 <%= fn_center.('Source Documents') %>
 

data/lib/rock_books/reports/templates/text/multidoc_txn_report.txt.erb

@@ -1,6 +1,9 @@
 <%= banner_line %>
 <%= fn_center.(entity || 'Unspecified Entity') %>
 <%= fn_center.('Multi Document Transaction Report') %>
+<%= fn_center.(accounting_period) %>
+
+<%= fn_center.(generated) %>
 
 <%= fn_center.('Source Documents') %>
 

data/lib/rock_books/reports/templates/text/receipts_report.txt.erb

@@ -4,6 +4,9 @@ end -%>
 <%= banner_line %>
 <%= fn_center.(entity || 'Unspecified Entity') %>
 <%= fn_center.('Receipts Report') %>
+<%= fn_center.(accounting_period) %>
+
+<%= fn_center.(generated) %>
 <%= banner_line %>
 
 <% # Unlike existing and missing, which arrays of hashes with keys :receipt and :journal, unused is an array of receipt filespecs %>

data/lib/rock_books/reports/templates/text/tx_one_account.txt.erb

@@ -2,6 +2,9 @@
 <%= fn_center.(entity || 'Unspecified Entity') %>
 <%= fn_center.("Transactions for Account #{account_string}") %>
 <%= fn_center.(sprintf("Total: %.2f", total)) %>
+<%= fn_center.(accounting_period) %>
+
+<%= fn_center.(generated) %>
 <%= banner_line %>
 
 

data/lib/rock_books/reports/tx_one_account.rb

@@ -2,14 +2,14 @@ require_relative 'data/tx_one_account_data'
 require_relative '../documents/chart_of_accounts'
 require_relative '../documents/journal'
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
 require_relative 'report_context'
 
 module RockBooks
 
   class TxOneAccount
 
-    include Reporter
+    include TextReportHelper
     include ErbHelper
 
     attr_reader :context, :account_code, :data

data/lib/rock_books/version.rb

@@ -1,3 +1,4 @@
 module RockBooks
-  VERSION = "0.7.0"
+  VERSION = '0.11.0'
+  PROJECT_URL = 'https://github.com/keithrbennett/rock_books'
 end

data/rock_books.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   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.7.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 2021-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !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
@@ -122,9 +136,12 @@ files:
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
+- MANUAL.md
 - README.md
 - RELEASE_NOTES.md
+- REPORTS.md
 - Rakefile
+- assets/doc-images/sample-index-html.png
 - assets/fonts/JetBrainsMono-Medium.ttf
 - bin/console
 - bin/setup
@@ -145,7 +162,6 @@ 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
@@ -157,8 +173,10 @@ files:
 - 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/reporter.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_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
@@ -181,7 +199,6 @@ files:
 - lib/rock_books/types/acct_amount.rb
 - lib/rock_books/types/journal_entry_context.rb
 - lib/rock_books/version.rb
-- manual.md
 - rock_books.gemspec
 - sample_data/minimal/receipts/01/2018-01-01-sample-receipt.jpg
 - sample_data/minimal/rockbooks-inputs/2018-xyz-chart-of-accounts.txt