rock_books 0.1.6 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80a8729354ab4814e6703e459d4a95ef1d2ce537cd71ab3d87c976ed45ec4b8c
-  data.tar.gz: aa7ac7d7ddbf5cc913631085c769e212460e5e317f884e4e847577a057c9ecc4
+  metadata.gz: 6a7c5d56c718ce58a0fdf060e25be5d3aaf5438ece48a76e02f912e09d203c39
+  data.tar.gz: b467740538a5e89504fc7e2ac6b72190181519471f898a5c26ae7cfa29a53496
 SHA512:
-  metadata.gz: b1d621b011fc393ce025cdd0729674eb52dcb09b8e106407a35547115a44a8af21453e1159c921b9604785d27e174af84bbf6819e3b61896db0821d89e7fbe87
-  data.tar.gz: b73f51018ef14b8db92d2e96d72ee5d08419ec119d9da753cd91861b7df827acfd922b70930f02a2fa51e3287b1c025935dc5605c2997f65ae1b9c6ea812b7ac
+  metadata.gz: b43529ffa215e13375538d173b939baf659b814dc07a85e7f6c9a695449a86a8dfe49d5134bca22b0c7a479d0707221c4d9bd87efdcef4ac9df95a815b148ca0
+  data.tar.gz: 15776062f22eeb7ad746c303289512c9f81005f04f87518c1738d3923991d45a9ef32951b930946d2c746b6b7a6a52516892f4a8cbf5811ca2d58da4fadff2d5

data/.gitignore

@@ -7,6 +7,11 @@
 /spec/reports/
 /tmp/
 /.idea/
+.DS_Store
 
 # 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/README.md

@@ -1,183 +1,105 @@
 # RockBooks
 
-A super primitive bookkeeping system using text files as input documents and console output
-for reporting.
+| Note: |
+| ---- |
+| The [manual.md file](manual.md) has more detailed information about RockBooks usage. |
 
-A supreme goal of this project is to give _you_ control over your data. 
-Want to serialize it to YAML, JSON, CSV, or manipulate it in your custom code?
-No problem! 
+**A simple but useful accounting software application for very small entities.**
 
-It assumes the traditional double entry bookkeeping system, with debits and credits.
-In general, assets and expenses are debit balance accounts, and income, liabilities and equity
-are credit balance accounts.
+A supreme goal of this project is to give _you_ control over your data. Want to serialize it to YAML, JSON, CSV, or manipulate it in your custom code? No problem! 
 
-So, to really have this software make sense to you, you should probably understand
-the double entry bookkeeping paradigm pretty well. 
+After entering the data in input files, there is a processing step (a single command) that is done to validate the input and generate the reports and home page. (This could be automated using `guard`, etc.) An `index.html` is generated that links to the reports, input documents, receipts, invoices, statements, worksheets, etc., in a unified interface. This `index.html` can be opened locally using a `file:///` URL but the directory tree can easily be copied to a web server for shared and/or remote access.
 
-# Terminology Usage
+#### How RockBooks Is Different
 
-* document - a RockBooks logical document such as a chart of accounts, a journal, etc.,
-usually containing information parsed from a data file
+Mainstream accounting packages like QuickBooks have lots of bells and whistles, but are opinionated and not customizable; if you want to use your data _your_ way, or do something differently, you're out of luck.
 
-* data file - a RockBooks data file, which is a text file with the extension `.txt`
+RockBooks is different in many ways.
 
+The software is in the form of Ruby classes and objects that can be incorporated into your own code for your own customizations. The data is available to programmers as Ruby objects (and therefore JSON, YAML, etc.) In addition, RockBooks could be used as an engine with alternate pluggable UI's. Feel free to write a web app for inputting the data!
 
-## Data File Format
+Rather than hiding accounting concepts from the user, RockBooks embraces and exposes them. There is no attempt to hide the traditional double entry bookkeeping system, with debits and credits. Accounting terminology is used throughout (e.g. "chart of accounts", "journals"). Some understanding of accounting or bookkeeping principles is helpful but not absolutely necessary.
 
-Lines beginning with `#` will be ignored.
+To simplify its implementation, RockBooks assumes some conventions:
 
-Data lines that contain the value of document properties,
-as opposed to transactions, etc., will be expressed as lines beginning with `@`:
+* Input documents (chart of accounts, journals) are assumed to be in the `rockbooks-inputs` directory.
 
-```
-@doc_type: journal
-@title: "ABC Bank Checking Account Disbursements Journal"
-@account: ck_abc
-```
-
-Repeating data types such as entries in journals, and accounts in the chart of accounts,
-should in general be input after the properties.
-
-Data lines will contain fields that an be separated with an arbitrary number of spaces, e.g.:
-
-```
-2018-05-18  123.45 703
-```
-
-In journals, all entries will begin with dates, and all dates begin with numerals, so the
-presence of a numeral in the first column will be interpreted as the beginning of a new
-transaction (entry). Any lines following it not beginning with a `#` or number will be
-assumed to be the textual description of the transaction, and will be saved along with
-its other data.
-
-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
-automatically prepended. So, for example, a journal might contain the following lines:
-
-```
-@date_prefix: 2018-
-# ...more lines...
-05-29   37.50   ofc.spls
-05-30   22.20   tr.taxi
-```
-
-All date strings must use the format `YYYY-MM-DD`, because that's what will be expected
-by the application when it converts the date strings into numeric dates.
-
-
-
-### Chart of Accounts
-
-Pretty much everything in this application assumes the presence of a chart of accounts
-listing the accounts, including their codes, types, and names.
-
-You'll need to provide a chart of accounts file that includes the following line in the header:
-
-`@document_type: chart_of_accounts`
-
-This file should contain the accounts
-that will be used. Each account should contain the following fields:
+* The following directories are assumed to contain the appropriate content, or nothing at all. They are simply presented on the reports web page as directories in the filesystem, so you can feel free to organize files in subdirectories as you see fit:
 
-| Property Name | Description |
-| ------------- | ------------- |
-| code          | a short string with which to identify an account, e.g. `ret.earn` for retained earnings
-| type          | 'A' for asset, 'L' for liability, 'O' for (owners) equity, 'I' for income, and 'E' for expenses.
-| name          | a longer more descriptive name, used in reports, so no more than 30 or so characters long is recommended
+  * `receipts` - receipts documenting expenses & other transactions
+  * `invoices` - sales/services invoices
+  * `statements` - statements from banks, etc.
+  * `worksheets` - spreadsheets, etc., e.g. mileage and per diem calculations
   
+#### Supported Operating Systems
 
-So, the chart of accounts data might include something like this:
+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.
 
-```
-ck.xyz       A   XYZ Bank Checking Account
-loan.owner   L   Loan Payable to Owner
-o.equity     O   Owner's Equity
-sls.cons     I   Consulting Sales
-tr.airfare   E   Travel - Air Fare
-```
-
-Although hyphens and underscores are typically used to logically separate string fragments,
-we recommend periods; they're much easier to type, and you'll be doing a lot of that.
-
-There is no maximum length for account codes, and reports will automatically align based
-on the longest account code. However, keep in mind that you will need to type these codes,
-and they will consume space in reports.
-
-### Journals
-
-Journals (also referred to as _documents_ by this application)
-are used to record transactions of, for example:
-
-* cash disbursements (expenditures for a single checking account)
-* cash receipts (funds coming into a single checking account)
-* combined cash disbursements and receipts
-* a credit card account
-* a Paypal account
-* sales
+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
 
-Each journal data file needs to contain:
+Instead of a web interface, data input is done in plain text files. This isn't as fancy but has the following advantages:
 
-`@doc_type: journal`
+* Data can be tracked in git or other version control software, offering a readable and easily accessible audit trail, manageable collaboration, with free cloud backup including history with Github, Gitlab, Bitbucket, etc.
 
-Also, it needs to identify the code of the account the journal is representing.
-So for example, if it is a journal of a PayPal account, and the PayPal 
-account's code is `paypal`, then you'll need a line like this in your journal file:
+* Text notes of arbitrary length can be included in input files, and included or excluded in reports. This can be useful, for example, in explaining the context of a transaction more thoroughly than could be done in a conventional accounting application. This can be helpful to accountants, auditors, etc., saving the time, and you money, and can demonstrate your helpfulness and transparency.
 
-`@account_code: paypal`
+* Data will be longer lived, as it is readable and printable without any special software.
 
-For your convenience, when entering transactions in a journal (but _not_ a _general_ journal),
-you may enter all numbers going in the direction natural for that journal as positive numbers.
+* Users can use their favorite text editors.
 
-For example, a _Cash Disbursements Journal_ (something like a
-check register) may contain a transaction like this:
+* All data entry can be done without moving the hands away from the keyboard.
 
-```
-05-29   37.50   ofc.spls
-```
 
-There may be many transactions in your journal, and it would be cumbersome to have to
-type minus signs in front of all of them if they were credits.
+#### The Accounting Period
 
-Because of this, the program allows you to configure each journal as to the direction
-(debit or credit) of the transaction. This is done with the `@debit_or_credit` property.
+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.
 
-For an asset journal whose numbers will be crediting the main account
-(e.g. a cash disbursements journal whose entries will primarily be crediting
-the cash account), you would set the property to `debit`:
+#### RockBooks Help Text
 
 ```
-@debit_or_credit: debit
+Command Line Switches:                    [rock-books version 0.2.1 at https://github.com/keithrbennett/rock_books]
+
+-i   input directory specification, default: './rockbooks-inputs'
+-o   output (reports) directory specification, default: './rockbooks-reports'
+-r   receipts directory, default: './receipts'
+-s   run in shell mode
+
+Commands:
+
+rec[eipts]                - receipts: a/:a all, m/:m missing, e/:e existing
+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
+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')
+
+When in interactive shell mode:
+* use quotes for string parameters such as method names.
+* for pry commands, use prefix `%`.
+* you can use the global variable $filter to filter reports
 ```
 
+----
 
-#### General Journal
+## What RockBooks Is Not
 
-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
-pairs, where positive numbers will result in debits, and negative numbers will result in credits, e.g.:
-
-```
-03-10   tr.perdiem.mi   495.00   loan.to.sh  -495.00
-Per Diem allowance for conference trip
-```
+As a product written by a single developer in his spare time, RockBooks lacks some conveniences of traditional accounting software programs, such as:
 
+* Import of data from financial institutions
+* 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
 
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rock_books'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
     $ gem install rock_books
 
 ## Contributing