NPO-Accounting/conservancy_beancount
6
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

plugin: Settle on words-with-dashes metadata keys.

Browse source
This commit is contained in:
Brett Smith 2020-03-15 10:36:49 -04:00
parent d8afb209f7
commit c9ff4ab746
5 changed files with 29 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
conservancy_beancount/plugin/meta_expense_allocation.py
View file

@ -1,4 +1,4 @@
"""meta_expense_allocation - Validate expenseAllocation metadata""" """meta_expense_allocation - Validate expense-allocation metadata"""
# Copyright © 2020 Brett Smith # Copyright © 2020 Brett Smith
# #
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
@ -18,7 +18,7 @@ from . import core
class MetaExpenseAllocation(core.PostingChecker): class MetaExpenseAllocation(core.PostingChecker):
ACCOUNTS = ('Expenses:',) ACCOUNTS = ('Expenses:',)
METADATA_KEY = 'expenseAllocation' METADATA_KEY = 'expense-allocation'
VALUES_ENUM = core.MetadataEnum(METADATA_KEY, { VALUES_ENUM = core.MetadataEnum(METADATA_KEY, {
'administration', 'administration',
'fundraising', 'fundraising',

4
conservancy_beancount/plugin/meta_tax_implication.py
View file

@ -1,4 +1,4 @@
"""meta_tax_implication - Validate taxImplication metadata""" """meta_tax_implication - Validate tax-implication metadata"""
# Copyright © 2020 Brett Smith # Copyright © 2020 Brett Smith
# #
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
@ -22,7 +22,7 @@ DEFAULT_STOP_AMOUNT = decimal.Decimal(0)
class MetaTaxImplication(core.PostingChecker): class MetaTaxImplication(core.PostingChecker):
ACCOUNTS = ('Assets:',) ACCOUNTS = ('Assets:',)
METADATA_KEY = 'taxImplication' METADATA_KEY = 'tax-implication'
VALUES_ENUM = core.MetadataEnum(METADATA_KEY, [ VALUES_ENUM = core.MetadataEnum(METADATA_KEY, [
'1099', '1099',
'Accountant-Advises-No-1099', 'Accountant-Advises-No-1099',

22
tests/test_meta_expenseAllocation.py → tests/test_meta_expense_allocation.py
View file

@ -1,4 +1,4 @@
"""Test handling of expenseAllocation metadata""" """Test handling of expense-allocation metadata"""
# Copyright © 2020 Brett Smith # Copyright © 2020 Brett Smith
# #
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
@ -35,22 +35,24 @@ INVALID_VALUES = {
'', '',
} }
TEST_KEY = 'expense-allocation'
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items()) @pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_postings(src_value, set_value): def test_valid_values_on_postings(src_value, set_value):
txn = testutil.Transaction(postings=[ txn = testutil.Transaction(postings=[
('Assets:Cash', -25), ('Assets:Cash', -25),
('Expenses:General', 25, {'expenseAllocation': src_value}), ('Expenses:General', 25, {TEST_KEY: src_value}),
]) ])
checker = meta_expense_allocation.MetaExpenseAllocation() checker = meta_expense_allocation.MetaExpenseAllocation()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
assert not errors assert not errors
assert txn.postings[-1].meta.get('expenseAllocation') == set_value assert txn.postings[-1].meta.get(TEST_KEY) == set_value
@pytest.mark.parametrize('src_value', INVALID_VALUES) @pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_postings(src_value): def test_invalid_values_on_postings(src_value):
txn = testutil.Transaction(postings=[ txn = testutil.Transaction(postings=[
('Assets:Cash', -25), ('Assets:Cash', -25),
('Expenses:General', 25, {'expenseAllocation': src_value}), ('Expenses:General', 25, {TEST_KEY: src_value}),
]) ])
checker = meta_expense_allocation.MetaExpenseAllocation() checker = meta_expense_allocation.MetaExpenseAllocation()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
@ -58,18 +60,18 @@ def test_invalid_values_on_postings(src_value):
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items()) @pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_transactions(src_value, set_value): def test_valid_values_on_transactions(src_value, set_value):
txn = testutil.Transaction(expenseAllocation=src_value, postings=[ txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
('Assets:Cash', -25), ('Assets:Cash', -25),
('Expenses:General', 25), ('Expenses:General', 25),
]) ])
checker = meta_expense_allocation.MetaExpenseAllocation() checker = meta_expense_allocation.MetaExpenseAllocation()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
assert not errors assert not errors
assert txn.postings[-1].meta.get('expenseAllocation') == set_value assert txn.postings[-1].meta.get(TEST_KEY) == set_value
@pytest.mark.parametrize('src_value', INVALID_VALUES) @pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_transactions(src_value): def test_invalid_values_on_transactions(src_value):
txn = testutil.Transaction(expenseAllocation=src_value, postings=[ txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
('Assets:Cash', -25), ('Assets:Cash', -25),
('Expenses:General', 25), ('Expenses:General', 25),
]) ])
@ -87,7 +89,7 @@ def test_invalid_values_on_transactions(src_value):
def test_non_expense_accounts_skipped(account): def test_non_expense_accounts_skipped(account):
txn = testutil.Transaction(postings=[ txn = testutil.Transaction(postings=[
(account, -25), (account, -25),
('Expenses:General', 25, {'expenseAllocation': 'program'}), ('Expenses:General', 25, {TEST_KEY: 'program'}),
]) ])
checker = meta_expense_allocation.MetaExpenseAllocation() checker = meta_expense_allocation.MetaExpenseAllocation()
errors = checker.run(txn, txn.postings[0], 0) errors = checker.run(txn, txn.postings[0], 0)
@ -108,7 +110,7 @@ def test_default_values(account, set_value):
checker = meta_expense_allocation.MetaExpenseAllocation() checker = meta_expense_allocation.MetaExpenseAllocation()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
assert not errors assert not errors
assert txn.postings[-1].meta['expenseAllocation'] == set_value assert txn.postings[-1].meta[TEST_KEY] == set_value
@pytest.mark.parametrize('date,set_value', [ @pytest.mark.parametrize('date,set_value', [
(testutil.EXTREME_FUTURE_DATE, False), (testutil.EXTREME_FUTURE_DATE, False),
@ -125,5 +127,5 @@ def test_default_value_set_in_date_range(date, set_value):
checker = meta_expense_allocation.MetaExpenseAllocation() checker = meta_expense_allocation.MetaExpenseAllocation()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
assert not errors assert not errors
got_value = (txn.postings[-1].meta or {}).get('expenseAllocation') got_value = (txn.postings[-1].meta or {}).get(TEST_KEY)
assert bool(got_value) == bool(set_value) assert bool(got_value) == bool(set_value)

18
tests/test_meta_taxImplication.py → tests/test_meta_tax_implication.py
View file

@ -1,4 +1,4 @@
"""Test handling of taxImplication metadata""" """Test handling of tax-implication metadata"""
# Copyright © 2020 Brett Smith # Copyright © 2020 Brett Smith
# #
# This program is free software: you can redistribute it and/or modify # This program is free software: you can redistribute it and/or modify
@ -47,22 +47,24 @@ INVALID_VALUES = {
'', '',
} }
TEST_KEY = 'tax-implication'
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items()) @pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_postings(src_value, set_value): def test_valid_values_on_postings(src_value, set_value):
txn = testutil.Transaction(postings=[ txn = testutil.Transaction(postings=[
('Accrued:AccountsPayable', 25), ('Accrued:AccountsPayable', 25),
('Assets:Cash', -25, {'taxImplication': src_value}), ('Assets:Cash', -25, {TEST_KEY: src_value}),
]) ])
checker = meta_tax_implication.MetaTaxImplication() checker = meta_tax_implication.MetaTaxImplication()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
assert not errors assert not errors
assert txn.postings[-1].meta.get('taxImplication') == set_value assert txn.postings[-1].meta.get(TEST_KEY) == set_value
@pytest.mark.parametrize('src_value', INVALID_VALUES) @pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_postings(src_value): def test_invalid_values_on_postings(src_value):
txn = testutil.Transaction(postings=[ txn = testutil.Transaction(postings=[
('Accrued:AccountsPayable', 25), ('Accrued:AccountsPayable', 25),
('Assets:Cash', -25, {'taxImplication': src_value}), ('Assets:Cash', -25, {TEST_KEY: src_value}),
]) ])
checker = meta_tax_implication.MetaTaxImplication() checker = meta_tax_implication.MetaTaxImplication()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
@ -70,18 +72,18 @@ def test_invalid_values_on_postings(src_value):
@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items()) @pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())
def test_valid_values_on_transactions(src_value, set_value): def test_valid_values_on_transactions(src_value, set_value):
txn = testutil.Transaction(taxImplication=src_value, postings=[ txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
('Accrued:AccountsPayable', 25), ('Accrued:AccountsPayable', 25),
('Assets:Cash', -25), ('Assets:Cash', -25),
]) ])
checker = meta_tax_implication.MetaTaxImplication() checker = meta_tax_implication.MetaTaxImplication()
errors = checker.run(txn, txn.postings[-1], -1) errors = checker.run(txn, txn.postings[-1], -1)
assert not errors assert not errors
assert txn.postings[-1].meta.get('taxImplication') == set_value assert txn.postings[-1].meta.get(TEST_KEY) == set_value
@pytest.mark.parametrize('src_value', INVALID_VALUES) @pytest.mark.parametrize('src_value', INVALID_VALUES)
def test_invalid_values_on_transactions(src_value): def test_invalid_values_on_transactions(src_value):
txn = testutil.Transaction(taxImplication=src_value, postings=[ txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[
('Accrued:AccountsPayable', 25), ('Accrued:AccountsPayable', 25),
('Assets:Cash', -25), ('Assets:Cash', -25),
]) ])
@ -97,7 +99,7 @@ def test_invalid_values_on_transactions(src_value):
def test_non_asset_accounts_skipped(account): def test_non_asset_accounts_skipped(account):
txn = testutil.Transaction(postings=[ txn = testutil.Transaction(postings=[
(account, 25), (account, 25),
('Assets:Cash', -25, {'taxImplication': 'USA-Corporation'}), ('Assets:Cash', -25, {TEST_KEY: 'USA-Corporation'}),
]) ])
checker = meta_tax_implication.MetaTaxImplication() checker = meta_tax_implication.MetaTaxImplication()
errors = checker.run(txn, txn.postings[0], 0) errors = checker.run(txn, txn.postings[0], 0)

6
tests/test_plugin_HookRegistry.py
View file

@ -31,19 +31,19 @@ def test_default_registrations():
assert 'MetaTaxImplication' in post_hook_names assert 'MetaTaxImplication' in post_hook_names
def test_exclude_single(): def test_exclude_single():
hooks = plugin.HOOK_REGISTRY.group_by_directive('-expenseAllocation') hooks = plugin.HOOK_REGISTRY.group_by_directive('-expense-allocation')
post_hook_names = hook_names(hooks, 'Posting') post_hook_names = hook_names(hooks, 'Posting')
assert post_hook_names assert post_hook_names
assert 'MetaExpenseAllocation' not in post_hook_names assert 'MetaExpenseAllocation' not in post_hook_names
def test_exclude_group_then_include_single(): def test_exclude_group_then_include_single():
hooks = plugin.HOOK_REGISTRY.group_by_directive('-metadata expenseAllocation') hooks = plugin.HOOK_REGISTRY.group_by_directive('-metadata expense-allocation')
post_hook_names = hook_names(hooks, 'Posting') post_hook_names = hook_names(hooks, 'Posting')
assert 'MetaExpenseAllocation' in post_hook_names assert 'MetaExpenseAllocation' in post_hook_names
assert 'MetaTaxImplication' not in post_hook_names assert 'MetaTaxImplication' not in post_hook_names
def test_include_group_then_exclude_single(): def test_include_group_then_exclude_single():
hooks = plugin.HOOK_REGISTRY.group_by_directive('metadata -taxImplication') hooks = plugin.HOOK_REGISTRY.group_by_directive('metadata -tax-implication')
post_hook_names = hook_names(hooks, 'Posting') post_hook_names = hook_names(hooks, 'Posting')
assert 'MetaExpenseAllocation' in post_hook_names assert 'MetaExpenseAllocation' in post_hook_names
assert 'MetaTaxImplication' not in post_hook_names assert 'MetaTaxImplication' not in post_hook_names