NPO-Accounting/conservancy_beancount Changeset - 9598b29ba791

Changeset - 9598b29ba791

Parent rev.

Child rev.

[Not reviewed]

0 3 0

Brett Smith - 4 years ago 2021-02-26 22:02:59
brettcsmith@brettcsmith.org

txn_date: Check more filenames.

This follows up on the recent change to books.Loader.

3 files changed with 26 insertions and 18 deletions:

conservancy_beancount/plugin/txn_date.py

setup.py

tests/test_plugin_txn_date.py

0 comments (0 inline, 0 general)

conservancy_beancount/plugin/txn_date.py

➞

Show inline comments

 """txn_date.py - Validate transactions are entered in the right file by date"""
 # Copyright © 2020  Brett Smith
 # License: AGPLv3-or-later WITH Beancount-Plugin-Additional-Permission-1.0
+#
 # Full copyright and licensing details can be found at toplevel file
 # LICENSE.txt in the repository.
 import os.path
 import re
 from ..beancount_types import (
     Transaction,
+)
 from . import core
 from .. import config as configmod
 from .. import errors as errormod
 from .. import ranges
 class TransactionDate(core.TransactionHook):
     def __init__(self, config: configmod.Config) -> None:
         books_path = config.books_path()
         if books_path is None:
             raise errormod.ConfigurationError(
                 "books dir setting is required to check transaction dates",
+            )
         books_pat = re.escape(str(books_path))
-        self.filename_re = re.compile(rf'^{books_pat}/(\d{{4,}})\.beancount$')
+        self.filename_re = re.compile(rf'^{books_pat}/(\d{{4,}})[{os.path.sep}_.]')
         self.fy = config.fiscal_year_begin()
     def run(self, txn: Transaction) -> errormod.Iter:
-        match = self.filename_re.fullmatch(txn.meta.get('filename', ''))
+        match = self.filename_re.match(txn.meta.get('filename', ''))
         if match is None:
             return
         file_fy = int(match.group(1))
         txn_fy = self.fy.for_date(txn.date)
         if file_fy != txn_fy:
             yield errormod.Error(
                 f"transaction dated in FY{txn_fy} entered in FY{file_fy} books",
                 txn,
+            )

setup.py

➞

Show inline comments

 #!/usr/bin/env python3
 from setuptools import setup
 setup(
     name='conservancy_beancount',
     description="Plugin, library, and reports for reading Conservancy's books",
-    version='1.18.3',
+    version='1.18.4',
     author='Software Freedom Conservancy',
     author_email='info@sfconservancy.org',
     license='GNU AGPLv3+',
     install_requires=[
         'babel>=2.6',  # Debian:python3-babel
         'beancount>=2.2',  # Debian:beancount
         'GitPython>=2.0',  # Debian:python3-git
         # 1.4.1 crashes when trying to save some documents.
         'odfpy>=1.4.0,!=1.4.1',  # Debian:python3-odf
         'pdfminer.six>=20200101',
         'PyYAML>=3.0',  # Debian:python3-yaml

tests/test_plugin_txn_date.py

➞

Show inline comments

 """test_txn_date.py - Unit tests for transaction date validation"""
 # Copyright © 2020  Brett Smith
 # License: AGPLv3-or-later WITH Beancount-Plugin-Additional-Permission-1.0
+#
 # Full copyright and licensing details can be found at toplevel file
 # LICENSE.txt in the repository.
 import itertools
 from datetime import date
 import pytest
 from . import testutil
 from conservancy_beancount import config as configmod
 from conservancy_beancount import errors as errormod
 from conservancy_beancount.plugin import txn_date as hookmod
 BOOKS_PATH = testutil.test_path('books')
 CONFIG = testutil.TestConfig(books_path=BOOKS_PATH)
 HOOK = hookmod.TransactionDate(CONFIG)
 SUFFIXES = itertools.cycle([
     '',
     '_sidefile',
     '/subdirfile',
 ])
 @pytest.mark.parametrize('txn_date,fyear', [
     (date(2016, 1, 1), 2015),
     (date(2016, 2, 29), 2015),
     (date(2016, 3, 1), 2016),
     (date(2016, 12, 31), 2016),
     (date(2017, 2, 28), 2016),
     (date(2017, 3, 1), 2017),
 @pytest.mark.parametrize('txn_date,fyear,suffix', [
     (date(2016, 1, 1), 2015, next(SUFFIXES)),
     (date(2016, 2, 29), 2015, next(SUFFIXES)),
     (date(2016, 3, 1), 2016, next(SUFFIXES)),
     (date(2016, 12, 31), 2016, next(SUFFIXES)),
     (date(2017, 2, 28), 2016, next(SUFFIXES)),
     (date(2017, 3, 1), 2017, next(SUFFIXES)),
 ])
 def test_good_txn(txn_date, fyear):
     filename = str(BOOKS_PATH / f'{fyear}.beancount')
 def test_good_txn(txn_date, fyear, suffix):
     filename = str(BOOKS_PATH / f'{fyear}{suffix}.beancount')
     txn = testutil.Transaction(date=txn_date, filename=filename, postings=[
         ('Assets:Cash', 5),
         ('Income:Donations', -5),
     ])
     assert not list(HOOK.run(txn))
 @pytest.mark.parametrize('txn_date,fyear', [
     (date(2018, 1, 1), 2017),
     (date(2018, 12, 31), 2018),
     (date(2019, 3, 1), 2019),
 @pytest.mark.parametrize('txn_date,fyear,suffix', [
     (date(2018, 1, 1), 2017, next(SUFFIXES)),
     (date(2018, 12, 31), 2018, next(SUFFIXES)),
     (date(2019, 3, 1), 2019, next(SUFFIXES)),
 ])
 def test_bad_txn(txn_date, fyear):
     filename = str(BOOKS_PATH / '2020.beancount')
 def test_bad_txn(txn_date, fyear, suffix):
     filename = str(BOOKS_PATH / f'2020{suffix}.beancount')
     txn = testutil.Transaction(date=txn_date, filename=filename, postings=[
         ('Assets:Cash', 5),
         ('Income:Donations', -5),
     ])
     errors = list(HOOK.run(txn))
     assert len(errors) == 1
     assert errors[0].message == f"transaction dated in FY{fyear} entered in FY2020 books"
 @pytest.mark.parametrize('path_s', [
     'books/2020.beancount',
     'historical/2020.beancount',
     'definitions.beancount',

0 comments (0 inline, 0 general)