rock_books 0.5.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7462246cd8ae62e943c75905486e1732586bd2d9c746c5ea145bd3c751cf637
-  data.tar.gz: 78fa22e6f1186a552d453340d2ac052e342f959ea1fb58c9a8ed6fc0ea4ed37b
+  metadata.gz: ebc94a9d98f612b4c8c13ed48739004619b4bc4d82d484314f50001d6ee784b6
+  data.tar.gz: c565f0945fbecc80f4af87afc67f57a9d73e293e95f096a02c1bdbcc2e7a1afb
 SHA512:
-  metadata.gz: b24be35a05935f8ae333f656d6400523a43a8f118b54cb0d42ecdc64bc405ac1ee5543d4292deef13676f898597ff6548142beb5089dc041fddd3e06bdceb6a0
-  data.tar.gz: 458d376cbad3a5d420c3908c6eb8a33037539b6d43d28f50ca5f55327d76edcd85b4d243a975fe72efdda40e0ea96b64570d3e3e551ef8678e354be0d05e4232
+  metadata.gz: 514102c4e924ee1890a3f0233b7584c63e9a988595e562b7387e2ed696e41ffffd3b48e72fd939442edeef5a146fd473bb9fe0ea2e657d3b3d57bedc748d8472
+  data.tar.gz: 67b889a280ed577daa98358b4a927d83bf9339a35d8e9106aa3127776a6028bda7108a55cd7ee3c4164217e8213728c4d742be44b55317e583d7d604151f1a48

data/README.md

@@ -31,7 +31,10 @@ To simplify its implementation, RockBooks assumes some conventions:
   * `statements` - statements from banks, etc.
   * `worksheets` - spreadsheets, etc., e.g. mileage and per diem calculations
   
-  
+#### Supported Operating Systems
+
+At this time, RockBooks is tested only on Mac OS and Linux. However, it will probably work fine on Windows.
+
 #### 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:
@@ -91,7 +94,6 @@ As a product written by a single developer in his spare time, RockBooks lacks so
 * On the fly data validation
 * Data entry conveniences such as drop down selection lists for data such as accounts
 * Fancy reporting and graphing -- however, RockBooks' bringing links to all the entity's documentation and output into a single web page may well be more useful
-* At this time, RockBooks is only tested on Macs. The input files are plain text files and could be created on any OS, but the validation and report generation might not work. Get in touch with me if you are using a different OS and want to use RockBooks, and are willing and available to test my changes. Linux in particular should be an easy port.
 
 
 ## Installation

data/RELEASE_NOTES.md

@@ -1,3 +1,38 @@
+### 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.
+
+### v0.6.0
+
+* Linux support added!
+
 ### v0.5.0
 
 * Add receipt hyperlinks to HTML output.

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -4,7 +4,7 @@ require 'ostruct'
 
 require_relative '../../rock_books'
 require_relative '../version'
-require_relative '../reports/reporter'
+require_relative '../reports/helpers/text_report_helper'
 require_relative '../helpers/book_set_loader'
 
 module RockBooks
@@ -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!
@@ -298,9 +298,9 @@ When in interactive shell mode:
 
 
   def cmd_d
-    book_set.all_reports($filter).each do |short_name, report_text|
+    book_set.all_reports($filter).each do |short_name, text_report|
       puts "#{short_name}:\n\n"
-      puts report_text
+      puts text_report
       puts "\n\n\n"
     end
     nil
@@ -358,7 +358,7 @@ When in interactive shell mode:
   end
 
   def cmd_w
-    book_set.all_reports_to_files(run_options.output_dir, $filter)
+    BookSetReporter.new(book_set, run_options.output_dir, $filter).generate
     nil
   end
 

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,18 +1,11 @@
-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/balance_sheet'
-require_relative '../reports/income_statement'
-require_relative '../reports/multidoc_transaction_report'
-require_relative '../reports/receipts_report'
-require_relative '../reports/report_context'
-require_relative '../reports/transaction_report'
-require_relative '../reports/tx_by_account'
-require_relative '../reports/tx_one_account'
+require_relative '../reports/book_set_reporter'
 
 require 'erb'
 require 'open3'
@@ -29,107 +22,6 @@ module RockBooks
     end
 
 
-    def report_context
-      @report_context ||= ReportContext.new(chart_of_accounts, journals, 80)
-    end
-
-
-    def all_reports(filter = nil)
-
-      context = report_context
-      report_hash = context.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
-
-
-    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
-
-
-    def all_reports_to_files(directory = '.', filter = nil)
-      reports = all_reports(filter)
-
-      create_directories = -> do
-        %w(txt pdf html).each do |format|
-          dir = File.join(directory, format, SINGLE_ACCT_SUBDIR)
-          FileUtils.mkdir_p(dir)
-        end
-      end
-
-      # "./pdf/short_name.pdf" or "./pdf/single_account/short_name.pdf"
-      build_filespec = ->(directory, short_name, file_format) do
-        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
-
-      create_index_html = -> do
-        filespec = build_filespec.(directory, 'index', 'html')
-        File.write(filespec, index_html_content)
-        puts "Created index.html"
-      end
-
-      write_reports = ->do
-
-        reports.each do |short_name, report_text|
-          txt_filespec  = build_filespec.(directory, short_name, 'txt')
-          html_filespec = build_filespec.(directory, short_name, 'html')
-          pdf_filespec  = build_filespec.(directory, short_name, 'pdf')
-
-          File.write(txt_filespec, report_text)
-          # Use smaller size for the PDF but larger size for the web pages:
-          run_command("textutil -convert html -font 'Courier New Bold' -fontsize 11 #{txt_filespec} -output #{html_filespec}")
-          run_command("cupsfilter #{html_filespec} > #{pdf_filespec}")
-          run_command("textutil -convert html -font 'Courier New Bold' -fontsize 14 #{txt_filespec} -output #{html_filespec}")
-
-          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
-
-      create_directories.()
-      create_index_html.()
-      write_reports.()
-    end
-
-
     def journal_names
       journals.map(&:short_name)
     end
@@ -146,37 +38,6 @@ module RockBooks
       @all_entries ||= Journal.entries_in_documents(journals)
     end
 
-
-    def receipt_full_filespec(receipt_filespec)
-      File.join(run_options.receipt_dir, receipt_filespec)
-    end
-
-
-    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
-
-    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/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
 
 

data/lib/rock_books/documents/journal.rb

@@ -7,7 +7,7 @@ require_relative '../types/acct_amount'
 require_relative '../types/journal_entry_context'
 require_relative 'journal_entry'
 require_relative 'journal_entry_builder'
-require_relative '../reports/reporter'
+require_relative '../reports/helpers/text_report_helper'
 
 module RockBooks
 
@@ -45,9 +45,7 @@ class Journal
   end
 
 
-
-
-    def self.acct_amounts_in_documents(documents, entries_filter = nil, acct_amounts_filter = nil)
+  def self.acct_amounts_in_documents(documents, entries_filter = nil, acct_amounts_filter = nil)
     entries = entries_in_documents(documents, entries_filter)
 
     acct_amounts = entries.each_with_object([]) do |entry, acct_amounts|
@@ -67,12 +65,10 @@ class Journal
   attr_reader :short_name, :account_code, :chart_of_accounts, :date_prefix, :debit_or_credit, :doc_type, :title, :entries
 
   # short_name is a name that will appear on reports identifying the journal from which a transaction comes
-  def initialize(chart_of_accounts, input_lines, short_name = nil)
+  def initialize(chart_of_accounts, input_lines)
     @chart_of_accounts = chart_of_accounts
-    @short_name = short_name
     @entries = []
     @date_prefix = ''
-    @title = ''
     input_lines.each_with_index do |line, linenum|
       context = JournalEntryContext.new(self, linenum + 1, line)
       parse_line(context)
@@ -131,7 +127,6 @@ class Journal
   end
 
 
-
   def acct_amounts
     entries.each_with_object([]) { |entry, acct_amounts|  acct_amounts << entry.acct_amounts }.flatten
   end