NPO-Accounting/conservancy_beancount Changeset - 212036b25ec5

Changeset - 212036b25ec5

Parent rev.

Child rev.

[Not reviewed]

0 2 0

Brett Smith - 4 years ago 2020-04-07 19:45:29
brettcsmith@brettcsmith.org

meta_approval: Stop checking payables.

That's handled by meta_payable_documentation now.

2 files changed with 11 insertions and 18 deletions:

conservancy_beancount/plugin/meta_approval.py

tests/test_meta_approval.py

0 comments (0 inline, 0 general)

conservancy_beancount/plugin/meta_approval.py

➞

Show inline comments

 """meta_approval - Validate approval metadata"""
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Affero General Public License for more details.
+#
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 import decimal
 from . import core
 from .. import config as configmod
 from .. import data
 from .. import errors as errormod
 from ..beancount_types import (
     Transaction,
+)
 class MetaApproval(core._RequireLinksPostingMetadataHook):
     CHECKED_METADATA = ['approval']
     def __init__(self, config: configmod.Config) -> None:
         self.payment_threshold = config.payment_threshold()
     def _run_on_txn(self, txn: Transaction) -> bool:
         if not super()._run_on_txn(txn):
             return False
         # approval is required when funds leave a cash equivalent asset,
         # UNLESS that transaction is a transfer to another asset,
         # or paying off a credit card.
         # debits_sum keeps a running tally of how much is moving in each
         # direction, and we'll return True if it ends up over the payment
         # threshold.
         debits_sum = decimal.Decimal(0)
         for post in data.iter_postings(txn):
             # approval is required:
             # 1. When a payable is accrued
             if (post.account.is_under('Liabilities:Payable:Accounts')
                 and post.is_debit(self.payment_threshold)):
                 return True
             # 2. When funds leave a cash equivalent asset, UNLESS that
             # transaction is a transfer to another asset, or paying off a
             # credit card.
             # In this case, debits_sum keeps a running tally of how much is
             # moving in each direction, and we'll return True if it ends up over
             # the payment threshold.
             elif post.account.is_cash_equivalent() or post.account.is_credit_card():
             if post.account.is_cash_equivalent() or post.account.is_credit_card():
                 debits_sum -= post.units.number or 0
         return debits_sum > self.payment_threshold
     def _run_on_post(self, txn: Transaction, post: data.Posting) -> bool:
         if post.account.is_under('Liabilities:Payable:Accounts'):
             threshold_check = post.is_debit(self.payment_threshold)
         else:
             threshold_check = post.is_payment(0)
         return threshold_check is not False
         return post.account.is_cash_equivalent() and not post.is_credit(0)

tests/test_meta_approval.py

➞

Show inline comments

 """Test validation of approval metadata"""
 # Copyright © 2020  Brett Smith
+#
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU Affero General Public License for more details.
+#
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 import pytest
 from . import testutil
 from conservancy_beancount.plugin import meta_approval
 REQUIRED_ACCOUNTS = {
     'Assets:Bank:Checking',
     'Assets:Cash',
     'Assets:Savings',
     'Liabilities:Payable:Accounts',
+}
 NON_REQUIRED_ACCOUNTS = {
     'Assets:Prepaid:Expenses',
     # Receivables are checked by meta_receivable_documentation
     'Assets:Receivable:Accounts',
     'Equity:QpeningBalance',
     'Expenses:Other',
     'Income:Other',
     # Payables are checked by meta_payable_documentation
     'Liabilities:Payable:Accounts',
     'Liabilities:Payable:Vacation',
     'Liabilities:UnearnedIncome:Donations',
+}
 CREDITCARD_ACCOUNT = 'Liabilities:CreditCard'
 TEST_KEY = 'approval'
 @pytest.fixture(scope='module')
 def hook():
     config = testutil.TestConfig()
     return meta_approval.MetaApproval(config)
 @pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
     testutil.LINK_METADATA_STRINGS,
 ))
 def test_valid_values_on_postings(hook, acct1, acct2, value):
     txn = testutil.Transaction(postings=[
         (acct2, 25),
         (acct1, -25, {TEST_KEY: value}),
     ])
     assert not list(hook.run(txn))
 @pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
     testutil.NON_LINK_METADATA_STRINGS,
 ))
 def test_invalid_values_on_postings(hook, acct1, acct2, value):
     txn = testutil.Transaction(postings=[
         (acct2, 25),
         (acct1, -25, {TEST_KEY: value}),
     ])
     actual = {error.message for error in hook.run(txn)}
     assert actual == {"{} missing {}".format(acct1, TEST_KEY)}
 @pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
     testutil.NON_STRING_METADATA_VALUES,
 ))
 def test_bad_type_values_on_postings(hook, acct1, acct2, value):
     txn = testutil.Transaction(postings=[
         (acct2, 25),
         (acct1, -25, {TEST_KEY: value}),
     ])
     expected_msg = "{} has wrong type of {}: expected str but is a {}".format(
         acct1,
         TEST_KEY,
         type(value).__name__,
+    )
     actual = {error.message for error in hook.run(txn)}
     assert expected_msg in actual
 @pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
     testutil.LINK_METADATA_STRINGS,
 ))
 def test_valid_values_on_transaction(hook, acct1, acct2, value):
     txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
         (acct2, 25),
         (acct1, -25),
     ])
     assert not list(hook.run(txn))
 @pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
     testutil.NON_LINK_METADATA_STRINGS,
 ))
 def test_invalid_values_on_transaction(hook, acct1, acct2, value):
     txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
         (acct2, 25),
         (acct1, -25),
     ])
     actual = {error.message for error in hook.run(txn)}
     assert actual == {"{} missing {}".format(acct1, TEST_KEY)}
 @pytest.mark.parametrize('acct1,acct2,value', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
     testutil.NON_STRING_METADATA_VALUES,
 ))
 def test_bad_type_values_on_transaction(hook, acct1, acct2, value):
     txn = testutil.Transaction(**{TEST_KEY: value}, postings=[
         (acct2, 25),
         (acct1, -25),
     ])
     expected_msg = "{} has wrong type of {}: expected str but is a {}".format(
         acct1,
         TEST_KEY,
         type(value).__name__,
+    )
     actual = {error.message for error in hook.run(txn)}
     assert expected_msg in actual
 @pytest.mark.parametrize('acct1,acct2', testutil.combine_values(
     REQUIRED_ACCOUNTS,
     NON_REQUIRED_ACCOUNTS,
 ))
 def test_approval_not_required_on_credits(hook, acct1, acct2):
     txn = testutil.Transaction(postings=[
         (acct2, -25),
         (acct1, 25),
     ])
     assert not list(hook.run(txn))
 def test_approval_not_required_to_charge_credit_card(hook):
     txn = testutil.Transaction(postings=[
         ('Expenses:Other', 25),
         (CREDITCARD_ACCOUNT, 25),
     ])
     assert not list(hook.run(txn))
 def test_approval_not_required_to_pay_credit_card(hook):
     txn = testutil.Transaction(postings=[
         ('Assets:Checking', -25),
         (CREDITCARD_ACCOUNT, 25),
     ])
     assert not list(hook.run(txn))
 def test_approval_not_required_for_asset_transfers(hook):
     txn = testutil.Transaction(postings=[
         ('Assets:Checking', -250, {'tax-implication': 'Bank-Transfer'}),
         ('Assets:Savings', 250),
     ])
     assert not list(hook.run(txn))
 def test_approval_required_for_partial_transfer(hook):
     # I'm not sure this ever comes up in reality, but just being thorough
     # out of an abundance of precaution.
     txn = testutil.Transaction(postings=[
         ('Assets:Checking', -250, {'tax-implication': 'Bank-Transfer'}),
         ('Assets:Savings', 225),
         ('Expenses:BankingFees', 25),
     ])
     actual = {error.message for error in hook.run(txn)}
     assert actual == {"Assets:Checking missing {}".format(TEST_KEY)}

0 comments (0 inline, 0 general)