"""meta_income_type - Validate income-type 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/>.

from . import core

from .. import data

from .. import errors as errormod

from ..beancount_types import (

    MetaValueEnum,

    Transaction,

)

class MetaIncomeType(core._NormalizePostingMetadataHook):

    VALUES_ENUM = core.MetadataEnum('income-type', {

        'Donations',

        'Payable-Derecognition',

        'RBI',

        'UBTI',

    })

    DEFAULT_VALUES = {

        'Income:Conferences:Registrations': 'RBI',

        'Income:Conferences:Sponsorship': 'RBI',

        'Income:Donations': 'Donations',

        'Income:Honoraria': 'RBI',

        'Income:Interest': 'RBI',

        'Income:Interest:Dividend': 'RBI',

        'Income:Royalties': 'RBI',

        'Income:Sales': 'RBI',

        'Income:SoftwareDevelopment': 'RBI',

        'Income:TrademarkLicensing': 'RBI',

    }

    def _run_on_post(self, txn: Transaction, post: data.Posting) -> bool:

        return post.account.is_under('Income') is not None

    def _default_value(self, txn: Transaction, post: data.Posting) -> MetaValueEnum:

        try:

            return self.DEFAULT_VALUES[post.account]

        except KeyError:

            raise errormod.InvalidMetadataError(txn, self.METADATA_KEY, None, post) from None

"""Test handling of income-type 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_income_type

VALID_VALUES = {

    'Donations': 'Donations',

    'Payable-Derecognition': 'Payable-Derecognition',

    'RBI': 'RBI',

    'UBTI': 'UBTI',

}

INVALID_VALUES = {

    'Dontion',

    'Payble-Derecognitoin',

    'RIB',

    'UTBI',

    '',

}

TEST_KEY = 'income-type'

@pytest.fixture(scope='module')

def hook():

    config = testutil.TestConfig()

    return meta_income_type.MetaIncomeType(config)

@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())

def test_valid_values_on_postings(hook, src_value, set_value):

    txn = testutil.Transaction(postings=[

        ('Assets:Cash', 25),

        ('Income:Other', -25, {TEST_KEY: src_value}),

    ])

    errors = list(hook.run(txn))

    assert not errors

    testutil.check_post_meta(txn, None, {TEST_KEY: set_value})

@pytest.mark.parametrize('src_value', INVALID_VALUES)

def test_invalid_values_on_postings(hook, src_value):

    txn = testutil.Transaction(postings=[

        ('Assets:Cash', 25),

        ('Income:Other', -25, {TEST_KEY: src_value}),

    ])

    errors = list(hook.run(txn))

    assert errors

    testutil.check_post_meta(txn, None, {TEST_KEY: src_value})

@pytest.mark.parametrize('src_value,set_value', VALID_VALUES.items())

def test_valid_values_on_transactions(hook, src_value, set_value):

    txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[

        ('Assets:Cash', 25),

        ('Income:Other', -25),

    ])

    errors = list(hook.run(txn))

    assert not errors

    testutil.check_post_meta(txn, None, {TEST_KEY: set_value})

@pytest.mark.parametrize('src_value', INVALID_VALUES)

def test_invalid_values_on_transactions(hook, src_value):

    txn = testutil.Transaction(**{TEST_KEY: src_value}, postings=[

        ('Assets:Cash', 25),

        ('Income:Other', -25),

    ])

    errors = list(hook.run(txn))

    assert errors

    testutil.check_post_meta(txn, None, None)

@pytest.mark.parametrize('account', [

    'Assets:Cash',

    'Assets:Receivable:Accounts',

    'Equity:OpeningBalance',

    'Expenses:Other',

    'Liabilities:CreditCard',

    'Liabilities:Payable:Vacation',

])

def test_non_income_accounts_skipped(hook, account):

    meta = {TEST_KEY: 'RBI'}

    txn = testutil.Transaction(postings=[

        (account, 25),

        ('Income:Other', -25, meta.copy()),

    ])

    errors = list(hook.run(txn))

    assert not errors

    testutil.check_post_meta(txn, None, meta)

@pytest.mark.parametrize('account,set_value', [

    ('Income:Conferences:Registrations', 'RBI'),

    ('Income:Conferences:Sponsorship', 'RBI'),

    ('Income:Donations', 'Donations'),

    ('Income:Honoraria', 'RBI'),

    ('Income:Interest', 'RBI'),

    ('Income:Interest:Dividend', 'RBI'),

    ('Income:Royalties', 'RBI'),

    ('Income:Sales', 'RBI'),

    ('Income:SoftwareDevelopment', 'RBI'),

    ('Income:TrademarkLicensing', 'RBI'),

])

def test_default_values(hook, account, set_value):

    txn = testutil.Transaction(postings=[

        ('Assets:Cash', 25),

        (account, -25),

    ])

    errors = list(hook.run(txn))

    assert not errors

    testutil.check_post_meta(txn, None, {TEST_KEY: set_value})

@pytest.mark.parametrize('account', [

    'Income:Other',

])

def test_no_default_value(hook, account):

    txn = testutil.Transaction(postings=[

        ('Assets:Cash', 25),

        (account, -25),

    ])

    errors = list(hook.run(txn))

    assert errors

    testutil.check_post_meta(txn, None, None)

@pytest.mark.parametrize('date,set_value', [

    (testutil.EXTREME_FUTURE_DATE, None),

    (testutil.FUTURE_DATE, 'Donations'),

    (testutil.FY_START_DATE, 'Donations'),

    (testutil.FY_MID_DATE, 'Donations'),

    (testutil.PAST_DATE, None),

])

def test_default_value_set_in_date_range(hook, date, set_value):

    txn = testutil.Transaction(date=date, postings=[

        ('Assets:Cash', 25),

        ('Income:Donations', -25),

    ])

    errors = list(hook.run(txn))

    assert not errors

    expect_meta = None if set_value is None else {TEST_KEY: set_value}

    testutil.check_post_meta(txn, None, expect_meta)

@pytest.mark.parametrize('src_value', INVALID_VALUES)

def test_flagged_txn_checked(hook, src_value):

    txn = testutil.Transaction(flag='!', postings=[

        ('Assets:Cash', 25),

        ('Income:Other', -25, {TEST_KEY: src_value}),

    ])

    errors = list(hook.run(txn))

    assert errors

    testutil.check_post_meta(txn, None, {TEST_KEY: src_value})