[17.0][MIG] sale_coupon_criteria_order_based

sale_loyalty_criteria_order_based/README.rst

@@ -0,0 +1,102 @@
+========================================
+Sales Coupon based on Sales Order values
+========================================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:979b0c094347147f5111cfc8288b9cc8e5881d909d64fb41c068cc4f2ab4f187
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fsale--promotion-lightgray.png?logo=github
+    :target: https://github.com/OCA/sale-promotion/tree/17.0/sale_loyalty_criteria_order_based
+    :alt: OCA/sale-promotion
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/sale-promotion-17-0/sale-promotion-17-0-sale_loyalty_criteria_order_based
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/sale-promotion&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module adds an option to configure your **Loyalty Program** and add
+additional constraints based on **Sales Order** values.
+
+Example: "If Sales Team is 'Europe' grant one point for the program"
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+Open or create a new Loyalty Program in the **Sales/Products/Discount &
+Loyalty** menu.
+
+There's two ways to add a condition based on orders:
+
+- On the program itself, allowing to define ``global`` conditions (valid
+  for all rules)
+  → Find and edit the **Based on Order** field on the **Loyalty
+  Program** form view.
+- On the rule, allowing to define conditions valid for a given rule only
+  → Open or create a new **Loyalty Rule**, and edit the **Based on
+  Order** field.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/sale-promotion/issues>`_.
+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
+`feedback <https://github.com/OCA/sale-promotion/issues/new?body=module:%20sale_loyalty_criteria_order_based%0Aversion:%2017.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
+-------
+
+* Ooops404
+* Cetmix
+
+Contributors
+------------
+
+- Ooops404 <https://www.ooops404.com/>
+- Cetmix <https://cetmix.com/>
+- `Tecnativa <https://www.tecnativa.com>`__
+
+  - Pilar Vargas
+
+- MmeQuignon <[email protected]>
+
+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/sale-promotion <https://github.com/OCA/sale-promotion/tree/17.0/sale_loyalty_criteria_order_based>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

sale_loyalty_criteria_order_based/__init__.py

@@ -0,0 +1 @@
+from . import models

sale_loyalty_criteria_order_based/__manifest__.py

@@ -0,0 +1,18 @@
+# Copyright 2022 Ooops404
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Sales Coupon based on Sales Order values",
+    "version": "17.0.1.0.0",
+    "summary": "Allows to set a sales order related domain for coupon",
+    "author": "Ooops404, Cetmix, Odoo Community Association (OCA)",
+    "contributors": "Ooops404, Cetmix",
+    "license": "AGPL-3",
+    "category": "Sale",
+    "website": "https://github.com/OCA/sale-promotion",
+    "depends": ["sale_loyalty"],
+    "data": [
+        "views/loyalty_program.xml",
+        "views/loyalty_rule.xml",
+    ],
+}

sale_loyalty_criteria_order_based/models/__init__.py

@@ -0,0 +1,3 @@
+from . import sale_order
+from . import loyalty_rule
+from . import loyalty_program

sale_loyalty_criteria_order_based/models/loyalty_program.py

@@ -0,0 +1,34 @@
+# Copyright 2022 Ooops404
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+import ast
+
+from odoo import _, api, fields, models
+from odoo.exceptions import UserError
+from odoo.osv.expression import expression
+
+
+class LoyaltyProgram(models.Model):
+    _inherit = "loyalty.program"
+
+    rule_order_domain = fields.Char(string="Based on Order", default="[]")
+
+    @api.constrains("rule_order_domain")
+    def _constrain_rule_order_domain(self):
+        model = self.env["sale.order"]
+        for program in self:
+            try:
+                domain = ast.literal_eval(program.rule_order_domain)
+                # Ensuring that domain is valid for sale.order
+                expression(domain, model)
+            except Exception as e:
+                raise UserError(_("Invalid domain on program")) from e
+
+    def _is_valid_order(self, order):
+        """Check that we can apply the program on current order"""
+        self.ensure_one()
+        order.ensure_one()
+        domain = ast.literal_eval(self.rule_order_domain)
+        if domain:
+            return bool(order.filtered_domain(domain))
+        return True

sale_loyalty_criteria_order_based/models/loyalty_rule.py

@@ -0,0 +1,35 @@
+# Copyright 2022 Ooops404
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+import ast
+
+from odoo import _, api, fields, models
+from odoo.exceptions import UserError
+from odoo.osv.expression import expression
+
+
+class LoyaltyRule(models.Model):
+    _inherit = "loyalty.rule"
+
+    rule_order_domain = fields.Char(string="Based on Order", default="[]")
+
+    @api.constrains("rule_order_domain")
+    def _constrain_rule_order_domain(self):
+        model = self.env["sale.order"]
+        for rule in self:
+            try:
+                domain = ast.literal_eval(rule.rule_order_domain)
+                # Ensuring that domain is valid for sale.order
+                expression(domain, model)
+            except Exception as e:
+                raise UserError(_("Invalid domain on rule")) from e
+
+    def _is_valid_order(self, order):
+        """Check that we can apply the rule on current order"""
+        self.ensure_one()
+        order.ensure_one()
+        domain = ast.literal_eval(self.rule_order_domain)
+        if domain:
+            return bool(order.filtered_domain(domain))
+        return True

sale_loyalty_criteria_order_based/models/sale_order.py

@@ -0,0 +1,28 @@
+# Copyright 2024 Camptocamp SA
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl)
+
+from odoo import _, models
+from odoo.osv.expression import AND
+
+
+class SaleOrder(models.Model):
+    _inherit = "sale.order"
+
+    def _try_apply_code(self, code):
+        self.ensure_one()
+        base_domain = self._get_trigger_domain()
+        domain = AND([base_domain, [("mode", "=", "with_code"), ("code", "=", code)]])
+        rule = self.env["loyalty.rule"].search(domain)
+        if rule and rule._is_valid_order(self):
+            return super()._try_apply_code(code)
+        return {
+            "error": _(
+                "This code (%(code)s) is not available for this order.", code=code
+            )
+        }
+
+    def _try_apply_program(self, program, coupon):
+        self.ensure_one()
+        if program and program._is_valid_order(self):
+            return super()._try_apply_program(program, coupon)
+        return {"error": _("The program is not available for this order.")}

sale_loyalty_criteria_order_based/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

sale_loyalty_criteria_order_based/readme/CONTRIBUTORS.md

@@ -0,0 +1,5 @@
+- Ooops404 \<<https://www.ooops404.com/>\>
+- Cetmix \<<https://cetmix.com/>\>
+- [Tecnativa](https://www.tecnativa.com)
+  - Pilar Vargas
+- MmeQuignon \<[email protected]\>

sale_loyalty_criteria_order_based/readme/DESCRIPTION.md

@@ -0,0 +1,3 @@
+This module adds an option to configure your **Loyalty Program** and add additional constraints based on **Sales Order** values.
+
+Example: "If Sales Team is 'Europe' grant one point for the program"

sale_loyalty_criteria_order_based/readme/USAGE.md

@@ -0,0 +1,7 @@
+Open or create a new Loyalty Program in the **Sales/Products/Discount & Loyalty** menu.
+
+There's two ways to add a condition based on orders:
+- On the program itself, allowing to define `global` conditions (valid for all rules)\
+  → Find and edit the **Based on Order** field on the **Loyalty Program** form view.
+- On the rule, allowing to define conditions valid for a given rule only\
+  → Open or create a new **Loyalty Rule**, and edit the **Based on Order** field.