diff --git a/edi_exchange_template_party_data/README.rst b/edi_exchange_template_party_data/README.rst index b52a821b9..b58485146 100644 --- a/edi_exchange_template_party_data/README.rst +++ b/edi_exchange_template_party_data/README.rst @@ -37,6 +37,13 @@ Glue module betweeb edi_exchange_template and edi_party_data. Exposes a get_party_data function to the rendering context of the template. This way you can retrieve party data on the fly. +**Deprecated**: `edi_party_data_oca` (and this glue module) are superseded +by `edi_party_helper_oca`, which has no dependency on the `component` +framework. Use its `edi.party.helper` model (or the `EDIParty` class +directly) instead of the `get_party_data` render context shortcut. A +deprecation notice is logged on server startup while this module is +installed. It is also no longer auto-installed. + .. IMPORTANT:: This is an alpha version, the data model and design can change at any time without warning. Only for development or testing purpose, do not use in production. diff --git a/edi_exchange_template_party_data/__init__.py b/edi_exchange_template_party_data/__init__.py index 0650744f6..5bf67492b 100644 --- a/edi_exchange_template_party_data/__init__.py +++ b/edi_exchange_template_party_data/__init__.py @@ -1 +1,2 @@ from . import models +from .hooks import post_load_hook diff --git a/edi_exchange_template_party_data/__manifest__.py b/edi_exchange_template_party_data/__manifest__.py index 20c19a138..8c0eeaea3 100644 --- a/edi_exchange_template_party_data/__manifest__.py +++ b/edi_exchange_template_party_data/__manifest__.py @@ -11,5 +11,5 @@ "maintainers": ["simahawk"], "website": "https://github.com/OCA/edi-framework", "depends": ["edi_exchange_template_oca", "edi_party_data_oca"], - "auto_install": True, + "post_load_hook": "post_load_hook", } diff --git a/edi_exchange_template_party_data/hooks.py b/edi_exchange_template_party_data/hooks.py new file mode 100644 index 000000000..ca1fa368f --- /dev/null +++ b/edi_exchange_template_party_data/hooks.py @@ -0,0 +1,13 @@ +import logging + +_logger = logging.getLogger(__name__) + + +def post_load_hook(): + _logger.info( + "`edi_exchange_template_party_data` is deprecated and will be removed. " + "`edi_party_data_oca` (and this glue module) are superseded by " + "`edi_party_helper_oca`: use its `edi.party.helper` model (or the " + "`EDIParty` class directly) instead of the `get_party_data` render " + "context shortcut." + ) diff --git a/edi_exchange_template_party_data/readme/DESCRIPTION.md b/edi_exchange_template_party_data/readme/DESCRIPTION.md index d308ac97f..fe7c15aa5 100644 --- a/edi_exchange_template_party_data/readme/DESCRIPTION.md +++ b/edi_exchange_template_party_data/readme/DESCRIPTION.md @@ -2,3 +2,10 @@ Glue module betweeb edi_exchange_template and edi_party_data. Exposes a get_party_data function to the rendering context of the template. This way you can retrieve party data on the fly. + +**Deprecated**: `edi_party_data_oca` (and this glue module) are superseded +by `edi_party_helper_oca`, which has no dependency on the `component` +framework. Use its `edi.party.helper` model (or the `EDIParty` class +directly) instead of the `get_party_data` render context shortcut. A +deprecation notice is logged on server startup while this module is +installed. It is also no longer auto-installed. diff --git a/edi_party_data_oca/README.rst b/edi_party_data_oca/README.rst index 7ce4a726b..a126b2b66 100644 --- a/edi_party_data_oca/README.rst +++ b/edi_party_data_oca/README.rst @@ -38,11 +38,12 @@ of an exchange. This module provides default component and a mixin to be used for registering new components for specific backends. -It's based on partner_identification so that the party information will -include allowed ID numbers for a given exchange. - -You can configure which ID number categories are allowed on the exchange -type. +**Deprecated**: the actual party data lookup logic has moved to +`edi_party_helper_oca`, which has no dependency on the `component` +framework. This module now only wraps it in a component for backward +compatibility and will be removed once its usages are ported over. A +deprecation notice is logged on server startup while this module is +installed. .. IMPORTANT:: This is an alpha version, the data model and design can change at any time without warning. diff --git a/edi_party_data_oca/__init__.py b/edi_party_data_oca/__init__.py index f24d3e242..d891f65b2 100644 --- a/edi_party_data_oca/__init__.py +++ b/edi_party_data_oca/__init__.py @@ -1,2 +1,2 @@ from . import components -from . import models +from .hooks import post_load_hook diff --git a/edi_party_data_oca/__manifest__.py b/edi_party_data_oca/__manifest__.py index db324b74a..12f847b8d 100644 --- a/edi_party_data_oca/__manifest__.py +++ b/edi_party_data_oca/__manifest__.py @@ -12,8 +12,6 @@ "website": "https://github.com/OCA/edi-framework", "author": "Camptocamp, Odoo Community Association (OCA)", "maintainers": ["simahawk"], - "depends": ["edi_component_oca", "partner_identification"], - "data": [ - "views/edi_exchange_type_views.xml", - ], + "depends": ["edi_component_oca", "edi_party_helper_oca"], + "post_load_hook": "post_load_hook", } diff --git a/edi_party_data_oca/components/common.py b/edi_party_data_oca/components/common.py index ad088a690..4e808e10c 100644 --- a/edi_party_data_oca/components/common.py +++ b/edi_party_data_oca/components/common.py @@ -2,13 +2,19 @@ # @author: Simone Orsi # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -from odoo.tools import DotDict - from odoo.addons.component.core import AbstractComponent class EDIExchangePartyDataMixin(AbstractComponent): - """Abstract component mixin provide partner data for exchanges.""" + """Abstract component mixin provide partner data for exchanges. + + .. deprecated:: + Business logic lives in the `edi_party_helper_oca` module, which has + no component dependency: `EDIParty` (plain dataclass) or the + `edi.party.helper` abstract model. This component only wraps it for + backward compatibility and will be dropped once its usages are + ported over. + """ _name = "edi.party.data.mixin" _inherit = "edi.component.mixin" @@ -25,59 +31,20 @@ def _get_partner(self): # based on current partner (eg: pick the parent). return self.work.partner + def _get_party(self): + return self.env["edi.party.helper"].get_party( + self.exchange_record, + self.partner, + name_field=getattr(self.work, "party_data_name_field", "name"), + lang_code=getattr(self.work, "lang", False), + ) + def get_party(self): """Return party information. Requires a res.partner to be passed via work context. - :return: odoo.tools.DotDict + :return: `EDIParty` (behaves like a read-only dict too, for + backward compatibility with the old ``DotDict``-based return) """ - return self._party_from_partner() - - def _party_from_partner(self, **kw): - # NB: for UBL this should probably replace - # `base.ubl._ubl_get_party_identification` which does nothing today. - party = DotDict( - name=self._get_name(), - identifiers=self._get_identifiers(), - endpoint=self._get_endpoint(), - lang=self._get_lang(), - partner=self.partner, - ) - party.update(kw) - return party - - def _get_name(self): - name_field = getattr(self.work, "party_data_name_field", "name") - return self.partner[name_field] - - def _get_endpoint(self): - return {} - - def _get_identifiers(self): - identifiers = self.partner.id_numbers.filtered( - lambda x: self._filter_id_number(x) - ) - return [self._get_indentity(x) for x in identifiers] - - def _filter_id_number(self, id_number): - if self.allowed_id_categories: - return id_number.category_id in self.allowed_id_categories - return True - - def _get_indentity(self, id_number): - return DotDict( - attrs={ - "schemeID": id_number.category_id.code, - }, - value=id_number.name, - ) - - def _get_lang(self): - lang_code = getattr(self.work, "lang", False) or self.partner.lang - if not lang_code: - return False - lang = self.env["res.lang"]._get_data(code=lang_code) - if not lang: - return False - return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + return self._get_party() diff --git a/edi_party_data_oca/hooks.py b/edi_party_data_oca/hooks.py new file mode 100644 index 000000000..5903417d7 --- /dev/null +++ b/edi_party_data_oca/hooks.py @@ -0,0 +1,13 @@ +import logging + +_logger = logging.getLogger(__name__) + + +def post_load_hook(): + _logger.info( + "`edi_party_data_oca` is deprecated and will be removed. Its " + "`edi.party.data.mixin` component is superseded by " + "`edi_party_helper_oca`: use its `edi.party.helper` model (or the " + "`EDIParty` class directly) instead, they don't require any " + "component lookup." + ) diff --git a/edi_party_data_oca/readme/CONFIGURE.md b/edi_party_data_oca/readme/CONFIGURE.md index cde50ad1d..ed7071d24 100644 --- a/edi_party_data_oca/readme/CONFIGURE.md +++ b/edi_party_data_oca/readme/CONFIGURE.md @@ -1,9 +1,6 @@ ## ID numbers selection -On the exchange type form, find the field "ID categories" and set the -categories allowed for that exchange type. - -If not set, *all the IDs* of the partner will be exposed. +See `edi_party_helper_oca`'s configuration. ## Name field diff --git a/edi_party_data_oca/readme/DESCRIPTION.md b/edi_party_data_oca/readme/DESCRIPTION.md index 7bc4f6988..a8e6d356a 100644 --- a/edi_party_data_oca/readme/DESCRIPTION.md +++ b/edi_party_data_oca/readme/DESCRIPTION.md @@ -4,8 +4,9 @@ of an exchange. This module provides default component and a mixin to be used for registering new components for specific backends. -It's based on partner_identification so that the party information will -include allowed ID numbers for a given exchange. - -You can configure which ID number categories are allowed on the exchange -type. +**Deprecated**: the actual party data lookup logic has moved to +`edi_party_helper_oca`, which has no dependency on the `component` +framework. This module now only wraps it in a component for backward +compatibility and will be removed once its usages are ported over. A +deprecation notice is logged on server startup while this module is +installed. diff --git a/edi_party_data_oca/readme/USAGE.md b/edi_party_data_oca/readme/USAGE.md index b2c95694c..35c339292 100644 --- a/edi_party_data_oca/readme/USAGE.md +++ b/edi_party_data_oca/readme/USAGE.md @@ -5,3 +5,6 @@ An handy util method is to retrive the component: component = get_party_data_component(exchange_record, partner) data = component.get_party() + +**Deprecated**: prefer `edi_party_helper_oca`'s `edi.party.helper` model or +its `EDIParty` class directly, they don't require any component lookup. diff --git a/edi_party_data_oca/tests/common.py b/edi_party_data_oca/tests/common.py new file mode 100644 index 000000000..9a423f967 --- /dev/null +++ b/edi_party_data_oca/tests/common.py @@ -0,0 +1,84 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.addons.edi_component_oca.tests.common import EDIBackendCommonComponentTestCase + + +class PartyDataCommonTestCase(EDIBackendCommonComponentTestCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.backend = cls.env.ref("edi_core_oca.demo_edi_backend") + cls.cat_model = cls.env["res.partner.id_category"] + cls.all_cat = cls.cat_model.browse() + for i in range(1, 4): + rec = cls.cat_model.create({"code": f"cat{i}", "name": f"Cat {i}"}) + cls.all_cat += rec + setattr(cls, f"category{i}", rec) + + parent = cls.env["res.partner"].create( + { + "name": "ACME inc", + "is_company": True, + } + ) + + for i in range(1, 4): + rec = cls.env["res.partner"].create( + { + "name": f"Test Partner {i}", + "parent_id": parent.id, + "id_numbers": [ + ( + 0, + 0, + { + "name": f"{cat.code}-p{i}", + "category_id": cat.id, + }, + ) + for cat in cls.all_cat[i - 1 :] + ], + } + ) + setattr(cls, f"partner{i}", rec) + + # No need for special file name gen + cls.exc_type = cls._create_exchange_type( + name="ID output test", + code="id_out_test", + direction="output", + ) + cls.exc_record = cls.backend.create_record("id_out_test", {}) + + def _expected_lang(self, partner): + if not partner.lang: + return False + lang = self.env["res.lang"]._get_data(code=partner.lang) + if not lang: + return False + return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + + def _make_expected_data( + self, partner, number, allowed_codes=None, name_field="name", **kw + ): + data = { + "name": partner[name_field], + "identifiers": [ + {"attrs": {"schemeID": "cat1"}, "value": f"cat1-p{number}"}, + {"attrs": {"schemeID": "cat2"}, "value": f"cat2-p{number}"}, + {"attrs": {"schemeID": "cat3"}, "value": f"cat3-p{number}"}, + ], + "endpoint": {}, + "lang": self._expected_lang(partner), + "partner": partner, + } + data.update(kw) + if allowed_codes: + data["identifiers"] = [ + x + for x in data["identifiers"] + if x["attrs"]["schemeID"] in allowed_codes + ] + return data diff --git a/edi_party_data_oca/tests/test_party_data.py b/edi_party_data_oca/tests/test_party_data.py index 7d1484cd5..c115773fa 100644 --- a/edi_party_data_oca/tests/test_party_data.py +++ b/edi_party_data_oca/tests/test_party_data.py @@ -2,161 +2,45 @@ # @author: Simone Orsi # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -from odoo.addons.edi_component_oca.tests.common import EDIBackendCommonComponentTestCase - from ..utils import get_party_data_component +from .common import PartyDataCommonTestCase +# Business logic is tested against the component-independent helper in +# `test_party_helper.py`. This suite only exercises the component wiring +# (work context plumbing, hooks) on top of it. -class PartyDataTestCase(EDIBackendCommonComponentTestCase): - @classmethod - def setUpClass(cls): - super().setUpClass() - cls.backend = cls.env.ref("edi_core_oca.demo_edi_backend") - cls.cat_model = cls.env["res.partner.id_category"] - cls.all_cat = cls.cat_model.browse() - for i in range(1, 4): - rec = cls.cat_model.create({"code": f"cat{i}", "name": f"Cat {i}"}) - cls.all_cat += rec - setattr(cls, f"category{i}", rec) - - parent = cls.env["res.partner"].create( - { - "name": "ACME inc", - "is_company": True, - } - ) - - for i in range(1, 4): - rec = cls.env["res.partner"].create( - { - "name": f"Test Partner {i}", - "parent_id": parent.id, - "id_numbers": [ - ( - 0, - 0, - { - "name": f"{cat.code}-p{i}", - "category_id": cat.id, - }, - ) - for cat in cls.all_cat[i - 1 :] - ], - } - ) - setattr(cls, f"partner{i}", rec) - - # No need for special file name gen - cls.exc_type = cls._create_exchange_type( - name="ID output test", - code="id_out_test", - direction="output", - ) - cls.exc_record = cls.backend.create_record("id_out_test", {}) +class PartyDataTestCase(PartyDataCommonTestCase): def _get_provider(self, partner, **kw): return get_party_data_component(self.exc_record, partner, **kw) - def _expected_lang(self, partner): - if not partner.lang: - return False - lang = self.env["res.lang"]._get_data(code=partner.lang) - if not lang: - return False - return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} - - def _make_expected_data( - self, partner, number, allowed_codes=None, name_field="name", **kw - ): - data = { - "name": partner[name_field], - "identifiers": [ - {"attrs": {"schemeID": "cat1"}, "value": f"cat1-p{number}"}, - {"attrs": {"schemeID": "cat2"}, "value": f"cat2-p{number}"}, - {"attrs": {"schemeID": "cat3"}, "value": f"cat3-p{number}"}, - ], - "endpoint": {}, - "lang": self._expected_lang(partner), - "partner": partner, - } - data.update(kw) - if allowed_codes: - data["identifiers"] = [ - x - for x in data["identifiers"] - if x["attrs"]["schemeID"] in allowed_codes - ] - return data - def test_lookup(self): provider = self._get_provider(self.partner1) self.assertEqual(provider.partner, self.partner1) self.assertFalse(provider.allowed_id_categories) def test_data(self): - expected = ( - (self.partner1, self._make_expected_data(self.partner1, 1)), - ( - self.partner2, - self._make_expected_data( - self.partner2, 2, allowed_codes=["cat2", "cat3"] - ), - ), - ( - self.partner3, - self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), - ), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) + expected = self._make_expected_data(self.partner1, 1) + provider = self._get_provider(self.partner1) + self.assertEqual(provider.get_party(), expected) - def test_data_fullname_override(self): - # `name` is the default `party_data_name_field` since it doesn't embed - # multi-company/disambiguation suffixes the way `display_name` does; - # `display_name` is still available by explicit override. - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, name_field="display_name"), - ), - ( - self.partner2, - self._make_expected_data( - self.partner2, - 2, - allowed_codes=["cat2", "cat3"], - name_field="display_name", - ), - ), - ( - self.partner3, - self._make_expected_data( - self.partner3, 3, allowed_codes=["cat3"], name_field="display_name" - ), - ), - ) - for partner, expected_data in expected: - provider = self._get_provider( - partner, work_ctx={"party_data_name_field": "display_name"} - ) - res = provider.get_party() - self.assertEqual(res, expected_data) + def test_data_limited(self): + self.exc_type.id_category_ids = self.category2 + expected = self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]) + provider = self._get_provider(self.partner2) + self.assertEqual(provider.get_party(), expected) - def test_lang(self): - # No lang set on the partner -> no `lang` key rendered. - self.partner1.lang = False - provider = self._get_provider(self.partner1) - self.assertFalse(provider.get_party()["lang"]) - # Partner's own lang is used by default. - self.partner1.lang = "en_US" - provider = self._get_provider(self.partner1) - self.assertEqual( - provider.get_party()["lang"], - {"name": "English (US)", "code": "en_US", "short": "en"}, + def test_data_name_field_override(self): + # `party_data_name_field` on the work context is forwarded to the + # party's `name_field`. + expected = self._make_expected_data(self.partner1, 1, name_field="display_name") + provider = self._get_provider( + self.partner1, work_ctx={"party_data_name_field": "display_name"} ) - # `work_ctx["lang"]` takes precedence over the partner's own lang. + self.assertEqual(provider.get_party(), expected) + + def test_lang_override_via_work_ctx(self): + # `lang` on the work context is forwarded to the party's `lang_code`. self.partner2.lang = False provider = self._get_provider(self.partner2, work_ctx={"lang": "en_US"}) self.assertEqual( @@ -167,57 +51,3 @@ def test_lang(self): def test_partner_in_party_data(self): provider = self._get_provider(self.partner1) self.assertEqual(provider.get_party()["partner"], self.partner1) - - def test_data_limited_1(self): - self.exc_type.id_category_ids = self.category1 - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, allowed_codes=["cat1"]), - ), - (self.partner2, self._make_expected_data(self.partner2, 2, identifiers=[])), - (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) - - def test_data_limited_2(self): - self.exc_type.id_category_ids = self.category2 - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, allowed_codes=["cat2"]), - ), - ( - self.partner2, - self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]), - ), - (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) - - def test_data_limited_3(self): - self.exc_type.id_category_ids = self.category3 - expected = ( - ( - self.partner1, - self._make_expected_data(self.partner1, 1, allowed_codes=["cat3"]), - ), - ( - self.partner2, - self._make_expected_data(self.partner2, 2, allowed_codes=["cat3"]), - ), - ( - self.partner3, - self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), - ), - ) - for partner, expected_data in expected: - provider = self._get_provider(partner) - res = provider.get_party() - self.assertEqual(res, expected_data) diff --git a/edi_party_helper_oca/README.rst b/edi_party_helper_oca/README.rst new file mode 100644 index 000000000..aab07cbf9 --- /dev/null +++ b/edi_party_helper_oca/README.rst @@ -0,0 +1 @@ +bot please :) diff --git a/edi_party_helper_oca/__init__.py b/edi_party_helper_oca/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/edi_party_helper_oca/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/edi_party_helper_oca/__manifest__.py b/edi_party_helper_oca/__manifest__.py new file mode 100644 index 000000000..337a9bbfc --- /dev/null +++ b/edi_party_helper_oca/__manifest__.py @@ -0,0 +1,20 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). +{ + "name": "EDI Party helper", + "summary": """ + Retrieve party information for EDI exchanges, without any component + dependency. + """, + "version": "18.0.1.0.0", + "development_status": "Alpha", + "license": "AGPL-3", + "website": "https://github.com/OCA/edi-framework", + "author": "Camptocamp, Odoo Community Association (OCA)", + "maintainers": ["simahawk"], + "depends": ["edi_core_oca", "partner_identification"], + "data": [ + "views/edi_exchange_type_views.xml", + ], +} diff --git a/edi_party_data_oca/models/__init__.py b/edi_party_helper_oca/models/__init__.py similarity index 50% rename from edi_party_data_oca/models/__init__.py rename to edi_party_helper_oca/models/__init__.py index 719704f71..0eac27201 100644 --- a/edi_party_data_oca/models/__init__.py +++ b/edi_party_helper_oca/models/__init__.py @@ -1 +1,2 @@ from . import edi_exchange_type +from . import edi_party_helper diff --git a/edi_party_data_oca/models/edi_exchange_type.py b/edi_party_helper_oca/models/edi_exchange_type.py similarity index 100% rename from edi_party_data_oca/models/edi_exchange_type.py rename to edi_party_helper_oca/models/edi_exchange_type.py diff --git a/edi_party_helper_oca/models/edi_party_helper.py b/edi_party_helper_oca/models/edi_party_helper.py new file mode 100644 index 000000000..814691d24 --- /dev/null +++ b/edi_party_helper_oca/models/edi_party_helper.py @@ -0,0 +1,24 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo import models + +from ..utils import EDIParty + + +class EDIPartyHelper(models.AbstractModel): + """Provide partner data for exchanges, without any component dependency.""" + + _name = "edi.party.helper" + _description = "EDI Party Helper" + + def get_party(self, exchange_record, partner, **kw): + """Return the party for `partner` on `exchange_record`. + + :param exchange_record: an `edi.exchange.record` record + :param partner: a `res.partner` record + :param kw: forwarded to `EDIParty` (eg. `name_field`, `lang_code`) + :return: `EDIParty` + """ + return EDIParty(exchange_record=exchange_record, partner=partner, **kw) diff --git a/edi_party_helper_oca/pyproject.toml b/edi_party_helper_oca/pyproject.toml new file mode 100644 index 000000000..4231d0ccc --- /dev/null +++ b/edi_party_helper_oca/pyproject.toml @@ -0,0 +1,3 @@ +[build-system] +requires = ["whool"] +build-backend = "whool.buildapi" diff --git a/edi_party_helper_oca/readme/CONFIGURE.md b/edi_party_helper_oca/readme/CONFIGURE.md new file mode 100644 index 000000000..619baca8a --- /dev/null +++ b/edi_party_helper_oca/readme/CONFIGURE.md @@ -0,0 +1,6 @@ +## ID numbers selection + +On the exchange type form, find the field "ID categories" and set the +categories allowed for that exchange type. + +If not set, *all the IDs* of the partner will be exposed. diff --git a/edi_party_helper_oca/readme/CONTRIBUTORS.md b/edi_party_helper_oca/readme/CONTRIBUTORS.md new file mode 100644 index 000000000..2b66303ae --- /dev/null +++ b/edi_party_helper_oca/readme/CONTRIBUTORS.md @@ -0,0 +1 @@ +- Simone Orsi \<\> diff --git a/edi_party_helper_oca/readme/DESCRIPTION.md b/edi_party_helper_oca/readme/DESCRIPTION.md new file mode 100644 index 000000000..fac36335a --- /dev/null +++ b/edi_party_helper_oca/readme/DESCRIPTION.md @@ -0,0 +1,7 @@ +Technical module to retrieve party information for EDI exchanges. + +It's based on partner_identification so that the party information will +include allowed ID numbers for a given exchange. + +You can configure which ID number categories are allowed on the exchange +type. diff --git a/edi_party_helper_oca/readme/USAGE.md b/edi_party_helper_oca/readme/USAGE.md new file mode 100644 index 000000000..738da5865 --- /dev/null +++ b/edi_party_helper_oca/readme/USAGE.md @@ -0,0 +1,18 @@ +Via the `edi.party.helper` abstract model: + + party = self.env["edi.party.helper"].get_party(exchange_record, partner) + +Or directly, with no ORM registry lookup involved: + + from odoo.addons.edi_party_helper_oca.utils import EDIParty + + party = EDIParty(exchange_record=exchange_record, partner=partner) + +Both return an `EDIParty` instance: the party data (`name`, `identifiers`, +`endpoint`, `lang`) is exposed directly as attributes, alongside `partner`. +It also behaves like a read-only dict of those same keys (`party["name"]`, +`dict(party)`, equality against a plain dict), for backward compatibility +with code expecting the old `DotDict`-based party data. + +Both accept the same optional keyword arguments: `name_field` (defaults to +`"name"`) and `lang_code` (a language code overriding the partner's own). diff --git a/edi_party_helper_oca/static/description/icon.png b/edi_party_helper_oca/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/edi_party_helper_oca/static/description/icon.png differ diff --git a/edi_party_helper_oca/tests/__init__.py b/edi_party_helper_oca/tests/__init__.py new file mode 100644 index 000000000..95a6f190f --- /dev/null +++ b/edi_party_helper_oca/tests/__init__.py @@ -0,0 +1,2 @@ +from . import test_party_helper +from . import test_party_helper_model diff --git a/edi_party_helper_oca/tests/common.py b/edi_party_helper_oca/tests/common.py new file mode 100644 index 000000000..f1b1b321f --- /dev/null +++ b/edi_party_helper_oca/tests/common.py @@ -0,0 +1,87 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from odoo.tests.common import TransactionCase + +from odoo.addons.edi_core_oca.tests.common import EDIBackendTestMixin + + +class PartyHelperCommonTestCase(TransactionCase, EDIBackendTestMixin): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls._setup_env() + cls._setup_records() + cls.cat_model = cls.env["res.partner.id_category"] + cls.all_cat = cls.cat_model.browse() + for i in range(1, 4): + rec = cls.cat_model.create({"code": f"cat{i}", "name": f"Cat {i}"}) + cls.all_cat += rec + setattr(cls, f"category{i}", rec) + + parent = cls.env["res.partner"].create( + { + "name": "ACME inc", + "is_company": True, + } + ) + + for i in range(1, 4): + rec = cls.env["res.partner"].create( + { + "name": f"Test Partner {i}", + "parent_id": parent.id, + "id_numbers": [ + ( + 0, + 0, + { + "name": f"{cat.code}-p{i}", + "category_id": cat.id, + }, + ) + for cat in cls.all_cat[i - 1 :] + ], + } + ) + setattr(cls, f"partner{i}", rec) + + # No need for special file name gen + cls.exc_type = cls._create_exchange_type( + name="ID output test", + code="id_out_test", + direction="output", + ) + cls.exc_record = cls.backend.create_record("id_out_test", {}) + + def _expected_lang(self, partner): + if not partner.lang: + return False + lang = self.env["res.lang"]._get_data(code=partner.lang) + if not lang: + return False + return {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + + def _make_expected_data( + self, partner, number, allowed_codes=None, name_field="name", **kw + ): + data = { + "name": partner[name_field], + "identifiers": [ + {"attrs": {"schemeID": "cat1"}, "value": f"cat1-p{number}"}, + {"attrs": {"schemeID": "cat2"}, "value": f"cat2-p{number}"}, + {"attrs": {"schemeID": "cat3"}, "value": f"cat3-p{number}"}, + ], + "endpoint": {}, + "lang": self._expected_lang(partner), + "partner": partner, + } + data.update(kw) + if allowed_codes: + data["identifiers"] = [ + x + for x in data["identifiers"] + if x["attrs"]["schemeID"] in allowed_codes + ] + return data diff --git a/edi_party_helper_oca/tests/test_party_helper.py b/edi_party_helper_oca/tests/test_party_helper.py new file mode 100644 index 000000000..dc3f93df2 --- /dev/null +++ b/edi_party_helper_oca/tests/test_party_helper.py @@ -0,0 +1,151 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from ..utils import EDIParty +from .common import PartyHelperCommonTestCase + + +class PartyDataHelperTestCase(PartyHelperCommonTestCase): + def _get_party(self, partner, **kw): + return EDIParty(exchange_record=self.exc_record, partner=partner, **kw) + + def test_lookup(self): + party = self._get_party(self.partner1) + self.assertEqual(party.partner, self.partner1) + self.assertFalse(party.allowed_id_categories) + + def test_data(self): + expected = ( + (self.partner1, self._make_expected_data(self.partner1, 1)), + ( + self.partner2, + self._make_expected_data( + self.partner2, 2, allowed_codes=["cat2", "cat3"] + ), + ), + ( + self.partner3, + self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), + ), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) + + def test_data_fullname_override(self): + # `name` is the default `name_field` since it doesn't embed + # multi-company/disambiguation suffixes the way `display_name` does; + # `display_name` is still available by explicit override. + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, name_field="display_name"), + ), + ( + self.partner2, + self._make_expected_data( + self.partner2, + 2, + allowed_codes=["cat2", "cat3"], + name_field="display_name", + ), + ), + ( + self.partner3, + self._make_expected_data( + self.partner3, 3, allowed_codes=["cat3"], name_field="display_name" + ), + ), + ) + for partner, expected_data in expected: + party = self._get_party(partner, name_field="display_name") + self.assertEqual(party, expected_data) + + def test_lang(self): + # No lang set on the partner -> `lang` is falsy. + self.partner1.lang = False + party = self._get_party(self.partner1) + self.assertFalse(party.lang) + # Partner's own lang is used by default. + self.partner1.lang = "en_US" + party = self._get_party(self.partner1) + self.assertEqual( + party.lang, + {"name": "English (US)", "code": "en_US", "short": "en"}, + ) + # Explicit `lang_code` takes precedence over the partner's own lang. + self.partner2.lang = False + party = self._get_party(self.partner2, lang_code="en_US") + self.assertEqual( + party.lang, + {"name": "English (US)", "code": "en_US", "short": "en"}, + ) + + def test_partner_in_party_data(self): + party = self._get_party(self.partner1) + self.assertEqual(party.partner, self.partner1) + + def test_mapping_access(self): + # `EDIParty` behaves like a read-only dict too, for backward + # compatibility with the old `DotDict`-based party data. + party = self._get_party(self.partner1) + self.assertEqual(party["name"], party.name) + self.assertEqual(party["partner"], self.partner1) + self.assertEqual( + set(party.keys()), set(self._make_expected_data(self.partner1, 1)) + ) + self.assertEqual(dict(party), self._make_expected_data(self.partner1, 1)) + with self.assertRaises(KeyError): + party["allowed_id_categories"] # pylint: disable=pointless-statement + + def test_data_limited_1(self): + self.exc_type.id_category_ids = self.category1 + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, allowed_codes=["cat1"]), + ), + (self.partner2, self._make_expected_data(self.partner2, 2, identifiers=[])), + (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) + + def test_data_limited_2(self): + self.exc_type.id_category_ids = self.category2 + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, allowed_codes=["cat2"]), + ), + ( + self.partner2, + self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]), + ), + (self.partner3, self._make_expected_data(self.partner3, 3, identifiers=[])), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) + + def test_data_limited_3(self): + self.exc_type.id_category_ids = self.category3 + expected = ( + ( + self.partner1, + self._make_expected_data(self.partner1, 1, allowed_codes=["cat3"]), + ), + ( + self.partner2, + self._make_expected_data(self.partner2, 2, allowed_codes=["cat3"]), + ), + ( + self.partner3, + self._make_expected_data(self.partner3, 3, allowed_codes=["cat3"]), + ), + ) + for partner, expected_data in expected: + party = self._get_party(partner) + self.assertEqual(party, expected_data) diff --git a/edi_party_helper_oca/tests/test_party_helper_model.py b/edi_party_helper_oca/tests/test_party_helper_model.py new file mode 100644 index 000000000..ef0fa918c --- /dev/null +++ b/edi_party_helper_oca/tests/test_party_helper_model.py @@ -0,0 +1,30 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from .common import PartyHelperCommonTestCase + +# Business logic is tested against `EDIParty` directly in +# `test_party_helper.py`. This suite only exercises the `edi.party.helper` +# abstract model wiring on top of it. + + +class PartyHelperModelTestCase(PartyHelperCommonTestCase): + def _get_party(self, partner, **kw): + return self.env["edi.party.helper"].get_party(self.exc_record, partner, **kw) + + def test_data(self): + expected = self._make_expected_data(self.partner1, 1) + party = self._get_party(self.partner1) + self.assertEqual(party, expected) + + def test_data_name_field_override(self): + expected = self._make_expected_data(self.partner1, 1, name_field="display_name") + party = self._get_party(self.partner1, name_field="display_name") + self.assertEqual(party, expected) + + def test_data_limited(self): + self.exc_type.id_category_ids = self.category2 + expected = self._make_expected_data(self.partner2, 2, allowed_codes=["cat2"]) + party = self._get_party(self.partner2) + self.assertEqual(party, expected) diff --git a/edi_party_helper_oca/utils.py b/edi_party_helper_oca/utils.py new file mode 100644 index 000000000..302159009 --- /dev/null +++ b/edi_party_helper_oca/utils.py @@ -0,0 +1,94 @@ +# Copyright 2022 Camptocamp SA +# @author: Simone Orsi +# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). + +from collections.abc import Mapping +from dataclasses import dataclass + +from odoo.tools import DotDict + + +@dataclass(eq=False) +class EDIParty(Mapping): + """Party information for an EDI exchange. + + The instance itself *is* the party: `name`, `identifiers`, `endpoint` + and `lang` are computed on init and exposed as plain attributes, + alongside `partner`. It also behaves like a read-only mapping of those + (eg: ``party["name"]``, ``dict(party)``, equality against a plain dict) + for backward compatibility with code expecting the old + ``DotDict``-based party data. + """ + + exchange_record: object + partner: object + name_field: str = "name" + lang_code: str | bool = False + #: constructor/config attributes, not part of the party data itself: + #: excluded from the Mapping interface (dict-like access / equality). + _non_party_attrs = frozenset( + {"exchange_record", "name_field", "lang_code", "allowed_id_categories"} + ) + + def __post_init__(self): + self.allowed_id_categories = self.exchange_record.type_id.id_category_ids + # NB: for UBL this should probably replace + # `base.ubl._ubl_get_party_identification` which does nothing today. + self.name = self._get_name() + self.identifiers = self._get_identifiers() + self.endpoint = self._get_endpoint() + self.lang = self._get_lang() + + @property + def env(self): + return self.exchange_record.env + + def _party_data_keys(self): + return [k for k in vars(self) if k not in self._non_party_attrs] + + def __getitem__(self, key): + if key in self._non_party_attrs or key not in vars(self): + raise KeyError(key) + return getattr(self, key) + + def __iter__(self): + return iter(self._party_data_keys()) + + def __len__(self): + return len(self._party_data_keys()) + + def _get_name(self): + return self.partner[self.name_field] + + def _get_endpoint(self): + return {} + + def _get_identifiers(self): + identifiers = self.partner.id_numbers.filtered( + lambda x: self._filter_id_number(x) + ) + return [self._get_identity(x) for x in identifiers] + + def _filter_id_number(self, id_number): + if self.allowed_id_categories: + return id_number.category_id in self.allowed_id_categories + return True + + def _get_identity(self, id_number): + return DotDict( + attrs={ + "schemeID": id_number.category_id.code, + }, + value=id_number.name, + ) + + def _get_lang(self): + lang_code = self.lang_code or self.partner.lang + if not lang_code: + return False + lang = self.env["res.lang"]._get_data(code=lang_code) + if not lang: + return False + return DotDict( + {"name": lang.name, "code": lang.code, "short": lang.code.split("_")[0]} + ) diff --git a/edi_party_data_oca/views/edi_exchange_type_views.xml b/edi_party_helper_oca/views/edi_exchange_type_views.xml similarity index 100% rename from edi_party_data_oca/views/edi_exchange_type_views.xml rename to edi_party_helper_oca/views/edi_exchange_type_views.xml