rock_books 0.1.6 → 0.6.0

data/RELEASE_NOTES.md

@@ -1,3 +1,41 @@
+### v0.6.0
+
+* Linux support added!
+
+### v0.5.0
+
+* Add receipt hyperlinks to HTML output.
+
+
+## v0.4.0
+
+* Sort unused receipts alphanumerically.
+* Add 'x' receipts option for reporting both missing and unused receipts.
+* Fix: journals were showing journal account instead of the other account in each transaction.
+* Improve Receipts report.
+
+
+## v0.3.0
+
+* Added ability to report unused receipts.
+* Errors now include more context information.
+* Improved chart of accounts validation.
+* Change license from MIT to Apache 2.
+
+
+## v0.2.1
+
+* Add help text to readme.
+
+
+## v0.2.0
+
+* Add instruction manual, modify readme.
+* Overhaul generated index.html.
+* Add accounting period start and end date to configuration and reports.
+* Add validation of transaction dates to ensure within configured date range.
+* Make report hash / OpenStruct keys consistently symbols.
+
 ## v0.1.6
 
 * Fixed PDF output; PDF files were corrupt because cupsfilter starting sending

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -49,7 +49,7 @@ Command Line Switches:                    [rock-books version #{RockBooks::VERSI
 
 Commands:
 
-rec[eipts]                - receipts: a/:a all, m/:m missing, e/:e existing
+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)
@@ -80,7 +80,14 @@ When in interactive shell mode:
 
   def validate_run_options(options)
 
-    return if options.suppress_command_line_validation
+    if [
+        # the command requested was to show the project page
+        find_command_action(ARGV[0]) == find_command_action('proj'),
+
+        options.suppress_command_line_validation,
+    ].any?
+      return  # do not validate
+    end
 
     validate_input_dir = -> do
       File.directory?(options.input_dir) ? nil : "Input directory '#{options.input_dir}' does not exist. "
@@ -280,7 +287,7 @@ When in interactive shell mode:
     os = OpenStruct.new(book_set.all_reports($filter))
 
     # add hash methods for convenience
-    def os.keys; to_h.keys.map(&:to_s); end
+    def os.keys; to_h.keys; end
     def os.values; to_h.values; end
 
     # to access as array, e.g. `a.at(1)`
@@ -310,17 +317,20 @@ When in interactive shell mode:
       raise Error.new("Receipt processing was requested but has been disabled with --no-receipts.")
     end
 
-    missing, existing = book_set.missing_and_existing_receipts
+    missing, existing, unused = book_set.missing_existing_unused_receipts
 
-    print_missing  = -> { puts "Missing Receipts:"; ap missing }
-    print_existing = -> { puts "Existing Receipts:"; ap existing }
+    print_missing  = -> { puts "\n\nMissing Receipts:";  ap missing }
+    print_existing = -> { puts "\n\nExisting Receipts:"; ap existing }
+    print_unused   = -> { puts "\n\nUnused Receipts:";   ap unused }
 
     case options.first.to_s
       when 'a'  # all
         if run_options.interactive_mode
-          { missing: missing, existing: existing }
+          { missing: missing, existing: existing, unused: unused }
         else
-           print_missing.(); print_existing.()
+           print_missing.()
+           print_existing.()
+           print_unused.()
         end
 
       when 'm'
@@ -329,8 +339,16 @@ When in interactive shell mode:
       when 'e'
         run_options.interactive_mode ? existing : print_existing.()
 
+      when 'u'
+        run_options.interactive_mode ? unused : print_unused.()
+
+      when 'x'
+        run_options.interactive_mode ? missing : print_missing.()
+        run_options.interactive_mode ? unused : print_unused.()
+
     else
-      message = "Invalid option for receipts. Must be 'a' for all, 'm' for missing, or 'e' for existing."
+      message = "Invalid option for receipts." + \
+          " Must be 'a' for all, 'm' for missing, 'e' for existing, 'u' for unused, or 'x' for errors (missing/unused)."
       if run_options.interactive_mode
         puts message
       else
@@ -340,7 +358,7 @@ When in interactive shell mode:
   end
 
   def cmd_w
-    book_set.all_reports_to_files(run_options.output_dir, $filter)
+    BookSetReporter.new(book_set, run_options.output_dir, $filter).call
     nil
   end
 
@@ -368,6 +386,8 @@ When in interactive shell mode:
 
 
   def find_command_action(command_string)
+    return nil if command_string.nil?
+
     result = commands.detect do |cmd|
       cmd.max_string.start_with?(command_string) \
     && \

data/lib/rock_books/documents/book_set.rb

@@ -1,18 +1,14 @@
 require 'awesome_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/balance_sheet'
-require_relative '../reports/income_statement'
-require_relative '../reports/multidoc_transaction_report'
-require_relative '../reports/receipts_report'
-require_relative '../reports/report_context'
-require_relative '../reports/transaction_report'
-require_relative '../reports/tx_by_account'
-require_relative '../reports/tx_one_account'
+require_relative '../reports/book_set_reporter'
 
+require 'erb'
 require 'open3'
 
 module RockBooks
@@ -27,80 +23,6 @@ module RockBooks
     end
 
 
-    def report_context
-      @report_context ||= ReportContext.new(chart_of_accounts, journals, nil, nil, 80)
-    end
-
-
-    def all_reports(filter = nil)
-      context = report_context
-      report_hash = context.journals.each_with_object({}) do |journal, report_hash|
-        report_hash[journal.short_name] = 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_and_existing_receipts).call
-      end
-
-      chart_of_accounts.accounts.each do |account|
-        key = 'acct_' + account.code
-        report = TxOneAccount.new(context, account.code).call
-        report_hash[key] = report
-      end
-      report_hash
-    end
-
-
-    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
-
-
-    def all_reports_to_files(directory = '.', filter = nil)
-      reports = all_reports(filter)
-
-      # "./pdf/short_name.pdf" or "./pdf/single_account/short_name.pdf"
-      build_filespec = ->(short_name, file_format) do
-        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
-
-      reports.each do |short_name, report_text|
-        txt_filespec  = build_filespec.(short_name, 'txt')
-        html_filespec = build_filespec.(short_name, 'html')
-        pdf_filespec  = build_filespec.(short_name, 'pdf')
-
-        FileUtils.mkdir_p(File.dirname(txt_filespec))
-        FileUtils.mkdir_p(File.dirname(html_filespec))
-        FileUtils.mkdir_p(File.dirname(pdf_filespec))
-
-        File.write(txt_filespec, report_text)
-        run_command("textutil -convert html -font 'Menlo Regular' -fontsize 10 #{txt_filespec} -output #{html_filespec}")
-        run_command("cupsfilter #{html_filespec} > #{pdf_filespec}")
-        puts "Created reports in txt, html, and pdf for #{"%-20s" % short_name} at #{File.dirname(txt_filespec)}.\n\n\n"
-      end
-    end
-
-
     def journal_names
       journals.map(&:short_name)
     end
@@ -117,22 +39,6 @@ module RockBooks
       @all_entries ||= Journal.entries_in_documents(journals)
     end
 
-
-    def receipt_full_filespec(receipt_filespec)
-      File.join(run_options.receipt_dir, receipt_filespec)
-    end
-
-
-    def missing_and_existing_receipts
-      missing = []; existing = []
-      all_entries.each do |entry|
-        entry.receipts.each do |receipt|
-          file_exists = File.file?(receipt_full_filespec(receipt))
-          list = (file_exists ? existing : missing)
-          list << { receipt: receipt, journal: entry.doc_short_name }
-        end
-      end
-      [missing, existing]
-    end
   end
 end
+

data/lib/rock_books/documents/chart_of_accounts.rb

@@ -1,11 +1,13 @@
 require_relative '../types/account'
 require_relative '../types/account_type'
 require_relative '../errors/error'
+require_relative '../errors/date_range_error'
 
 module RockBooks
 class ChartOfAccounts
 
-  attr_reader :doc_type, :title, :accounts, :entity
+  REQUIRED_FIELDS = %i(doc_type  title  accounts  entity  start_date  end_date)
+  REQUIRED_FIELDS.each { |field| attr_reader(field) }
 
 
   def self.from_file(file)
@@ -21,36 +23,64 @@ class ChartOfAccounts
   def initialize(input_lines)
     @accounts = []
     input_lines.each { |line| parse_line(line) }
-  end
+    # TODO: Add validation for required fields.
 
+    missing_fields = REQUIRED_FIELDS.select do |field|
+      instance_variable_get("@#{field}").nil?
+    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 /^$/
-      # 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]
+    unless missing_fields.empty?
+      raise Error.new("Chart of accounts lacks required fields: #{missing_fields.join(', ')}")
+    end
+  end
 
-      matcher = rest.match(/^(\S+)\s+(.*)$/)
-      account_type_token = matcher[1]
-      account_type = AccountType.to_type(account_type_token).symbol
 
-      name = matcher[2]
+  def parse_date(date_string)
+    # TODO: Add better handling for this error.
+    # begin
+      date = Date.iso8601(date_string)
+    # rescue ArgumentError
+    #  ..
+    # end
+  end
 
-      accounts << Account.new(code, account_type, name)
+  def parse_line(line)
+    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
 
 
@@ -69,6 +99,11 @@ class ChartOfAccounts
   end
 
 
+  def included_in_period?(date)
+    (start_date..end_date).include?(date)
+  end
+
+
   def report_string
     result = ''
 
@@ -119,10 +154,12 @@ class ChartOfAccounts
 
 
   def ==(other)
-    doc_type == other.doc_type   && \
-    title    == other.title      && \
-    accounts == other.accounts   && \
-    entity   == other.entity
+    doc_type   == other.doc_type   && \
+    title      == other.title      && \
+    accounts   == other.accounts   && \
+    entity     == other.entity     && \
+    start_date == other.start_date && \
+    end_date   == other.end_date
   end
 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