rock_books 0.7.0 → 0.11.0

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -4,7 +4,8 @@ require 'ostruct'
 
 require_relative '../../rock_books'
 require_relative '../version'
-require_relative '../reports/helpers/reporter'
+require_relative '../reports/data/receipts_report_data'
+require_relative '../reports/helpers/text_report_helper'
 require_relative '../helpers/book_set_loader'
 
 module RockBooks
@@ -51,12 +52,11 @@ Commands:
 
 rec[eipts]                - receipts: a/:a all, m/:m missing, e/:e existing, u/:u unused
 rep[orts]                 - return an OpenStruct containing all reports (interactive shell mode only)
-d[isplay_reports]         - display all reports on stdout
 w[rite_reports]           - write all reports to the output directory (see -o option)
 c[hart_of_accounts]       - chart of accounts
 h[elp]                    - prints this help
 jo[urnals]                - list of the journals' short names
-proj[ect_page]            - open the RockBooks Github project page in a browser
+proj[ect_page]            - prints the RockBooks Github project page URL
 rel[oad_data]             - reload data from input files
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
 x[it]                     - exits this program (interactive shell mode only) (see also 'q')
@@ -281,7 +281,7 @@ When in interactive shell mode:
   # All reports as Ruby objects; only makes sense in shell mode.
   def cmd_rep
     unless run_options.interactive_mode
-      raise Error.new("Option 'all_reports' is only available in shell mode. Try 'display_reports' or 'write_reports'.")
+      raise Error.new("Option 'all_reports' is only available in shell mode. Try 'write_reports'.")
     end
 
     os = OpenStruct.new(book_set.all_reports($filter))
@@ -297,18 +297,8 @@ When in interactive shell mode:
   end
 
 
-  def cmd_d
-    book_set.all_reports($filter).each do |short_name, text_report|
-      puts "#{short_name}:\n\n"
-      puts text_report
-      puts "\n\n\n"
-    end
-    nil
-  end
-
-
   def cmd_proj
-    `open https://github.com/keithrbennett/rock_books`
+    puts 'https://github.com/keithrbennett/rock_books'
   end
 
 
@@ -317,7 +307,9 @@ When in interactive shell mode:
       raise Error.new("Receipt processing was requested but has been disabled with --no-receipts.")
     end
 
-    missing, existing, unused = book_set.missing_existing_unused_receipts
+    data = ReceiptsReportData.new(all_entries, run_options.receipt_dir).fetch
+
+    missing, existing, unused = data[:missing], data[:existing], data[:unused]
 
     print_missing  = -> { puts "\n\nMissing Receipts:";  ap missing }
     print_existing = -> { puts "\n\nExisting Receipts:"; ap existing }
@@ -326,11 +318,11 @@ When in interactive shell mode:
     case options.first.to_s
       when 'a'  # all
         if run_options.interactive_mode
-          { missing: missing, existing: existing, unused: unused }
+          data
         else
-           print_missing.()
-           print_existing.()
-           print_unused.()
+          print_missing.()
+          print_existing.()
+          print_unused.()
         end
 
       when 'm'
@@ -372,7 +364,6 @@ When in interactive shell mode:
     @commands_ ||= [
         Command.new('rec', 'receipts',          -> (*options)  { cmd_rec(options)  }),
         Command.new('rep', 'reports',           -> (*_options) { cmd_rep           }),
-        Command.new('d',   'display_reports',   -> (*_options) { cmd_d             }),
         Command.new('w',   'write_reports',     -> (*_options) { cmd_w             }),
         Command.new('c',   'chart_of_accounts', -> (*_options) { cmd_c             }),
         Command.new('jo',  'journals',          -> (*_options) { cmd_j             }),

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'
 
@@ -39,6 +38,10 @@ module RockBooks
       @all_entries ||= Journal.entries_in_documents(journals)
     end
 
+
+    def all_reports(filter = nil)
+      BookSetReporter.new(self, nil, filter).get_all_report_data
+    end
   end
 end
 

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

@@ -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'
@@ -11,16 +12,18 @@ 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/receipts_hyperlink_converter'
 
 require 'prawn'
+require 'tty-progressbar'
 
 module RockBooks
 class BookSetReporter
 
   extend Forwardable
 
-  attr_reader :book_set, :output_dir, :filter, :context
+  attr_reader :book_set, :context, :filter, :output_dir, :progress_bar
 
   def_delegator :book_set, :all_entries
   def_delegator :book_set, :journals
@@ -35,6 +38,7 @@ class BookSetReporter
     @output_dir = output_dir
     @filter = filter
     @context = ReportContext.new(book_set.chart_of_accounts, book_set.journals, 80)
+    @progress_bar = TTY::ProgressBar.new("[:bar] :caption", total: report_count + 10)
   end
 
 
@@ -47,9 +51,44 @@ class BookSetReporter
     do_transaction_reports
     do_single_account_reports
     do_receipts_report
+    progress_bar.advance(caption: 'Finished generating reports.')
+    progress_bar.finish
   end
 
 
+  def report_count
+    bal_sheet_income_statement = 2
+    journal_count = journals.size
+    txn_report_count = 3
+    single_account_count = chart_of_accounts.accounts.size
+    receipt_report_count = 1
+    bal_sheet_income_statement + journal_count + txn_report_count + single_account_count + receipt_report_count
+  end
+
+
+  def get_all_report_data
+    reports = {}
+
+    reports[:bs_is] = BsIsData.new(context)
+
+    reports[:journals] = journals.each_with_object({}) do |journal, journals|
+      journals[journal.short_name] = JournalData.new(journal, context, filter).fetch
+    end
+
+    reports[:txn_reports] = {
+      by_account: MultidocTxnByAccountData.new(context).fetch,
+      by_date: MultidocTxnReportData.new(context, :date, filter).fetch,
+      by_amount: MultidocTxnReportData.new(context, :amount, filter).fetch
+    }
+
+    reports[:single_accounts] = chart_of_accounts.accounts.each_with_object({}) do |account, single_accts|
+      single_accts[account.code.to_sym] = TxOneAccountData.new(context, account.code).fetch
+    end
+
+    reports[:receipts] = ReceiptsReportData.new(book_set.all_entries, run_options.receipt_dir).fetch
+    reports
+  end
+
   # All methods after this point are private.
 
   private def do_statements
@@ -109,16 +148,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)
@@ -138,22 +167,29 @@ 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
-    puts "Finished generating #{pdf_filespec} with prawn."
+  end
+
+
+  private def html_metadata_comment(doc_short_name)
+    "\n" + report_metadata(doc_short_name).ai(plain: true) + "\n"
   end
 
 
@@ -165,12 +201,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 }
+      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 = HtmlHelper.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
 
@@ -178,41 +218,15 @@ 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"
-  end
-
-
-  private def missing_existing_unused_receipts
-    missing_receipts = []
-    existing_receipts = []
-    receipt_full_filespec = ->(receipt_filespec) { File.join(run_options.receipt_dir, receipt_filespec) }
-
-    # We will start out putting all filespecs in the unused array, and delete them as they are found in the transactions.
-    unused_receipt_filespecs = Dir['receipts/**/*'].select { |s| File.file?(s) } \
-        .sort \
-        .map { |s| "./" +  s }  # Prepend './' to match the data
-
-    all_entries.each do |entry|
-      entry.receipts.each do |receipt|
-        filespec = receipt_full_filespec.(receipt)
-        unused_receipt_filespecs.delete(filespec)
-        file_exists = File.file?(filespec)
-        list = (file_exists ? existing_receipts : missing_receipts)
-        list << { receipt: receipt, journal: entry.doc_short_name }
-      end
-    end
-    [missing_receipts, existing_receipts, unused_receipt_filespecs]
+    progress_bar.advance(caption: "Generating report: #{short_name}")
   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
+    progress_bar.advance(caption: 'Generating 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)
   end
 end
 end

data/lib/rock_books/reports/data/bs_is_section_data.rb

@@ -19,7 +19,9 @@ class BsIsSectionData
     totals = journals_acct_totals.select { |code, _amount| codes.include?(code) }
     need_to_reverse_sign = %i{liability equity income}.include?(type)
     if need_to_reverse_sign
-      totals.keys.each { |code| totals[code] = -totals[code] }
+      totals.keys.each do |code|
+        totals[code] = -totals[code] unless totals[code] == 0.0
+      end
     end
     totals
   end

data/lib/rock_books/reports/data/journal_data.rb

@@ -25,6 +25,7 @@ class JournalData
       name: journal.chart_of_accounts.name_for_code(journal.account_code),
       title: journal.title,
       short_name: journal.short_name,
+      debit_or_credit: journal.debit_or_credit,
       start_date: context.chart_of_accounts.start_date,
       end_date: context.chart_of_accounts.end_date,
       entries: entries,

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/reports/helpers/receipts_hyperlink_converter.rb

@@ -0,0 +1,59 @@
+module RockBooks
+class ReceiptsHyperlinkConverter
+
+  def self.convert(html_string, html_filespec)
+    ReceiptsHyperlinkConverter.new(html_string, html_filespec).convert
+  end
+
+  RECEIPT_REGEX = /Receipt:\s*(\S*)/
+  INVOICE_REGEX = /Invoice:\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
+    process_link_type = ->(line, regex, dir_name) do
+      matches = regex.match(line)
+      if matches
+        listed_filespec = matches[1]
+        anchor_line(line, listed_filespec, dir_name)
+      else
+        line
+      end
+    end
+
+    html_string.split("\n").map do |line|
+      line = process_link_type.(line, RECEIPT_REGEX, 'receipts')
+      process_link_type.(line, INVOICE_REGEX, 'invoices')
+    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]'
+  #
+  # `dir_name` will be 'receipts' or 'invoices'
+  private def dirized_filespec(listed_filespec, dir_name)
+    File.join(('../' * num_dirs_up), dir_name, listed_filespec)
+  end
+
+  private def anchor_line(line, listed_filespec, dir_name)
+    label = {
+      'receipts' => 'Receipt',
+      'invoices' => 'Invoice'
+    }.fetch(dir_name)
+
+    line.gsub( \
+          /#{label}:\s*#{listed_filespec}/, \
+          %Q{#{label}: <a href="#{dirized_filespec(listed_filespec, dir_name)}">#{listed_filespec}</a>})
+  end
+end
+end
+