rock_books 0.1.0

data/lib/rock_books/reports/reporter.rb

@@ -0,0 +1,118 @@
+require_relative '../documents/journal_entry'
+
+module RockBooks
+module Reporter
+
+  module_function
+
+  SHORT_NAME_MAX_LENGTH = 16
+
+  SHORT_NAME_FORMAT_STRING = "%#{SHORT_NAME_MAX_LENGTH}.#{SHORT_NAME_MAX_LENGTH}s"
+
+
+  def page_width
+    context.page_width || 80
+  end
+
+
+  def format_account_code(code)
+    "%*.*s" % [max_account_code_length, max_account_code_length, code]
+  end
+
+
+  def account_code_name_type_string(account)
+    "#{account.code} -- #{account.name}  (#{account.type.to_s.capitalize})"
+  end
+
+
+  def format_amount(amount)
+    "%9.2f" % amount
+  end
+
+
+  # e.g. "    117.70     tr.mileage  Travel - Mileage Allowance"
+  def format_acct_amount(acct_amount)
+    "%s  %s  %s" % [
+        format_amount(acct_amount.amount),
+        format_account_code(acct_amount.code),
+        context.chart_of_accounts.name_for_code(acct_amount.code)
+    ]
+  end
+
+
+  def banner_line
+    @banner_line ||= '-' * page_width
+  end
+
+
+  def center(string)
+    indent = (page_width - string.length) / 2
+    indent = 0 if indent < 0
+    (' ' * indent) + string
+  end
+
+
+  def max_account_code_length
+    @max_account_code_length ||= context.chart_of_accounts.max_account_code_length
+  end
+
+
+  def generate_and_format_totals(section_caption, totals)
+    output = section_caption
+    output << "\n#{'-' * section_caption.length}\n\n"
+    format_string = "%12.2f   %-#{context.chart_of_accounts.max_account_code_length}s   %s\n"
+    totals.keys.sort.each do |account_code|
+      account_name = context.chart_of_accounts.name_for_code(account_code)
+      account_total = totals[account_code]
+      output << format_string % [account_total, account_code, account_name]
+    end
+
+    output << "------------\n"
+    output << "%12.2f\n" % totals.values.sum.round(2)
+    output
+  end
+
+
+  def generate_account_type_section(section_caption, totals, section_type, need_to_reverse_sign)
+    account_codes_this_section = context.chart_of_accounts.account_codes_of_type(section_type)
+
+    totals_this_section = totals.select do |account_code, _amount|
+      account_codes_this_section.include?(account_code)
+    end
+
+    if need_to_reverse_sign
+      totals_this_section.each { |code, amount| totals_this_section[code] = -amount }
+    end
+
+    section_total_amount = totals_this_section.map { |aa| aa.last }.sum
+
+    output = generate_and_format_totals(section_caption, totals_this_section)
+    [ output, section_total_amount ]
+  end
+
+
+  def format_multidoc_entry(entry)
+    acct_amounts = entry.acct_amounts
+
+    # "2017-10-29  hsbc_visa":
+    output = entry.date.to_s << '  ' << (SHORT_NAME_FORMAT_STRING % entry.doc_short_name)
+
+    indent = ' ' * output.length
+
+    output << format_acct_amount(acct_amounts.first) << "\n"
+
+    acct_amounts[1..-1].each do |acct_amount|
+      output << indent << format_acct_amount(acct_amount) << "\n"
+    end
+
+    if entry.description && entry.description.length > 0
+      output << entry.description
+    end
+
+    output
+  end
+
+end
+end
+
+

data/lib/rock_books/reports/transaction_report.rb

@@ -0,0 +1,103 @@
+require_relative 'reporter'
+require_relative 'report_context'
+
+module RockBooks
+
+class TransactionReport
+
+  include Reporter
+
+  attr_accessor :journal, :context
+
+
+  def initialize(journal, report_context)
+    @journal = journal
+    @context = report_context
+  end
+
+
+  def generate_header
+
+    code = journal.account_code
+    name = journal.chart_of_accounts.name_for_code(code)
+    title = "Transactions for Account ##{code} -- #{name}"
+
+    lines = [banner_line]
+    lines << center(context.entity || 'Unspecified Entity')
+    lines << center(journal.title) if journal.title && journal.title.length > 0
+    lines << center(title)
+    lines << banner_line
+    lines << ''
+    lines << ''
+    lines << ''
+    lines.join("\n")
+  end
+
+
+  def format_entry_first_acct_amount(entry)
+    entry.date.to_s \
+        << '  ' \
+        << format_acct_amount(entry.acct_amounts.first) \
+        << "\n"
+  end
+
+
+  # Formats an entry like this, with entry description added on additional line(s) if it exists:
+  # 2018-05-21   $120.00   701  Office Supplies
+  def format_entry_no_split(entry)
+    output = format_entry_first_acct_amount(entry)
+
+    if entry.description && entry.description.length > 0
+      output << entry.description
+    end
+    output
+  end
+
+
+  # Formats an entry like this, with entry description added on additional line(s) if it exists::
+  # 2018-05-21   $120.00   95.00     701  Office Supplies
+  #                        25.00     751  Gift to Customer
+  def format_entry_with_split(entry)
+    output = format_entry_first_acct_amount(entry)
+    indent = ' ' * 12
+
+    entry.acct_amounts[1..-1].each do |acct_amount|
+      output << indent << format_acct_amount(acct_amount) << "\n"
+    end
+
+    if entry.description && entry.description.length > 0
+      output << entry.description
+    end
+  end
+
+
+  def format_entry(entry)
+    if entry.acct_amounts.size > 2
+      format_entry_with_split(entry)
+    else
+      format_entry_no_split(entry)
+    end
+  end
+
+
+  def generate_report(filter = nil)
+    sio = StringIO.new
+    sio << generate_header
+
+    entries = journal.entries
+    if filter
+      entries = entries.select { |entry| filter.(entry) }
+    end
+
+    entries.each { |entry| sio << format_entry(entry) << "\n" }
+    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
+    sio << generate_and_format_totals('Totals', totals)
+    sio.string
+  end
+
+
+  alias_method :to_s, :generate_report
+  alias_method :call, :generate_report
+end
+
+end

data/lib/rock_books/reports/tx_by_account.rb

@@ -0,0 +1,82 @@
+require_relative '../documents/chart_of_accounts'
+require_relative '../documents/journal'
+require_relative 'reporter'
+require_relative 'report_context'
+
+module RockBooks
+
+class TxByAccount
+
+  include Reporter
+
+  attr_accessor :context
+
+
+  def initialize(report_context)
+    @context = report_context
+  end
+
+
+  def generate_header
+    lines = [banner_line]
+    lines << center(context.entity || 'Unspecified Entity')
+    lines << center("Transactions by Account")
+    lines << banner_line
+    lines << ''
+    lines << ''
+    lines << ''
+    lines.join("\n")
+  end
+
+
+  def account_header(account, account_total)
+    total_string = "%.2f" % account_total
+    title =  "Total: #{total_string} -- #{account_code_name_type_string(account)})"
+
+    <<~HEREDOC
+    #{banner_line}
+    #{center(title)}
+    #{banner_line}
+
+    HEREDOC
+  end
+
+
+  def account_total_line(account_code, account_total)
+    account_name = context.chart_of_accounts.name_for_code(account_code)
+    "%.2f  Total for account: %s - %s" % [account_total, account_code, account_name]
+  end
+
+
+  def generate_report
+    output = generate_header
+
+    all_entries = Journal.entries_in_documents(context.journals)
+
+    context.chart_of_accounts.accounts.each do |account|
+      code = account.code
+      account_entries = JournalEntry.entries_containing_account_code(all_entries, code)
+      account_total = JournalEntry.total_for_code(account_entries, code)
+      output << account_header(account, account_total)
+
+      account_entries.each do |entry|
+        output << format_multidoc_entry(entry) << "\n"
+        output << "\n" if entry.description && entry.description.length > 0
+      end
+      output << account_total_line(code, account_total) << "\n"
+      output  << "\n\n\n"
+    end
+
+    totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(all_entries))
+    output << generate_and_format_totals('Totals', totals)
+
+    output
+  end
+
+  alias_method :to_s, :generate_report
+  alias_method :call, :generate_report
+
+
+end
+
+end

data/lib/rock_books/reports/tx_one_account.rb

@@ -0,0 +1,63 @@
+require_relative '../documents/chart_of_accounts'
+require_relative '../documents/journal'
+require_relative 'reporter'
+require_relative 'report_context'
+
+module RockBooks
+
+  class TxOneAccount
+
+    include Reporter
+
+    attr_reader :context, :account_code, :account
+
+
+    def initialize(report_context, account_code)
+      @context = report_context
+      @account_code = account_code
+      @account = context.chart_of_accounts.account_for_code(account_code)
+    end
+
+
+    def generate_header(account_total)
+      lines = [banner_line]
+      lines << center(context.entity || 'Unspecified Entity')
+      lines << center("Transactions for Account #{account_code_name_type_string(account)}")
+      lines << center("Total: %.2f" % account_total)
+      lines << banner_line
+      lines << ''
+      lines << ''
+      lines << ''
+      lines.join("\n")
+    end
+
+
+    def process_account(entries)
+      entries.each_with_object('') do |entry, output|
+        output << format_multidoc_entry(entry) << "\n"
+        output << "\n" if entry.description && entry.description.length > 0
+      end
+    end
+
+
+    def generate_report
+      entries = Journal.entries_in_documents(context.journals, JournalEntryFilters.account_code_filter(account_code))
+      account_total = JournalEntry.total_for_code(entries, account_code)
+      output = generate_header(account_total)
+
+      if entries.empty?
+        output << "There were no transactions for this account.\n\n\n\n"
+      else
+        output << process_account(entries)
+        totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
+        output << generate_and_format_totals('Totals', totals)
+      end
+
+      output
+    end
+
+    alias_method :to_s, :generate_report
+    alias_method :call, :generate_report
+  end
+
+end

data/lib/rock_books/types/account.rb

@@ -0,0 +1,7 @@
+module RockBooks
+
+  # The ChartOfAccount holds the set of all these accounts for the entity.
+  class Account < Struct.new(:code, :type, :name)
+  end
+
+end

data/lib/rock_books/types/account_type.rb

@@ -0,0 +1,33 @@
+require_relative '../errors/error'
+
+module RockBooks
+
+  class AccountType < Struct.new(:symbol, :singular_name, :plural_name)
+
+    ASSET         = self.new(:asset,      'Asset',      'Assets')
+    LIABILITY     = self.new(:liability,  'Liability',  'Liabilities')
+    EQUITY        = self.new(:equity,     'Equity',     'Equity')
+    INCOME        = self.new(:income,     'Income',     'Income')
+    EXPENSE       = self.new(:expense,    'Expense',    'Expenses')
+
+    ALL_TYPES = [ASSET, LIABILITY, EQUITY, INCOME, EXPENSE]
+
+    TYPE_HASH = {
+        'A' => ASSET,
+        'L' => LIABILITY,
+        'O' => EQUITY,
+        'I' => INCOME,
+        'E' => EXPENSE
+    }
+
+    # Converts strings
+    def self.to_type(string)
+      type = TYPE_HASH[string[0].upcase]
+      if type.nil?
+        raise Error.new("Account type of #{string} not valid. " +
+            "Must be one of #{TYPE_HASH.keys} (#{ALL_TYPES.map(&:singular_name)})")
+      end
+      type
+    end
+  end
+end

data/lib/rock_books/types/acct_amount.rb

@@ -0,0 +1,52 @@
+module RockBooks
+
+# This class represents an account code and an amount.
+# Journal entries will have multiple instances of these.
+class AcctAmount < Struct.new(:date, :code, :amount)
+
+
+  # Same as constructor except it raises an error if the account code is not in the chart of accounts.
+  def self.create_with_chart_validation(date, code, amount, chart_of_accounts)
+    unless chart_of_accounts.include?(code)
+      raise AccountNotFoundError.new(code)
+    end
+    self.new(date, code, amount)
+  end
+
+
+  def self.total_amount(acct_amounts)
+    acct_amounts.inject(0) { |sum, acct_amount| sum += acct_amount.amount }
+  end
+
+
+  # Returns a hash whose keys are account codes and values are the totals for those codes.
+  # The 'aggregate' in the method name is intended to be a noun, not a verb.
+  def self.aggregate_amounts_by_account(acct_amounts)
+    totals = acct_amounts.each_with_object(Hash.new(0)) do |acct_amount, by_account|
+      by_account[acct_amount.code] += acct_amount.amount
+    end
+    totals.each do |code, amount |
+      totals[code] = amount.round(2)
+    end
+  end
+
+
+  # Returns the subset of the passed array of acct_amount's that contain the specified account code
+  def self.containing_code(acct_amounts, account_code)
+    acct_amounts.select { |acct_amount| acct_amount.code == account_code }
+  end
+
+
+  # For the passed array of AcctAmount's, calculate the total for a single account.
+  def self.total_amount_for_code(acct_amounts, account_code)
+    containing_code(acct_amounts, account_code) \
+        .map(&:amount) \
+        .sum
+  end
+
+
+  def self.filter(acct_amounts, filter)
+    acct_amounts.select { |acct_amount| filter.(acct_amount)}
+  end
+end
+end

data/lib/rock_books/version.rb

@@ -0,0 +1,3 @@
+module RockBooks
+  VERSION = "0.1.0"
+end

data/lib/rock_books.rb

@@ -0,0 +1,7 @@
+module RockBooks
+
+  DEFAULT_INPUT_DIR   = './rockbooks-inputs'
+  DEFAULT_OUTPUT_DIR  = './rockbooks-reports'
+  DEFAULT_RECEIPT_DIR = './receipts'
+  SINGLE_ACCT_SUBDIR  = 'single-account'
+end

data/rock_books.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rock_books/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rock_books"
+  spec.version       = RockBooks::VERSION
+  spec.authors       = ["Keith Bennett"]
+  spec.email         = ["keithrbennett@gmail.com"]
+
+  spec.summary       = %q{Very basic accounting package.}
+  spec.description   = %q{Extremely primitive accounting software.}
+  spec.homepage      = "http://example.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = ": Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'awesome_print', '> 0'
+  spec.add_dependency 'pry', '> 0.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/sample_data/minimal/rockbooks-inputs/2017-xyz-chart-of-accounts.rbt

@@ -0,0 +1,62 @@
+@doc_type: chart_of_accounts
+@title: Chart of Accounts - 2017
+@entity: XYZ Consulting, Inc.
+
+
+# Assets
+
+ck.hsbc     A  HSBC Checking
+paypal      A  Paypal
+accts.rec   A  Accounts Receivable
+
+
+# Liabilities
+
+cc.hsbc.visa   L  Visa Credit Card
+loan.to.sh     L  Loan Payable to Shareholder
+
+
+# Equity
+
+own.equity  O  Owner's Equity
+ret.earn    O  Retained Earnings
+
+
+# Income
+
+sls.cons    I  Sales - Consulting
+
+
+# Expenses
+
+bank.fees     E  Bank Charges
+books.refs    E  Books, Screencasts, References
+conf.fees     E  Conference Fees
+cowork.fees   E  Coworking Fees
+govt.fees     E  Government Fees
+inet.fees     E  Internet Service, Domain, and Hosting Fees
+insurance     E  Insurance
+int.exp       E  Interest Expense
+mktng.exp     E  Marketing Expenses
+meals.ent     E  Meals & Entertainment
+misc.exp      E  Miscellaneous Expenses
+prof.fees     E  Professional Fees
+repair.maint  E  Repair & Maintenance
+ship.exp      E  Shipping and Mailing Expenses
+sw.exp        E  Software Expense
+supplies      E  Supplies
+cc.proc       E  Credit Card Processing Fees
+tr.airfare    E  Travel - Air Fares
+tr.autorent   E  Travel - Auto Rental
+tr.gas.etc    E  Travel - Gas, Oil, Tolls, etc.
+tr.govt       E  Travel - Government Fees
+tr.lodging    E  Travel - Lodging
+tr.m.i        E  Travel - Meals & Incidentals
+tr.mileage    E  Travel - Mileage Allowance
+tr.misc       E  Travel - Miscellaneous
+tr.parking    E  Travel - Parking
+tr.perdiem.mi E  Travel - Per Diem (Meals and Incidentals)
+tr.taxi       E  Travel - Taxi
+tr.trainfare  E  Travel - Train Fare
+tr.m.e        E  Meals and Entertainment
+tr.unclass    E  Expenses Not Yet Classified

data/sample_data/minimal/rockbooks-inputs/2017-xyz-checking-journal.rbt

@@ -0,0 +1,17 @@
+@doc_type: journal
+@title: HSBC Checking Disbursements Journal - 2017
+@account_code: ck.hsbc
+@debit_or_credit: debit
+@short_name: ck.hsbc
+@date_prefix: 2017-
+
+01-01   -5000.00   own.equity
+Initial Deposit from Shareholder
+
+01-05    2000.00  cc.hsbc.visa
+
+01-07  -10000.00   sls.cons
+Invoice #437, Dec. 2016 work, ABC, Inc.
+
+
+

data/sample_data/minimal/rockbooks-inputs/2017-xyz-general-journal.rbt

@@ -0,0 +1,14 @@
+@doc_type: general_journal
+@title: General Journal - 2017
+@date_prefix: 2017-
+@short_name: general
+
+01-08   tr.airfare   300.00   loan.to.sh  -300.00
+Phoenix conference air ticket paid on personal credit card
+
+01-20   tr.perdiem.mi   495.00   loan.to.sh  -495.00
+Per diem allowance for Phoenix conference (see worksheet)
+
+01-31   tr.mileage  117.70   loan.to.sh  -117.70
+Mileage reimbursement for business travel of January 2017 (see worksheet)
+

data/sample_data/minimal/rockbooks-inputs/2017-xyz-visa-journal.rbt

@@ -0,0 +1,23 @@
+@doc_type: journal
+@title: HSBC Visa Journal - 2017
+@account_code: cc.hsbc.visa
+@short_name: hsbc_visa
+@debit_or_credit: debit
+@date_prefix: 2017-
+
+01-02     750   insurance
+Professional insurance for the year 2017, Hartford Insurance
+Receipt: 01/2017-01-02-hartford-insurance.pdf
+
+01-02     100   cowork.fees
+New Work City coworking fee for the month of January
+Receipt: 01/2017-01-02-nwc.pdf
+
+01-06     500   conf.fees
+Phoenix conference registration fee
+Receipt: 01/2017-01-06-phoenix-conference-registration.pdf
+
+01-20     400   tr.lodging
+Hampton Inn Phoenix (conference)
+Receipt: 01/2017-01-20-phoenix-hampton.pdf
+