rock_books 0.1.6 → 0.6.0

data/lib/rock_books/documents/journal_entry_builder.rb

@@ -136,17 +136,23 @@ class JournalEntryBuilder < Struct.new(:journal_entry_context)
     tokens = line.split
     acct_amount_tokens = tokens[1..-1]
     date_string = journal.date_prefix + tokens[0]
-    raise_error = -> do
-      raise Error.new("In journal '#{journal.short_name}', date string was '#{date_string}'" +
-          " but should be a valid date in the form YYYY-MM-DD.")
+
+    raise_date_format_error = -> do
+      raise Error.new("Date string was '#{date_string}' but should be a valid date in the form YYYY-MM-DD in " + \
+          "journal '#{journal_entry_context[:journal].title}', line #{journal_entry_context[:linenum]}.")
     end
 
-    raise_error.() if date_string.length != 10
+    raise_date_format_error.() if date_string.length != 10
 
     begin
       date = Date.iso8601(date_string)
     rescue ArgumentError
-      raise_error.()
+      raise_date_format_error.()
+    end
+
+    unless chart_of_accounts.included_in_period?(date)
+      raise DateRangeError.new(date, chart_of_accounts.start_date,
+          chart_of_accounts.end_date, journal_entry_context)
     end
 
     acct_amounts = build_acct_amount_array(date, acct_amount_tokens)

data/lib/rock_books/errors/date_range_error.rb

@@ -0,0 +1,20 @@
+module RockBooks
+  class DateRangeError < RuntimeError
+
+    attr_reader :date, :start_date, :end_date, :extra_string
+
+    def initialize(date, start_date, end_date, extra_string = nil)
+      @date = date
+      @start_date = start_date
+      @end_date = end_date
+      @extra_string = extra_string
+    end
+
+    def to_s
+      s = "#{date} is not within this data set's period of #{start_date} to #{end_date}"
+      s << " (#{extra_string})" if extra_string
+      s << '.'
+      s
+    end
+  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/balance_sheet.rb

@@ -19,14 +19,14 @@ class BalanceSheet
 
 
   def end_date
-    context.end_date || Time.new.to_date
+    context.chart_of_accounts.end_date
   end
 
 
   def generate_header
     lines = [banner_line]
     lines << center(context.entity || 'Unspecified Entity')
-    lines << center("Balance Sheet -- #{end_date}")
+    lines << center("Balance Sheet for Period Ending #{end_date}")
     lines << banner_line
     lines << ''
     lines << ''

data/lib/rock_books/reports/book_set_reporter.rb

@@ -0,0 +1,201 @@
+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 cupsfilter)
+    missing_exes = required_exes.reject { |exe| executable_exists?(exe) }
+    if missing_exes.any?
+      raise "Missing required report generation executable(s): #{missing_exes.join(', ')}"
+    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)
+
+      # Linux & Mac OS
+      cupsfilter = -> { run_command("cupsfilter #{txt_filespec} > #{pdf_filespec}") }
+
+      # Mac OS
+      textutil = ->(font_size) do
+        run_command("textutil -convert html -font 'Courier New Bold' -fontsize #{font_size} #{txt_filespec} -output #{html_filespec}")
+      end
+
+      # Linux
+      txt2html = -> { run_command("txt2html --preformat_trigger_lines 0 #{txt_filespec} > #{html_filespec}") }
+
+      # Use smaller size for the PDF but larger size for the web pages:
+      if OS.mac?
+        textutil.(11)
+        cupsfilter.()
+        textutil.(14)
+      else
+        txt2html.()
+        cupsfilter.()
+      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/income_statement.rb

@@ -17,12 +17,12 @@ module RockBooks
 
 
   def start_date
-    context.start_date || Date.new(1900, 1, 1)
+    context.chart_of_accounts.start_date
   end
 
 
   def end_date
-    context.end_date || Date.new(2100, 1, 1)
+    context.chart_of_accounts.end_date
   end
 
 

data/lib/rock_books/reports/index.html.erb

@@ -0,0 +1,156 @@
+<!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><%= 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-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 ">
+  <%
+    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-success">#{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-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>
+
+<% 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-success" 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>
+<div class="collapse" id="journal-reports">
+  <div class="card card-body this_page_style">
+    <ul>
+      <% journals.each do |journal|
+        filespec = journal.short_name + '.html'
+        caption = "#{journal.title} -- #{journal.short_name} -- #{journal.account_code}"%>
+        <li><a href="<%= filespec %>" class="this_page_style" target="_blank"><%= caption %></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>
+</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" 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>