rock_books 0.5.0 → 0.8.0

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

@@ -0,0 +1,20 @@
+<%= banner_line %>
+<%= fn_center.(entity || 'Unspecified Entity') %>
+<%= fn_center.(title) %>
+<%= fn_center.(accounting_period) %>
+<% if code && name -%>
+<%= fn_center.("Account: #{name} (#{code})") %>
+<% end -%>
+<% if short_name -%>
+<%= fn_center.("Journal Short Name: #{short_name}") %>
+<% end -%>
+<%= fn_center.(generated) %>
+<%= banner_line %>
+
+
+<% entries.each do |entry| -%>
+<%= fn_format_entry.(entry) %>
+<% end %>
+
+<%= fn_erb_render_binding.('text/_totals.txt.erb', binding) %>
+

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

@@ -0,0 +1,30 @@
+<%= banner_line %>
+<%= fn_center.(entity || 'Unspecified Entity') %>
+<%= fn_center.('Multi Document Transaction Report by Account') %>
+<%= fn_center.(accounting_period) %>
+<%= fn_center.(generated) %>
+
+<%= fn_center.('Source Documents') %>
+
+<% journals.each do |journal| -%>
+<%   short_name = sprintf(short_name_format_string, journal.short_name) -%>
+<%=  fn_center.("#{short_name} -- #{journal.title}") %>
+<% end -%>
+<%= banner_line %>
+
+<% acct_sections.each do |acct| %>
+
+
+<%=   banner_line %>
+<%    total_string = "%.2f" % acct[:total]  -%>
+<%=   fn_center.("Total: #{total_string} -- #{fn_account_code_name_type_string_for_code.(acct[:code])}") %>
+<%=   banner_line %>
+
+<%    acct[:entries].each do |entry| -%>
+<%=     fn_format_multidoc_entry.(entry) %>
+<%    end %>
+<%=   fn_account_total_line.(acct[:code], acct[:total]) %>
+<% end %>
+
+
+<%= fn_erb_render_binding.('text/_totals.txt.erb', binding) %>

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

@@ -0,0 +1,24 @@
+<%= banner_line %>
+<%= fn_center.(entity || 'Unspecified Entity') %>
+<%= fn_center.('Multi Document Transaction Report') %>
+<%= fn_center.(accounting_period) %>
+<%= fn_center.(generated) %>
+
+<%= fn_center.('Source Documents') %>
+
+<% journals.each do |journal| -%>
+<%   short_name = sprintf(short_name_format_string, journal.short_name) -%>
+<%=  fn_center.("#{short_name} -- #{journal.title}") %>
+<% end -%>
+<%= banner_line %>
+
+
+   Date     Document           Amount      Account
+   ----     --------           ------      -------
+
+<% entries.each do |entry| -%>
+<%=  fn_format_multidoc_entry.(entry) %>
+<% end %>
+
+
+<%= fn_erb_render_binding.('text/_totals.txt.erb', binding) %>

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

@@ -0,0 +1,15 @@
+<% create_section = ->(name, list) do
+  fn_erb_render_hashes.('text/_receipt_section.txt.erb', { name: name, list: list }, {})
+end -%>
+<%= banner_line %>
+<%= fn_center.(entity || 'Unspecified Entity') %>
+<%= fn_center.('Receipts Report') %>
+<%= fn_center.(accounting_period) %>
+<%= fn_center.(generated) %>
+<%= banner_line %>
+
+<% # Unlike existing and missing, which arrays of hashes with keys :receipt and :journal, unused is an array of receipt filespecs %>
+
+<%= create_section.('Missing', missing) %>
+<%= create_section.('Unused', unused.map { |receipt| { receipt: receipt, journal: nil } }) %>
+<%= create_section.('Existing', existing) %>

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

@@ -0,0 +1,20 @@
+<%= banner_line %>
+<%= fn_center.(entity || 'Unspecified Entity') %>
+<%= fn_center.("Transactions for Account #{account_string}") %>
+<%= fn_center.(sprintf("Total: %.2f", total)) %>
+<%= fn_center.(accounting_period) %>
+<%= fn_center.(generated) %>
+<%= banner_line %>
+
+
+<% if entries.empty? %>
+There were no transactions for this account.
+
+
+<% else -%>
+<%   entries.each do |entry| -%>
+<%=    fn_format_multidoc_entry.(entry) %>
+<%   end -%>
+
+<%= fn_erb_render_binding.('text/_totals.txt.erb', binding) %>
+<% end %>

data/lib/rock_books/reports/tx_one_account.rb

@@ -1,63 +1,28 @@
+require_relative 'data/tx_one_account_data'
 require_relative '../documents/chart_of_accounts'
 require_relative '../documents/journal'
-require_relative 'reporter'
+require_relative 'helpers/erb_helper'
+require_relative 'helpers/text_report_helper'
 require_relative 'report_context'
 
 module RockBooks
 
   class TxOneAccount
 
-    include Reporter
+    include TextReportHelper
+    include ErbHelper
 
-    attr_reader :context, :account_code, :account
+    attr_reader :context, :account_code, :data
 
 
-    def initialize(report_context, account_code)
+    def initialize(data, report_context)
+      @data = data
       @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")
+    def generate
+      ErbHelper.render_hashes('text/tx_one_account.txt.erb', data, template_presentation_context)
     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(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

@@ -2,6 +2,18 @@ module RockBooks
 
   # The ChartOfAccount holds the set of all these accounts for the entity.
   class Account < Struct.new(:code, :type, :name)
-  end
 
+    PERMITTED_CODE_CHAR_REGEX = /[\w\-\.]$/ # word chars (letters, numbers, underscores), hyphens, periods
+
+    def validate_code(code)
+      unless PERMITTED_CODE_CHAR_REGEX.match(code)
+        raise "Code {#{code}} may only contain letters, numbers, underscores, hyphens, and periods."
+      end
+    end
+
+    def initialize(code, type, name)
+      validate_code(code)
+      super
+    end
+  end
 end

data/lib/rock_books/types/account_type.rb

@@ -12,7 +12,7 @@ module RockBooks
 
     ALL_TYPES = [ASSET, LIABILITY, EQUITY, INCOME, EXPENSE]
 
-    TYPE_HASH = {
+    LETTER_TO_TYPE = {
         'A' => ASSET,
         'L' => LIABILITY,
         'O' => EQUITY,
@@ -20,14 +20,25 @@ module RockBooks
         'E' => EXPENSE
     }
 
-    # Converts strings
-    def self.to_type(string)
-      type = TYPE_HASH[string[0].upcase]
-      if type.nil?
+    SYMBOL_TO_TYPE = {
+        :asset => ASSET,
+        :liability => LIABILITY,
+        :equity => EQUITY,
+        :income => INCOME,
+        :expense => EXPENSE
+    }
+
+    # Converts type upper case letter representation to a type object (e.g. 'A' => ASSET)
+    def self.letter_to_type(string)
+      key = string[0].upcase
+      LETTER_TO_TYPE.fetch(key) do
         raise Error.new("Account type of #{string} not valid. " +
-            "Must be one of #{TYPE_HASH.keys} (#{ALL_TYPES.map(&:singular_name)})")
+            "Must be one of #{LETTER_TO_TYPE.keys} (#{ALL_TYPES.map(&:singular_name)})")
       end
-      type
+    end
+
+    def self.symbol_to_type(symbol)
+      SYMBOL_TO_TYPE[symbol]
     end
   end
 end

data/lib/rock_books/version.rb

@@ -1,3 +1,4 @@
 module RockBooks
-  VERSION = "0.5.0"
+  VERSION = '0.8.0'
+  PROJECT_URL = 'https://github.com/keithrbennett/rock_books'
 end

data/rock_books.gemspec

@@ -30,10 +30,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'awesome_print', '> 0'
+  spec.add_dependency 'amazing_print', '> 0'
+  spec.add_dependency 'os', '> 1.0.0'
   spec.add_dependency 'pry', '> 0.0.0'
+  spec.add_dependency 'prawn', '>= 2.1'
 
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rock_books
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2021-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: awesome_print
+  name: amazing_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
@@ -24,6 +24,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -38,34 +52,48 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 0.0.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -97,6 +125,7 @@ files:
 - README.md
 - RELEASE_NOTES.md
 - Rakefile
+- assets/fonts/JetBrainsMono-Medium.ttf
 - bin/console
 - bin/setup
 - exe/rock_books
@@ -105,11 +134,9 @@ files:
 - lib/rock_books/cmd_line/main.rb
 - lib/rock_books/documents/book_set.rb
 - lib/rock_books/documents/chart_of_accounts.rb
-- lib/rock_books/documents/index.html.erb
 - lib/rock_books/documents/journal.rb
 - lib/rock_books/documents/journal_entry.rb
 - lib/rock_books/documents/journal_entry_builder.rb
-- lib/rock_books/documents/receipts.html.erb
 - lib/rock_books/errors/account_not_found_error.rb
 - lib/rock_books/errors/date_range_error.rb
 - lib/rock_books/errors/error.rb
@@ -118,16 +145,37 @@ files:
 - lib/rock_books/filters/acct_amount_filters.rb
 - lib/rock_books/filters/journal_entry_filters.rb
 - lib/rock_books/helpers/book_set_loader.rb
-- lib/rock_books/helpers/html_helper.rb
 - lib/rock_books/helpers/parse_helper.rb
 - lib/rock_books/reports/balance_sheet.rb
+- lib/rock_books/reports/book_set_reporter.rb
+- lib/rock_books/reports/data/bs_is_data.rb
+- lib/rock_books/reports/data/bs_is_section_data.rb
+- lib/rock_books/reports/data/journal_data.rb
+- lib/rock_books/reports/data/multidoc_txn_by_account_data.rb
+- lib/rock_books/reports/data/multidoc_txn_report_data.rb
+- lib/rock_books/reports/data/receipts_report_data.rb
+- lib/rock_books/reports/data/tx_one_account_data.rb
+- lib/rock_books/reports/helpers/erb_helper.rb
+- lib/rock_books/reports/helpers/receipts_hyperlink_converter.rb
+- lib/rock_books/reports/helpers/text_report_helper.rb
 - lib/rock_books/reports/income_statement.rb
-- lib/rock_books/reports/multidoc_transaction_report.rb
+- lib/rock_books/reports/index_html_page.rb
+- lib/rock_books/reports/journal_report.rb
+- lib/rock_books/reports/multidoc_txn_by_account_report.rb
+- lib/rock_books/reports/multidoc_txn_report.rb
 - lib/rock_books/reports/receipts_report.rb
 - lib/rock_books/reports/report_context.rb
-- lib/rock_books/reports/reporter.rb
-- lib/rock_books/reports/transaction_report.rb
-- lib/rock_books/reports/tx_by_account.rb
+- lib/rock_books/reports/templates/html/index.html.erb
+- lib/rock_books/reports/templates/html/report_page.html.erb
+- lib/rock_books/reports/templates/text/_receipt_section.txt.erb
+- lib/rock_books/reports/templates/text/_totals.txt.erb
+- lib/rock_books/reports/templates/text/balance_sheet.txt.erb
+- lib/rock_books/reports/templates/text/income_statement.txt.erb
+- lib/rock_books/reports/templates/text/journal.txt.erb
+- lib/rock_books/reports/templates/text/multidoc_txn_by_account_report.txt.erb
+- lib/rock_books/reports/templates/text/multidoc_txn_report.txt.erb
+- lib/rock_books/reports/templates/text/receipts_report.txt.erb
+- lib/rock_books/reports/templates/text/tx_one_account.txt.erb
 - lib/rock_books/reports/tx_one_account.rb
 - lib/rock_books/types/account.rb
 - lib/rock_books/types/account_type.rb
@@ -416,7 +464,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Very basic accounting package.

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

@@ -1,156 +0,0 @@
-<!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>