rock_books 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c30673728b99315fc841b99b96081751f91459663c736758b7340a317407cc56
-  data.tar.gz: 751adad9c6038a85a696deb4076bbc93bbfb8a8650d53159aca691b281388d9f
+  metadata.gz: d37feeb3b20b730f06340d5e026dca81b564dc7cd6cb174a2d8bd0ffcbcb6441
+  data.tar.gz: 41a1e166136c536fde00512d8e624ce49c894766cd5f18ed673f8f67fdaf8908
 SHA512:
-  metadata.gz: 84ff76b2001eed18b4f4ec69f9949720a4dbca892f41a4fa6b96ddda9e19dde5660b34c514568f5410a117df8afddf84c33bf23ba31256efc2bceccbdb06bd01
-  data.tar.gz: 2214c3b52b24bf4b9b822059c4f41c67d7d3fc3a6fc666b8a073be79a794c769d1403d8f164085e382e1714320d71cbacd0673f591b26dd958e43f7b4cb1ab50
+  metadata.gz: 41e4511367107b2be92ff53eb28c42635884413c3fa91c010eee41a53da6ac94b3b9a8f7eccf3522610eee287008944d318f3250dcdc349544491dcb13dd515c
+  data.tar.gz: 45239916850fd6102b50c8ca719a2d336b0704a116c0c4f2af5014c5a061c8b6a6147f95811a88fe13f51e23f345baeb3eda16b0e789b9682596945b92ddabb4

data/RELEASE_NOTES.md

@@ -1,3 +1,11 @@
+### v0.7.1
+
+* Refactor report helpers. 
+* Improve/reduce text output during reporting.
+* Add title to HTML reports.
+* Minor fixes.
+
+
 ### v0.7.0
 
 * Dependencies on external commands in Linux and Mac OS for generating PDF and HTML files has been eliminated,

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -4,7 +4,7 @@ require 'ostruct'
 
 require_relative '../../rock_books'
 require_relative '../version'
-require_relative '../reports/helpers/reporter'
+require_relative '../reports/helpers/text_report_helper'
 require_relative '../helpers/book_set_loader'
 
 module RockBooks

data/lib/rock_books/documents/book_set.rb

@@ -4,7 +4,6 @@ require 'os'
 require_relative 'chart_of_accounts'
 require_relative 'journal'
 require_relative '../filters/journal_entry_filters'  # for shell mode
-require_relative '../helpers/html_helper'
 require_relative '../helpers/parse_helper'
 require_relative '../reports/book_set_reporter'
 

data/lib/rock_books/documents/journal.rb

@@ -7,7 +7,7 @@ require_relative '../types/acct_amount'
 require_relative '../types/journal_entry_context'
 require_relative 'journal_entry'
 require_relative 'journal_entry_builder'
-require_relative '../reports/helpers/reporter'
+require_relative '../reports/helpers/text_report_helper'
 
 module RockBooks
 

data/lib/rock_books/reports/balance_sheet.rb

@@ -1,5 +1,5 @@
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
 
 module RockBooks
 
@@ -8,7 +8,7 @@ module RockBooks
 # in order to calculate the correct balances, so we ignore the global $filter.
 class BalanceSheet
 
-  include Reporter
+  include TextReportHelper
   include ErbHelper
 
   attr_accessor :context, :data

data/lib/rock_books/reports/book_set_reporter.rb

@@ -11,7 +11,8 @@ require_relative 'journal_report'
 require_relative 'multidoc_txn_by_account_report'
 require_relative 'tx_one_account'
 require_relative 'helpers/erb_helper'
-require_relative 'helpers/reporter'
+require_relative 'helpers/text_report_helper'
+require_relative 'helpers/html_report_helper'
 
 require 'prawn'
 
@@ -109,16 +110,6 @@ class BookSetReporter
   end
 
 
-  private def run_command(command)
-    puts "\n----\nRunning command: #{command}"
-    stdout, stderr, status = Open3.capture3(command)
-    puts "Exit code was #{status.exitstatus}."
-    puts "\nStdout was:\n\n#{stdout}" unless stdout.size == 0
-    puts "\nStderr was:\n\n#{stderr}" unless stderr.size == 0
-    puts
-  end
-
-
   private def create_directories
     %w(txt pdf html).each do |format|
       dir = File.join(output_dir, format, SINGLE_ACCT_SUBDIR)
@@ -153,7 +144,6 @@ class BookSetReporter
       unicode_nonbreaking_space = "\u00A0"
       text(text.gsub(' ', unicode_nonbreaking_space))
     end
-    puts "Finished generating #{pdf_filespec} with prawn."
   end
 
 
@@ -168,9 +158,9 @@ class BookSetReporter
     create_pdf_report = -> { prawn_create_document(pdf_filespec, text_report) }
 
     create_html_report = -> do
-      data = { report_body: text_report }
+      data = { report_body: text_report, title: "#{short_name} Report -- RockBooks" }
       html_raw_report = ErbHelper.render_hashes("html/report_page.html.erb", data, {})
-      html_report = HtmlHelper.convert_receipts_to_hyperlinks(html_raw_report, html_filespec)
+      html_report = HtmlReportHelper.convert_receipts_to_hyperlinks(html_raw_report, html_filespec)
       File.write(html_filespec, html_report)
     end
 
@@ -178,8 +168,7 @@ class BookSetReporter
     create_pdf_report.()
     create_html_report.()
 
-
-    puts "Created reports in txt, html, and pdf for #{"%-20s" % short_name} at #{File.dirname(txt_filespec)}.\n\n\n"
+    puts "Created text, PDF, and HTML reports for #{short_name}."
   end
 
 

data/lib/rock_books/reports/data/multidoc_txn_by_account_data.rb

@@ -1,7 +1,7 @@
 module RockBooks
 class MultidocTxnByAccountData
 
-  include Reporter
+  include TextReportHelper
 
   attr_reader :context, :account_code
 

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

@@ -1,7 +1,7 @@
 module RockBooks
   class TxOneAccountData
 
-    include Reporter
+    include TextReportHelper
 
     attr_reader :context, :account_code, :account, :entries, :account_total, :totals
 

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

@@ -8,19 +8,14 @@ module ErbHelper
 
 
   def self.render_binding(erb_relative_filespec, template_binding)
-    print "Rendering template #{erb_relative_filespec}..."
     result = erb_template(erb_relative_filespec).result(template_binding)
-    puts 'done.'
     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)
-    print "Rendering template #{erb_relative_filespec}..."
     combined_hash = (data_hash || {}).merge(presentation_hash || {})
-    result = erb_template(erb_relative_filespec).result_with_hash(combined_hash)
-    puts 'done.'
-    result
+    erb_template(erb_relative_filespec).result_with_hash(combined_hash)
   end
 end

data/lib/rock_books/{helpers/html_helper.rb → reports/helpers/html_report_helper.rb}

@@ -1,5 +1,5 @@
 module RockBooks
-module HtmlHelper
+module HtmlReportHelper
 
   def self.convert_receipts_to_hyperlinks(original_html_string, html_filespec)
     html_lines = original_html_string.split("\n")

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
 

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

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/report_page.html.erb

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

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,3 @@
 module RockBooks
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rock_books
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Keith Bennett
@@ -145,7 +145,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,7 +156,8 @@ 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/html_report_helper.rb
+- lib/rock_books/reports/helpers/text_report_helper.rb
 - lib/rock_books/reports/income_statement.rb
 - lib/rock_books/reports/journal_report.rb
 - lib/rock_books/reports/multidoc_txn_by_account_report.rb