[13.0][MIG] l10n_nl_postcode

l10n_nl_postcode/README.rst

@@ -0,0 +1,97 @@
+======================================
+Dutch postcode validation for Partners
+======================================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+    :alt: License: AGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fl10n--netherlands-lightgray.png?logo=github
+    :target: https://github.com/OCA/l10n-netherlands/tree/13.0/l10n_nl_postcode
+    :alt: OCA/l10n-netherlands
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/l10n-netherlands-13-0/l10n-netherlands-13-0-l10n_nl_postcode
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/176/13.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module checks and validates the Dutch zip code (postcode) on partner forms.
+
+* In case the postcode is not valid, a non-blocking alert is shown.
+* In case the postcode is valid, it will be formatted in the form *1234 AB*.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+The module depends on the external library 'python-stdnum'.
+
+You can install that library by using pip:
+
+.. code-block:: console
+
+    $ pip3 install python-stdnum
+
+Usage
+=====
+
+To use this module, you need to:
+
+* Open a form of a contact and set it as *Individual* (not a *Company*)
+* Enter the country = Netherlands
+* Enter a valid postcode: not any warning is displayed
+* Enter a wrong postcode: a non-blocking warning is displayed
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/l10n-netherlands/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/l10n-netherlands/issues/new?body=module:%20l10n_nl_postcode%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+
+Do not contact contributors directly about support or help with technical issues.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Onestein
+
+Contributors
+~~~~~~~~~~~~
+
+* Andrea Stirpe <a.stirpe@onestein.nl>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+OCA, or the Odoo Community Association, is a nonprofit organization whose
+mission is to support the collaborative development of Odoo features and
+promote its widespread use.
+
+This module is part of the `OCA/l10n-netherlands <https://github.com/OCA/l10n-netherlands/tree/13.0/l10n_nl_postcode>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

l10n_nl_postcode/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import models

l10n_nl_postcode/__manifest__.py

@@ -0,0 +1,14 @@
+# Copyright 2016-2020 Onestein (<http://www.onestein.eu>)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Dutch postcode validation for Partners",
+    "version": "13.0.1.0.0",
+    "category": "Localization",
+    "author": "Onestein,Odoo Community Association (OCA)",
+    "maintainers": ["astirpe"],
+    "website": "https://github.com/OCA/l10n-netherlands",
+    "license": "AGPL-3",
+    "depends": ["base"],
+    "external_dependencies": {"python": ["python-stdnum"]},
+}

l10n_nl_postcode/models/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import res_partner

l10n_nl_postcode/models/res_partner.py

@@ -0,0 +1,43 @@
+# Copyright 2016-2020 Onestein (<http://www.onestein.eu>)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import logging
+
+from odoo import _, api, models
+
+_logger = logging.getLogger(__name__)
+try:
+    from stdnum.nl import postcode
+except ImportError:
+    _logger.debug("Cannot import stdnum.nl.postcode.")
+
+
+class ResPartner(models.Model):
+    _inherit = "res.partner"
+
+    def _l10n_nl_postcode_get_warning(self):
+        self.ensure_one()
+        msg = _("The Postcode you entered (%s) is not valid.")
+        return {"title": _("Warning!"), "message": msg % self.zip}
+
+    def _l10n_nl_postcode_check_country(self):
+        self.ensure_one()
+        if not self.country_id or self.country_id != self.env.ref("base.nl"):
+            return False
+        return True
+
+    @api.onchange("zip", "country_id")
+    def onchange_zip_l10n_nl_postcode(self):
+        # if 'skip_postcode_check' passed in context: will disable the check
+        if self.env.context.get("skip_postcode_check"):
+            return
+
+        if self.zip and self._l10n_nl_postcode_check_country():
+            # check that the postcode is valid
+            if postcode.is_valid(self.zip):
+                # properly format the entered postcode
+                self.zip = postcode.validate(self.zip)
+            else:
+                # display a warning
+                warning_msg = self._l10n_nl_postcode_get_warning()
+                return {"warning": warning_msg}

l10n_nl_postcode/readme/CONTRIBUTORS.rst

@@ -0,0 +1 @@
+* Andrea Stirpe <a.stirpe@onestein.nl>

l10n_nl_postcode/readme/DESCRIPTION.rst

@@ -0,0 +1,4 @@
+This module checks and validates the Dutch zip code (postcode) on partner forms.
+
+* In case the postcode is not valid, a non-blocking alert is shown.
+* In case the postcode is valid, it will be formatted in the form *1234 AB*.

l10n_nl_postcode/readme/INSTALL.rst

@@ -0,0 +1,7 @@
+The module depends on the external library 'python-stdnum'.
+
+You can install that library by using pip:
+
+.. code-block:: console
+
+    $ pip3 install python-stdnum

l10n_nl_postcode/readme/USAGE.rst

@@ -0,0 +1,6 @@
+To use this module, you need to:
+
+* Open a form of a contact and set it as *Individual* (not a *Company*)
+* Enter the country = Netherlands
+* Enter a valid postcode: not any warning is displayed
+* Enter a wrong postcode: a non-blocking warning is displayed