[MIG] website_sale_coupon_selection_wizard: Migration to version 16.0

TT44379

website_sale_coupon_selection_wizard/README.rst

@@ -1,13 +1,13 @@
 ===============================
-Coupons Selection for eCommerce
+Loyalty Selection for eCommerce
 ===============================
 
 .. 
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-   !! source digest: sha256:94c44400c8e0661ca641d2c4de75be1950d9d1107237aa4189128911a9d1b019
+   !! source digest: sha256:d3a541663fd3180e254392c60810609dea963dabe291610a5d3e57c7df4f2507
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
@@ -17,19 +17,20 @@ Coupons Selection for eCommerce
     :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/15.0/website_sale_coupon_selection_wizard
+    :target: https://github.com/OCA/sale-promotion/tree/16.0/website_sale_coupon_selection_wizard
     :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-15-0/sale-promotion-15-0-website_sale_coupon_selection_wizard
+    :target: https://translation.odoo-community.org/projects/sale-promotion-16-0/sale-promotion-16-0-website_sale_coupon_selection_wizard
     :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=15.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/sale-promotion&target_branch=16.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module allows to apply multi-gift mult-criteria promotion with a fancy wizard on
-the eCommerce.
+This module makes suggestions for promotions whose rules include a product added to the
+cart. It also allows you to configure and apply these promotions with an elegant eCommerce
+wizard.
 
 **Table of contents**
 
@@ -49,22 +50,22 @@ Option 1:
 
 Option 2:
 
-#. Add a product in the promotion criteria.
-#. A cart hint will show up.
+#. Add a product in the promotion rules.
+#. A cart suggestion will appear.
 #. Add the promotion and configure the options.
 
 Option 3:
 
-#. Add a promotion code.
-#. If the promotion needs to be configured (i.e.: select the present)
+#. Select a suggested promotion in the shopping cart from a list of "Suggested promotions".
+#. Add the promotion and configure the options.
 
 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:%20website_sale_coupon_selection_wizard%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/sale-promotion/issues/new?body=module:%20website_sale_coupon_selection_wizard%0Aversion:%2016.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.
 
@@ -82,6 +83,7 @@ Contributors
 * `Tecnativa <https://www.tecnativa.com>`_:
 
   * David Vidal
+  * Pilar Vargas
 
 Maintainers
 ~~~~~~~~~~~
@@ -104,6 +106,6 @@ Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
 
 |maintainer-chienandalu| 
 
-This module is part of the `OCA/sale-promotion <https://github.com/OCA/sale-promotion/tree/15.0/website_sale_coupon_selection_wizard>`_ project on GitHub.
+This module is part of the `OCA/sale-promotion <https://github.com/OCA/sale-promotion/tree/16.0/website_sale_coupon_selection_wizard>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

website_sale_coupon_selection_wizard/__manifest__.py

@@ -1,29 +1,27 @@
 # Copyright 2021 Tecnativa - David Vidal
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 {
-    "name": "Coupons Selection for eCommerce",
-    "summary": "Allows to apply and configure promotions directly from the website",
-    "version": "15.0.1.0.0",
+    "name": "Loyalty Selection for eCommerce",
+    "summary": "Suggests promotions and allows you to configure and apply these "
+    "promotions directly from the website",
+    "version": "16.0.1.0.0",
     "development_status": "Beta",
     "category": "eCommerce",
     "website": "https://github.com/OCA/sale-promotion",
     "author": "Tecnativa, Odoo Community Association (OCA)",
     "maintainers": ["chienandalu"],
     "license": "AGPL-3",
     "depends": [
-        "sale_coupon_selection_wizard",
-        "sale_coupon_order_suggestion",
-        "website_sale_coupon_page",
+        "sale_loyalty",
+        "sale_loyalty_order_suggestion",
+        "website_sale_loyalty_page",
     ],
-    "data": ["templates/promotion_templates.xml"],
+    "data": ["templates/promotion_templates.xml", "templates/wizard_templates.xml"],
     "assets": {
         "web.assets_frontend": [
             "/website_sale_coupon_selection_wizard/static/src/scss/"
             "website_sale_coupon_selection.scss",
-            "/sale_coupon_selection_wizard/static/src/js/"
-            "coupon_selection_wizard_mixin.js",
-            "/website_sale_coupon_selection_wizard/static/src/js/"
-            "website_sale_coupon_selection_wizard.js",
+            "/website_sale_coupon_selection_wizard/static/src/js/*",
         ]
     },
 }

website_sale_coupon_selection_wizard/controllers/__init__.py

@@ -1,3 +1,3 @@
-from . import coupon_page
+from . import promotion_page
 from . import main
 from . import promotion_wizard

website_sale_coupon_selection_wizard/controllers/main.py

@@ -1,16 +1,25 @@
 # Copyright 2021 Tecnativa - David Vidal
+# Copyright 2024 Tecnativa - Pilar Vargas
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 from odoo.http import request, route
 
 from odoo.addons.website_sale.controllers.main import WebsiteSale
 
 
 class WebsiteSaleCouponWizard(WebsiteSale):
+    def _get_sale_loyalty_reward_wizard(self, order, program):
+        wizard = (
+            request.env["sale.loyalty.reward.wizard"]
+            .with_context(active_id=order.id)
+            .create({"selected_reward_id": program.reward_ids[:1].id})
+        )
+        return wizard.id
+
     @route(
         ["/promotions/<int:program_id>/apply"], type="http", auth="public", website=True
     )
     def promotion_program_apply(self, program_id, **kwargs):
-        program = request.env["coupon.program"].sudo().browse(program_id).exists()
+        program = request.env["loyalty.program"].sudo().browse(program_id).exists()
         if not program or not program.active or not program.is_published:
             return
         # Prevent to apply a promotion to a processed order
@@ -19,42 +28,30 @@ def promotion_program_apply(self, program_id, **kwargs):
             request.session["sale_order_id"] = None
             order = request.website.sale_get_order()
         # We won't apply it twice
-        if program in (order.no_code_promo_program_ids | order.code_promo_program_id):
+        if program in order._get_reward_programs():
             return
-        # If the promotion is directly applicable (promotion code), just apply without
-        # further ado.
-        if program.promo_code_usage == "code_needed" and (
-            program not in order.sudo()._available_multi_criteria_multi_gift_programs()
-        ):
-            return self.pricelist(program.promo_code)
         # Let's inject some context into the view
         request.session["promotion_id"] = program.id
+        request.session["order_id"] = order.id
         return request.redirect("/shop/cart")
 
-    @route()
-    def pricelist(self, promo, **post):
-        """When applying a configurable promotion code, we'll offer the customer
-        to configure it."""
-        if promo:
-            order = request.website.sale_get_order()
-            program = (
-                request.env["coupon.program"]
-                .sudo()
-                .search([("promo_code", "=", promo)])
-            )
-            if program in order.sudo()._available_multi_criteria_multi_gift_programs():
-                request.session["promotion_id"] = program.id
-                return request.redirect("/shop/cart")
-        return super().pricelist(promo)
-
     @route()
     def cart(self, **post):
+        error = request.session.get("error_promo_code")
         response = super().cart(**post)
         promotion = request.session.get("promotion_id")
+        order = request.session.get("sale_order_id")
         if promotion:
-            response.qcontext["promotion_id"] = (
-                request.env["coupon.program"].sudo().browse(promotion)
-            )
+            program_id = request.env["loyalty.program"].browse(promotion)
+            order_id = request.env["sale.order"].browse(order)
+            wizard_id = self._get_sale_loyalty_reward_wizard(order_id, program_id)
+            wiz = request.env["sale.loyalty.reward.wizard"].browse(wizard_id)
+            mandatory_program_options = wiz.loyalty_rule_line_ids
+            response.qcontext["promotion_id"] = program_id
+            response.qcontext["order_id"] = order_id
+            response.qcontext["mandatory_program_options"] = mandatory_program_options
+        if error:
+            request.session["error_promo_code"] = error
         return response
 
     @route(["/promotions/dismiss"], type="http", auth="public", website=True)

website_sale_coupon_selection_wizard/controllers/coupon_page.py → website_sale_coupon_selection_wizard/controllers/promotion_page.py

@@ -2,7 +2,7 @@
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
 from odoo.http import request, route
 
-from odoo.addons.website_sale_coupon_page.controllers.main import WebsiteSale
+from odoo.addons.website_sale_loyalty_page.controllers.main import WebsiteSale
 
 
 class CouponPage(WebsiteSale):
@@ -16,13 +16,8 @@ def promotion(self, **post):
         promo_values = response.qcontext.get("promos", [])
         for promo_dict in promo_values:
             promo_dict["applicable"] = False
-            promo = request.env["coupon.program"].sudo().browse(promo_dict["id"])
-            if (
-                promo in (order.no_code_promo_program_ids | order.code_promo_program_id)
-            ) or (
-                promo
-                not in order.sudo()._available_multi_criteria_multi_gift_programs()
-            ):
+            promo = request.env["loyalty.program"].sudo().browse(promo_dict["id"])
+            if promo not in order.sudo()._get_available_programs():
                 continue
             promo_dict["applicable"] = True
         return response

website_sale_coupon_selection_wizard/controllers/promotion_wizard.py

@@ -1,14 +1,12 @@
 # Copyright 2021 Tecnativa - David Vidal
 # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
-from odoo import _
+from odoo.exceptions import ValidationError
 from odoo.http import request, route
 
-from odoo.addons.sale_coupon_selection_wizard.controllers.main import (
-    CouponSelectionWizardController,
-)
+from odoo.addons.website_sale_loyalty.controllers.main import WebsiteSale
 
 
-class CouponSelectionWizardController(CouponSelectionWizardController):
+class CouponSelectionWizardController(WebsiteSale):
     @route(
         "/website_sale_coupon_selection_wizard/apply",
         type="json",
@@ -19,24 +17,37 @@ def apply_promotion_public(
         self, program_id, sale_order_id, promotion_lines, reward_line_options, **kw
     ):
         """Frontend controller that wraps common methods and handles errors properly"""
-        error, sale_form, program = self._try_to_apply_promotion(
-            program_id, sale_order_id, promotion_lines, reward_line_options, **kw
+        order = request.env["sale.order"].browse(sale_order_id)
+        program = request.env["loyalty.program"].browse(program_id)
+        wizard_id = self._get_sale_loyalty_reward_wizard(order, program)
+        wiz = request.env["sale.loyalty.reward.wizard"].browse(wizard_id)
+        reward_id = reward_line_options.get("reward", False)
+        wiz.selected_reward_id = int(reward_id) or (
+            program.reward_ids.id if len(program.reward_ids) == 1 else False
         )
-        if error:
-            request.session["error_promo_code"] = error
+        if wiz.selected_reward_id:
+            reward = wiz.selected_reward_id
+            for product, qty in promotion_lines.items():
+                line = wiz.loyalty_rule_line_ids.filtered(
+                    lambda x: x.product_id.id == int(product)
+                )
+                if len(promotion_lines) == 1:
+                    qty = line.units_required - line.units_included
+                if not qty:
+                    continue
+                line.units_to_include = qty
+            if reward.reward_type == "product":
+                reward_products = reward.reward_product_ids
+                if len(reward_products) == 1:
+                    wiz.selected_product_id = reward_products.id
+                else:
+                    wiz.selected_product_id = int(
+                        reward_line_options.get("reward_product")
+                    )
+        try:
+            wiz.action_apply()
+        except ValidationError as e:
+            request.session["error_promo_code"] = str(e)
             return
-        # Once checked write the new lines and force the code if the promo has one
-        order = sale_form.save()
-        promo_applied = self._apply_promotion(order, program, reward_line_options)
-        if not promo_applied:
-            request.session["error_promo_code"] = _(
-                "This promotion can't be applied to this order"
-            )
         request.session.pop("promotion_id", None)
         request.session.pop("error_promo_code", None)
-
-    @route(website=True)
-    def configure_promotion(self, program_id, **kw):
-        if not self._get_order(kw.get("sale_order_id")):
-            kw["sale_order_id"] = request.website.sale_get_order(force_create=True)
-        return super().configure_promotion(program_id, **kw)

website_sale_coupon_selection_wizard/readme/CONTRIBUTORS.rst

@@ -1,3 +1,4 @@
 * `Tecnativa <https://www.tecnativa.com>`_:
 
   * David Vidal
+  * Pilar Vargas

website_sale_coupon_selection_wizard/readme/DESCRIPTION.rst

@@ -1,2 +1,3 @@
-This module allows to apply multi-gift mult-criteria promotion with a fancy wizard on
-the eCommerce.
+This module makes suggestions for promotions whose rules include a product added to the
+cart. It also allows you to configure and apply these promotions with an elegant eCommerce
+wizard.

website_sale_coupon_selection_wizard/readme/USAGE.rst

@@ -8,11 +8,11 @@ Option 1:
 
 Option 2:
 
-#. Add a product in the promotion criteria.
-#. A cart hint will show up.
+#. Add a product in the promotion rules.
+#. A cart suggestion will appear.
 #. Add the promotion and configure the options.
 
 Option 3:
 
-#. Add a promotion code.
-#. If the promotion needs to be configured (i.e.: select the present)
+#. Select a suggested promotion in the shopping cart from a list of "Suggested promotions".
+#. Add the promotion and configure the options.