rock_books 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7462246cd8ae62e943c75905486e1732586bd2d9c746c5ea145bd3c751cf637
-  data.tar.gz: 78fa22e6f1186a552d453340d2ac052e342f959ea1fb58c9a8ed6fc0ea4ed37b
+  metadata.gz: 6a7c5d56c718ce58a0fdf060e25be5d3aaf5438ece48a76e02f912e09d203c39
+  data.tar.gz: b467740538a5e89504fc7e2ac6b72190181519471f898a5c26ae7cfa29a53496
 SHA512:
-  metadata.gz: b24be35a05935f8ae333f656d6400523a43a8f118b54cb0d42ecdc64bc405ac1ee5543d4292deef13676f898597ff6548142beb5089dc041fddd3e06bdceb6a0
-  data.tar.gz: 458d376cbad3a5d420c3908c6eb8a33037539b6d43d28f50ca5f55327d76edcd85b4d243a975fe72efdda40e0ea96b64570d3e3e551ef8678e354be0d05e4232
+  metadata.gz: b43529ffa215e13375538d173b939baf659b814dc07a85e7f6c9a695449a86a8dfe49d5134bca22b0c7a479d0707221c4d9bd87efdcef4ac9df95a815b148ca0
+  data.tar.gz: 15776062f22eeb7ad746c303289512c9f81005f04f87518c1738d3923991d45a9ef32951b930946d2c746b6b7a6a52516892f4a8cbf5811ca2d58da4fadff2d5

data/README.md

@@ -31,6 +31,11 @@ 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 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.
+
+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`).
   
 #### Text Files as Input
 
@@ -91,7 +96,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,7 @@
+### 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

@@ -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).call
     nil
   end
 

data/lib/rock_books/documents/book_set.rb

@@ -1,18 +1,12 @@
 require 'awesome_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 +23,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 +39,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/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/version.rb

@@ -1,3 +1,3 @@
 module RockBooks
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/rock_books.gemspec

@@ -30,10 +30,11 @@ 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_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.6.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-02 00:00:00.000000000 Z
+date: 2020-10-30 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
@@ -44,28 +58,28 @@ dependencies:
     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
@@ -105,11 +119,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
@@ -121,8 +133,11 @@ files:
 - 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/income_statement.rb
+- lib/rock_books/reports/index.html.erb
 - lib/rock_books/reports/multidoc_transaction_report.rb
+- lib/rock_books/reports/receipts.html.erb
 - lib/rock_books/reports/receipts_report.rb
 - lib/rock_books/reports/report_context.rb
 - lib/rock_books/reports/reporter.rb
@@ -416,7 +431,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Very basic accounting package.