Merge pull request #34 from countvajhula/sid-refactor-3

Refactor #3

Dockerfile

@@ -6,10 +6,7 @@ RUN apt-mark hold git-man
 
 # Copies your code file from your action repository to the filesystem path `/` of the container
 COPY entrypoint.sh /entrypoint.sh
-COPY oldabe/__init__.py /oldabe/__init__.py
-COPY oldabe/money_in.py /oldabe/money_in.py
-COPY oldabe/money_out.py /oldabe/money_out.py
-COPY oldabe/models.py /oldabe/models.py
+COPY oldabe /
 
 # Code file to execute when the docker container starts up (`entrypoint.sh`)
 ENTRYPOINT ["/entrypoint.sh"]

docs/oldabe.scrbl

@@ -25,7 +25,7 @@ One of the defining properties of ABE is that all accounting is publicly conduct
 
 @section{Inputs}
 
-Old Abe considers precisely three inputs in doing all of its accounting, and it will be useful to keep these in mind as we learn more:
+Old Abe considers precisely four inputs in doing all of its accounting, and it will be useful to keep these in mind as we learn more:
 
 @itemlist[
 #:style 'ordered
@@ -56,7 +56,7 @@ Current accounting flows are a mix of manual and automated actions. Old Abe is n
 
 @subsection{Payment}
 
-When someone makes a payment to a project, Old Abe allocates portions of that payment to project contributors and creates a report that tells maintainers how much money the project owes to each individual contributor. We'll get deep into the weeds of how it does that in a moment. If the incoming payment represents an investment (that is, it brings the payer's total amount paid above the project price), the payer is considered a project contributor. The system adds them to the attributions file with a share equal to their investment (or increases their pre-existing attributive share). The project valuation is increased by the investment amount and all existing attributive shares are diluted so that percentage shares still add up 100%.
+When someone makes a payment to a project, Old Abe allocates portions of that payment to project contributors and creates a report that tells maintainers how much money the project owes to each individual contributor. We'll get deep into the weeds of how it does that in a moment. If the incoming payment represents an investment (that is, it brings the payer's total amount paid above the project price), the payer is considered a project contributor. The system adds them to the attributions file with a share equal to their investment (or increases their pre-existing attributive share). The project valuation is increased by the investment amount and all existing attributive shares are diluted so that percentage shares still add up to 100%.
 
 Now, let's talk about how Old Abe allocates an incoming payment.
 

oldabe/accounting_utils.py → oldabe/accounting.py

@@ -26,6 +26,8 @@ def correct_rounding_error(attributions, incoming_attribution):
 
 
 def assert_attributions_normalized(attributions):
+    """A complete set of attributions must be normalized, i.e. must add up to
+    1. This raises an error if the provided attributions are not normalized."""
     print(_get_attributions_total(attributions))
     assert _get_attributions_total(attributions) == Decimal("1")