[IMP] product_ribbons: enhance ribbon assignment logic and added tests

Enhanced ribbon assignment logic for better dynamic and manual control.
Ensured ribbon style and position updates save and reflect in the UI.
Added automated tests to ensure correct ribbon assignment behavior.

Author: tpma-odoo

Diff for: product_ribbons/controllers/shop.py

@@ -13,7 +13,8 @@ def shop(self, page=0, category=None, search='', min_price=0.0, max_price=0.0, p
         response = super().shop(page, category, search, min_price, max_price, ppg, **post)
 
         if response.qcontext.get('products'):
+            products_prices = response.qcontext.get('products_prices')
             for product in response.qcontext['products']:
-                product._get_ribbon({})  
+                product._get_ribbon(products_prices)
 
         return response

Diff for: product_ribbons/models/product_ribbon.py

@@ -1,4 +1,5 @@
-from odoo import fields, models
+from odoo import  api, fields, models
+from odoo.exceptions import ValidationError
 
 
 class ProductRibbon(models.Model):
@@ -28,3 +29,21 @@ def _get_position_class(self):
             return 'o_ribbon_left' if self.position == 'left' else 'o_ribbon_right'
         else:  # self.style == 'badge'
             return 'o_tag_left' if self.position == 'left' else 'o_tag_right'
+
+    @api.model_create_multi
+    def create(self, vals_list):
+        for vals in vals_list:
+            assign_type = vals.get('assign')
+            if assign_type and assign_type != 'manual':
+                existing_ribbon = self.search([('assign', '=', assign_type)], limit=1)
+                if existing_ribbon:
+                    raise ValidationError(f"A ribbon with assign type '{assign_type}' already exists. You cannot create another one.")
+        return super().create(vals_list)
+        
+    def write(self, vals):
+        assign_type = vals.get('assign')
+        if assign_type != 'manual':
+            existing_ribbon = self.search([('assign', '=', assign_type), ('id', '!=', self.id)])
+            if existing_ribbon:
+                raise ValidationError(f"A ribbon with assign type '{assign_type}' already exists. You cannot assign another one.")
+        return super().write(vals)

Diff for: product_ribbons/models/product_template.py

@@ -1,12 +1,12 @@
-from odoo import models, fields
+from odoo import fields, models
 
 
 class ProductTemplate(models.Model):
     _inherit = 'product.template'
 
     website_ribbon_auto = fields.Boolean("Automatic Ribbon", default=False)
 
-    def _get_ribbon(self, product_prices):
+    def _get_ribbon(self, products_prices):
         self.ensure_one()
 
         product_ribbon_sudo = self.env['product.ribbon'].sudo()
@@ -15,21 +15,22 @@ def _get_ribbon(self, product_prices):
             return
 
         # Out of Stock Ribbon
-        out_of_stock_ribbon = product_ribbon_sudo.search([('assign', '=', 'out_of_stock')], limit=1)
+        out_of_stock_ribbon = product_ribbon_sudo.search([('assign', '=', 'out_of_stock')])
         if out_of_stock_ribbon and self.qty_available <= 0.0 and not self.allow_out_of_stock_order:
             self.website_ribbon_id = out_of_stock_ribbon.id
             self.website_ribbon_auto = True
             return 
 
         # Sale Ribbon
-        sale_ribbon = product_ribbon_sudo.search([('assign', '=', 'sale')], limit=1)
-        if sale_ribbon and self.list_price < self.standard_price:
+        pricelist_price = products_prices[self.id].get('price_reduce')
+        sale_ribbon = product_ribbon_sudo.search([('assign', '=', 'sale')])
+        if sale_ribbon and (pricelist_price < self.list_price or self.list_price < self.compare_list_price):            
             self.website_ribbon_id = sale_ribbon.id
             self.website_ribbon_auto = True
-            return  
+            return
 
         # New Product Ribbon
-        new_ribbon = product_ribbon_sudo.search([('assign', '=', 'new')], limit=1)
+        new_ribbon = product_ribbon_sudo.search([('assign', '=', 'new')])
         if new_ribbon:
             days_since_publish = (fields.Date.today() - self.create_date.date()).days
             if days_since_publish <= new_ribbon.show_period:

Diff for: product_ribbons/static/src/js/adapter.js

@@ -3,7 +3,9 @@ import { patch } from "@web/core/utils/patch";
 
 
 patch(WysiwygAdapterComponent.prototype, {
-
+    /**
+     * @override
+    */
     async init() {
         await super.init(...arguments);
 
@@ -15,38 +17,13 @@ patch(WysiwygAdapterComponent.prototype, {
                 ['id', 'name', 'bg_color', 'text_color', 'position', 'style'],
             );
         }
-        this.ribbons = Object.fromEntries(ribbons.map(ribbon => [ribbon.id, ribbon]));
+        this.ribbons = Object.fromEntries(ribbons.map(ribbon => {
+            return [ribbon.id, ribbon];
+        }));
         this.originalRibbons = Object.assign({}, this.ribbons);
         this.productTemplatesRibbons = [];
         this.deletedRibbonClasses = '';
-        this.stylePositionClasses = {
-            'ribbon': { 'left': 'o_ribbon_left', 'right': 'o_ribbon_right' },
-            'badge': { 'left': 'o_tag_left', 'right': 'o_tag_right' },
-        };
-    },
-
-    _onGetRibbonClasses(ev) {
-        const classes = Object.values(this.ribbons).reduce((classes, ribbon) => {
-            const style = ribbon.style || 'ribbon';
-            return classes + ` ${this.stylePositionClasses[style][ribbon.position]}`;
-        }, '') + this.deletedRibbonClasses;
-        ev.data.callback(classes);
+        this.ribbonPositionClasses = {'left': 'o_ribbon_left', 'right': 'o_ribbon_right'};
     },
 
-    _onDeleteRibbon(ev) {
-        const ribbon = this.ribbons[ev.data.id];
-        const style = ribbon.style || 'ribbon';
-        this.deletedRibbonClasses += ` ${this.stylePositionClasses[style][ribbon.position]}`;
-        delete this.ribbons[ev.data.id];
-    },
-
-    _onSetRibbon(ev) {
-        const { ribbon } = ev.data;
-        const previousRibbon = this.ribbons[ribbon.id];
-        if (previousRibbon) {
-            const prevStyle = previousRibbon.style || 'ribbon';
-            this.deletedRibbonClasses += ` ${this.stylePositionClasses[prevStyle][previousRibbon.position]}`;
-        }
-        this.ribbons[ribbon.id] = ribbon;
-    },
-});
+});

Diff for: product_ribbons/static/src/js/website_sale_editor_extend.js

@@ -82,9 +82,9 @@ options.registry.WebsiteSaleProductsItem = options.registry.WebsiteSaleProductsI
             ? (currentStyle === 'badge' ? 'o_tag_left' : 'o_ribbon_left')
             : (currentStyle === 'badge' ? 'o_tag_right' : 'o_ribbon_right');
 
-        this.$ribbon[0].className = this.$ribbon[0].className.replace(
-            /o_(ribbon|tag)_(left|right)/, positionClass
-        );
+        this.$ribbon.removeClass('o_ribbon_left o_ribbon_right o_tag_left o_tag_right')
+            .addClass(positionClass)
+            .attr('data-style', currentStyle);
 
         await this._saveRibbon();
     },

Diff for: product_ribbons/tests/__init__.py

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

Diff for: product_ribbons/tests/test_product_ribbons.py

@@ -0,0 +1,83 @@
+from odoo.tests.common import TransactionCase, tagged
+from odoo.exceptions import ValidationError
+
+
+@tagged("post_install", "-at_install")
+class TestSaleRibbon(TransactionCase):
+    @classmethod
+    def setUpClass(cls):
+        super().setUpClass()
+        cls.website = cls.env["website"].search([], limit=1)
+        cls.product = cls.env["product.template"].search([], limit=1)
+        cls.christmas_pricelist = cls.env["product.pricelist"].search(
+            [("name", "=", "Christmas")], limit=1
+        )
+        cls.christmas_pricelist.write({"selectable": True})
+        cls.prices = cls.product._get_sales_prices(cls.website)
+
+    def test_pricelist_discount_applies_sale_ribbon(self):
+        sale_ribbon = self.env["product.ribbon"].create({
+            "name": "Sale",
+            "assign": "sale",
+        })
+        self.product._get_ribbon(self.prices)
+        self.assertEqual(
+            self.product.website_ribbon_id,
+            sale_ribbon,
+            "Pricelist discount applied, but Sale Ribbon was not correctly assigned!",
+        )
+
+    def test_ribbon_priority_out_of_stock(self):
+        self.product.write({"qty_available": 0, "allow_out_of_stock_order": False})
+        out_of_stock_ribbon = self.env["product.ribbon"].create({
+            "name": "Out of Stock",
+            "assign": "out_of_stock",
+        })
+        self.env["product.ribbon"].create({"name": "Sale", "assign": "sale"})
+        self.product._get_ribbon(self.prices)
+        self.assertEqual(
+            self.product.website_ribbon_id,
+            out_of_stock_ribbon,
+            " Out of Stock Ribbon not prioritized!",
+        )
+
+    def test_duplicate_ribbon_validation(self):
+        self.env["product.ribbon"].create({"name": "Sale Discount", "assign": "sale"})
+        with self.assertRaises(ValidationError):
+            self.env["product.ribbon"].create({"name": "Sale Offer", "assign": "sale"})
+
+    def test_manual_ribbon_priority_over_any(self):
+        manual_ribbon = self.env["product.ribbon"].create({
+            "name": "Sold Out",
+            "assign": "manual",
+        })
+        self.product.write({"website_ribbon_id": manual_ribbon.id})
+        self.env["product.ribbon"].create({"name": "New", "assign": "new"})
+        self.product._get_ribbon(self.prices)
+        self.assertEqual(
+            self.product.website_ribbon_id,
+            manual_ribbon,
+            " Manual ribbon was replaced by an automatic ribbon!",
+        )
+
+    def test_out_of_stock_ribbon_respects_allow_out_of_stock(self):
+        out_of_stock_ribbon = self.env["product.ribbon"].create({
+            "name": "Out of Stock",
+            "assign": "out_of_stock",
+        })
+
+        self.product.write({"allow_out_of_stock_order": False, "qty_available": 0})
+        self.product._get_ribbon(self.prices)
+        self.assertEqual(
+            self.product.website_ribbon_id,
+            out_of_stock_ribbon,
+            " Out of Stock ribbon did NOT apply when allow_out_of_stock_order is False!",
+        )
+
+        self.product.write({"allow_out_of_stock_order": True, "qty_available": 0})
+        self.product._get_ribbon(self.prices)
+        self.assertNotEqual(
+            self.product.website_ribbon_id,
+            out_of_stock_ribbon,
+            " Out of Stock ribbon incorrectly applied when allow_out_of_stock_order is True!",
+        )