rock_books 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9e80afcb8f6644e9fa3cc629a4cac6d723843d1609bab54641c77b779fba89
-  data.tar.gz: db3b9f6979da2408202715737fedf5f69b55d44657622364706d7597eac827bf
+  metadata.gz: 974a379630080a4b8ec174d0b79fe46ce629f0c0fab0c6e147e3b1e4cd472c3f
+  data.tar.gz: 289a1cccf88c3ab27fccac9bfd98c9b4e88f4d14d791d92ebcf52dfd6d7509ee
 SHA512:
-  metadata.gz: de4ffe3cbf12789ffa874565e7e60299290e3cc8888a41a2756f0ef7b405152997286f2d4a0b9dd2c00aeb75afc8d2bb10245ae7e747492b14c9da4393948d79
-  data.tar.gz: c19a5de4f323c6d50a6a684f87b38e3f12dab1cc55accbeed9ec8560521f02932bf8b6b8788069807496d37e4ff3c6d89056fc16cfcddf87f1c14d1af8e002da
+  metadata.gz: 57489817b4cae0dd70db00ee4fc10f8fc432ebb1a6ed01a93b6c1f646b681ae5eb456d171c5a7fe2d981bada1771da33eccba7ed08cebceee57925c5c1bb7560
+  data.tar.gz: 2f530db52499773bae28f24f6ee4cf0a243056b6e8df9a83723826b132b4cecc558451bcf357840946e437e6e22740aa4b7d417789df84ec3bbba6050917fe57

data/README.md

@@ -47,17 +47,17 @@ Instead of a web interface, data input is done in plain text files. This isn't a
 
 * Users can use their favorite text editors.
 
-* All data entry can be done without moving the hands away from the keyboard.
+* All data entry can be done without moving the hands away from the keyboard (assuming the editor software supports it, as does `vim`).
 
 
 #### The Accounting Period
 
-There is no handling of end of year closings or the like; the entire set of data in the input files is considered included in the reporting period when generating the reports. Therefore, the best approach is to create a new data set for each year. The chart of accounts and journal files can be copied and modified as necessary.
+There is no handling of end of year closings or the like; the entire set of data in the input files is considered included in the reporting period when generating the reports. Therefore, the best approach is to create a new data set for each year. The chart of accounts and journal files can be copied from the previous year and modified as necessary.
 
 #### RockBooks Help Text
 
 ```
-Command Line Switches:                    [rock-books version 0.2.1 at https://github.com/keithrbennett/rock_books]
+Command Line Switches:                    [rock-books version 0.10.0 at https://github.com/keithrbennett/rock_books]
 
 -i   input directory specification, default: './rockbooks-inputs'
 -o   output (reports) directory specification, default: './rockbooks-reports'
@@ -66,14 +66,13 @@ Command Line Switches:                    [rock-books version 0.2.1 at https://g
 
 Commands:
 
-rec[eipts]                - receipts: a/:a all, m/:m missing, e/:e existing
+rec[eipts]                - receipts: a/:a all, m/:m missing, e/:e existing, u/:u unused
 rep[orts]                 - return an OpenStruct containing all reports (interactive shell mode only)
-d[isplay_reports]         - display all reports on stdout
 w[rite_reports]           - write all reports to the output directory (see -o option)
 c[hart_of_accounts]       - chart of accounts
 h[elp]                    - prints this help
 jo[urnals]                - list of the journals' short names
-proj[ect_page]            - open the RockBooks Github project page in a browser
+proj[ect_page]            - prints the RockBooks Github project page URL
 rel[oad_data]             - reload data from input files
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
 x[it]                     - exits this program (interactive shell mode only) (see also 'q')
@@ -88,7 +87,8 @@ When in interactive shell mode:
 
 ## What RockBooks Is Not
 
-As a product written by a single developer in his spare time, RockBooks lacks some conveniences of traditional accounting software programs, such as:
+As a product written by a single developer in his spare time, 
+RockBooks lacks many conveniences of traditional accounting software programs, such as:
 
 * Import of data from financial institutions
 * On the fly data validation

data/RELEASE_NOTES.md

@@ -1,3 +1,15 @@
+### v0.10.0
+
+* Add invoice hyperlinks to generated HTML.
+* Improve documentation.
+* Add progress bar to report generation.
+* Change 'proj[ect]' command to print the project home page URL, rather than call `open` on it. This makes the command useful in more cases and removes environment dependency.
+* Remove interactive 'display reports' option. It's not that useful and easy enough to write all reports to disk and selectively view them.
+* Fix rep[orts] interactive option.
+* Fix and refactor handling of receipt data on command line.
+* Add styling to report HTML pages, mostly for centering the reports, increasing the font size, and providing a faint blue background.
+
+
 ### v0.9.0
 
 * Center generated index.html's content.

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -4,6 +4,7 @@ require 'ostruct'
 
 require_relative '../../rock_books'
 require_relative '../version'
+require_relative '../reports/data/receipts_report_data'
 require_relative '../reports/helpers/text_report_helper'
 require_relative '../helpers/book_set_loader'
 
@@ -51,12 +52,11 @@ Commands:
 
 rec[eipts]                - receipts: a/:a all, m/:m missing, e/:e existing, u/:u unused
 rep[orts]                 - return an OpenStruct containing all reports (interactive shell mode only)
-d[isplay_reports]         - display all reports on stdout
 w[rite_reports]           - write all reports to the output directory (see -o option)
 c[hart_of_accounts]       - chart of accounts
 h[elp]                    - prints this help
 jo[urnals]                - list of the journals' short names
-proj[ect_page]            - open the RockBooks Github project page in a browser
+proj[ect_page]            - prints the RockBooks Github project page URL
 rel[oad_data]             - reload data from input files
 q[uit]                    - exits this program (interactive shell mode only) (see also 'x')
 x[it]                     - exits this program (interactive shell mode only) (see also 'q')
@@ -281,7 +281,7 @@ When in interactive shell mode:
   # All reports as Ruby objects; only makes sense in shell mode.
   def cmd_rep
     unless run_options.interactive_mode
-      raise Error.new("Option 'all_reports' is only available in shell mode. Try 'display_reports' or 'write_reports'.")
+      raise Error.new("Option 'all_reports' is only available in shell mode. Try 'write_reports'.")
     end
 
     os = OpenStruct.new(book_set.all_reports($filter))
@@ -297,18 +297,8 @@ When in interactive shell mode:
   end
 
 
-  def cmd_d
-    book_set.all_reports($filter).each do |short_name, text_report|
-      puts "#{short_name}:\n\n"
-      puts text_report
-      puts "\n\n\n"
-    end
-    nil
-  end
-
-
   def cmd_proj
-    `open https://github.com/keithrbennett/rock_books`
+    puts 'https://github.com/keithrbennett/rock_books'
   end
 
 
@@ -317,7 +307,9 @@ When in interactive shell mode:
       raise Error.new("Receipt processing was requested but has been disabled with --no-receipts.")
     end
 
-    missing, existing, unused = book_set.missing_existing_unused_receipts
+    data = ReceiptsReportData.new(all_entries, run_options.receipt_dir).fetch
+
+    missing, existing, unused = data[:missing], data[:existing], data[:unused]
 
     print_missing  = -> { puts "\n\nMissing Receipts:";  ap missing }
     print_existing = -> { puts "\n\nExisting Receipts:"; ap existing }
@@ -326,11 +318,11 @@ When in interactive shell mode:
     case options.first.to_s
       when 'a'  # all
         if run_options.interactive_mode
-          { missing: missing, existing: existing, unused: unused }
+          data
         else
-           print_missing.()
-           print_existing.()
-           print_unused.()
+          print_missing.()
+          print_existing.()
+          print_unused.()
         end
 
       when 'm'
@@ -372,7 +364,6 @@ When in interactive shell mode:
     @commands_ ||= [
         Command.new('rec', 'receipts',          -> (*options)  { cmd_rec(options)  }),
         Command.new('rep', 'reports',           -> (*_options) { cmd_rep           }),
-        Command.new('d',   'display_reports',   -> (*_options) { cmd_d             }),
         Command.new('w',   'write_reports',     -> (*_options) { cmd_w             }),
         Command.new('c',   'chart_of_accounts', -> (*_options) { cmd_c             }),
         Command.new('jo',  'journals',          -> (*_options) { cmd_j             }),

data/lib/rock_books/documents/book_set.rb

@@ -38,6 +38,10 @@ module RockBooks
       @all_entries ||= Journal.entries_in_documents(journals)
     end
 
+
+    def all_reports(filter = nil)
+      BookSetReporter.new(self, nil, filter).get_all_report_data
+    end
   end
 end
 

data/lib/rock_books/reports/book_set_reporter.rb

@@ -16,13 +16,14 @@ require_relative 'helpers/text_report_helper'
 require_relative 'helpers/receipts_hyperlink_converter'
 
 require 'prawn'
+require 'tty-progressbar'
 
 module RockBooks
 class BookSetReporter
 
   extend Forwardable
 
-  attr_reader :book_set, :context, :filter, :output_dir
+  attr_reader :book_set, :context, :filter, :output_dir, :progress_bar
 
   def_delegator :book_set, :all_entries
   def_delegator :book_set, :journals
@@ -37,6 +38,7 @@ class BookSetReporter
     @output_dir = output_dir
     @filter = filter
     @context = ReportContext.new(book_set.chart_of_accounts, book_set.journals, 80)
+    @progress_bar = TTY::ProgressBar.new("[:bar] :caption", total: report_count + 10)
   end
 
 
@@ -49,9 +51,44 @@ class BookSetReporter
     do_transaction_reports
     do_single_account_reports
     do_receipts_report
+    progress_bar.advance(caption: 'Finished generating reports.')
+    progress_bar.finish
   end
 
 
+  def report_count
+    bal_sheet_income_statement = 2
+    journal_count = journals.size
+    txn_report_count = 3
+    single_account_count = chart_of_accounts.accounts.size
+    receipt_report_count = 1
+    bal_sheet_income_statement + journal_count + txn_report_count + single_account_count + receipt_report_count
+  end
+
+
+  def get_all_report_data
+    reports = {}
+
+    reports[:bs_is] = BsIsData.new(context)
+
+    reports[:journals] = journals.each_with_object({}) do |journal, journals|
+      journals[journal.short_name] = JournalData.new(journal, context, filter).fetch
+    end
+
+    reports[:txn_reports] = {
+      by_account: MultidocTxnByAccountData.new(context).fetch,
+      by_date: MultidocTxnReportData.new(context, :date, filter).fetch,
+      by_amount: MultidocTxnReportData.new(context, :amount, filter).fetch
+    }
+
+    reports[:single_accounts] = chart_of_accounts.accounts.each_with_object({}) do |account, single_accts|
+      single_accts[account.code.to_sym] = TxOneAccountData.new(context, account.code).fetch
+    end
+
+    reports[:receipts] = ReceiptsReportData.new(book_set.all_entries, run_options.receipt_dir).fetch
+    reports
+  end
+
   # All methods after this point are private.
 
   private def do_statements
@@ -181,38 +218,15 @@ class BookSetReporter
     create_pdf_report.()
     create_html_report.()
 
-    puts "Created text, PDF, and HTML reports for #{short_name}."
-  end
-
-
-  private def missing_existing_unused_receipts
-    missing_receipts = []
-    existing_receipts = []
-    receipt_full_filespec = ->(receipt_filespec) { File.join(run_options.receipt_dir, receipt_filespec) }
-
-    # We will start out putting all filespecs in the unused array, and delete them as they are found in the transactions.
-    unused_receipt_filespecs = Dir['receipts/**/*'].select { |s| File.file?(s) } \
-        .sort \
-        .map { |s| "./" +  s }  # Prepend './' to match the data
-
-    all_entries.each do |entry|
-      entry.receipts.each do |receipt|
-        filespec = receipt_full_filespec.(receipt)
-        unused_receipt_filespecs.delete(filespec)
-        file_exists = File.file?(filespec)
-        list = (file_exists ? existing_receipts : missing_receipts)
-        list << { receipt: receipt, journal: entry.doc_short_name }
-      end
-    end
-    [missing_receipts, existing_receipts, unused_receipt_filespecs]
+    progress_bar.advance(caption: "Generating report: #{short_name}")
   end
 
 
   private def create_index_html
+    progress_bar.advance(caption: 'Generating index.html')
     filespec = build_filespec(output_dir, 'index', 'html')
     content = IndexHtmlPage.new(context, html_metadata_comment('index.html'), run_options).generate
     File.write(filespec, content)
-    puts "Created index.html"
   end
 end
 end

data/lib/rock_books/reports/helpers/receipts_hyperlink_converter.rb

@@ -6,6 +6,7 @@ class ReceiptsHyperlinkConverter
   end
 
   RECEIPT_REGEX = /Receipt:\s*(\S*)/
+  INVOICE_REGEX = /Invoice:\s*(\S*)/
 
   attr_reader :html_string, :num_dirs_up
 
@@ -16,14 +17,19 @@ class ReceiptsHyperlinkConverter
 
 
   def convert
-    html_string.split("\n").map do |line|
-      matches = RECEIPT_REGEX.match(line)
+    process_link_type = ->(line, regex, dir_name) do
+      matches = regex.match(line)
       if matches
-        listed_receipt_filespec = matches[1]
-        receipt_anchor_line(line, listed_receipt_filespec)
+        listed_filespec = matches[1]
+        anchor_line(line, listed_filespec, dir_name)
       else
         line
       end
+    end
+
+    html_string.split("\n").map do |line|
+      line = process_link_type.(line, RECEIPT_REGEX, 'receipts')
+      process_link_type.(line, INVOICE_REGEX, 'invoices')
     end.join("\n")
   end
 
@@ -32,16 +38,22 @@ class ReceiptsHyperlinkConverter
   #   the processed link should be '../../../receipts/[receipt_filespec]'
   # else it's in DATA_DIR/rockbooks-reports/html, and
   #   the processed link should be '../../receipts/[receipt_filespec]'
-  private def processed_receipt_filespec(listed_receipt_filespec)
-    File.join(('../' * num_dirs_up), 'receipts', listed_receipt_filespec)
+  #
+  # `dir_name` will be 'receipts' or 'invoices'
+  private def dirized_filespec(listed_filespec, dir_name)
+    File.join(('../' * num_dirs_up), dir_name, listed_filespec)
   end
 
-  private def receipt_anchor_line(line, listed_receipt_filespec)
+  private def anchor_line(line, listed_filespec, dir_name)
+    label = {
+      'receipts' => 'Receipt',
+      'invoices' => 'Invoice'
+    }.fetch(dir_name)
+
     line.gsub( \
-          /Receipt:\s*#{listed_receipt_filespec}/, \
-          %Q{Receipt: <a href="#{processed_receipt_filespec(listed_receipt_filespec)}">#{listed_receipt_filespec}</a>})
+          /#{label}:\s*#{listed_filespec}/, \
+          %Q{#{label}: <a href="#{dirized_filespec(listed_filespec, dir_name)}">#{listed_filespec}</a>})
   end
-
 end
 end
 

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

@@ -4,6 +4,18 @@
   <head>
     <title><%= title %></title>
     <meta name="generator" content="RockBooks Accounting"/>
+    <style>
+        body {
+            padding: 36px;
+            background-color: #d5f3fb;
+            color: #01182d;
+            max-width: 1024px;
+            float: none !important;
+            margin: 0 auto !important;
+            border: 0px;
+            font-size: 15px !important;
+        }
+    </style>
   </head>
   <body>
     <pre>

data/lib/rock_books/version.rb

@@ -1,4 +1,4 @@
 module RockBooks
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
   PROJECT_URL = 'https://github.com/keithrbennett/rock_books'
 end

data/manual.md

@@ -15,7 +15,7 @@ Install the RockBooks software:
 It is recommended that you create a directory structure such as this:
 
 ```.
-├── 2018-xyz-inc
+├── 2021-xyz-inc
 │   ├── invoices
 │   ├── receipts
 │   ├── references
@@ -44,9 +44,9 @@ Feel free to organize your files in subdirectories of these directories in whate
 
 ### Version Control
 
-Tracking this directory tree with version control software such as `git` in a private repository is _highly_ recommended because it provides:
+Tracking this directory tree with version control software such as `git` is _highly_ recommended because it provides:
 
-* free cloud backup with Github, Gitlab, and/or Bitbucket
+* free cloud backup in a private repository with Github, Gitlab, and/or Bitbucket
 * an audit trail with human readable diffs
 * manageable collaboration
 
@@ -58,7 +58,7 @@ You will need a chart of accounts in the `rockbooks-inputs` directory. A sample
 
 ### Journals
 
-You will need journals. Usually there would be one journal per external financial institution accounts, such as checking and credit card accounts. Samples have been provided in the sample_data/minimal/rockbooks-inputs directory of the gem:
+You will need journals. Usually there would be one journal per external financial institution account, such as checking and credit card accounts. Samples have been provided in the sample_data/minimal/rockbooks-inputs directory of the gem:
 
 * [Checking](sample_data/minimal/rockbooks-inputs/2018-xyz-checking-journal.txt)
 * [Credit Card](sample_data/minimal/rockbooks-inputs/2018-xyz-visa-journal.txt)
@@ -92,10 +92,8 @@ Fields are space separated; any number of spaces can be used.
 
 #### Comment Lines
 
-Lines beginning with `#` will be ignored when the input data is parsed. Comment lines are useful for:
- 
-* explanations of the input itself
-* information that you would like to be available for deeper research or examination but not printed in the reports
+Lines beginning with `#` will be ignored when the input data is parsed. Therefore, comment lines will not be included in the generated reports. Comment lines are useful for explanations that are too verbose for the reports, but that should be available for deeper research. An example might be several lines of explanatory notes about an unusual transaction.
+
 
 #### Document Properties
 
@@ -110,19 +108,19 @@ as opposed to input records, will be expressed as lines beginning with `@`:
 
 #### Input Records
 
-Input records are multiple records for the type appropriate to the document:
+Input records are records of a type appropriate to the document:
 
 * chart of accounts - each account
 * journals - each transaction
 
-Input records are, in general, entered into the text files after all properties. One exception is that the `@date_prefix` is often specified in multiple places in the journal, usually with a new month (e.g. `@date_prefix: 2018-11`).
+Input records are, in general, entered into the text files after all properties. One exception is that the `@date_prefix` is often specified in multiple places in the journal, usually with a new month (e.g. `@date_prefix: 2021-11`).
 
 
 
 Data lines will contain fields that an be separated with an arbitrary number of spaces, e.g.:
 
 ```
-2018-05-18   123.45   supplies 
+2021-05-18   123.45   supplies 
 ```
 
 In journals, all entries will begin with dates, and all dates begin with numerals, so the
@@ -133,11 +131,11 @@ its other data and included in reports.
 
 In order to make the entry of dates more convenient, many documents will support
 a `@date_prefix` property that will be prepended to dates. For example, if this prefix
-contains `2018-`, then subsequent dates must exclude that prefix since it will be
+contains `2021-`, then subsequent dates must exclude that prefix since it will be
 automatically prepended. So, for example, a journal might contain the following lines:
 
 ```
-@date_prefix: 2018-
+@date_prefix: 2021-
 # ...more lines...
 05-29   37.50   ofc.spls
 05-30   22.20   tr.taxi
@@ -236,9 +234,8 @@ the cash account), you would set the property to `debit`:
 
 #### General Journal
 
-The general journal is a special form of journal that does not have a primary account.
-
-In this journal, debits and credits need to be specified literally as account code/amount
+Since the general journal is a special form of journal that does not have a primary account, 
+debits and credits need to be specified literally as account code/amount
 pairs, where positive numbers will result in debits, and negative numbers will result in credits, e.g.:
 
 ```

data/rock_books.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'os', '> 1.0.0'
   spec.add_dependency 'pry', '> 0.0.0'
   spec.add_dependency 'prawn', '>= 2.1'
+  spec.add_dependency 'tty-progressbar'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", ">= 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rock_books
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amazing_print
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: tty-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement