rock_books 0.2.1 → 0.4.0

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/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
 

data/lib/rock_books/reports/report_context.rb

@@ -1,9 +1,6 @@
 module RockBooks
 
-class ReportContext < Struct.new(
-    :chart_of_accounts,
-    :journals,
-    :page_width)
+class ReportContext < Struct.new(:chart_of_accounts, :journals, :page_width)
 
   def entity
     chart_of_accounts.entity

data/lib/rock_books/reports/reporter.rb

@@ -95,7 +95,7 @@ module Reporter
     acct_amounts = entry.acct_amounts
 
     # "2017-10-29  hsbc_visa":
-    output = entry.date.to_s << '  ' << (SHORT_NAME_FORMAT_STRING % entry.doc_short_name)
+    output = entry.date.to_s << '  ' << (SHORT_NAME_FORMAT_STRING % entry.doc_short_name) << '  '
 
     indent = ' ' * output.length
 

data/lib/rock_books/reports/transaction_report.rb

@@ -37,7 +37,7 @@ class TransactionReport
   def format_entry_first_acct_amount(entry)
     entry.date.to_s \
         << '  ' \
-        << format_acct_amount(entry.acct_amounts.first) \
+        << format_acct_amount(entry.acct_amounts.last) \
         << "\n"
   end
 
@@ -89,7 +89,9 @@ class TransactionReport
       entries = entries.select { |entry| filter.(entry) }
     end
 
-    entries.each { |entry| sio << format_entry(entry) << "\n" }
+    entries.each do |entry|
+      sio << format_entry(entry) << "\n"
+    end
     totals = AcctAmount.aggregate_amounts_by_account(JournalEntry.entries_acct_amounts(entries))
     sio << generate_and_format_totals('Totals', totals)
     sio.string

data/lib/rock_books/version.rb

@@ -1,3 +1,3 @@
 module RockBooks
-  VERSION = "0.2.1"
+  VERSION = "0.4.0"
 end

data/sample_data/minimal/rockbooks-reports/html/ck_hsbc_disb.html

@@ -0,0 +1,40 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <meta http-equiv="Content-Style-Type" content="text/css">
+  <title></title>
+  <meta name="Generator" content="Cocoa HTML Writer">
+  <meta name="CocoaVersion" content="1671.2">
+  <style type="text/css">
+    p.p1 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px 'Courier New'}
+    p.p2 {margin: 0.0px 0.0px 0.0px 0.0px; font: 14.0px 'Courier New'; min-height: 16.0px}
+  </style>
+</head>
+<body>
+<p class="p1"><b>--------------------------------------------------------------------------------</b></p>
+<p class="p1"><b><span class="Apple-converted-space">                              </span>XYZ Consulting, Inc.</b></p>
+<p class="p1"><b><span class="Apple-converted-space">                   </span>HSBC Checking Disbursements Journal - 2018</b></p>
+<p class="p1"><b><span class="Apple-converted-space">               </span>Transactions for Account #ck.hsbc -- HSBC Checking</b></p>
+<p class="p1"><b>--------------------------------------------------------------------------------</b></p>
+<p class="p2"><b></b><br></p>
+<p class="p2"><b></b><br></p>
+<p class="p1"><b>2018-01-01<span class="Apple-converted-space">    </span>5000.00<span class="Apple-converted-space">        </span>ck.hsbc<span class="Apple-converted-space">  </span>HSBC Checking</b></p>
+<p class="p1"><b>Initial Deposit from Shareholder</b></p>
+<p class="p2"><b></b><br></p>
+<p class="p1"><b>2018-01-05 <span class="Apple-converted-space">  </span>-2000.00<span class="Apple-converted-space">        </span>ck.hsbc<span class="Apple-converted-space">  </span>HSBC Checking</b></p>
+<p class="p2"><b></b><br></p>
+<p class="p1"><b>2018-01-07 <span class="Apple-converted-space">  </span>10000.00<span class="Apple-converted-space">        </span>ck.hsbc<span class="Apple-converted-space">  </span>HSBC Checking</b></p>
+<p class="p1"><b>Invoice #437, Dec. 2017 work, ABC, Inc.</b></p>
+<p class="p2"><b></b><br></p>
+<p class="p1"><b>Totals</b></p>
+<p class="p1"><b>------</b></p>
+<p class="p2"><b></b><br></p>
+<p class="p1"><b><span class="Apple-converted-space">     </span>2000.00 <span class="Apple-converted-space">  </span>cc.hsbc.visa<span class="Apple-converted-space">    </span>Visa Credit Card</b></p>
+<p class="p1"><b><span class="Apple-converted-space">    </span>13000.00 <span class="Apple-converted-space">  </span>ck.hsbc <span class="Apple-converted-space">        </span>HSBC Checking</b></p>
+<p class="p1"><b><span class="Apple-converted-space">    </span>-5000.00 <span class="Apple-converted-space">  </span>own.equity<span class="Apple-converted-space">      </span>Owner's Equity</b></p>
+<p class="p1"><b><span class="Apple-converted-space">   </span>-10000.00 <span class="Apple-converted-space">  </span>sls.cons<span class="Apple-converted-space">        </span>Sales - Consulting</b></p>
+<p class="p1"><b>------------</b></p>
+<p class="p1"><b><span class="Apple-converted-space">        </span>0.00</b></p>
+</body>
+</html>

data/sample_data/minimal/rockbooks-reports/html/index.html

@@ -0,0 +1,271 @@
+<!DOCTYPE html>
+
+
+<html>
+
+<head>
+
+<!--Bootstrap:-->
+<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/css/bootstrap.min.css" integrity="sha384-GJzZqFGwb1QTTN6wy59ffF1BuGJpLSa9DkKMp0DgiMDm4iYMj70gZWKYbI706tWS" crossorigin="anonymous">
+
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.2.1/js/bootstrap.min.js" integrity="sha384-B0UglyR+jN6CkvvICOB2joaf5I4l3gm9GU6Hc1og6Ls7i6U/mkkaduKaBhlAXv9k" crossorigin="anonymous"></script>
+
+  <style>
+    body {
+      padding: 18px;
+      background-color: #e7f7cd;
+      color: darkgreen;
+    }
+
+    h2 {
+      margin-top: 32px;
+      margin-bottom: 12px;
+    }
+
+    .this_page_style {
+      background-color: #e7f7cd;
+      color: darkgreen;
+      border: 0px;
+    }
+
+
+
+  </style>
+
+</head>
+
+<body>
+
+<h1>XYZ Consulting, Inc.</h1>
+<p class="muted">Reports Generated at 2019-03-04 12:09:49 by RockBooks version 0.2.1</p>
+
+
+<h2>Financial Statements</h2>
+<div id="financial-statements">
+<a href='balance_sheet.html' class="btn btn-success">Balance Sheet</a>
+<a href='income_statement.html' class="btn btn-success">Income Statement</a>
+</div>
+
+
+<h2>Supporting Documents</h2>
+<div id="supporting-documents" style="display: inline ">
+  
+  
+  <a href=/Users/kbennett/work/rock_books/sample_data/minimal/receipts class="btn btn-success">Receipts</a>
+  
+  
+</div>
+
+
+<h2>All Transactions Reports</h2>
+<div id="all-transactions">
+<a href="all_txns_by_acct.html" class="btn btn-success">By Account</a>
+<a href="all_txns_by_amount.html" class="btn btn-success">By Amount</a>
+<a href="all_txns_by_date.html" class="btn btn-success">By Date</a>
+</div>
+
+
+
+<br /><br />
+  <div class="collapsible-heading">
+    <div class="container-fluid">
+      <div class="row">
+
+        <div class="col-sm2" style="margin-right: 12px;">
+          <a class="btn btn-success" data-toggle="collapse" href="#journal-reports" role="button" aria-expanded="false" aria-controls="collapseExample">
+            +/-
+          </a>
+        </div>
+
+        <div class="col-sm10">
+          <h2 style="margin: 0px;">Journal Reports</h2>
+        </div>
+      </div>
+    </div>
+  </div>
+  
+
+</div>
+<div class="collapse" id="journal-reports">
+  <div class="card card-body this_page_style">
+    <ul>
+      
+        <li><a href="ck.hsbc.disb.html" class="this_page_style" target="_blank">HSBC Checking Disbursements Journal - 2018 -- ck.hsbc.disb -- ck.hsbc</a></li>
+      
+        <li><a href="hsbc_visa.html" class="this_page_style" target="_blank">HSBC Visa Journal - 2018 -- hsbc_visa -- cc.hsbc.visa</a></li>
+      
+        <li><a href="general.html" class="this_page_style" target="_blank">General Journal - 2018 -- general -- </a></li>
+      
+    </ul>
+  </div>
+</div>
+
+
+<br /><br />
+  <div class="collapsible-heading">
+    <div class="container-fluid">
+      <div class="row">
+
+        <div class="col-sm2" style="margin-right: 12px;">
+          <a class="btn btn-success" data-toggle="collapse" href="#individual-accounts" role="button" aria-expanded="false" aria-controls="collapseExample">
+            +/-
+          </a>
+        </div>
+
+        <div class="col-sm10">
+          <h2 style="margin: 0px;">Individual Accounts</h2>
+        </div>
+      </div>
+    </div>
+  </div>
+  
+
+<div class="collapse" id="individual-accounts">
+  <div class="card card-body  this_page_style">
+    <ul>
+
+    
+      <li><a href="single-account/acct_ck.hsbc.html" class="this_page_style">HSBC Checking (ck.hsbc)</a></li>
+    
+      <li><a href="single-account/acct_paypal.html" class="this_page_style">Paypal (paypal)</a></li>
+    
+      <li><a href="single-account/acct_accts.rec.html" class="this_page_style">Accounts Receivable (accts.rec)</a></li>
+    
+      <li><a href="single-account/acct_cc.hsbc.visa.html" class="this_page_style">Visa Credit Card (cc.hsbc.visa)</a></li>
+    
+      <li><a href="single-account/acct_loan.to.sh.html" class="this_page_style">Loan Payable to Shareholder (loan.to.sh)</a></li>
+    
+      <li><a href="single-account/acct_own.equity.html" class="this_page_style">Owner's Equity (own.equity)</a></li>
+    
+      <li><a href="single-account/acct_ret.earn.html" class="this_page_style">Retained Earnings (ret.earn)</a></li>
+    
+      <li><a href="single-account/acct_sls.cons.html" class="this_page_style">Sales - Consulting (sls.cons)</a></li>
+    
+      <li><a href="single-account/acct_bank.fees.html" class="this_page_style">Bank Charges (bank.fees)</a></li>
+    
+      <li><a href="single-account/acct_books.refs.html" class="this_page_style">Books, Screencasts, References (books.refs)</a></li>
+    
+      <li><a href="single-account/acct_conf.fees.html" class="this_page_style">Conference Fees (conf.fees)</a></li>
+    
+      <li><a href="single-account/acct_cowork.fees.html" class="this_page_style">Coworking Fees (cowork.fees)</a></li>
+    
+      <li><a href="single-account/acct_govt.fees.html" class="this_page_style">Government Fees (govt.fees)</a></li>
+    
+      <li><a href="single-account/acct_inet.fees.html" class="this_page_style">Internet Service, Domain, and Hosting Fees (inet.fees)</a></li>
+    
+      <li><a href="single-account/acct_insurance.html" class="this_page_style">Insurance (insurance)</a></li>
+    
+      <li><a href="single-account/acct_int.exp.html" class="this_page_style">Interest Expense (int.exp)</a></li>
+    
+      <li><a href="single-account/acct_mktng.exp.html" class="this_page_style">Marketing Expenses (mktng.exp)</a></li>
+    
+      <li><a href="single-account/acct_meals.ent.html" class="this_page_style">Meals & Entertainment (meals.ent)</a></li>
+    
+      <li><a href="single-account/acct_misc.exp.html" class="this_page_style">Miscellaneous Expenses (misc.exp)</a></li>
+    
+      <li><a href="single-account/acct_prof.fees.html" class="this_page_style">Professional Fees (prof.fees)</a></li>
+    
+      <li><a href="single-account/acct_repair.maint.html" class="this_page_style">Repair & Maintenance (repair.maint)</a></li>
+    
+      <li><a href="single-account/acct_ship.exp.html" class="this_page_style">Shipping and Mailing Expenses (ship.exp)</a></li>
+    
+      <li><a href="single-account/acct_sw.exp.html" class="this_page_style">Software Expense (sw.exp)</a></li>
+    
+      <li><a href="single-account/acct_supplies.html" class="this_page_style">Supplies (supplies)</a></li>
+    
+      <li><a href="single-account/acct_cc.proc.html" class="this_page_style">Credit Card Processing Fees (cc.proc)</a></li>
+    
+      <li><a href="single-account/acct_tr.airfare.html" class="this_page_style">Travel - Air Fares (tr.airfare)</a></li>
+    
+      <li><a href="single-account/acct_tr.autorent.html" class="this_page_style">Travel - Auto Rental (tr.autorent)</a></li>
+    
+      <li><a href="single-account/acct_tr.gas.etc.html" class="this_page_style">Travel - Gas, Oil, Tolls, etc. (tr.gas.etc)</a></li>
+    
+      <li><a href="single-account/acct_tr.govt.html" class="this_page_style">Travel - Government Fees (tr.govt)</a></li>
+    
+      <li><a href="single-account/acct_tr.lodging.html" class="this_page_style">Travel - Lodging (tr.lodging)</a></li>
+    
+      <li><a href="single-account/acct_tr.m.i.html" class="this_page_style">Travel - Meals & Incidentals (tr.m.i)</a></li>
+    
+      <li><a href="single-account/acct_tr.mileage.html" class="this_page_style">Travel - Mileage Allowance (tr.mileage)</a></li>
+    
+      <li><a href="single-account/acct_tr.misc.html" class="this_page_style">Travel - Miscellaneous (tr.misc)</a></li>
+    
+      <li><a href="single-account/acct_tr.parking.html" class="this_page_style">Travel - Parking (tr.parking)</a></li>
+    
+      <li><a href="single-account/acct_tr.perdiem.mi.html" class="this_page_style">Travel - Per Diem (Meals and Incidentals) (tr.perdiem.mi)</a></li>
+    
+      <li><a href="single-account/acct_tr.taxi.html" class="this_page_style">Travel - Taxi (tr.taxi)</a></li>
+    
+      <li><a href="single-account/acct_tr.trainfare.html" class="this_page_style">Travel - Train Fare (tr.trainfare)</a></li>
+    
+      <li><a href="single-account/acct_tr.m.e.html" class="this_page_style">Meals and Entertainment (tr.m.e)</a></li>
+    
+      <li><a href="single-account/acct_tr.unclass.html" class="this_page_style">Expenses Not Yet Classified (tr.unclass)</a></li>
+    
+    </ul>
+</div>
+</div>
+</div>
+
+
+<br /><br />
+  <div class="collapsible-heading">
+    <div class="container-fluid">
+      <div class="row">
+
+        <div class="col-sm2" style="margin-right: 12px;">
+          <a class="btn btn-success" data-toggle="collapse" href="#other" role="button" aria-expanded="false" aria-controls="collapseExample">
+            +/-
+          </a>
+        </div>
+
+        <div class="col-sm10">
+          <h2 style="margin: 0px;">Other</h2>
+        </div>
+      </div>
+    </div>
+  </div>
+  
+
+<div class="collapse" id="other">
+  <div class="card card-body this_page_style">
+    <ul>
+      
+        <li><a href="receipts.html" class="this_page_style">Missing and Existing Receipts</a></li>
+      
+    </ul>
+  </div>
+</div>
+
+<br /><br />
+  <div class="collapsible-heading">
+    <div class="container-fluid">
+      <div class="row">
+
+        <div class="col-sm2" style="margin-right: 12px;">
+          <a class="btn btn-success" data-toggle="collapse" href="#other-formats" role="button" aria-expanded="false" aria-controls="collapseExample">
+            +/-
+          </a>
+        </div>
+
+        <div class="col-sm10">
+          <h2 style="margin: 0px;">Reports in PDF and Text Formats</h2>
+        </div>
+      </div>
+    </div>
+  </div>
+  
+
+<div class="collapse" id="other-formats">
+  <div class="card card-body this_page_style">
+    <ul>
+        <li><a href="../pdf" class="this_page_style" target="_blank">PDF Format</a></li>
+        <li><a href="../txt" class="this_page_style" target="_blank">Text Format</a></li>
+    </ul>
+  </div>
+</div>
+
+</body>
+</html>