rock_books 0.2.1 → 0.7.0

data/lib/rock_books/reports/income_statement.rb

@@ -1,5 +1,5 @@
-require_relative '../documents/journal'
-require_relative 'report_context'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/reporter'
 
 module RockBooks
 
@@ -7,57 +7,19 @@ module RockBooks
   class IncomeStatement
 
   include Reporter
+  include ErbHelper
 
-  attr_accessor :context
+  attr_reader :data, :context
 
 
-  def initialize(report_context)
+  def initialize(report_context, data)
     @context = report_context
+    @data = data
   end
 
 
-  def start_date
-    context.chart_of_accounts.start_date
+  def generate
+    ErbHelper.render_hashes('text/income_statement.txt.erb', data, template_presentation_context)
   end
-
-
-  def end_date
-    context.chart_of_accounts.end_date
-  end
-
-
-  def generate_header
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << "#{center("Income Statement -- #{start_date} to #{end_date}")}"
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-
-
-  def generate_report
-    filter = RockBooks::JournalEntryFilters.date_in_range(start_date, end_date)
-    acct_amounts = Journal.acct_amounts_in_documents(context.journals, filter)
-    totals = AcctAmount.aggregate_amounts_by_account(acct_amounts)
-    totals.each { |aa| aa[1] = -aa[1] } # income statement shows credits as positive, debits as negative
-    output = generate_header
-
-    income_output,  income_total  = generate_account_type_section('Income',   totals, :income,  true)
-    expense_output, expense_total = generate_account_type_section('Expenses', totals, :expense, false)
-
-    grand_total = income_total - expense_total
-
-    output << [income_output, expense_output].join("\n\n")
-    output << "\n#{"%12.2f    Net Income" % grand_total}\n============\n"
-    output
-  end
-
-alias_method :to_s, :generate_report
-alias_method :call, :generate_report
-
-
 end
 end

data/lib/rock_books/reports/journal_report.rb

@@ -0,0 +1,72 @@
+require_relative 'data/journal_data'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/reporter'
+
+module RockBooks
+
+class JournalReport
+
+  include Reporter
+  include ErbHelper
+
+  attr_accessor :context, :report_data
+
+
+  def initialize(report_data, report_context, filter = nil)
+    @report_data = report_data
+    @context = report_context
+  end
+
+
+  def generate
+    presentation_context = template_presentation_context.merge(fn_format_entry: method(:format_entry))
+    ErbHelper.render_hashes('text/journal.txt.erb', report_data, presentation_context)
+  end
+
+
+  private def format_entry_first_acct_amount(entry)
+    entry.date.to_s \
+         + '  ' \
+         + format_acct_amount(entry.acct_amounts.last) \
+         + "\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
+  private 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
+  private 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
+
+
+  private def format_entry(entry)
+    if entry.acct_amounts.size > 2
+      format_entry_with_split(entry)
+    else
+      format_entry_no_split(entry)
+    end
+  end
+end
+end

data/lib/rock_books/reports/multidoc_txn_by_account_report.rb

@@ -0,0 +1,32 @@
+require_relative '../documents/chart_of_accounts'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/reporter'
+require_relative 'report_context'
+require_relative 'data/multidoc_txn_by_account_data'
+
+module RockBooks
+
+class MultidocTransactionByAccountReport
+
+  include Reporter
+  include ErbHelper
+
+  attr_reader :context, :data
+
+
+  def initialize(data, report_context)
+    @data = data
+    @context = report_context
+  end
+
+  def account_total_line(account_code, account_total)
+    account_name = context.chart_of_accounts.name_for_code(account_code)
+    sprintf("%.2f  Total for account: %s - %s", account_total, account_code, account_name)
+  end
+
+  def generate
+    presentation_context = template_presentation_context.merge({ fn_account_total_line: method(:account_total_line) })
+    ErbHelper.render_hashes('text/multidoc_txn_by_account_report.txt.erb', data, presentation_context)
+  end
+end
+end

data/lib/rock_books/reports/multidoc_txn_report.rb

@@ -0,0 +1,25 @@
+require_relative 'data/multidoc_txn_report_data'
+require_relative '../documents/journal'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/reporter'
+require_relative 'report_context'
+
+module RockBooks
+
+class MultidocTransactionReport
+
+  include Reporter
+  include ErbHelper
+
+  attr_reader :context, :data
+
+  def initialize(report_data, report_context)
+    @data = report_data
+    @context = report_context
+  end
+
+  def generate
+    ErbHelper.render_hashes('text/multidoc_txn_report.txt.erb', data, template_presentation_context)
+  end
+end
+end

data/lib/rock_books/reports/receipts_report.rb

@@ -6,52 +6,16 @@ class ReceiptsReport
 
   include Reporter
 
-  attr_reader :context, :missing, :existing
+  attr_reader :context, :data
 
-
-  def initialize(report_context, missing, existing)
+  def initialize(report_context, data)
     @context = report_context
-    @missing = missing
-    @existing = existing
-  end
-
-
-  def generate_header
-    lines = [banner_line]
-    lines << center(context.entity || 'Unspecified Entity')
-    lines << "#{center("Receipts Report")}"
-    lines << banner_line
-    lines << ''
-    lines << ''
-    lines << ''
-    lines.join("\n")
-  end
-
-
-  def receipt_info_line(info)
-    "%-16.16s  %s\n" % [info[:journal], info[:receipt]]
+    @data = data
   end
 
 
-  def column_headings
-    format_string = "%-16.16s  %s\n"
-    (format_string % ['Journal', 'Receipt Filespec']) << (format_string % %w(------- ----------------)) << "\n"
+  def generate
+    ErbHelper.render_hashes('text/receipts_report.txt.erb', data, template_presentation_context)
   end
-
-
-  def generate_report
-    output = generate_header
-
-    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
-  end
-
-  alias_method :to_s, :generate_report
-  alias_method :call, :generate_report
 end
 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/templates/html/index.html.erb

@@ -0,0 +1,141 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+
+    <meta charset="utf-8">
+
+    <!--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: 36px;
+        background-color: #88c1f7;
+        color: #01182d;
+      }
+
+      h2 {
+        margin-top: 32px;
+        margin-bottom: 12px;
+      }
+
+      .this_page_style {
+        background-color: #88c1f7;
+        color: #01182d;
+        border: 0px;
+      }
+    </style>
+  </head>
+
+  <body>
+
+    <h1><%= chart_of_accounts.entity %></h1>
+    <p class="muted">Reports Generated at <%= DateTime.now.strftime('%Y-%m-%d %H:%M:%S') %> by RockBooks version <%=RockBooks::VERSION %></p>
+
+    <h2>Financial Statements</h2>
+    <div id="financial-statements">
+      <a href='balance_sheet.html' class="btn btn-primary">Balance Sheet</a>
+      <a href='income_statement.html' class="btn btn-primary">Income Statement</a>
+    </div>
+
+
+    <h2>Supporting Documents</h2>
+    <div id="supporting-documents" style="display: inline ">
+      <%
+        subdir_link = ->(name, caption) do
+          dir_name = File.expand_path(File.join(Dir.pwd, name))
+          if Dir.exist?(dir_name)
+            %Q{<a href=#{dir_name} class="btn btn-primary">#{caption}</a>}
+          end
+        end
+      %>
+      <%= subdir_link.('invoices',   'Invoices')   %>
+      <%= subdir_link.('receipts',   'Receipts')   %>
+      <%= subdir_link.('statements', 'Statements') %>
+      <%= subdir_link.('worksheets', 'Worksheets') %>
+    </div>
+
+
+    <h2>All Transactions Reports</h2>
+    <div id="all-transactions">
+      <a href="all_txns_by_acct.html" class="btn btn-primary">By Account</a>
+      <a href="all_txns_by_amount.html" class="btn btn-primary">By Amount</a>
+      <a href="all_txns_by_date.html" class="btn btn-primary">By Date</a>
+    </div>
+
+    <% collapsible_heading = ->(caption, href) do %Q{
+    <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-primary" data-toggle="collapse" href="#{href}" role="button" aria-expanded="false" aria-controls="collapseExample">
+              +/-
+            </a>
+          </div>
+
+          <div class="col-sm10">
+            <h2 style="margin: 0px;">#{caption}</h2>
+          </div>
+        </div>
+      </div>
+    </div>
+    } end %>
+
+    <%= collapsible_heading.('Journal Reports', '#journal-reports') %>
+
+    <div class="collapse" id="journal-reports">
+      <div class="card card-body this_page_style">
+        <ul>
+          <% journals.each do |journal|
+            filespec = journal.short_name + '.html' %>
+            <li><a href="<%= filespec %>" class="this_page_style"><%= journal.title %></a></li>
+          <% end %>
+        </ul>
+      </div>
+    </div>
+
+    <%= collapsible_heading.('Individual Accounts', '#individual-accounts') %>
+
+    <div class="collapse" id="individual-accounts">
+      <div class="card card-body  this_page_style">
+        <ul>
+        <%
+            chart_of_accounts.accounts.each do |account|
+              filespec = File.join('single-account', "acct_#{account.code}.html")
+              caption = "#{account.name} (#{account.code})"
+        %>
+          <li><a href="<%= filespec %>" class="this_page_style"><%= caption %></a></li>
+        <% end %>
+        </ul>
+      </div>
+    </div>
+
+    <%= collapsible_heading.('Other', '#other') %>
+
+    <div class="collapse" id="other">
+      <div class="card card-body this_page_style">
+        <ul>
+          <% if run_options.do_receipts  %>
+            <li><a href="receipts.html" class="this_page_style">Missing and Existing Receipts</a></li>
+          <% end %>
+        </ul>
+      </div>
+    </div>
+
+    <%= collapsible_heading.('Reports in PDF and Text Formats', '#other-formats') %>
+
+    <div class="collapse" id="other-formats">
+      <div class="card card-body this_page_style">
+        <ul>
+          <li><a href="../pdf" class="this_page_style">PDF Format</a></li>
+          <li><a href="../txt" class="this_page_style">Text Format</a></li>
+        </ul>
+      </div>
+    </div>
+
+  </body>
+</html>

data/lib/rock_books/reports/templates/html/report_page.html.erb

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <title></title>
+    <meta name="generator" content="RockBooks Accounting"/>
+  </head>
+  <body>
+    <pre>
+<%=   report_body %>
+    </pre>
+  </body>
+</html>

data/lib/rock_books/reports/templates/text/_receipt_section.txt.erb

@@ -0,0 +1,17 @@
+<% receipt_info_line = ->(info) { sprintf("%-16.16s  %s", info[:journal], info[:receipt]) } -%>
+<% format_heading_line = ->(str1, str2) { sprintf("%-16.16s  %s", str1, str2) } -%>
+
+
+
+<%= name %> Receipts:
+
+<%= format_heading_line.('Journal', 'Receipt Filespec') %>
+<%= format_heading_line.('-------', '----------------') %>
+
+<% if list.empty? -%>
+[None]
+<% else -%>
+<%   list.each do |receipt|  -%>
+<%=    receipt_info_line.(receipt) %>
+<%   end -%>
+<% end -%>