rock_books 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a7c5d56c718ce58a0fdf060e25be5d3aaf5438ece48a76e02f912e09d203c39
-  data.tar.gz: b467740538a5e89504fc7e2ac6b72190181519471f898a5c26ae7cfa29a53496
+  metadata.gz: ba9e80afcb8f6644e9fa3cc629a4cac6d723843d1609bab54641c77b779fba89
+  data.tar.gz: db3b9f6979da2408202715737fedf5f69b55d44657622364706d7597eac827bf
 SHA512:
-  metadata.gz: b43529ffa215e13375538d173b939baf659b814dc07a85e7f6c9a695449a86a8dfe49d5134bca22b0c7a479d0707221c4d9bd87efdcef4ac9df95a815b148ca0
-  data.tar.gz: 15776062f22eeb7ad746c303289512c9f81005f04f87518c1738d3923991d45a9ef32951b930946d2c746b6b7a6a52516892f4a8cbf5811ca2d58da4fadff2d5
+  metadata.gz: de4ffe3cbf12789ffa874565e7e60299290e3cc8888a41a2756f0ef7b405152997286f2d4a0b9dd2c00aeb75afc8d2bb10245ae7e747492b14c9da4393948d79
+  data.tar.gz: c19a5de4f323c6d50a6a684f87b38e3f12dab1cc55accbeed9ec8560521f02932bf8b6b8788069807496d37e4ff3c6d89056fc16cfcddf87f1c14d1af8e002da

data/README.md

@@ -33,10 +33,8 @@ To simplify its implementation, RockBooks assumes some conventions:
   
 #### Supported Operating Systems
 
-At this time, RockBooks is supported only on Mac OS and Linux. (It's really the external tools that is the issue, not the Ruby code.) It should probably work with Windows Subsystem for Linux (WSL) but it hasn't been tested. If you're unsuccessful trying to use RockBooks with WSL, give me as much information as possible and I'll try to resolve the issue.
+At this time, RockBooks is tested only on Mac OS and Linux. However, it will probably work fine on Windows.
 
-If you get an error message saying that an external command is missing, install that command using your system's package manager (e.g. `sudo apt install txt2html`).
-  
 #### Text Files as Input
 
 Instead of a web interface, data input is done in plain text files. This isn't as fancy but has the following advantages:

data/RELEASE_NOTES.md

@@ -1,3 +1,42 @@
+### v0.9.0
+
+* Center generated index.html's content.
+* Improve report headings.
+* Fix index.html hyperlinks to resource (receipts, invoices, statements, worksheets) directories.
+* Fix cases where split journal entries were not included in the journal report.
+
+
+### 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. 
+* 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,
+using the prawn gem for PDF and simple ERB templating for HTML.
+* Massive refactoring of reports to separate data generation from presentation.
+* Reports are now computed and then written one at a time. Previously they were all computed, then all written.
+* ERB is now used for generating text reports.
+* Fix receipt hyperlinks in HTML output.
+* Improve some error output.
+* Various minor improvements and bug fixes.
+
+
+### v0.6.1
+
+* Linux PDF generation fixed by using wkhtmltopdf instead of cupsfilter.
+
 ### v0.6.0
 
 * Linux support added!
@@ -7,7 +46,7 @@
 * Add receipt hyperlinks to HTML output.
 
 
-## v0.4.0
+### v0.4.0
 
 * Sort unused receipts alphanumerically.
 * Add 'x' receipts option for reporting both missing and unused receipts.
@@ -15,7 +54,7 @@
 * Improve Receipts report.
 
 
-## v0.3.0
+### v0.3.0
 
 * Added ability to report unused receipts.
 * Errors now include more context information.
@@ -23,12 +62,12 @@
 * Change license from MIT to Apache 2.
 
 
-## v0.2.1
+### v0.2.1
 
 * Add help text to readme.
 
 
-## v0.2.0
+### v0.2.0
 
 * Add instruction manual, modify readme.
 * Overhaul generated index.html.
@@ -36,18 +75,18 @@
 * Add validation of transaction dates to ensure within configured date range.
 * Make report hash / OpenStruct keys consistently symbols.
 
-## v0.1.6
+### v0.1.6
 
 * Fixed PDF output; PDF files were corrupt because cupsfilter starting sending
 output to stderr at some point.
 
 
-## v0.1.4, v0.1.5
+### v0.1.4, v0.1.5
 
 * Intermediate unsatisfactory fixes, these versions were published but yanked. 
 
 
-## v0.1.3
+### v0.1.3
 
 * Report output now goes to separate txt, html, and pdf subdirectories.
 * Add vendor.yml to exclude generated report files from language reporting.
@@ -62,17 +101,17 @@ output to stderr at some point.
 * Add 'from_string' methods to Journal and ChartOfAccounts.
 
 
-## v0.1.2
+### v0.1.2
 
 * Improve error message when the needed directories do not exist. 
 
 
-## v0.1.1
+### v0.1.1
 
 * Fix startup error.
 
 
-## v0.1.0
+### v0.1.0
 
 * First release.
 

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/reporter'
+require_relative '../reports/helpers/text_report_helper'
 require_relative '../helpers/book_set_loader'
 
 module RockBooks
@@ -105,7 +105,7 @@ When in interactive shell mode:
       end
     end
 
-    validate_receipts_dir = -> do
+    validate_receipt_dir = -> do
       File.directory?(options.receipt_dir) ? nil : \
           "Receipts directory '#{options.receipt_dir}' does not exist. "
     end
@@ -114,7 +114,7 @@ When in interactive shell mode:
     output << validate_input_dir.()
     output << validate_output_dir.()
     if run_options.do_receipts
-      output << validate_receipts_dir.()
+      output << validate_receipt_dir.()
     end
 
     output.compact!
@@ -298,9 +298,9 @@ When in interactive shell mode:
 
 
   def cmd_d
-    book_set.all_reports($filter).each do |short_name, report_text|
+    book_set.all_reports($filter).each do |short_name, text_report|
       puts "#{short_name}:\n\n"
-      puts report_text
+      puts text_report
       puts "\n\n\n"
     end
     nil
@@ -358,7 +358,7 @@ When in interactive shell mode:
   end
 
   def cmd_w
-    BookSetReporter.new(book_set, run_options.output_dir, $filter).call
+    BookSetReporter.new(book_set, run_options.output_dir, $filter).generate
     nil
   end
 

data/lib/rock_books/cmd_line/main.rb

@@ -1,4 +1,4 @@
-require 'awesome_print'
+require 'amazing_print'
 require 'optparse'
 require 'pry'
 require 'shellwords'
@@ -67,10 +67,6 @@ class Main
         options.verbose_mode = v
       end
 
-      parser.on('-y', '--[no-]say', 'Say error messages.') do |v|
-        options.say = v
-      end
-
       parser.on('', '--[no-]receipts', 'Include report on existing and missing receipts.') do |v|
         options.do_receipts = v
       end
@@ -101,10 +97,6 @@ class Main
 
       HEREDOC
 
-      if run_options.say
-        `say #{error}`
-      end
-
       exit(-1)
       binding.pry
       raise error

data/lib/rock_books/documents/book_set.rb

@@ -1,10 +1,9 @@
-require 'awesome_print'
+require 'amazing_print'
 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/chart_of_accounts.rb

@@ -1,3 +1,4 @@
+require 'stringio'
 require_relative '../types/account'
 require_relative '../types/account_type'
 require_relative '../errors/error'
@@ -10,8 +11,8 @@ class ChartOfAccounts
   REQUIRED_FIELDS.each { |field| attr_reader(field) }
 
 
-  def self.from_file(file)
-    self.new(File.readlines(file).map(&:chomp))
+  def self.from_file(filespec)
+    self.new(File.readlines(filespec).map(&:chomp), filespec)
   end
 
 
@@ -20,11 +21,16 @@ class ChartOfAccounts
   end
 
 
-  def initialize(input_lines)
+  def initialize(input_lines, filespec = nil)
+    @filespec = filespec
     @accounts = []
-    input_lines.each { |line| parse_line(line) }
+    parse_lines(input_lines)
     # TODO: Add validation for required fields.
+    check_for_missing_fields
+  end
+
 
+  def check_for_missing_fields
     missing_fields = REQUIRED_FIELDS.select do |field|
       instance_variable_get("@#{field}").nil?
     end
@@ -35,6 +41,19 @@ class ChartOfAccounts
   end
 
 
+  def parse_lines(input_lines)
+    input_lines.each_with_index do |line, line_num|
+      begin
+        parse_line(line)
+      rescue => e
+        file_message_fragment = (@filespec ? " in file '#{@filespec}'" : '')
+        puts "Error parsing chart of accounts#{file_message_fragment}. Bad line is line ##{line_num}, text is:\n#{line}\n\n"
+        raise
+      end
+    end
+  end
+
+
   def parse_date(date_string)
     # TODO: Add better handling for this error.
     # begin
@@ -69,16 +88,14 @@ class ChartOfAccounts
         rest = matcher[2]
 
         matcher = rest.match(/^(\S+)\s+(.*)$/)
+
         account_type_token = matcher[1]
-        account_type = AccountType.to_type(account_type_token).symbol
+        account_type = AccountType.letter_to_type(account_type_token)
 
         name = matcher[2]
 
-        accounts << Account.new(code, account_type, name)
+        accounts << Account.new(code, account_type.symbol, name)
       end
-    rescue => e
-      puts "Error parsing chart of accounts. Line text is:\n#{line}\n\n"
-      raise
     end
 
   end
@@ -105,7 +122,7 @@ class ChartOfAccounts
 
 
   def report_string
-    result = ''
+    result = StringIO.new
 
     if title
       result << title << "\n\n"
@@ -113,9 +130,9 @@ class ChartOfAccounts
 
     code_width = @accounts.inject(0) { |width, a| width = [width, a.code.length].max }
     format_string = "%-#{code_width}s  %-10.10s  %s\n"
-    accounts.each { |a| result << (format_string % [a.code, a.type.to_s, a.name]) }
+    accounts.each { |a| result << sprintf(format_string, a.code, a.type.to_s, a.name) }
 
-    result
+    result.string
   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/reporter'
+require_relative '../reports/helpers/text_report_helper'
 
 module RockBooks
 
@@ -45,9 +45,7 @@ class Journal
   end
 
 
-
-
-    def self.acct_amounts_in_documents(documents, entries_filter = nil, acct_amounts_filter = nil)
+  def self.acct_amounts_in_documents(documents, entries_filter = nil, acct_amounts_filter = nil)
     entries = entries_in_documents(documents, entries_filter)
 
     acct_amounts = entries.each_with_object([]) do |entry, acct_amounts|
@@ -67,12 +65,10 @@ 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 = ''
-    @title = ''
     input_lines.each_with_index do |line, linenum|
       context = JournalEntryContext.new(self, linenum + 1, line)
       parse_line(context)
@@ -131,7 +127,6 @@ class Journal
   end
 
 
-
   def acct_amounts
     entries.each_with_object([]) { |entry, acct_amounts|  acct_amounts << entry.acct_amounts }.flatten
   end

data/lib/rock_books/documents/journal_entry.rb

@@ -32,12 +32,17 @@ class JournalEntry < Struct.new(:date, :acct_amounts, :doc_short_name, :descript
 
   def self.sort_entries_by_amount_descending!(entries)
     entries.sort_by! do |entry|
-      [entry.total_absolute_value, entry.doc_short_name]
+      [-entry.total_absolute_value, entry.doc_short_name]
       end
-    entries.reverse!
   end
 
 
+  def self.sort_entries_by_date!(entries)
+    entries.sort_by! { |entry| [entry.date, entry.doc_short_name] }
+  end
+
+
+
   def total_for_code(account_code)
     acct_amounts_with_code(account_code).map(&:amount).sum
   end

data/lib/rock_books/documents/journal_entry_builder.rb

@@ -14,6 +14,10 @@ class JournalEntryBuilder < Struct.new(:journal_entry_context)
   def chart_of_accounts; journal_entry_context.chart_of_accounts;  end
 
 
+  # A "token" in this context means an account name and account amount pair, e.g. "pnc.checking 1234.56".
+  # @param tokens the account name/amount pairs found in the source text
+  # @date transaction date
+  # @return array of AcctAmount instances
   def acct_amounts_from_tokens(tokens, date)
     acct_amounts = []
 

data/lib/rock_books/helpers/book_set_loader.rb

@@ -7,6 +7,7 @@ module RockBooks
 
     module_function
 
+    # @return a hash whose keys are the filespecs and values are the document types
     def get_files_with_types(directory)
       files = Dir[File.join(directory, '*.txt')]
       files.each_with_object({}) do |filespec, files_with_types|
@@ -42,7 +43,7 @@ module RockBooks
 
     # Uses all *.txt files in the specified directory; uses @doc_type to determine which
     # is the chart of accounts and which are journals.
-    # To exclude a file, make the extension other than .rdt.
+    # To exclude a file, make the extension something other than .txt.
     def load(run_options)
 
       files_with_types = get_files_with_types(run_options.input_dir)
@@ -54,9 +55,8 @@ module RockBooks
       validate_journal_file_count(journal_files)
 
       chart_of_accounts = ChartOfAccounts.from_file(chart_of_account_files.first)
-      journals = journal_files.map { |fs| Journal.from_file(chart_of_accounts, fs) }
+      journals = journal_files.map { |filespec| Journal.from_file(chart_of_accounts, filespec) }
       BookSet.new(run_options, chart_of_accounts, journals)
     end
-
   end
 end

data/lib/rock_books/reports/balance_sheet.rb

@@ -1,6 +1,5 @@
-require_relative '../filters/journal_entry_filters'
-require_relative '../documents/journal'
-require_relative 'report_context'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/text_report_helper'
 
 module RockBooks
 
@@ -9,52 +8,19 @@ 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
+  attr_accessor :context, :data
 
-  def initialize(report_context)
+  def initialize(report_context, data)
     @context = report_context
+    @data = data
   end
 
 
-  def end_date
-    context.chart_of_accounts.end_date
+  def generate
+    ErbHelper.render_hashes('text/balance_sheet.txt.erb', data, template_presentation_context)
   end
-
-
-  def generate_header
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << center("Balance Sheet for Period Ending #{end_date}")
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-
-
- def generate_report
-    filter = RockBooks::JournalEntryFilters.date_on_or_before(end_date)
-    acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
-    totals = AcctAmount.aggregate_amounts_by_account(acct_amounts)
-    output = generate_header
-
-    asset_output,  asset_total  = generate_account_type_section('Assets',      totals, :asset,     false)
-    liab_output,   liab_total   = generate_account_type_section('Liabilities', totals, :liability, true)
-    equity_output, equity_total = generate_account_type_section('Equity',      totals, :equity,    true)
-
-    output << [asset_output, liab_output, equity_output].join("\n\n")
-
-    grand_total = asset_total - (liab_total + equity_total)
-
-    output << "\n#{"%12.2f    Assets - (Liabilities + Equity)" % grand_total}\n============\n"
-    output
-  end
-
-  alias_method :to_s, :generate_report
-  alias_method :call, :generate_report
-
 end
 end