delivery_auto_refresh: multi-company

Move config to company level
Prefix config settings by sale

Author: jbaudoux

delivery_auto_refresh/migrations/16.0.2.0.0/post-migration.py

@@ -10,6 +10,21 @@ def _migrate_setting_to_company(env):
     ):
         env["res.company"].search([]).sale_auto_assign_carrier_on_create = True
 
+    if env["ir.config_parameter"].get_param(
+        "delivery_auto_refresh.auto_add_delivery_line"
+    ):
+        env["res.company"].search([]).sale_auto_add_delivery_line = True
+
+    if env["ir.config_parameter"].get_param(
+        "delivery_auto_refresh.refresh_after_picking"
+    ):
+        env["res.company"].search([]).sale_refresh_delivery_after_picking = True
+
+    if env["ir.config_parameter"].get_param(
+        "delivery_auto_refresh.auto_void_delivery_line"
+    ):
+        env["res.company"].search([]).sale_auto_void_delivery_line = True
+
 
 def migrate(cr, version):
     env = api.Environment(cr, SUPERUSER_ID, {})

delivery_auto_refresh/models/res_company.py

@@ -12,3 +12,13 @@ class ResCompany(models.Model):
         "Set default shipping method automatically"
     )
     # End migration note
+
+    sale_auto_add_delivery_line = fields.Boolean(
+        "Refresh shipping cost line automatically",
+    )
+    sale_refresh_delivery_after_picking = fields.Boolean(
+        "Refresh delivery after picking automatically",
+    )
+    sale_auto_void_delivery_line = fields.Boolean(
+        "Void delivery lines automatically",
+    )

delivery_auto_refresh/models/res_config_settings.py

@@ -14,15 +14,15 @@ class ResConfigSettings(models.TransientModel):
     )
     # End migration note
 
-    auto_add_delivery_line = fields.Boolean(
-        "Refresh shipping cost line automatically",
-        config_parameter="delivery_auto_refresh.auto_add_delivery_line",
+    sale_auto_add_delivery_line = fields.Boolean(
+        related="company_id.sale_auto_add_delivery_line",
+        readonly=False,
     )
-    refresh_after_picking = fields.Boolean(
-        "Refresh after picking automatically",
-        config_parameter="delivery_auto_refresh.refresh_after_picking",
+    sale_refresh_delivery_after_picking = fields.Boolean(
+        related="company_id.sale_refresh_delivery_after_picking",
+        readonly=False,
     )
-    auto_void_delivery_line = fields.Boolean(
-        "Void delivery lines automatically",
-        config_parameter="delivery_auto_refresh.auto_void_delivery_line",
+    sale_auto_void_delivery_line = fields.Boolean(
+        related="company_id.sale_auto_void_delivery_line",
+        readonly=False,
     )

delivery_auto_refresh/models/sale_order.py

@@ -72,16 +72,12 @@ def _is_auto_set_carrier_on_create(self):
 
     # End migration note
 
-    def _get_param_auto_add_delivery_line(self):
+    def _is_auto_add_delivery_line(self):
         # When we have the context 'website_id' it means that we are doing the order from
         # e-commerce. So we don't want to add the delivery line automatically.
         if self.env.context.get("website_id"):
             return False
-        return (
-            self.env["ir.config_parameter"]
-            .sudo()
-            .get_param("delivery_auto_refresh.auto_add_delivery_line")
-        )
+        return self.company_id.sale_auto_add_delivery_line
 
     def _get_delivery_discount(self, delivery_lines):
         return delivery_lines[-1:].discount
@@ -122,7 +118,7 @@ def _auto_refresh_delivery(self):
         self.ensure_one()
         if self.env.context.get("auto_refresh_delivery"):
             return
-        if not self._get_param_auto_add_delivery_line():
+        if not self._is_auto_add_delivery_line():
             return
         if self.state not in ("draft", "sent"):
             return
@@ -178,7 +174,7 @@ def write(self, vals):
         return res
 
     def set_delivery_line(self, carrier, amount):
-        if self._get_param_auto_add_delivery_line() and self.state in ("draft", "sent"):
+        if self._is_auto_add_delivery_line() and self.state in ("draft", "sent"):
             # This will trigger an _auto_refresh_delivery in write
             self.carrier_id = carrier.id
         else:
@@ -188,6 +184,10 @@ def _is_delivery_line_voidable(self):
         """If the picking is returned before being invoiced, like when the picking
         is delivered but immediately return because the customer refused the order,
         so no delivery charges should be applied."""
+        self.ensure_one()
+        if not self.company_id.sale_auto_void_delivery_line:
+            return False
+
         # There are invoiceable lines so there's no full return or the lines
         # were not set to refund.
         qty_delivered = sum(

delivery_auto_refresh/models/stock_picking.py

@@ -13,15 +13,9 @@ def _add_delivery_cost_to_so(self):
         # based on rules doesn't refresh with real picking data, only with SO
         # ones.
         res = super()._add_delivery_cost_to_so()
-        refresh_after_picking = (
-            self.env["ir.config_parameter"]
-            .sudo()
-            .get_param("delivery_auto_refresh.refresh_after_picking")
-        )
-        if not refresh_after_picking:
-            return res
-        self.ensure_one()
         sale_order = self.sale_id
+        if not sale_order.company_id.sale_refresh_delivery_after_picking:
+            return res
         if not sale_order or not self.carrier_id:  # pragma: no cover
             return res
         so_line = sale_order.order_line.filtered(lambda x: x.is_delivery)[:1]
@@ -65,13 +59,6 @@ def _action_done(self):
         # If configured, we want to set to 0 automatically the delivery line
         # when we have a returned picking that isn't invoiced so we don't have
         # it as invoiceable line. Otherwise, the salesman has to do it by hand.
-        auto_void_delivery_line = (
-            self.env["ir.config_parameter"]
-            .sudo()
-            .get_param("delivery_auto_refresh.auto_void_delivery_line")
-        )
-        if not auto_void_delivery_line:
-            return res
         sales_to_void_delivery = self.filtered(
             lambda x: x.sale_id
             and x.picking_type_code == "incoming"

delivery_auto_refresh/tests/test_delivery_auto_refresh.py

@@ -74,9 +74,6 @@ def setUpClass(cls):
                 "property_product_pricelist": pricelist.id,
             }
         )
-        cls.auto_add_delivery_line = "delivery_auto_refresh.auto_add_delivery_line"
-        cls.refresh_after_picking = "delivery_auto_refresh.refresh_after_picking"
-        cls.auto_void_delivery_line = "delivery_auto_refresh.auto_void_delivery_line"
         cls.settings = cls.env["res.config.settings"].create({})
         cls.settings.execute()
         order_form = Form(cls.env["sale.order"])
@@ -90,7 +87,7 @@ def setUpClass(cls):
 
     def test_auto_refresh_so(self):
         self.assertFalse(self.order.order_line.filtered("is_delivery"))
-        self.settings.auto_add_delivery_line = True
+        self.settings.sale_auto_add_delivery_line = True
         self.settings.execute()
         self.order.write(
             {"order_line": [(1, self.order.order_line.id, {"product_uom_qty": 3})]}
@@ -128,7 +125,7 @@ def test_auto_refresh_so(self):
         self.assertEqual(line_delivery.name, "Test carrier 1")
 
     def test_auto_refresh_picking(self):
-        self.settings.refresh_after_picking = True
+        self.settings.sale_refresh_delivery_after_picking = True
         self.settings.execute()
         self.order.order_line.product_uom_qty = 3
         wiz = Form(
@@ -147,7 +144,7 @@ def test_auto_refresh_picking(self):
         self.assertEqual(line_delivery.price_unit, 50)
 
     def test_auto_refresh_picking_fixed_price(self):
-        self.settings.refresh_after_picking = True
+        self.settings.sale_refresh_delivery_after_picking = True
         self.settings.execute()
         product_fixed_price = self.env["product.product"].create(
             {
@@ -178,7 +175,7 @@ def test_auto_refresh_picking_fixed_price(self):
         self.assertEqual(line_delivery.price_unit, 2)
 
     def test_no_auto_refresh_picking(self):
-        self.settings.refresh_after_picking = False
+        self.settings.sale_refresh_delivery_after_picking = False
         self.settings.execute()
         self.order.order_line.product_uom_qty = 3
         wiz = Form(
@@ -232,8 +229,8 @@ def _return_whole_picking(self, picking, to_refund=True):
     def _test_autorefresh_void_line(self, lock=False, to_refund=True, invoice=False):
         """Helper method to test the possible cases for voiding the line"""
         self.assertFalse(self.order.order_line.filtered("is_delivery"))
-        self.settings.auto_add_delivery_line = True
-        self.settings.auto_void_delivery_line = True
+        self.settings.sale_auto_add_delivery_line = True
+        self.settings.sale_auto_void_delivery_line = True
         self.settings.execute()
         line_delivery = self._confirm_sale_order(self.order)
         self._validate_picking(self.order.picking_ids)
@@ -274,7 +271,7 @@ def test_auto_refresh_so_and_return_no_refund(self):
     def _test_autorefresh_unlink_line(self):
         """Helper method to test the possible cases for voiding the line"""
         self.assertFalse(self.order.order_line.filtered("is_delivery"))
-        self.settings.auto_add_delivery_line = True
+        self.settings.sale_auto_add_delivery_line = True
         self.settings.execute()
         sale_form = Form(self.order)
         # Force the delivery line creation
@@ -295,7 +292,8 @@ def test_auto_refresh_so_and_unlink_line(self):
 
     def test_auto_add_delivery_line_add_service(self):
         """No delivery line when service only"""
-        self.env["ir.config_parameter"].sudo().set_param(self.auto_add_delivery_line, 1)
+        self.settings.sale_auto_add_delivery_line = True
+        self.settings.set_values()
         service = self.env["product.product"].create(
             {"name": "Service Test", "type": "service"}
         )

delivery_auto_refresh/views/res_config_settings_views.xml

@@ -29,30 +29,30 @@
                 <!-- End Migratio note -->
 
                 <div class="o_setting_left_pane">
-                    <field name="auto_add_delivery_line" />
+                    <field name="sale_auto_add_delivery_line" />
                 </div>
                 <div class="o_setting_right_pane">
-                    <label for="auto_add_delivery_line" />
+                    <label for="sale_auto_add_delivery_line" />
                     <div class="text-muted">
                         On the sales quotation, refresh the shipping cost line when saving
                     </div>
                 </div>
 
                 <div class="o_setting_left_pane">
-                    <field name="refresh_after_picking" />
+                    <field name="sale_refresh_delivery_after_picking" />
                 </div>
                 <div class="o_setting_right_pane">
-                    <label for="refresh_after_picking" />
+                    <label for="sale_refresh_delivery_after_picking" />
                     <div class="text-muted">
                         After delivering a sales order, update the shipping cost line based on what has been delivered
                     </div>
                 </div>
 
                 <div class="o_setting_left_pane">
-                    <field name="auto_void_delivery_line" />
+                    <field name="sale_auto_void_delivery_line" />
                 </div>
                 <div class="o_setting_right_pane">
-                    <label for="auto_void_delivery_line" />
+                    <label for="sale_auto_void_delivery_line" />
                     <div class="text-muted">
                         Void the shipping cost line when the delivery is returned before invoicing
                     </div>