[18.0][ADD] sale_loyalty_margin_computation: New module

sale_loyalty_margin_computation/README.rst

@@ -0,0 +1,80 @@
+===============================
+Sale Loyalty Margin Computation
+===============================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:9130c282b0515dc9f3fe5dfb48a3eb3f560b930e1067711ba89332ad2cc697c9
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fmargin--analysis-lightgray.png?logo=github
+    :target: https://github.com/OCA/margin-analysis/tree/18.0/sale_loyalty_margin_computation
+    :alt: OCA/margin-analysis
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/margin-analysis-18-0/margin-analysis-18-0-sale_loyalty_margin_computation
+    :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/margin-analysis&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows configuring a formula to calculate the margin of a
+sale order line with loyalty rewards
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/margin-analysis/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/margin-analysis/issues/new?body=module:%20sale_loyalty_margin_computation%0Aversion:%2018.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
+-------
+
+* Tecnativa
+
+Contributors
+------------
+
+- `Tecnativa <https://www.tecnativa.com>`__:
+
+  - Pedro M. Baeza
+  - Andrii Kompaniiets
+
+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/margin-analysis <https://github.com/OCA/margin-analysis/tree/18.0/sale_loyalty_margin_computation>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

sale_loyalty_margin_computation/__init__.py

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

sale_loyalty_margin_computation/__manifest__.py

@@ -0,0 +1,19 @@
+# Copyright 2026 Tecnativa - Andrii Kompaniiets
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+{
+    "name": "Sale Loyalty Margin Computation",
+    "summary": "Allows to use a formula from reward for calculate sale margin",
+    "version": "18.0.1.0.0",
+    "category": "Sale",
+    "website": "https://github.com/OCA/margin-analysis",
+    "author": "Tecnativa, Odoo Community Association (OCA)",
+    "license": "AGPL-3",
+    "depends": [
+        "loyalty_margin_computation",
+        "sale_loyalty_order_line_link",
+        "sale_margin_pricelist_computation",
+    ],
+    "data": [
+        "views/loyalty_reward_views.xml",
+    ],
+}

sale_loyalty_margin_computation/i18n/es.po

@@ -0,0 +1,63 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* sale_loyalty_margin_computation
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 18.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2026-05-05 19:15+0000\n"
+"PO-Revision-Date: 2026-05-05 21:18+0200\n"
+"Last-Translator: Andrii Kompaniiets <andrii.kompaniiets@tecnativa.com>\n"
+"Language-Team: \n"
+"Language: es_ES\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+"X-Generator: Poedit 3.9\n"
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>context</code>: The context"
+msgstr "<code>context</code>: El contexto"
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>origin_line</code>: The origin sale order line"
+msgstr "<code>origin_line</code>: La línea del pedido de venta de origen"
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>reward_line</code>: The Reward line"
+msgstr "<code>reward_line</code>: La línea de recompensa"
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>reward_lines</code>: The Reward lines"
+msgstr "<code>reward_lines</code>: Las líneas de recompensas"
+
+#. module: sale_loyalty_margin_computation
+#. odoo-python
+#: code:addons/sale_loyalty_margin_computation/models/loyalty_reward.py:0
+msgid ""
+"Invalid sale margin formula:\n"
+"%(error)s"
+msgstr ""
+"Fórmula de margen de venta no válida:\n"
+"%(error)s"
+
+#. module: sale_loyalty_margin_computation
+#: model:ir.model,name:sale_loyalty_margin_computation.model_loyalty_reward
+msgid "Loyalty Reward"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model:ir.model,name:sale_loyalty_margin_computation.model_sale_order_line
+msgid "Sales Order Line"
+msgstr "Linea de pedido de venta"
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "result = origin_lines[0].price_unit * origin_lines[0].product_uom_qty - 11"
+msgstr ""

sale_loyalty_margin_computation/i18n/sale_loyalty_margin_computation.pot

@@ -0,0 +1,60 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# 	* sale_loyalty_margin_computation
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 18.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2026-05-05 19:15+0000\n"
+"PO-Revision-Date: 2026-05-05 19:15+0000\n"
+"Last-Translator: \n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>context</code>: The context"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>origin_line</code>: The origin sale order line"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>reward_line</code>: The Reward line"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid "<code>reward_lines</code>: The Reward lines"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#. odoo-python
+#: code:addons/sale_loyalty_margin_computation/models/loyalty_reward.py:0
+msgid ""
+"Invalid sale margin formula:\n"
+"%(error)s"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model:ir.model,name:sale_loyalty_margin_computation.model_loyalty_reward
+msgid "Loyalty Reward"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model:ir.model,name:sale_loyalty_margin_computation.model_sale_order_line
+msgid "Sales Order Line"
+msgstr ""
+
+#. module: sale_loyalty_margin_computation
+#: model_terms:ir.ui.view,arch_db:sale_loyalty_margin_computation.sale_margin_product_loyalty_reward_form_view
+msgid ""
+"result = origin_lines[0].price_unit * origin_lines[0].product_uom_qty - 11"
+msgstr ""

sale_loyalty_margin_computation/models/__init__.py

@@ -0,0 +1,2 @@
+from . import loyalty_reward
+from . import sale_order_line

sale_loyalty_margin_computation/models/loyalty_reward.py

@@ -0,0 +1,60 @@
+# Copyright 2026 Tecnativa - Andrii Kompaniiets
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+from odoo import Command, api, models
+from odoo.exceptions import ValidationError
+from odoo.tools.float_utils import float_compare
+from odoo.tools.safe_eval import safe_eval
+
+
+class LoyaltyReward(models.Model):
+    _inherit = "loyalty.reward"
+
+    @api.constrains("sale_margin_formula")
+    def _check_sale_margin_formula(self):
+        res = super()._check_sale_margin_formula()
+        main_product = self.env["product.product"].new(
+            {
+                "name": "Main Product",
+                "list_price": 35.0,
+                "standard_price": 11.52,
+            }
+        )
+        order = self.env["sale.order"].new(
+            {
+                "partner_id": self.env.ref("base.partner_admin").id,
+                "order_line": [
+                    Command.create(
+                        {
+                            "product_id": main_product.id,
+                            "product_uom_qty": 2.0,
+                            "price_unit": 35.0,
+                        }
+                    )
+                ],
+            }
+        )
+        fake_eval_context = {
+            "env": self.env,
+            "context": self.env.context,
+            "user": self.env.user,
+            "origin_line": order.order_line[0],
+            "reward_line": order.order_line[0],
+            "reward_lines": order.order_line,
+            "float_compare": float_compare,
+        }
+        for reward in self:
+            if not reward.sale_margin_formula:
+                continue
+            fake_eval_context.update({"reward": reward})
+            try:
+                safe_eval(
+                    str(reward.sale_margin_formula).strip(),
+                    fake_eval_context,
+                    mode="exec",
+                    nocopy=True,
+                )
+            except Exception as e:
+                raise ValidationError(
+                    self.env._("Invalid sale margin formula:\n%(error)s", error=e)
+                ) from e
+        return res

sale_loyalty_margin_computation/models/sale_order_line.py

@@ -0,0 +1,75 @@
+from odoo import api, models
+from odoo.tools.float_utils import float_compare
+from odoo.tools.safe_eval import safe_eval
+
+
+class SaleOrderLine(models.Model):
+    _inherit = "sale.order.line"
+
+    @api.depends(
+        "reward_generated_line_ids",
+        "reward_origin_generated_line_ids",
+        "reward_generated_line_ids.purchase_price",
+    )
+    def _compute_margin(self):
+        res = super()._compute_margin()
+        reward_lines_margin_without_formula = {}
+        for line in self.filtered(lambda x: x.reward_origin_generated_line_ids):
+            if not line.reward_id.sale_margin_formula:
+                if (
+                    line.reward_origin_generated_line_ids[0].id
+                    in reward_lines_margin_without_formula
+                ):
+                    reward_lines_margin_without_formula[
+                        line.reward_origin_generated_line_ids[0].id
+                    ] += line.margin
+                else:
+                    reward_lines_margin_without_formula[
+                        line.reward_origin_generated_line_ids[0].id
+                    ] = line.margin
+            # It sets the margin of the reward line to 0
+            line.margin = 0
+        for origin_line in self.filtered(lambda x: x.reward_generated_line_ids):
+            calculated_margin = 0.0
+            processed_reward = set()
+            for reward_line in origin_line.reward_generated_line_ids:
+                if (
+                    not reward_line.reward_id.sale_margin_formula
+                    or reward_line.reward_id in processed_reward
+                ):
+                    continue
+                processed_reward.add(reward_line.reward_id)
+                eval_context = origin_line._get_reward_eval_context(reward_line)
+                safe_eval(
+                    str(reward_line.reward_id.sale_margin_formula).strip(),
+                    eval_context,
+                    mode="exec",
+                    nocopy=True,
+                )
+                calculated_margin += eval_context.get("result", 0)
+            if processed_reward:
+                origin_line.margin = (
+                    calculated_margin
+                    + reward_lines_margin_without_formula.get(origin_line.id, 0.0)
+                )
+            else:
+                origin_line.margin += reward_lines_margin_without_formula.get(
+                    origin_line.id, 0.0
+                )
+            if origin_line.price_subtotal:
+                origin_line.margin_percent = (
+                    origin_line.margin / origin_line.price_subtotal
+                )
+        return res
+
+    def _get_reward_eval_context(self, reward_line):
+        return {
+            "env": self.env,
+            "context": self.env.context,
+            "user": self.env.user,
+            "origin_line": self,
+            "reward": reward_line.reward_id,
+            "reward_line": reward_line,
+            "reward_lines": self.reward_generated_line_ids,
+            "float_compare": float_compare,
+        }

sale_loyalty_margin_computation/pyproject.toml

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

sale_loyalty_margin_computation/readme/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+- [Tecnativa](https://www.tecnativa.com):
+  - Pedro M. Baeza
+  - Andrii Kompaniiets

sale_loyalty_margin_computation/readme/DESCRIPTION.md

@@ -0,0 +1,2 @@
+This module allows configuring a formula to calculate the margin of 
+a sale order line with loyalty rewards