rock_books 0.2.1 → 0.7.0

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'
@@ -6,11 +7,12 @@ require_relative '../errors/date_range_error'
 module RockBooks
 class ChartOfAccounts
 
-  attr_reader :doc_type, :title, :accounts, :entity, :start_date, :end_date
+  REQUIRED_FIELDS = %i(doc_type  title  accounts  entity  start_date  end_date)
+  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
 
 
@@ -19,10 +21,36 @@ 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
+
+    unless missing_fields.empty?
+      raise Error.new("Chart of accounts lacks required fields: #{missing_fields.join(', ')}")
+    end
+  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
 
 
@@ -36,36 +64,40 @@ class ChartOfAccounts
   end
 
   def parse_line(line)
-    case line.strip
-    when /^@doc_type:/
-      @doc_type = line.split('@doc_type:').last.strip
-    when /^@entity:/
-      @entity ||= line.split('@entity:').last.strip
-    when /^@title:/
-      @title = line.split('@title:').last.strip
-    when /^@start_date:/
-      @start_date = parse_date(line.split('@start_date:').last.strip)
-    when /^@end_date:/
-      @end_date = parse_date(line.split('@end_date:').last.strip)
-    when /^$/
-      # ignore empty line
-    when /^#/
-      # ignore comment line
-    else
-      # this is an account line in the form: 101 Asset First National City Bank
-      # The regex below gets everything before the first whitespace in token 1, and the rest in token 2.
-      matcher = line.match(/^(\S+)\s+(.*)$/)
-      code = matcher[1]
-      rest = matcher[2]
-
-      matcher = rest.match(/^(\S+)\s+(.*)$/)
-      account_type_token = matcher[1]
-      account_type = AccountType.to_type(account_type_token).symbol
-
-      name = matcher[2]
-
-      accounts << Account.new(code, account_type, name)
+    begin
+      case line.strip
+      when /^@doc_type:/
+        @doc_type = line.split('@doc_type:').last.strip
+      when /^@entity:/
+        @entity ||= line.split('@entity:').last.strip
+      when /^@title:/
+        @title = line.split('@title:').last.strip
+      when /^@start_date:/
+        @start_date = parse_date(line.split('@start_date:').last.strip)
+      when /^@end_date:/
+        @end_date = parse_date(line.split('@end_date:').last.strip)
+      when /^$/
+        # ignore empty line
+      when /^#/
+        # ignore comment line
+      else
+        # this is an account line in the form: 101 Asset First National City Bank
+        # The regex below gets everything before the first whitespace in token 1, and the rest in token 2.
+        matcher = line.match(/^(\S+)\s+(.*)$/)
+        code = matcher[1]
+        rest = matcher[2]
+
+        matcher = rest.match(/^(\S+)\s+(.*)$/)
+
+        account_type_token = matcher[1]
+        account_type = AccountType.letter_to_type(account_type_token)
+
+        name = matcher[2]
+
+        accounts << Account.new(code, account_type.symbol, name)
+      end
     end
+
   end
 
 
@@ -90,7 +122,7 @@ class ChartOfAccounts
 
 
   def report_string
-    result = ''
+    result = StringIO.new
 
     if title
       result << title << "\n\n"
@@ -98,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/reporter'
 
 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|
@@ -72,7 +70,6 @@ class Journal
     @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)
@@ -81,52 +78,56 @@ class Journal
 
 
   def parse_line(journal_entry_context)
-    line = journal_entry_context.line
-    case line.strip
-    when /^@doc_type:/
-      @doc_type = line.split(/^@doc_type:/).last.strip
-    when  /^@account_code:/
-      @account_code = line.split(/^@account_code:/).last.strip
-
-      unless chart_of_accounts.include?(@account_code)
-        raise AccountNotFoundError.new(@account_code, journal_entry_context)
-      end
-
-      # if debit or credit has not yet been specified, inherit the setting from the account:
-      unless @debit_or_credit
-        @debit_or_credit = chart_of_accounts.debit_or_credit_for_code(@account_code)
-      end
-
-    when /^@title:/
-      @title = line.split(/^@title:/).last.strip
-    when /^@short_name:/
-      @short_name = line.split(/^@short_name:/).last.strip
-    when /^@date_prefix:/
-      @date_prefix = line.split(/^@date_prefix:/).last.strip
-    when /^@debit_or_credit:/
-      data = line.split(/^@debit_or_credit:/).last.strip
-      @debit_or_credit = data.to_sym
-    when /^$/
-      # ignore empty line
-    when /^#/
-      # ignore comment line
-    when /^\d/  # a date/acct/amount line starting with a number
-      entries << JournalEntryBuilder.new(journal_entry_context).build
-    else # Text line(s) to be attached to the most recently parsed transaction
-      unless entries.last
-        raise Error.new("Entry for this description cannot be found: #{line}")
-      end
-      entries.last.description << line << "\n"
-
-      if /^Receipt:/.match(line)
-        receipt_spec = line.split(/^Receipt:/).last.strip
-        entries.last.receipts << receipt_spec
+    begin
+      line = journal_entry_context.line
+      case line.strip
+      when /^@doc_type:/
+        @doc_type = line.split(/^@doc_type:/).last.strip
+      when  /^@account_code:/
+        @account_code = line.split(/^@account_code:/).last.strip
+
+        unless chart_of_accounts.include?(@account_code)
+          raise AccountNotFoundError.new(@account_code, journal_entry_context)
+        end
+
+        # if debit or credit has not yet been specified, inherit the setting from the account:
+        unless @debit_or_credit
+          @debit_or_credit = chart_of_accounts.debit_or_credit_for_code(@account_code)
+        end
+
+      when /^@title:/
+        @title = line.split(/^@title:/).last.strip
+      when /^@short_name:/
+        @short_name = line.split(/^@short_name:/).last.strip
+      when /^@date_prefix:/
+        @date_prefix = line.split(/^@date_prefix:/).last.strip
+      when /^@debit_or_credit:/
+        data = line.split(/^@debit_or_credit:/).last.strip
+        @debit_or_credit = data.to_sym
+      when /^$/
+        # ignore empty line
+      when /^#/
+        # ignore comment line
+      when /^\d/  # a date/acct/amount line starting with a number
+        entries << JournalEntryBuilder.new(journal_entry_context).build
+      else # Text line(s) to be attached to the most recently parsed transaction
+        unless entries.last
+          raise Error.new("Entry for this description cannot be found: #{line}")
+        end
+        entries.last.description << line << "\n"
+
+        if /^Receipt:/.match(line)
+          receipt_spec = line.split(/^Receipt:/).last.strip
+          entries.last.receipts << receipt_spec
+        end
       end
+    rescue => e
+      puts "Error occurred parsing:\n#{journal_entry_context}\n\n"
+      raise
     end
   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/helpers/html_helper.rb

@@ -0,0 +1,35 @@
+module RockBooks
+module HtmlHelper
+
+  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

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/reporter'
 
 module RockBooks
 
@@ -10,51 +9,18 @@ module RockBooks
 class BalanceSheet
 
   include Reporter
+  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

data/lib/rock_books/reports/book_set_reporter.rb

@@ -0,0 +1,218 @@
+require_relative '../documents/book_set'
+
+require_relative 'balance_sheet'
+require_relative 'data/bs_is_data'
+require_relative 'data/receipts_report_data'
+require_relative 'income_statement'
+require_relative 'multidoc_txn_report'
+require_relative 'receipts_report'
+require_relative 'report_context'
+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 'prawn'
+
+module RockBooks
+class BookSetReporter
+
+  extend Forwardable
+
+  attr_reader :book_set, :output_dir, :filter, :context
+
+  def_delegator :book_set, :all_entries
+  def_delegator :book_set, :journals
+  def_delegator :book_set, :chart_of_accounts
+  def_delegator :book_set, :run_options
+
+  FONT_FILESPEC = File.absolute_path(File.join(File.dirname(__FILE__), '..', '..', '..', 'assets', 'fonts', 'JetBrainsMono-Medium.ttf'))
+
+
+  def initialize(book_set, output_dir, filter = nil)
+    @book_set = book_set
+    @output_dir = output_dir
+    @filter = filter
+    @context = ReportContext.new(book_set.chart_of_accounts, book_set.journals, 80)
+  end
+
+
+  def generate
+    create_directories
+    create_index_html
+
+    do_statements
+    do_journals
+    do_transaction_reports
+    do_single_account_reports
+    do_receipts_report
+  end
+
+
+  # All methods after this point are private.
+
+  private def do_statements
+    bs_is_data = BsIsData.new(context)
+
+    bal_sheet_text_report = BalanceSheet.new(context, bs_is_data.bal_sheet_data).generate
+    write_report(:balance_sheet, bal_sheet_text_report)
+
+    inc_stat_text_report = IncomeStatement.new(context, bs_is_data.inc_stat_data).generate
+    write_report(:income_statement, inc_stat_text_report)
+  end
+
+
+  private def do_journals
+    journals.each do |journal|
+      report_data = JournalData.new(journal, context, filter).fetch
+      text_report = JournalReport.new(report_data, context, filter).generate
+      write_report(journal.short_name, text_report)
+    end
+  end
+
+
+  private def do_transaction_reports
+
+    do_date_or_amount_report = ->(sort_field, short_name) do
+      data = MultidocTxnReportData.new(context, sort_field, filter).fetch
+      text_report = MultidocTransactionReport.new(data, context).generate
+      write_report(short_name, text_report)
+    end
+
+    do_acct_report = -> do
+      data = MultidocTxnByAccountData.new(context).fetch
+      text_report = MultidocTransactionByAccountReport.new(data, context).generate
+      write_report(:all_txns_by_acct, text_report)
+    end
+
+    do_date_or_amount_report.(:date,   :all_txns_by_date)
+    do_date_or_amount_report.(:amount, :all_txns_by_amount)
+    do_acct_report.()
+  end
+
+
+  private def do_single_account_reports
+    chart_of_accounts.accounts.each do |account|
+      short_name = ('acct_' + account.code).to_sym
+      data = TxOneAccountData.new(context, account.code).fetch
+      text_report = TxOneAccount.new(data, context).generate
+      write_report(short_name, text_report)
+    end
+  end
+
+
+  private def do_receipts_report
+    data = ReceiptsReportData.new(book_set.all_entries, run_options.receipt_dir).fetch
+    text_report = ReceiptsReport.new(context, data).generate
+    write_report(:receipts, text_report)
+  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)
+      FileUtils.mkdir_p(dir)
+    end
+  end
+
+
+  # "./pdf/short_name.pdf" or "./pdf/single_account/short_name.pdf"
+  private def build_filespec(directory, short_name, file_format)
+    fragments = [directory, file_format, "#{short_name}.#{file_format}"]
+    is_acct_report = /^acct_/.match(short_name)
+    if is_acct_report
+      fragments.insert(2, SINGLE_ACCT_SUBDIR)
+    end
+    File.join(*fragments)
+  end
+
+
+  private def create_index_html
+    filespec = build_filespec(output_dir, 'index', 'html')
+    File.write(filespec, index_html_content)
+    puts "Created index.html"
+  end
+
+
+  private def prawn_create_document(pdf_filespec, text)
+    Prawn::Document.generate(pdf_filespec) do
+      font(FONT_FILESPEC, size: 10)
+
+      utf8_nonbreaking_space = "\uC2A0"
+      unicode_nonbreaking_space = "\u00A0"
+      text(text.gsub(' ', unicode_nonbreaking_space))
+    end
+    puts "Finished generating #{pdf_filespec} with prawn."
+  end
+
+
+  private def write_report(short_name, text_report)
+
+    txt_filespec = build_filespec(output_dir, short_name, 'txt')
+    html_filespec = build_filespec(output_dir, short_name, 'html')
+    pdf_filespec = build_filespec(output_dir, short_name, 'pdf')
+
+    create_text_report = -> { File.write(txt_filespec, text_report) }
+
+    create_pdf_report = -> { prawn_create_document(pdf_filespec, text_report) }
+
+    create_html_report = -> do
+      data = { report_body: text_report }
+      html_raw_report = ErbHelper.render_hashes("html/report_page.html.erb", data, {})
+      html_report = HtmlHelper.convert_receipts_to_hyperlinks(html_raw_report, html_filespec)
+      File.write(html_filespec, html_report)
+    end
+
+    create_text_report.()
+    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]
+  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)
+  end
+end
+end