rock_books 0.2.0 → 0.6.1

data/lib/rock_books/documents/chart_of_accounts.rb

@@ -6,7 +6,8 @@ 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)
@@ -23,6 +24,14 @@ class ChartOfAccounts
     @accounts = []
     input_lines.each { |line| parse_line(line) }
     # TODO: Add validation for required 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
 
 
@@ -36,36 +45,42 @@ 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.to_type(account_type_token).symbol
+
+        name = matcher[2]
+
+        accounts << Account.new(code, account_type, name)
+      end
+    rescue => e
+      puts "Error parsing chart of accounts. Line text is:\n#{line}\n\n"
+      raise
     end
+
   end
 
 

data/lib/rock_books/documents/journal.rb

@@ -81,47 +81,52 @@ 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
 

data/lib/rock_books/helpers/html_helper.rb

@@ -0,0 +1,29 @@
+module RockBooks
+module HtmlHelper
+
+  module_function
+
+  def self.convert_receipts_to_hyperlinks(html_text)
+    html_lines = html_text.split("\n")
+    replacements_made = false
+
+    html_lines.each_with_index do |line, index|
+      matches = /Receipt:\s*(.*?)</.match(line)
+      if matches
+        receipt_filespec = matches[1]
+        line_with_hyperlink = line.gsub( \
+            /Receipt:\s*#{receipt_filespec}/, \
+            %Q{Receipt: <a href="../../../receipts/#{receipt_filespec}">#{receipt_filespec}</a>})
+        html_lines[index] = line_with_hyperlink
+        replacements_made = true
+      end
+    end
+
+    if replacements_made
+      html_text = html_lines.join("\n")
+    end
+
+    [html_text, replacements_made]
+  end
+end
+end

data/lib/rock_books/reports/book_set_reporter.rb

@@ -0,0 +1,200 @@
+require_relative '../documents/book_set'
+
+require_relative 'balance_sheet'
+require_relative 'income_statement'
+require_relative 'multidoc_transaction_report'
+require_relative 'receipts_report'
+require_relative 'report_context'
+require_relative 'transaction_report'
+require_relative 'tx_by_account'
+require_relative 'tx_one_account'
+
+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
+
+
+  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 call
+    check_prequisite_executables
+    reports = all_reports(filter)
+    create_directories
+    create_index_html
+    write_reports(reports)
+  end
+
+
+  # All methods after this point are private.
+
+  private def all_reports(filter = nil)
+
+    report_hash = journals.each_with_object({}) do |journal, report_hash|
+      key = journal.short_name.to_sym
+      report_hash[key] = TransactionReport.new(journal, context).call(filter)
+    end
+
+    report_hash[:all_txns_by_date] = MultidocTransactionReport.new(context).call(filter)
+    report_hash[:all_txns_by_amount] = MultidocTransactionReport.new(context).call(filter, :amount)
+    report_hash[:all_txns_by_acct] = TxByAccount.new(context).call
+    report_hash[:balance_sheet] = BalanceSheet.new(context).call
+    report_hash[:income_statement] = IncomeStatement.new(context).call
+
+    if run_options.do_receipts
+      report_hash[:receipts] = ReceiptsReport.new(context, *missing_existing_unused_receipts).call
+    end
+
+    chart_of_accounts.accounts.each do |account|
+      key = ('acct_' + account.code).to_sym
+      report = TxOneAccount.new(context, account.code).call
+      report_hash[key] = report
+    end
+
+    report_hash
+  end
+
+
+  private def run_command(command)
+    puts "\n----\nRunning command: #{command}"
+    stdout, stderr, status = Open3.capture3(command)
+    puts "Status was #{status}."
+    unless stdout.size == 0
+      puts "\nStdout was:\n\n#{stdout}"
+    end
+    unless stderr.size == 0
+      puts "\nStderr was:\n\n#{stderr}"
+    end
+    puts
+    stdout
+  end
+
+
+  private def executable_exists?(name)
+    `which #{name}`
+    $?.success?
+  end
+
+
+  private def check_prequisite_executables
+    raise "Report generation is not currently supported in Windows." if OS.windows?
+    required_exes = OS.mac? ? %w(textutil cupsfilter) : %w(txt2html wkhtmltopdf)
+    missing_exes = required_exes.reject { |exe| executable_exists?(exe) }
+    if missing_exes.any?
+      raise "Missing required report generation executable(s): #{missing_exes.join(', ')}. Please install them with your system's package manager."
+    end
+  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 write_reports(reports)
+
+    reports.each do |short_name, report_text|
+      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')
+
+      File.write(txt_filespec, report_text)
+
+      # Mac OS
+      textutil = ->(font_size) do
+        run_command("textutil -convert html -font 'Courier New Bold' -fontsize #{font_size} #{txt_filespec} -output #{html_filespec}")
+      end
+      cupsfilter = -> { run_command("cupsfilter #{txt_filespec} > #{pdf_filespec}") }
+
+      # Linux
+      txt2html = -> { run_command("txt2html --preformat_trigger_lines 0 #{txt_filespec} > #{html_filespec}") }
+      html2pdf = -> { run_command("wkhtmltopdf #{html_filespec} #{pdf_filespec}") }
+
+      # Use smaller size for the PDF but larger size for the web pages:
+      if OS.mac?
+        textutil.(11)
+        cupsfilter.()
+        textutil.(14)
+      else
+        txt2html.()
+        html2pdf.()
+      end
+
+      hyperlinkized_text, replacements_made = HtmlHelper.convert_receipts_to_hyperlinks(File.read(html_filespec))
+      if replacements_made
+        File.write(html_filespec, hyperlinkized_text)
+      end
+
+      puts "Created reports in txt, html, and pdf for #{"%-20s" % short_name} at #{File.dirname(txt_filespec)}.\n\n\n"
+    end
+  end
+
+
+  private def receipt_full_filespec(receipt_filespec)
+    File.join(run_options.receipt_dir, receipt_filespec)
+  end
+
+
+  private def missing_existing_unused_receipts
+    missing = []
+    existing = []
+    unused = Dir['receipts/**/*'].select { |s| File.file?(s) }.sort # Remove files as they are found
+    unused.map! { |s| "./" +  s }  # Prepend './' to match the data
+
+    all_entries.each do |entry|
+      entry.receipts.each do |receipt|
+        filespec = receipt_full_filespec(receipt)
+        unused.delete(filespec)
+        file_exists = File.file?(filespec)
+        list = (file_exists ? existing : missing)
+        list << { receipt: receipt, journal: entry.doc_short_name }
+      end
+    end
+    [missing, existing, unused]
+  end
+
+
+  private def index_html_content
+    erb_filespec = File.join(File.dirname(__FILE__), '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

data/lib/rock_books/reports/receipts_report.rb

@@ -6,13 +6,14 @@ class ReceiptsReport
 
   include Reporter
 
-  attr_reader :context, :missing, :existing
+  attr_reader :context, :missing, :existing, :unused
 
 
-  def initialize(report_context, missing, existing)
+  def initialize(report_context, missing, existing, unused)
     @context = report_context
     @missing = missing
     @existing = existing
+    @unused = unused
   end
 
 
@@ -21,9 +22,6 @@ class ReceiptsReport
     lines << center(context.entity || 'Unspecified Entity')
     lines << "#{center("Receipts Report")}"
     lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
     lines.join("\n")
   end
 
@@ -39,15 +37,30 @@ class ReceiptsReport
   end
 
 
+  def report_one_section(name, list)
+    output = ''
+    output << "\n\n\n#{name} Receipts:\n\n" << column_headings
+    if list.empty?
+      output << "[None]\n\n\n"
+    else
+      list.each { |receipt| output << receipt_info_line(receipt) }
+    end
+    output
+  end
+
+
   def generate_report
     output = generate_header
+    output << report_one_section('Missing',  missing)
 
-    output << "Missing Receipts:\n\n" << column_headings
-    missing.each { |info| output << receipt_info_line(info) }
-
-    output << "\n\n\nExisting Receipts:\n\n" << column_headings
-    existing.each { |info| output << receipt_info_line(info) }
+    output << "\n\n\nUnused Receipts:\n\n"
+    if unused.empty?
+      output << "[None]\n\n\n"
+    else
+      unused.each { |filespec| output << filespec << "\n" }
+    end
 
+    output << report_one_section('Existing', existing)
     output
   end