[MIG] delivery_carrier_multi_zip: Migration to 17.0

TT54925

Author: victoralmau

delivery_carrier_multi_zip/README.rst

@@ -36,29 +36,15 @@ matching each shipping method.
 .. contents::
    :local:
 
-Installation
-============
-
-This module generates the initial ZIP interval entry from existing "ZIP
-from" and "ZIP to", filling one of the two interval parts with wildcard
-strings.
-
 Configuration
 =============
 
 To configure delivery methods with multiple ZIPs:
 
 1. Go to Inventory > Configuration > Delivery > Shipping Methods
 2. Create or edit an existing record.
-3. Introduce a line for each interval of zip codes.
-
-Known issues / Roadmap
-======================
-
--  There's some code for proxying the standard values to the new
-   intervals, for covering cases like automatisms or other modules that
-   touch such fields, but there are still non covered cases like
-   multiple consecutive writings creating weird ZIP interval tables.
+3. Set Zip Option as Ranges.
+4. Introduce a line for each interval of zip codes.
 
 Bug Tracker
 ===========
@@ -84,6 +70,7 @@ Contributors
 -  \`Tecnativa <https://www.tecnativa.com>\_\_\`:
 
    -  Pedro M. Baeza
+   -  Víctor Martínez
 
 -  Philipp Zimmer
 

delivery_carrier_multi_zip/__init__.py

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

delivery_carrier_multi_zip/__manifest__.py

@@ -2,13 +2,12 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 {
     "name": "Multiple ZIP intervals for the same delivery method",
-    "version": "15.0.1.0.0",
+    "version": "17.0.1.0.0",
     "category": "Delivery",
     "website": "https://github.com/OCA/delivery-carrier",
     "author": "Tecnativa, Odoo Community Association (OCA)",
     "license": "AGPL-3",
     "installable": True,
-    "depends": ["delivery"],
+    "depends": ["stock_delivery"],
     "data": ["security/ir.model.access.csv", "views/delivery_carrier_view.xml"],
-    "post_init_hook": "post_init_hook",
 }

delivery_carrier_multi_zip/hooks.py

@@ -7,47 +7,23 @@
 class DeliveryCarrier(models.Model):
     _inherit = "delivery.carrier"
 
+    zip_option = fields.Selection(
+        selection=[
+            ("prefix", "Prefixes"),
+            ("range", "Ranges"),
+        ],
+        default="prefix",
+    )
     zip_range_ids = fields.One2many(
         comodel_name="delivery.carrier.zip",
         inverse_name="carrier_id",
         string="ZIP codes",
     )
 
-    @api.model
-    def _convert_zip_to_intervals(self, vals):
-        if self.env.context.get("bypass_multi_zip"):
-            return
-        if vals.get("zip_from") or vals.get("zip_to"):
-            vals.setdefault("zip_range_ids", [])
-            vals["zip_range_ids"].append(
-                (
-                    0,
-                    0,
-                    {
-                        "zip_from": vals.get("zip_from", "0") or "0",
-                        "zip_to": vals.get("zip_to", "z") or "z",
-                    },
-                )
-            )
-            vals.pop("zip_from", False)
-            vals.pop("zip_to", False)
-
-    @api.model_create_multi
-    def create(self, vals_list):
-        """Intercept creation for changing ZIP values to ZIP interval."""
-        for vals in vals_list:
-            self._convert_zip_to_intervals(vals)
-        return super().create(vals_list)
-
-    def write(self, vals):
-        """Intercept write for changing ZIP values to ZIP interval."""
-        self._convert_zip_to_intervals(vals)
-        return super().write(vals)
-
     def _match_address(self, partner):
         """Match as well by zip intervals if they are present."""
         res = super()._match_address(partner)  # it has self.ensure_one()
-        if res and self.zip_range_ids:
+        if res and self.zip_option == "range" and self.zip_range_ids:
             partner_zip = partner.zip or ""
             res = bool(
                 self.zip_range_ids.filtered(
@@ -71,4 +47,4 @@ class DeliveryCarrierZip(models.Model):
     @api.depends("zip_from", "zip_to")
     def _compute_name(self):
         for record in self:
-            record.name = "%s - %s" % (record.zip_from, record.zip_to)
+            record.name = f"{record.zip_from} - {record.zip_to}"

delivery_carrier_multi_zip/models/delivery_carrier.py

@@ -2,4 +2,5 @@ To configure delivery methods with multiple ZIPs:
 
 1.  Go to Inventory \> Configuration \> Delivery \> Shipping Methods
 2.  Create or edit an existing record.
+3.  Set Zip Option as Ranges.
 3.  Introduce a line for each interval of zip codes.

delivery_carrier_multi_zip/readme/CONFIGURE.md

@@ -1,3 +1,4 @@
 - \`Tecnativa \<<https://www.tecnativa.com>\>\_\_\`:
   - Pedro M. Baeza
+  - Víctor Martínez
 - Philipp Zimmer

delivery_carrier_multi_zip/readme/CONTRIBUTORS.md

@@ -375,70 +375,55 @@ <h1 class="title">Multiple ZIP intervals for the same delivery method</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#installation" id="toc-entry-1">Installation</a></li>
-<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
-<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-3">Known issues / Roadmap</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
+<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-4">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-5">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-6">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
-<div class="section" id="installation">
-<h1><a class="toc-backref" href="#toc-entry-1">Installation</a></h1>
-<p>This module generates the initial ZIP interval entry from existing “ZIP
-from” and “ZIP to”, filling one of the two interval parts with wildcard
-strings.</p>
-</div>
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <p>To configure delivery methods with multiple ZIPs:</p>
 <ol class="arabic simple">
 <li>Go to Inventory &gt; Configuration &gt; Delivery &gt; Shipping Methods</li>
 <li>Create or edit an existing record.</li>
+<li>Set Zip Option as Ranges.</li>
 <li>Introduce a line for each interval of zip codes.</li>
 </ol>
 </div>
-<div class="section" id="known-issues-roadmap">
-<h1><a class="toc-backref" href="#toc-entry-3">Known issues / Roadmap</a></h1>
-<ul class="simple">
-<li>There’s some code for proxying the standard values to the new
-intervals, for covering cases like automatisms or other modules that
-touch such fields, but there are still non covered cases like
-multiple consecutive writings creating weird ZIP interval tables.</li>
-</ul>
-</div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/delivery-carrier/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/delivery-carrier/issues/new?body=module:%20delivery_carrier_multi_zip%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#toc-entry-5">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-6">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-4">Authors</a></h2>
 <ul class="simple">
 <li>Tecnativa</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-7">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Contributors</a></h2>
 <ul class="simple">
 <li>`Tecnativa &lt;<a class="reference external" href="https://www.tecnativa.com">https://www.tecnativa.com</a>&gt;__`:<ul>
 <li>Pedro M. Baeza</li>
+<li>Víctor Martínez</li>
 </ul>
 </li>
 <li>Philipp Zimmer</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-8">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Maintainers</a></h2>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org">
 <img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />

delivery_carrier_multi_zip/readme/INSTALL.md

@@ -1,12 +1,11 @@
 # Copyright 2022 Tecnativa - Pedro M. Baeza
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 
-from odoo.tests import common
 
-from odoo.addons.delivery_carrier_multi_zip.hooks import post_init_hook
+from odoo.addons.base.tests.common import BaseCommon
 
 
-class TestDeliveryCarrierMultiZip(common.TransactionCase):
+class TestDeliveryCarrierMultiZip(BaseCommon):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
@@ -23,30 +22,11 @@ def setUpClass(cls):
             {
                 "name": "Test carrier multi ZIP",
                 "product_id": cls.product.id,
-                "zip_from": "0001",
-                "zip_to": "0001",
+                "zip_option": "range",
+                "zip_range_ids": [(0, 0, {"zip_from": "0001", "zip_to": "0001"})],
             }
         )
 
-    def test_delivery_multi_zip_write_create(self):
-        self.assertEqual(len(self.carrier.zip_range_ids), 1)
-        self.assertEqual(self.carrier.zip_range_ids.zip_from, "0001")
-        self.assertEqual(self.carrier.zip_range_ids.zip_to, "0001")
-        self.carrier.write({"zip_to": "0002"})
-        self.assertEqual(len(self.carrier.zip_range_ids), 2)
-        self.assertEqual(self.carrier.zip_range_ids[1].zip_from, "0")
-        self.assertEqual(self.carrier.zip_range_ids[1].zip_to, "0002")
-
-    def test_post_init_hook(self):
-        self.carrier.zip_range_ids.unlink()
-        self.carrier.with_context(bypass_multi_zip=True).write({"zip_from": "0002"})
-        post_init_hook(self.env.cr, None)
-        self.assertEqual(len(self.carrier.zip_range_ids), 1)
-        self.assertEqual(self.carrier.zip_range_ids.zip_from, "0002")
-        self.assertEqual(self.carrier.zip_range_ids.zip_to, "z")
-        self.carrier.refresh()
-        self.assertFalse(self.carrier.zip_from)
-
     def test_available_carriers(self):
         self.assertIn(self.carrier, self.carrier.available_carriers(self.partner_1))
         self.assertNotIn(self.carrier, self.carrier.available_carriers(self.partner_2))

delivery_carrier_multi_zip/readme/ROADMAP.md

@@ -6,22 +6,24 @@
         <field name="model">delivery.carrier</field>
         <field name="inherit_id" ref="delivery.view_delivery_carrier_form" />
         <field name="arch" type="xml">
-            <group name="zip_from" position="attributes">
-                <attribute name="invisible">1</attribute>
-            </group>
-            <group name="zip_to" position="attributes">
-                <attribute name="invisible">1</attribute>
-            </group>
-            <xpath expr="//group[@name='country_details']/.." position="after">
-                <group name="group_zip_range_ids" colspan="2">
-                    <field name="zip_range_ids">
-                        <tree editable="bottom" default_order="zip_from, zip_to">
-                            <field name="zip_from" />
-                            <field name="zip_to" />
-                        </tree>
-                    </field>
-                </group>
-            </xpath>
+            <field name="zip_prefix_ids" position="before">
+                <field
+                    name="zip_option"
+                    widget="radio"
+                    options="{'horizontal': true}"
+                />
+            </field>
+            <field name="zip_prefix_ids" position="attributes">
+                <attribute name="invisible">zip_option!='prefix'</attribute>
+            </field>
+            <field name="zip_prefix_ids" position="after">
+                <field name="zip_range_ids" invisible="zip_option!='range'">
+                    <tree editable="bottom" default_order="zip_from, zip_to">
+                        <field name="zip_from" />
+                        <field name="zip_to" />
+                    </tree>
+                </field>
+            </field>
         </field>
     </record>
 </odoo>