rock_books 0.6.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81be281ee187aa03b43808391235de30c85e05b7983e243a5df887ec6eb12b2b
-  data.tar.gz: 9069620c1ad95d22e35358caa4ed473899c7a897ad741f679047def6b6fee1e7
+  metadata.gz: 974a379630080a4b8ec174d0b79fe46ce629f0c0fab0c6e147e3b1e4cd472c3f
+  data.tar.gz: 289a1cccf88c3ab27fccac9bfd98c9b4e88f4d14d791d92ebcf52dfd6d7509ee
 SHA512:
-  metadata.gz: e67e7be616f654e5ed67e7f32836b03f56cdfc18821a7d0ee50570aadbb5cb65d0f288d0c4def2999ce2f32b150490e93aa0a6107a1995297b69d178e4ab9de9
-  data.tar.gz: 38819a0cfa909e3171705f11d3151bc2d128d0b946d6a31ff3cb1e6a7278e60670cb820c2fceb8e66be9891891a91dcd317079050675c1b2678b099d26b76676
+  metadata.gz: 57489817b4cae0dd70db00ee4fc10f8fc432ebb1a6ed01a93b6c1f646b681ae5eb456d171c5a7fe2d981bada1771da33eccba7ed08cebceee57925c5c1bb7560
+  data.tar.gz: 2f530db52499773bae28f24f6ee4cf0a243056b6e8df9a83723826b132b4cecc558451bcf357840946e437e6e22740aa4b7d417789df84ec3bbba6050917fe57

data/README.md

@@ -33,10 +33,8 @@ To simplify its implementation, RockBooks assumes some conventions:
   
 #### Supported Operating Systems
 
-At this time, RockBooks is supported only on Mac OS and Linux. (It's really the external tools that is the issue, not the Ruby code.) It should probably work with Windows Subsystem for Linux (WSL) but it hasn't been tested. If you're unsuccessful trying to use RockBooks with WSL, give me as much information as possible and I'll try to resolve the issue.
+At this time, RockBooks is tested only on Mac OS and Linux. However, it will probably work fine on Windows.
 
-If you get an error message saying that an external command is missing, install that command using your system's package manager (e.g. `sudo apt install txt2html`). For `wkhtmltopdf` on Linux, see [https://wkhtmltopdf.org/](https://wkhtmltopdf.org/).
-  
 #### Text Files as Input
 
 Instead of a web interface, data input is done in plain text files. This isn't as fancy but has the following advantages:
@@ -49,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'
@@ -68,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')
@@ -90,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,50 @@
+### 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.
+* Improve report headings.
+* Fix index.html hyperlinks to resource (receipts, invoices, statements, worksheets) directories.
+* Fix cases where split journal entries were not included in the journal report.
+
+
+### v0.8.0
+
+* Add metadata to PDF and HTML reports
+* Add report generation timestamp and accounting period to all reports.
+* Refactoring and cleanup.
+
+
+### v0.7.1
+
+* Refactor report helpers. 
+* Improve/reduce text output during reporting.
+* Add title to HTML reports.
+* Minor fixes.
+
+
+### v0.7.0
+
+* Dependencies on external commands in Linux and Mac OS for generating PDF and HTML files has been eliminated,
+using the prawn gem for PDF and simple ERB templating for HTML.
+* Massive refactoring of reports to separate data generation from presentation.
+* Reports are now computed and then written one at a time. Previously they were all computed, then all written.
+* ERB is now used for generating text reports.
+* Fix receipt hyperlinks in HTML output.
+* Improve some error output.
+* Various minor improvements and bug fixes.
+
+
 ### v0.6.1
 
 * Linux PDF generation fixed by using wkhtmltopdf instead of cupsfilter.
@@ -11,7 +58,7 @@
 * Add receipt hyperlinks to HTML output.
 
 
-## v0.4.0
+### v0.4.0
 
 * Sort unused receipts alphanumerically.
 * Add 'x' receipts option for reporting both missing and unused receipts.
@@ -19,7 +66,7 @@
 * Improve Receipts report.
 
 
-## v0.3.0
+### v0.3.0
 
 * Added ability to report unused receipts.
 * Errors now include more context information.
@@ -27,12 +74,12 @@
 * Change license from MIT to Apache 2.
 
 
-## v0.2.1
+### v0.2.1
 
 * Add help text to readme.
 
 
-## v0.2.0
+### v0.2.0
 
 * Add instruction manual, modify readme.
 * Overhaul generated index.html.
@@ -40,18 +87,18 @@
 * Add validation of transaction dates to ensure within configured date range.
 * Make report hash / OpenStruct keys consistently symbols.
 
-## v0.1.6
+### v0.1.6
 
 * Fixed PDF output; PDF files were corrupt because cupsfilter starting sending
 output to stderr at some point.
 
 
-## v0.1.4, v0.1.5
+### v0.1.4, v0.1.5
 
 * Intermediate unsatisfactory fixes, these versions were published but yanked. 
 
 
-## v0.1.3
+### v0.1.3
 
 * Report output now goes to separate txt, html, and pdf subdirectories.
 * Add vendor.yml to exclude generated report files from language reporting.
@@ -66,17 +113,17 @@ output to stderr at some point.
 * Add 'from_string' methods to Journal and ChartOfAccounts.
 
 
-## v0.1.2
+### v0.1.2
 
 * Improve error message when the needed directories do not exist. 
 
 
-## v0.1.1
+### v0.1.1
 
 * Fix startup error.
 
 
-## v0.1.0
+### v0.1.0
 
 * First release.
 

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -4,7 +4,8 @@ require 'ostruct'
 
 require_relative '../../rock_books'
 require_relative '../version'
-require_relative '../reports/reporter'
+require_relative '../reports/data/receipts_report_data'
+require_relative '../reports/helpers/text_report_helper'
 require_relative '../helpers/book_set_loader'
 
 module RockBooks
@@ -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')
@@ -105,7 +105,7 @@ When in interactive shell mode:
       end
     end
 
-    validate_receipts_dir = -> do
+    validate_receipt_dir = -> do
       File.directory?(options.receipt_dir) ? nil : \
           "Receipts directory '#{options.receipt_dir}' does not exist. "
     end
@@ -114,7 +114,7 @@ When in interactive shell mode:
     output << validate_input_dir.()
     output << validate_output_dir.()
     if run_options.do_receipts
-      output << validate_receipts_dir.()
+      output << validate_receipt_dir.()
     end
 
     output.compact!
@@ -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, report_text|
-      puts "#{short_name}:\n\n"
-      puts report_text
-      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'
@@ -358,7 +350,7 @@ When in interactive shell mode:
   end
 
   def cmd_w
-    BookSetReporter.new(book_set, run_options.output_dir, $filter).call
+    BookSetReporter.new(book_set, run_options.output_dir, $filter).generate
     nil
   end
 
@@ -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/cmd_line/main.rb

@@ -1,4 +1,4 @@
-require 'awesome_print'
+require 'amazing_print'
 require 'optparse'
 require 'pry'
 require 'shellwords'
@@ -67,10 +67,6 @@ class Main
         options.verbose_mode = v
       end
 
-      parser.on('-y', '--[no-]say', 'Say error messages.') do |v|
-        options.say = v
-      end
-
       parser.on('', '--[no-]receipts', 'Include report on existing and missing receipts.') do |v|
         options.do_receipts = v
       end
@@ -101,10 +97,6 @@ class Main
 
       HEREDOC
 
-      if run_options.say
-        `say #{error}`
-      end
-
       exit(-1)
       binding.pry
       raise error

data/lib/rock_books/documents/book_set.rb

@@ -1,10 +1,9 @@
-require 'awesome_print'
+require 'amazing_print'
 require 'os'
 
 require_relative 'chart_of_accounts'
 require_relative 'journal'
 require_relative '../filters/journal_entry_filters'  # for shell mode
-require_relative '../helpers/html_helper'
 require_relative '../helpers/parse_helper'
 require_relative '../reports/book_set_reporter'
 
@@ -39,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/documents/chart_of_accounts.rb

@@ -1,3 +1,4 @@
+require 'stringio'
 require_relative '../types/account'
 require_relative '../types/account_type'
 require_relative '../errors/error'
@@ -10,8 +11,8 @@ class ChartOfAccounts
   REQUIRED_FIELDS.each { |field| attr_reader(field) }
 
 
-  def self.from_file(file)
-    self.new(File.readlines(file).map(&:chomp))
+  def self.from_file(filespec)
+    self.new(File.readlines(filespec).map(&:chomp), filespec)
   end
 
 
@@ -20,11 +21,16 @@ class ChartOfAccounts
   end
 
 
-  def initialize(input_lines)
+  def initialize(input_lines, filespec = nil)
+    @filespec = filespec
     @accounts = []
-    input_lines.each { |line| parse_line(line) }
+    parse_lines(input_lines)
     # TODO: Add validation for required fields.
+    check_for_missing_fields
+  end
+
 
+  def check_for_missing_fields
     missing_fields = REQUIRED_FIELDS.select do |field|
       instance_variable_get("@#{field}").nil?
     end
@@ -35,6 +41,19 @@ class ChartOfAccounts
   end
 
 
+  def parse_lines(input_lines)
+    input_lines.each_with_index do |line, line_num|
+      begin
+        parse_line(line)
+      rescue => e
+        file_message_fragment = (@filespec ? " in file '#{@filespec}'" : '')
+        puts "Error parsing chart of accounts#{file_message_fragment}. Bad line is line ##{line_num}, text is:\n#{line}\n\n"
+        raise
+      end
+    end
+  end
+
+
   def parse_date(date_string)
     # TODO: Add better handling for this error.
     # begin
@@ -69,16 +88,14 @@ class ChartOfAccounts
         rest = matcher[2]
 
         matcher = rest.match(/^(\S+)\s+(.*)$/)
+
         account_type_token = matcher[1]
-        account_type = AccountType.to_type(account_type_token).symbol
+        account_type = AccountType.letter_to_type(account_type_token)
 
         name = matcher[2]
 
-        accounts << Account.new(code, account_type, name)
+        accounts << Account.new(code, account_type.symbol, name)
       end
-    rescue => e
-      puts "Error parsing chart of accounts. Line text is:\n#{line}\n\n"
-      raise
     end
 
   end
@@ -105,7 +122,7 @@ class ChartOfAccounts
 
 
   def report_string
-    result = ''
+    result = StringIO.new
 
     if title
       result << title << "\n\n"
@@ -113,9 +130,9 @@ class ChartOfAccounts
 
     code_width = @accounts.inject(0) { |width, a| width = [width, a.code.length].max }
     format_string = "%-#{code_width}s  %-10.10s  %s\n"
-    accounts.each { |a| result << (format_string % [a.code, a.type.to_s, a.name]) }
+    accounts.each { |a| result << sprintf(format_string, a.code, a.type.to_s, a.name) }
 
-    result
+    result.string
   end