[IMP]sale_pricelist_global_rule: Extend ancestor category rule logic (ref PR #3533)

Update Readme and logic code

Update Readme and logic code

Update Test

Author: DucTruongKomit

sale_pricelist_global_rule/README.rst

@@ -1,8 +1,12 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
 ==========================
 Sale pricelist global rule
 ==========================
 
-.. 
+..
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
@@ -13,7 +17,7 @@ Sale pricelist global rule
 .. |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
+.. |badge2| image:: https://img.shields.io/badge/license-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%2Fsale--workflow-lightgray.png?logo=github
@@ -52,6 +56,30 @@ quantities across lines allow the pricelist rule to apply, as they meet
 the minimum threshold (16 in the product template example and 20 in the
 product category example).
 
+**Global by Ancestor Product Category**
+
+This option allows defining a rule on an *ancestor category*, and it will
+apply to all products that belong to this category or any of its descendants.
+The minimum quantity check is performed on the **total ordered quantity**
+across all descendant categories.
+
+For example, suppose we have the following category tree:
+
+- Cat A
+  - Cat B
+  - Cat C
+    - Cat D
+
+And a pricelist rule is configured on *Cat C* with a minimum quantity = 5
+and a 20% discount.
+If a sales order contains:
+
+- Line 1: Product in Cat C, quantity = 4
+- Line 2: Product in Cat D, quantity = 2
+
+Then the total for Cat C’s branch = 6 (4 + 2), which meets the minimum
+threshold of 5. As a result, the 20% discount rule applies to both lines.
+
 **Table of contents**
 
 .. contents::
@@ -60,11 +88,14 @@ product category example).
 Configuration
 =============
 
-- Go to Sales -> Products -> Pricelist.
-- Create a new Pricelist and add at least one line with the Apply On
-  option set to Global - Product template or Global - Product category
-- Choose the specific product template or category for the rule.
-- Set the computation mode and save
+- Go to **Sales → Products → Pricelists**.
+- Create a new Pricelist and add at least one line with the *Apply On*
+  option set to **Global - Product Template**, **Global - Product Category**, or
+  **Global - Ancestor Product Category**.
+- When using *Ancestor Product Category*, select the top-level or ancestor
+  category that will include all of its descendant categories.
+- Choose the specific product, template, or category for the rule.
+- Set the computation mode (e.g., percentage discount) and save.
 
 Usage
 =====
@@ -75,6 +106,14 @@ Usage
   Category or Product).
 - Click the **Recompute pricelist global** button to update prices
   according to the specified pricelist rules.
+- When using **Ancestor Product Category**, the system will sum the ordered
+  quantities of all products belonging to the selected ancestor category
+  and all its descendants.
+  If the accumulated quantity meets the rule’s minimum quantity, the
+  discount will be applied to each matching order line.
+- When multiple percentage-based rules apply, the system automatically
+  selects the **highest discount available**, ensuring that the most
+  beneficial rule is applied to the sale order.
 
 Known issues / Roadmap
 ======================
@@ -100,6 +139,7 @@ Authors
 -------
 
 * Tecnativa
+* Truong Duc (Komit-consulting)
 
 Contributors
 ------------
@@ -108,6 +148,7 @@ Contributors
 
   - Pedro M. Baeza
   - Carlos López
+  - Truong Duc (Komit-consulting)
 
 Maintainers
 -----------

sale_pricelist_global_rule/__manifest__.py

@@ -2,7 +2,8 @@
     "name": "Sale pricelist global rule",
     "version": "16.0.1.0.0",
     "summary": "Apply a global rule to all sale order",
-    "author": "Tecnativa, Odoo Community Association (OCA)",
+    "author": "Tecnativa, Odoo Community Association (OCA),"
+    "Truong Duc (Komit-consulting)",
     "category": "Sales Management",
     "website": "https://github.com/OCA/sale-workflow",
     "depends": [

sale_pricelist_global_rule/models/product_pricelist.py

@@ -9,10 +9,15 @@ class ProductPricelistItem(models.Model):
         selection_add=[
             ("3_1_global_product_template", "Global - Product template"),
             ("3_2_global_product_category", "Global - Product category"),
+            (
+                "3_3_global_product_ancestor_category",
+                "Global - Ancestor Product Category",
+            ),
         ],
         ondelete={
             "3_1_global_product_template": "set default",
             "3_2_global_product_category": "set default",
+            "3_3_global_product_ancestor_category": "set default",
         },
     )
     global_product_tmpl_id = fields.Many2one(
@@ -26,6 +31,9 @@ class ProductPricelistItem(models.Model):
         "Product Category",
         ondelete="cascade",
     )
+    ancestor_product_category_id = fields.Many2one(
+        "product.category", ondelete="cascade"
+    )
 
     @api.constrains(
         "product_id",
@@ -57,6 +65,16 @@ def _check_product_consistency(self):
                         "for which this global rule should be applied"
                     )
                 )
+            elif (
+                item.applied_on == "3_3_global_product_ancestor_category"
+                and not item.ancestor_product_category_id
+            ):
+                raise ValidationError(
+                    _(
+                        "Please specify the product ancestor category for which this global"
+                        " rule should be applied"
+                    )
+                )
         return res
 
     @api.depends(
@@ -90,6 +108,13 @@ def _compute_name_and_price(self):
                 item.name = _("Global product: %s") % (
                     item.global_product_tmpl_id.display_name
                 )
+            elif (
+                item.ancestor_product_category_id
+                and item.applied_on == "3_3_global_product_ancestor_category"
+            ):
+                item.name = _("Ancestor product category: %s") % (
+                    item.ancestor_product_category_id.display_name
+                )
         return res
 
     @api.model_create_multi
@@ -105,6 +130,7 @@ def create(self, vals_list):
                             "product_tmpl_id": None,
                             "categ_id": None,
                             "global_product_tmpl_id": None,
+                            "ancestor_product_category_id": None,
                         }
                     )
                 elif applied_on == "3_1_global_product_template":
@@ -114,6 +140,17 @@ def create(self, vals_list):
                             "product_tmpl_id": None,
                             "categ_id": None,
                             "global_categ_id": None,
+                            "ancestor_product_category_id": None,
+                        }
+                    )
+                elif applied_on == "3_3_global_product_ancestor_category":
+                    values.update(
+                        {
+                            "product_id": None,
+                            "product_tmpl_id": None,
+                            "categ_id": None,
+                            "global_categ_id": None,
+                            "global_product_tmpl_id": None,
                         }
                     )
         return super().create(vals_list)
@@ -129,6 +166,7 @@ def write(self, values):
                         "product_tmpl_id": None,
                         "categ_id": None,
                         "global_product_tmpl_id": None,
+                        "ancestor_product_category_id": None,
                     }
                 )
             elif applied_on == "3_1_global_product_template":
@@ -138,6 +176,17 @@ def write(self, values):
                         "product_tmpl_id": None,
                         "categ_id": None,
                         "global_categ_id": None,
+                        "ancestor_product_category_id": None,
+                    }
+                )
+            elif applied_on == "3_3_global_product_ancestor_category":
+                values.update(
+                    {
+                        "product_id": None,
+                        "product_tmpl_id": None,
+                        "categ_id": None,
+                        "global_categ_id": None,
+                        "global_product_tmpl_id": None,
                     }
                 )
         return super().write(values)
@@ -155,19 +204,26 @@ def _is_applicable_for(self, product, qty_in_product_uom):
         :rtype: bool
         """
         self.ensure_one()
-        qty_data = self.env.context.get("pricelist_global_cummulative_quantity", {})
-        if not qty_data or self.applied_on not in [
+        qty_data = (
+            self.env.context.get("pricelist_global_cummulative_quantity", {}) or {}
+        )
+        supported = {
             "3_1_global_product_template",
             "3_2_global_product_category",
-        ]:
+            "3_3_global_product_ancestor_category",
+        }
+        # Fallback to base behavior if not a supported global case or no context
+        if not qty_data or self.applied_on not in supported:
             return super()._is_applicable_for(product, qty_in_product_uom)
+
         is_applicable = True
         if self.applied_on == "3_1_global_product_template":
             total_qty = qty_data["by_template"].get(product.product_tmpl_id, 0.0)
             if self.min_quantity and total_qty < self.min_quantity:
                 is_applicable = False
             elif self.global_product_tmpl_id != product.product_tmpl_id:
                 is_applicable = False
+        # Global Product Category
         elif self.applied_on == "3_2_global_product_category":
             total_qty = qty_data["by_categ"].get(product.categ_id, 0.0)
             if self.min_quantity and total_qty < self.min_quantity:
@@ -176,4 +232,80 @@ def _is_applicable_for(self, product, qty_in_product_uom):
                 self.global_categ_id.parent_path
             ):
                 is_applicable = False
+        # Global Product Category
+        elif self.applied_on == "3_3_global_product_ancestor_category":
+            ancestor_categ = self.ancestor_product_category_id
+            if not ancestor_categ:
+                return False
+
+            Category = self.env["product.category"]
+
+            # ancestor + all descendants (fast, uses parent_path internally)
+            child_categories = Category.search([("id", "child_of", ancestor_categ.id)])
+
+            # product's category must belong to this ancestor branch
+            prod_categ = product.categ_id
+            if not prod_categ or prod_categ not in child_categories:
+                return False
+
+            # Normalize by_categ keys to ids: {id: qty}
+            by_categ_raw = qty_data.get("by_categ") or {}
+            by_categ_id = {
+                (k.id if hasattr(k, "id") else int(k)): v
+                for k, v in by_categ_raw.items()
+            }
+
+            # Sum total quantity across the whole ancestor branch
+            total_qty = sum(by_categ_id.get(cid, 0.0) for cid in child_categories.ids)
+
+            # Check minimum quantity threshold over the branch total
+            if self.min_quantity and total_qty < self.min_quantity:
+                is_applicable = False
+
+        if not is_applicable:
+            return False
+        # --------------------------------------------------------------
+        # Ensure current price item has best discount
+        #
+        # By default Odoo will just pick the first applicable rule  based on sequence.
+        # That means if two percentage rules apply to the same product
+        # (e.g. Cat A = 10%, Cat C = 20%), the system might pick the 10% rule just
+        # because it comes first. Therefore, we need the code below to check if the
+        # current price item is already higher discount.
+        # --------------------------------------------------------------
+        if self._has_better_percentage_rule(product, qty_in_product_uom):
+            is_applicable = False
         return is_applicable
+
+    def _has_better_percentage_rule(self, product, qty_in_product_uom):
+        """
+        Check if there is another percentage rule that should take precedence.
+        This prevents a weaker discount (lower percent_price) from overriding
+        a stronger one when multiple percentage rules apply.
+        """
+        if (
+            self.compute_price != "percentage"
+            or not self.percent_price
+            or self.env.context.get("skip_best_percent_check")
+        ):
+            return False
+
+        # Fetch all other percentage rules from the same pricelist
+        # context skip_best_percent_check to avoid run forever
+        items = self.pricelist_id.item_ids.with_context(
+            skip_best_percent_check=True
+        ).filtered(
+            lambda it: it != self
+            and it.compute_price == "percentage"
+            and it.percent_price > 0
+        )
+        for it in items:
+            # Check if rival rule also applies to this product & quantity
+            if not it._is_applicable_for(product, qty_in_product_uom):
+                continue
+
+            # Get another price item which discount is higher
+            if it.percent_price > self.percent_price:
+                return True
+
+        return False

sale_pricelist_global_rule/readme/CONTRIBUTORS.md

@@ -1,3 +1,4 @@
 - [Tecnativa](https://www.tecnativa.com)
   - Pedro M. Baeza
   - Carlos López
+  - Truong Duc (Komit-consulting)