rock_books 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37feeb3b20b730f06340d5e026dca81b564dc7cd6cb174a2d8bd0ffcbcb6441
-  data.tar.gz: 41a1e166136c536fde00512d8e624ce49c894766cd5f18ed673f8f67fdaf8908
+  metadata.gz: ebc94a9d98f612b4c8c13ed48739004619b4bc4d82d484314f50001d6ee784b6
+  data.tar.gz: c565f0945fbecc80f4af87afc67f57a9d73e293e95f096a02c1bdbcc2e7a1afb
 SHA512:
-  metadata.gz: 41e4511367107b2be92ff53eb28c42635884413c3fa91c010eee41a53da6ac94b3b9a8f7eccf3522610eee287008944d318f3250dcdc349544491dcb13dd515c
-  data.tar.gz: 45239916850fd6102b50c8ca719a2d336b0704a116c0c4f2af5014c5a061c8b6a6147f95811a88fe13f51e23f345baeb3eda16b0e789b9682596945b92ddabb4
+  metadata.gz: 514102c4e924ee1890a3f0233b7584c63e9a988595e562b7387e2ed696e41ffffd3b48e72fd939442edeef5a146fd473bb9fe0ea2e657d3b3d57bedc748d8472
+  data.tar.gz: 67b889a280ed577daa98358b4a927d83bf9339a35d8e9106aa3127776a6028bda7108a55cd7ee3c4164217e8213728c4d742be44b55317e583d7d604151f1a48

data/RELEASE_NOTES.md

@@ -1,3 +1,10 @@
+### v0.8.0
+
+* Add metadata to PDF and HTML reports
+* Add report generation timestamp and accounting period to all reports.
+* Refactoring and cleanup.
+
+
 ### v0.7.1
 
 * Refactor report helpers. 

data/lib/rock_books/documents/journal.rb

@@ -65,9 +65,8 @@ class Journal
   attr_reader :short_name, :account_code, :chart_of_accounts, :date_prefix, :debit_or_credit, :doc_type, :title, :entries
 
   # short_name is a name that will appear on reports identifying the journal from which a transaction comes
-  def initialize(chart_of_accounts, input_lines, short_name = nil)
+  def initialize(chart_of_accounts, input_lines)
     @chart_of_accounts = chart_of_accounts
-    @short_name = short_name
     @entries = []
     @date_prefix = ''
     input_lines.each_with_index do |line, linenum|

data/lib/rock_books/reports/book_set_reporter.rb

@@ -4,6 +4,7 @@ require_relative 'balance_sheet'
 require_relative 'data/bs_is_data'
 require_relative 'data/receipts_report_data'
 require_relative 'income_statement'
+require_relative 'index_html_page'
 require_relative 'multidoc_txn_report'
 require_relative 'receipts_report'
 require_relative 'report_context'
@@ -12,7 +13,7 @@ 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_relative 'helpers/receipts_hyperlink_converter'
 
 require 'prawn'
 
@@ -21,7 +22,7 @@ class BookSetReporter
 
   extend Forwardable
 
-  attr_reader :book_set, :output_dir, :filter, :context
+  attr_reader :book_set, :context, :filter, :output_dir
 
   def_delegator :book_set, :all_entries
   def_delegator :book_set, :journals
@@ -129,24 +130,32 @@ class BookSetReporter
   end
 
 
-  private def create_index_html
-    filespec = build_filespec(output_dir, 'index', 'html')
-    File.write(filespec, index_html_content)
-    puts "Created index.html"
+  private def report_metadata(doc_short_name)
+    {
+        RBCreator:      "RockBooks v#{VERSION} (#{PROJECT_URL})",
+        RBEntity:       context.entity,
+        RBCreated:      Time.now.to_s,
+        RBDocumentCode: doc_short_name.to_s,
+    }
   end
 
 
-  private def prawn_create_document(pdf_filespec, text)
-    Prawn::Document.generate(pdf_filespec) do
+  private def prawn_create_document(pdf_filespec, report_text, doc_short_name)
+    Prawn::Document.generate(pdf_filespec, info: report_metadata(doc_short_name)) do
       font(FONT_FILESPEC, size: 10)
 
       utf8_nonbreaking_space = "\uC2A0"
       unicode_nonbreaking_space = "\u00A0"
-      text(text.gsub(' ', unicode_nonbreaking_space))
+      text(report_text.gsub(' ', unicode_nonbreaking_space))
     end
   end
 
 
+  private def html_metadata_comment(doc_short_name)
+    "\n" + report_metadata(doc_short_name).ai(plain: true) + "\n"
+  end
+
+
   private def write_report(short_name, text_report)
 
     txt_filespec = build_filespec(output_dir, short_name, 'txt')
@@ -155,12 +164,16 @@ class BookSetReporter
 
     create_text_report = -> { File.write(txt_filespec, text_report) }
 
-    create_pdf_report = -> { prawn_create_document(pdf_filespec, text_report) }
+    create_pdf_report = -> { prawn_create_document(pdf_filespec, text_report, short_name) }
 
     create_html_report = -> do
-      data = { report_body: text_report, title: "#{short_name} Report -- RockBooks" }
+      data = {
+          report_body: text_report,
+          title: "#{short_name} Report -- RockBooks",
+          metadata_comment: html_metadata_comment(short_name)
+      }
       html_raw_report = ErbHelper.render_hashes("html/report_page.html.erb", data, {})
-      html_report = HtmlReportHelper.convert_receipts_to_hyperlinks(html_raw_report, html_filespec)
+      html_report = ReceiptsHyperlinkConverter.convert(html_raw_report, html_filespec)
       File.write(html_filespec, html_report)
     end
 
@@ -195,13 +208,11 @@ class BookSetReporter
   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)
+  private def create_index_html
+    filespec = build_filespec(output_dir, 'index', 'html')
+    content = IndexHtmlPage.new(context, html_metadata_comment('index.html'), run_options).generate
+    File.write(filespec, content)
+    puts "Created index.html"
   end
 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

@@ -110,8 +110,15 @@ module TextReportHelper
   end
 
 
+  # e.g. "Generated at 2021-01-09 18:22:18 by RockBooks version 0.7.1"
+  def generation_info_display_string
+    "Reports Generated at #{DateTime.now.strftime('%Y-%m-%d %H:%M:%S')} 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 +130,7 @@ module TextReportHelper
       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: "Generated at #{DateTime.now.strftime('%Y-%m-%d %H:%M:%S')} by RockBooks version #{RockBooks::VERSION}",
       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/index_html_page.rb

@@ -0,0 +1,25 @@
+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
+      ErbHelper.render_hashes('html/index.html.erb', data, template_presentation_context)
+    end
+  end
+end

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">
@@ -31,8 +32,10 @@
 
   <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><%= entity %></h1>
+    <h1><%= accounting_period %></h1>
+    <p class="muted"><%= generated %></p>
+<!--    <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">

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

@@ -1,5 +1,6 @@
 <!DOCTYPE html>
 <html lang="en">
+  <!-- <%= metadata_comment %> -->
   <head>
     <title><%= title %></title>
     <meta name="generator" content="RockBooks Accounting"/>

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

@@ -1,6 +1,7 @@
 <%= 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,7 @@
 <%= 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,14 @@
 <%= 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}") %>
 <% 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,8 @@
 <%= 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,8 @@
 <%= 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,8 @@ 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,8 @@
 <%= 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/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_books
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-03 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -156,9 +156,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/html_report_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_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

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

@@ -1,35 +0,0 @@
-module RockBooks
-module HtmlReportHelper
-
-  def self.convert_receipts_to_hyperlinks(original_html_string, html_filespec)
-    html_lines = original_html_string.split("\n")
-    content_changed = false
-
-    # 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]'
-    processed_receipt_filespec = ->(listed_receipt_filespec) do
-      num_dirs_up = html_filespec.include?('/single-account/') ? 3 : 2
-      File.join(('../' * num_dirs_up), 'receipts', listed_receipt_filespec)
-    end
-
-    receipt_anchor_line = ->(line, listed_receipt_filespec) do
-      line.gsub( \
-            /Receipt:\s*#{listed_receipt_filespec}/, \
-            %Q{Receipt: <a href="#{processed_receipt_filespec.(listed_receipt_filespec)}">#{listed_receipt_filespec}</a>})
-    end
-
-    html_lines.each_with_index do |line, index|
-      matches = /Receipt:\s*(\S*)/.match(line)
-      if matches
-        listed_receipt_filespec = matches[1]
-        html_lines[index] = receipt_anchor_line.(line, listed_receipt_filespec)
-        content_changed = true
-      end
-    end
-
-    content_changed ? html_lines.join("\n") : original_html_string
-  end
-end
-end