rock_books 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88be3c166ad253939496c416a3fe7fde2e8b9e1054622332cb80dbed50f810da
-  data.tar.gz: 4c50a67abb70676e51004c7da9a2e01135a292e1de6009d0723f257d97dd207a
+  metadata.gz: ce2a320fd7ced495ee7c8ab111413b0b368928c5da80dcb0885d6d1b4bbb22a3
+  data.tar.gz: 607db6692e994e1a4f3a3400cb56a6827e176c707f917e81cb065cf6655cfc8f
 SHA512:
-  metadata.gz: 9aae80ffcb3e9dd87e0e0d8df80e1b58b2e8b7bb9d4cd8fb5a77d7f5421bf961bbc89a50395599b1a061f10d9c2ac442b52ce33fb3bbfc67d47cb8e3f77ee0dc
-  data.tar.gz: a281b5dba15773df5a34a38fc029c36487c638585bfc44a38aa83ecced12ecb1d610ecdb173ea54f3cbb6d58920425a4ed62c5c88aabf0329dabe11ff903e0c0
+  metadata.gz: d29c0671a29843c0dbaeb4521e0d4b1fd61427476cd96ae726a651693975bedd129e82ddd51c1486318878b22fac199733cd2d7fc984d602a9abd682dc652c04
+  data.tar.gz: 6cb2feaf8126241c2211f8188a500cadc6e88302b0671c495060a408075dadf34a3820370348417a5bc2c9d72537c9a0301a77b05f89c392af51b35ad1661bea

data/.gitignore

@@ -11,3 +11,7 @@
 
 # rspec failure tracking
 .rspec_status
+
+Gemfile.lock
+projectFilesBackup
+*.gem

data/LICENSE.txt

@@ -1,21 +1,201 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Keith Bennett
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2019 Bennett Business Solutions, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/RELEASE_NOTES.md

@@ -1,3 +1,19 @@
+## v0.4.0
+
+* Sort unused receipts alphanumerically.
+* Add 'x' receipts option for reporting both missing and unused receipts.
+* Fix: journals were showing journal account instead of the other account in each transaction.
+* Improve Receipts report.
+
+
+## v0.3.0
+
+* Added ability to report unused receipts.
+* Errors now include more context information.
+* Improved chart of accounts validation.
+* Change license from MIT to Apache 2.
+
+
 ## v0.2.1
 
 * Add help text to readme.

data/lib/rock_books/cmd_line/command_line_interface.rb

@@ -49,7 +49,7 @@ Command Line Switches:                    [rock-books version #{RockBooks::VERSI
 
 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)
@@ -317,17 +317,20 @@ When in interactive shell mode:
       raise Error.new("Receipt processing was requested but has been disabled with --no-receipts.")
     end
 
-    missing, existing = book_set.missing_and_existing_receipts
+    missing, existing, unused = book_set.missing_existing_unused_receipts
 
-    print_missing  = -> { puts "Missing Receipts:"; ap missing }
-    print_existing = -> { puts "Existing Receipts:"; ap existing }
+    print_missing  = -> { puts "\n\nMissing Receipts:";  ap missing }
+    print_existing = -> { puts "\n\nExisting Receipts:"; ap existing }
+    print_unused   = -> { puts "\n\nUnused Receipts:";   ap unused }
 
     case options.first.to_s
       when 'a'  # all
         if run_options.interactive_mode
-          { missing: missing, existing: existing }
+          { missing: missing, existing: existing, unused: unused }
         else
-           print_missing.(); print_existing.()
+           print_missing.()
+           print_existing.()
+           print_unused.()
         end
 
       when 'm'
@@ -336,8 +339,16 @@ When in interactive shell mode:
       when 'e'
         run_options.interactive_mode ? existing : print_existing.()
 
+      when 'u'
+        run_options.interactive_mode ? unused : print_unused.()
+
+      when 'x'
+        run_options.interactive_mode ? missing : print_missing.()
+        run_options.interactive_mode ? unused : print_unused.()
+
     else
-      message = "Invalid option for receipts. Must be 'a' for all, 'm' for missing, or 'e' for existing."
+      message = "Invalid option for receipts." + \
+          " Must be 'a' for all, 'm' for missing, 'e' for existing, 'u' for unused, or 'x' for errors (missing/unused)."
       if run_options.interactive_mode
         puts message
       else

data/lib/rock_books/documents/book_set.rb

@@ -35,11 +35,9 @@ module RockBooks
 
     def all_reports(filter = nil)
 
-      periods_to_underscores = ->(string) { string.gsub('.', '_') }
-
       context = report_context
       report_hash = context.journals.each_with_object({}) do |journal, report_hash|
-        key = periods_to_underscores.(journal.short_name).to_sym
+        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)
@@ -49,14 +47,15 @@ module RockBooks
       report_hash[:income_statement] = IncomeStatement.new(context).call
 
       if run_options.do_receipts
-        report_hash[:receipts] = ReceiptsReport.new(context, *missing_and_existing_receipts).call
+        report_hash[:receipts] = ReceiptsReport.new(context, *missing_existing_unused_receipts).call
       end
 
       chart_of_accounts.accounts.each do |account|
-        key = ('acct_' + periods_to_underscores.(account.code)).to_sym
+        key = ('acct_' + account.code).to_sym
         report = TxOneAccount.new(context, account.code).call
         report_hash[key] = report
       end
+
       report_hash
     end
 
@@ -146,16 +145,22 @@ module RockBooks
     end
 
 
-    def missing_and_existing_receipts
-      missing = []; existing = []
+    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|
-          file_exists = File.file?(receipt_full_filespec(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]
+      [missing, existing, unused]
     end
 
     def index_html_content

data/lib/rock_books/documents/chart_of_accounts.rb

@@ -6,7 +6,8 @@ require_relative '../errors/date_range_error'
 module RockBooks
 class ChartOfAccounts
 
-  attr_reader :doc_type, :title, :accounts, :entity, :start_date, :end_date
+  REQUIRED_FIELDS = %i(doc_type  title  accounts  entity  start_date  end_date)
+  REQUIRED_FIELDS.each { |field| attr_reader(field) }
 
 
   def self.from_file(file)
@@ -23,6 +24,14 @@ class ChartOfAccounts
     @accounts = []
     input_lines.each { |line| parse_line(line) }
     # TODO: Add validation for required fields.
+
+    missing_fields = REQUIRED_FIELDS.select do |field|
+      instance_variable_get("@#{field}").nil?
+    end
+
+    unless missing_fields.empty?
+      raise Error.new("Chart of accounts lacks required fields: #{missing_fields.join(', ')}")
+    end
   end
 
 
@@ -36,36 +45,42 @@ class ChartOfAccounts
   end
 
   def parse_line(line)
-    case line.strip
-    when /^@doc_type:/
-      @doc_type = line.split('@doc_type:').last.strip
-    when /^@entity:/
-      @entity ||= line.split('@entity:').last.strip
-    when /^@title:/
-      @title = line.split('@title:').last.strip
-    when /^@start_date:/
-      @start_date = parse_date(line.split('@start_date:').last.strip)
-    when /^@end_date:/
-      @end_date = parse_date(line.split('@end_date:').last.strip)
-    when /^$/
-      # ignore empty line
-    when /^#/
-      # ignore comment line
-    else
-      # this is an account line in the form: 101 Asset First National City Bank
-      # The regex below gets everything before the first whitespace in token 1, and the rest in token 2.
-      matcher = line.match(/^(\S+)\s+(.*)$/)
-      code = matcher[1]
-      rest = matcher[2]
-
-      matcher = rest.match(/^(\S+)\s+(.*)$/)
-      account_type_token = matcher[1]
-      account_type = AccountType.to_type(account_type_token).symbol
-
-      name = matcher[2]
-
-      accounts << Account.new(code, account_type, name)
+    begin
+      case line.strip
+      when /^@doc_type:/
+        @doc_type = line.split('@doc_type:').last.strip
+      when /^@entity:/
+        @entity ||= line.split('@entity:').last.strip
+      when /^@title:/
+        @title = line.split('@title:').last.strip
+      when /^@start_date:/
+        @start_date = parse_date(line.split('@start_date:').last.strip)
+      when /^@end_date:/
+        @end_date = parse_date(line.split('@end_date:').last.strip)
+      when /^$/
+        # ignore empty line
+      when /^#/
+        # ignore comment line
+      else
+        # this is an account line in the form: 101 Asset First National City Bank
+        # The regex below gets everything before the first whitespace in token 1, and the rest in token 2.
+        matcher = line.match(/^(\S+)\s+(.*)$/)
+        code = matcher[1]
+        rest = matcher[2]
+
+        matcher = rest.match(/^(\S+)\s+(.*)$/)
+        account_type_token = matcher[1]
+        account_type = AccountType.to_type(account_type_token).symbol
+
+        name = matcher[2]
+
+        accounts << Account.new(code, account_type, name)
+      end
+    rescue => e
+      puts "Error parsing chart of accounts. Line text is:\n#{line}\n\n"
+      raise
     end
+
   end