[IMP] sale_order_carrier_auto_assign

Allow to assign carrier on create

Author: jbaudoux

sale_order_carrier_auto_assign/__manifest__.py

@@ -2,12 +2,12 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl)
 {
     "name": "Sale Order Carrier Auto Assign",
-    "summary": "Auto assign delivery carrier on sale order confirmation",
-    "version": "16.0.1.1.0",
+    "summary": "Auto assign delivery carrier on sales order",
+    "version": "16.0.2.0.0",
     "development_status": "Alpha",
     "category": "Operations/Inventory/Delivery",
     "website": "https://github.com/OCA/sale-workflow",
-    "author": "Camptocamp, Odoo Community Association (OCA)",
+    "author": "Camptocamp, BCIM, Odoo Community Association (OCA)",
     "license": "AGPL-3",
     "data": ["views/res_config_settings_views.xml"],
     "application": False,

sale_order_carrier_auto_assign/migrations/16.0.2.0.0/pre-migrate.py

@@ -0,0 +1,11 @@
+# Copyright 2024 Jacques-Etienne Baudoux (BCIM) <je@bcim.be>
+# License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl.html).
+
+from odoo.tools import sql
+
+
+def migrate(cr, version):
+    if sql.column_exists(cr, "res_company", "carrier_auto_assign"):
+        sql.rename_column(
+            cr, "res_company", "carrier_auto_assign", "carrier_auto_assign_on_confirm"
+        )

sale_order_carrier_auto_assign/models/res_company.py

@@ -1,4 +1,5 @@
 # Copyright 2023 Camptocamp SA
+# Copyright 2024 Jacques-Etienne Baudoux (BCIM) <je@bcim.be>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 from odoo import fields, models
@@ -7,4 +8,5 @@
 class ResCompany(models.Model):
     _inherit = "res.company"
 
-    carrier_auto_assign = fields.Boolean()
+    carrier_auto_assign_on_create = fields.Boolean()
+    carrier_auto_assign_on_confirm = fields.Boolean()

sale_order_carrier_auto_assign/models/res_config_settings.py

@@ -1,4 +1,5 @@
 # Copyright 2023 Camptocamp SA
+# Copyright 2024 Jacques-Etienne Baudoux (BCIM) <je@bcim.be>
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 from odoo import fields, models
@@ -7,8 +8,14 @@
 class ResConfigSettings(models.TransientModel):
     _inherit = "res.config.settings"
 
-    carrier_auto_assign = fields.Boolean(
-        related="company_id.carrier_auto_assign",
+    carrier_auto_assign_on_create = fields.Boolean(
+        related="company_id.carrier_auto_assign_on_create",
         readonly=False,
-        help="Enable carrier auto assign on sale order confirmation.",
+        help="Enable carrier auto assign on sales order creation.",
+    )
+
+    carrier_auto_assign_on_confirm = fields.Boolean(
+        related="company_id.carrier_auto_assign_on_confirm",
+        readonly=False,
+        help="Enable carrier auto assign on sales order confirmation.",
     )

sale_order_carrier_auto_assign/models/sale_order.py

@@ -1,32 +1,80 @@
 # Copyright 2020 Camptocamp SA
+# Copyright 2024 Jacques-Etienne Baudoux (BCIM) <je@bcim.be>
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl)
-from odoo import models
 
+from odoo import api, models
 
-class SaleOrder(models.Model):
 
+class SaleOrder(models.Model):
     _inherit = "sale.order"
 
-    def action_confirm(self):
-        for rec in self:
-            if not rec.company_id.carrier_auto_assign:
-                continue
-            rec._add_delivery_carrier_on_confirmation()
-        return super().action_confirm()
-
-    def _add_delivery_carrier_on_confirmation(self):
-        """Automatically add delivery.carrier on sale order confirmation"""
+    def _set_delivery_carrier(self, set_delivery_line=True):
         for order in self:
-            if order.delivery_set:
-                continue
             delivery_wiz_action = order.action_open_delivery_wizard()
             delivery_wiz_context = delivery_wiz_action.get("context", {})
             if not delivery_wiz_context.get("default_carrier_id"):
                 continue
             delivery_wiz = (
                 self.env[delivery_wiz_action.get("res_model")]
                 .with_context(**delivery_wiz_context)
-                .create({})
+                .new({})
             )
-            delivery_wiz._get_shipment_rate()
-            delivery_wiz.button_confirm()
+
+            # Do not override carrier
+            if order.carrier_id:
+                delivery_wiz.carrier_id = order.carrier_id
+
+            # If the carrier isn't allowed, we won't default to it
+            if (
+                delivery_wiz.carrier_id
+                not in delivery_wiz.available_carrier_ids._origin
+            ):
+                return
+
+            if not set_delivery_line or order.is_all_service:
+                # Only set the carrier
+                if order.carrier_id != delivery_wiz.carrier_id:
+                    order.carrier_id = delivery_wiz.carrier_id
+            else:
+                delivery_wiz._get_shipment_rate()
+                delivery_wiz.button_confirm()
+
+    @api.onchange("partner_id", "partner_shipping_id")
+    def _add_delivery_carrier_on_partner_change(self):
+        partner = self.partner_shipping_id or self.partner_id
+        if not partner:
+            return
+        if self.company_id.carrier_auto_assign_on_create:
+            self._set_delivery_carrier(set_delivery_line=False)
+
+    def _is_auto_set_carrier_on_create(self):
+        self.ensure_one()
+        if self.state not in ("draft", "sent"):
+            return False
+        if self.company_id.carrier_auto_assign_on_create:
+            return True
+        return False
+
+    @api.model_create_multi
+    def create(self, vals_list):
+        orders = super().create(vals_list)
+        for order in orders:
+            if not order.carrier_id and order._is_auto_set_carrier_on_create():
+                order._set_delivery_carrier()
+        return orders
+
+    def _add_delivery_carrier_on_confirmation(self):
+        """Automatically add delivery.carrier on sale order confirmation"""
+        for order in self:
+            if order.delivery_set:
+                continue
+            if order.is_all_service:
+                continue
+            order._set_delivery_carrier()
+
+    def action_confirm(self):
+        for order in self:
+            if not order.company_id.carrier_auto_assign_on_confirm:
+                continue
+            order._add_delivery_carrier_on_confirmation()
+        return super().action_confirm()

sale_order_carrier_auto_assign/readme/CONFIGURE.rst

@@ -1,3 +1,6 @@
 To enable sale order carrier auto assign:
 
 #. Go to *Settings > Sales > Carrier Auto Assign*.
+
+* Enable on creation: only the carrier will be set.
+* Enable on confirmation: the carrier and delivery line will be set.

sale_order_carrier_auto_assign/readme/CONTRIBUTORS.rst

@@ -3,4 +3,5 @@
 * Phuc (Tran Thanh) <phuc@trobz.com>
 * Telmo Santos <telmo.santos@camptocamp.com>
 * Tris Doan <tridm@trobz.com>
+* Jacques-Etienne Baudoux (BCIM) <je@bcim.be>
 

sale_order_carrier_auto_assign/readme/DESCRIPTION.rst

@@ -1 +1,3 @@
-This module assigns automatically delivery carrier on sale order confirmation.
+This module assigns automatically delivery carrier on sale order creation or confirmation.
+
+You may also have a look at the module delivery_auto_refresh in delivery-carrier repository.

sale_order_carrier_auto_assign/tests/test_sale_order_carrier_auto_assign.py

@@ -1,28 +1,96 @@
 # Copyright 2020 Camptocamp SA
+# Copyright 2024 Jacques-Etienne Baudoux (BCIM) <je@bcim.be>
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl)
 from odoo.tests import Form, TransactionCase
 
 from odoo.addons.base.tests.common import DISABLED_MAIL_CONTEXT
 
 
-class TestSaleOrderCarrierAutoAssign(TransactionCase):
+class TestSaleOrderCarrierAutoAssignCommon(TransactionCase):
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
         cls.env = cls.env["base"].with_context(**DISABLED_MAIL_CONTEXT).env
-        cls.settings = cls.env["res.config.settings"].create({})
-        cls.settings.carrier_auto_assign = True
-        cls.settings.set_values()
 
         cls.partner = cls.env.ref("base.res_partner_2")
-        product = cls.env.ref("product.product_product_9")
+        cls.product_storable = cls.env.ref("product.product_product_9")
         cls.delivery_local_delivery = cls.env.ref("delivery.delivery_local_delivery")
         cls.delivery_local_delivery.fixed_price = 10
-        sale_order_form = Form(cls.env["sale.order"])
-        sale_order_form.partner_id = cls.partner
-        with sale_order_form.order_line.new() as line_form:
-            line_form.product_id = product
-        cls.sale_order = sale_order_form.save()
+
+
+class TestSaleOrderCarrierAutoAssignOnCreate(TestSaleOrderCarrierAutoAssignCommon):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.settings = cls.env["res.config.settings"].create({})
+
+    def test_sale_order_carrier_auto_assign_onchange(self):
+        self.assertEqual(
+            self.partner.property_delivery_carrier_id, self.delivery_local_delivery
+        )
+        self.settings.carrier_auto_assign_on_create = True
+        self.settings.set_values()
+        sale_order_form = Form(self.env["sale.order"])
+        sale_order_form.partner_id = self.partner
+        sale_order = sale_order_form.save()
+        self.assertEqual(sale_order.carrier_id, self.delivery_local_delivery)
+
+    def test_sale_order_carrier_auto_assign_create(self):
+        self.assertEqual(
+            self.partner.property_delivery_carrier_id, self.delivery_local_delivery
+        )
+        self.settings.carrier_auto_assign_on_create = True
+        self.settings.set_values()
+        sale_order = self.env["sale.order"].create({"partner_id": self.partner.id})
+        self.assertEqual(sale_order.carrier_id, self.delivery_local_delivery)
+
+    def test_sale_order_carrier_auto_assign_disabled(self):
+        self.assertEqual(
+            self.partner.property_delivery_carrier_id, self.delivery_local_delivery
+        )
+        self.settings.carrier_auto_assign_on_create = False
+        self.settings.set_values()
+        sale_order_form = Form(self.env["sale.order"])
+        sale_order_form.partner_id = self.partner
+        sale_order = sale_order_form.save()
+        self.assertFalse(sale_order.carrier_id)
+
+    def test_sale_order_carrier_auto_assign_no_carrier(self):
+        self.partner.property_delivery_carrier_id = False
+        self.settings.carrier_auto_assign_on_create = True
+        self.settings.set_values()
+        sale_order_form = Form(self.env["sale.order"])
+        sale_order_form.partner_id = self.partner
+        sale_order = sale_order_form.save()
+        self.assertFalse(sale_order.carrier_id)
+
+    def test_sale_order_carrier_auto_assign_carrier_already_set(self):
+        self.assertEqual(
+            self.partner.property_delivery_carrier_id, self.delivery_local_delivery
+        )
+        self.settings.carrier_auto_assign_on_create = True
+        carrier = self.env.ref("delivery.delivery_carrier")
+        sale_order = self.env["sale.order"].create(
+            {
+                "partner_id": self.partner.id,
+                "carrier_id": carrier.id,
+            }
+        )
+        self.assertEqual(sale_order.carrier_id, carrier)
+
+
+class TestSaleOrderCarrierAutoAssignOnConfirm(TestSaleOrderCarrierAutoAssignCommon):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.settings = cls.env["res.config.settings"].create({})
+        cls.settings.carrier_auto_assign_on_confirm = True
+        cls.settings.set_values()
+        cls.sale_order_form = Form(cls.env["sale.order"])
+        cls.sale_order_form.partner_id = cls.partner
+        with cls.sale_order_form.order_line.new() as line_form:
+            line_form.product_id = cls.product_storable
+        cls.sale_order = cls.sale_order_form.save()
 
     def test_sale_order_carrier_auto_assign(self):
         self.assertEqual(
@@ -36,9 +104,30 @@ def test_sale_order_carrier_auto_assign(self):
         delivery_rate = self.delivery_local_delivery.rate_shipment(self.sale_order)
         self.assertEqual(delivery_line.price_unit, delivery_rate["carrier_price"])
 
+    def test_sale_order_carrier_auto_assign_disabled(self):
+        self.assertEqual(
+            self.partner.property_delivery_carrier_id, self.delivery_local_delivery
+        )
+        self.assertFalse(self.sale_order.carrier_id)
+        self.settings.carrier_auto_assign_on_confirm = False
+        self.settings.set_values()
+        self.sale_order.action_confirm()
+        self.assertEqual(self.sale_order.state, "sale")
+        self.assertFalse(self.sale_order.carrier_id)
+
     def test_sale_order_carrier_auto_assign_no_carrier(self):
         self.partner.property_delivery_carrier_id = False
         self.assertFalse(self.sale_order.carrier_id)
         self.sale_order.action_confirm()
         self.assertEqual(self.sale_order.state, "sale")
         self.assertFalse(self.sale_order.carrier_id)
+
+    def test_sale_order_carrier_auto_assign_carrier_already_set(self):
+        self.assertEqual(
+            self.partner.property_delivery_carrier_id, self.delivery_local_delivery
+        )
+        carrier = self.env.ref("delivery.delivery_carrier")
+        self.sale_order.carrier_id = carrier
+        self.sale_order.action_confirm()
+        self.assertEqual(self.sale_order.state, "sale")
+        self.assertEqual(self.sale_order.carrier_id, carrier)

sale_order_carrier_auto_assign/views/res_config_settings_views.xml

@@ -8,12 +8,27 @@
             <xpath expr="//div[@name='shipping_setting_container']" position="inside">
                 <div class="col-12 col-lg-6 o_setting_box" id="carrier_auto_assign">
                     <div class="o_setting_left_pane">
-                        <field name="carrier_auto_assign" />
+                        <field name="carrier_auto_assign_on_create" />
                     </div>
                     <div class="o_setting_right_pane">
-                        <label for="carrier_auto_assign" string="Carrier auto assign" />
+                        <label
+                            for="carrier_auto_assign_on_create"
+                            string="Carrier auto assign on create"
+                        />
                         <div class="text-muted">
-                            Assigns automatically delivery carrier on sale order confirmation.
+                            Assigns automatically the delivery carrier on sales order creation.
+                        </div>
+                    </div>
+                    <div class="o_setting_left_pane">
+                        <field name="carrier_auto_assign_on_confirm" />
+                    </div>
+                    <div class="o_setting_right_pane">
+                        <label
+                            for="carrier_auto_assign_on_confirm"
+                            string="Carrier auto assign on confirmation"
+                        />
+                        <div class="text-muted">
+                            Assigns automatically delivery carrier on sales order confirmation.
                         </div>
                     </div>
                 </div>