[MIG] product_variant_default_code: Migration to 10.0

product_variant_default_code/README.rst

@@ -1,37 +1,112 @@
-Product Variant Default Code(product_variant_default_code)
------------------------------------------------------------
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/agpl
+   :alt: License: AGPL-3
 
-In 'product.template' object new field 'Variant reference mask' is added
+============================
+Product Variant Default Code
+============================
 
-In 'product.attribute.value' object new field 'Attribute Code' is added.
+This module allows to define a reference mask on the product templates so the
+variants references are automatically set. For example:
 
-When creating a new product template without specifying the 'Variant reference
-mask', a default value for 'Variant reference mask' will be automatically
-generated according to the attribute line settings on the product template.
-The mask will then be used as an instruction to generate default code of each
-product variant of the product template with the corresponding Attribute Code
-(of the attribute value) inserted. Besides the default value, 'Variant
-reference mask' can be configure to your liking, make sure puting Attribut Name
-inside '[]' mark. 
+- Product template: Jacket
+- Attributes:
+  - Color: White, Black
+  - Size: M, L
+- Reference mask: `JKT01-[Color]-[Size]`
+
+- Reference on variants:
+
+  - `JKT01-Wh-M` Jacket White M
+  - `JKT01-Bl-M` Jacket Black M
+  - `JKT01-Wh-L` Jacket White L
+  - `JKT01-Bl-L` Jacket Black L
+
+Configuration
+=============
+
+To set the reference mask up on any product template 'Variant reference mask'
+new field.
+
+When creating a new product template without specifying the *Variant reference
+mask*, a default value for *Variant reference mask* will be automatically
+generated according to the attribute line settings on the product template (if
+any). The mask will then be used as an instruction to generate default code of
+each product variant of the product template with the corresponding *Attribute
+Code* (of the attribute value) inserted. Besides the default value, *Variant
+reference mask* can be configured to your liking, make sure putting the
+*Attribute Name* inside `[]` marks (it is case sensitive).
 
 Example:
 
-Creating a product named 'A' with two attributes, 'Size' and 'Color'::
+Creating a product named *Jacket* with two attributes, *Size* and *Color*::
 
-   Product: A
-   Color: Red(r), Yellow(y), Black(b) #Red, Yellow, Black are the attribute
-          value, 'r', 'y', 'b' are the corresponding code
-   Size: L (l), XL(x)
+   Product: Jacket
+   Color: Black(Bl), White(Wh) # Black and White are the attribute values;
+                                 'Bl' and 'Wh' are the corresponding codes
+   Size: L (L), XL(XL)
 
 The automatically generated default value for the Variant reference mask will
-be `[Color]-[Size]` and then the 'default code' on the variants will be
-something like `r-l` `b-l` `r-x` ...
+be `[Color]-[Size]` and so the 'default code' on the variants will be `Bl-L`,
+`Wh-L`, `Bl-XL` and `Wh-XL`.
+
+The mask value can be fully custumizedwhatever you like. You can even have
+the attribute name appear more than once in the mask such as,
+`Jacket/[Size]~[Color]~[Size]`, and the generated code on variants will be
+something like `Jacket/L~Bl~L` (for variant with Color "Black" and Size "L").
+
+When the code attribute is changed, it automatically regenerates the 'default
+code' on all variants affected.
+
+Avoiding mask in variants
+-------------------------
+
+You can avoid this behavior or force a manual default_code on variant. To do
+so, go to *Product Variants > [any variant you want to set up]* and set
+manually its reference code. The field `manual code` will be set to on and the
+variant internal reference will no longer be changed by this module.
+
+Unset `manual code` and the reference code will be unlocked again.
+
+.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+   :alt: Try me on Runbot
+   :target: https://runbot.odoo-community.org/runbot/137/10.0
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues
+<https://github.com/OCA/product_variant/issues>`_. In case of trouble, please
+check there if your issue has already been reported. If you spotted it first,
+help us smash it by providing detailed and welcomed feedback.
+
+Credits
+=======
+
+Images
+------
+
+* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
+
+Contributors
+------------
+
+* Alfredo de la Fuente <alfredodelafuente@avanzosc.com>
+* Pedro M. Baeza <pedro.baeza@tecnativa.com>
+* Tony Gu <tony@openerp.cn>
+* David Vidal <david.vidal@tecnativa.com>
+
+Maintainer
+----------
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+This module is maintained by the OCA.
 
-If you like, you can change the mask value whatever you like. You can even have
-the attribute name appear more than once in the mask such as ,
-`fancyA/[Size]~[Color]~[Size]`, when saved the default code on variants will be
-something like `fancyA/l~r~l` (for variant with Color "Red" and Size "L")
-`fancyA/x~y~x` (for variant with Color "Yellow" and Size "XL").
+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.
 
-when the code attribute is changed, it automatically regenerates the 'default
-code'.
+To contribute to this module, please visit https://odoo-community.org.

product_variant_default_code/__init__.py

@@ -1,18 +1,3 @@
 # -*- encoding: utf-8 -*-
-##############################################################################
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU Affero General Public License as
-#    published by the Free Software Foundation, either version 3 of the
-#    License, or (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU Affero General Public License for more details.
-#
-#    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see http://www.gnu.org/licenses/.
-#
-##############################################################################
+
 from . import models

product_variant_default_code/__manifest__.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+# Copyright 2014 AvancOSC - Alfredo de la Fuente
+# Copyright 2014 Tecnativa - Pedro M. Baeza
+# Copyright 2014 Shine IT - Tony Gu
+# Copyright 2017 Tecnativa - David Vidal
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+{
+    'name': 'Product Variant Default Code',
+    'version': '10.0.1.0.0',
+    'author': 'AvancOSC,'
+              'Shine IT,'
+              'Tecnativa,'
+              'Odoo Community Association (OCA)',
+    'website': 'https://odoo-community.org/',
+    'license': 'AGPL-3',
+    'category': 'Product',
+    'depends': [
+        'product',
+    ],
+    'data': [
+        'views/product_attribute_value_view.xml',
+        'views/product_view.xml',
+    ],
+    'installable': True
+}

product_variant_default_code/models/__init__.py

@@ -1,18 +1,3 @@
 # -*- encoding: utf-8 -*-
-##############################################################################
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU Affero General Public License as
-#    published by the Free Software Foundation, either version 3 of the
-#    License, or (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU Affero General Public License for more details.
-#
-#    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see http://www.gnu.org/licenses/.
-#
-##############################################################################
+
 from . import product

product_variant_default_code/models/product.py

@@ -1,22 +1,12 @@
-# -*- encoding: utf-8 -*-
-##############################################################################
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU Affero General Public License as
-#    published by the Free Software Foundation, either version 3 of the
-#    License, or (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU Affero General Public License for more details.
-#
-#    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see http://www.gnu.org/licenses/.
-#
-##############################################################################
-from openerp import models, fields, api, _
-from openerp.exceptions import except_orm
+# -*- coding: utf-8 -*-
+# Copyright 2014 AvancOSC - Alfredo de la Fuente
+# Copyright 2014 Tecnativa - Pedro M. Baeza
+# Copyright 2014 Shine IT - Tony Gu
+# Copyright 2017 Tecnativa - David Vidal
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import _, api, fields, models
+from odoo.exceptions import UserError
 import re
 from string import Template
 from collections import defaultdict
@@ -45,8 +35,8 @@ def sanitize_reference_mask(product, mask):
     for line in product.attribute_line_ids:
         attribute_names.add(line.attribute_id.name)
     if not tokens.issubset(attribute_names):
-        raise except_orm(_('Error'), _('Found unrecognized attribute name in '
-                                       '"Variant Reference Mask"'))
+        raise UserError(_('Found unrecognized attribute name in "Variant '
+                          'Reference Mask"'))
 
 
 def get_rendered_default_code(product, mask):
@@ -109,7 +99,6 @@ def create(self, vals):
             sanitize_reference_mask(product, vals['reference_mask'])
         return super(ProductTemplate, self).create(vals)
 
-    @api.one
     def write(self, vals):
         product_obj = self.env['product.product']
         if 'reference_mask' in vals and not vals['reference_mask']:
@@ -138,13 +127,12 @@ class ProductProduct(models.Model):
     manual_code = fields.Boolean(string='Manual code')
 
     @api.model
-    def create(self, values):
-        product = super(ProductProduct, self).create(values)
+    def create(self, vals):
+        product = super(ProductProduct, self).create(vals)
         if product.reference_mask:
             render_default_code(product, product.reference_mask)
         return product
 
-    @api.one
     @api.onchange('default_code')
     def onchange_default_code(self):
         self.manual_code = bool(self.default_code)
@@ -160,35 +148,29 @@ class ProductAttribute(models.Model):
 class ProductAttributeValue(models.Model):
     _inherit = 'product.attribute.value'
 
-    @api.one
     @api.onchange('name')
     def onchange_name(self):
         if self.name:
             self.attribute_code = self.name[0:2]
 
     attribute_code = fields.Char(
-        string='Attribute Code', default=onchange_name)
+        string='Attribute Code',
+        default=onchange_name,
+    )
 
     @api.model
-    def create(self, values):
-        if 'attribute_code' not in values:
-            values['attribute_code'] = values.get('name', '')[0:2]
-        value = super(ProductAttributeValue, self).create(values)
-        return value
+    def create(self, vals):
+        if 'attribute_code' not in vals:
+            vals['attribute_code'] = vals.get('name', '')[0:2]
+        return super(ProductAttributeValue, self).create(vals)
 
-    @api.one
     def write(self, vals):
-        attribute_line_obj = self.env['product.attribute.line']
-        product_obj = self.env['product.product']
+        if 'attribute_code' not in vals:
+            return super(ProductAttributeValue, self).write(vals)
         result = super(ProductAttributeValue, self).write(vals)
-        if 'attribute_code' in vals:
-            cond = [('attribute_id', '=', self.attribute_id.id)]
-            attribute_lines = attribute_line_obj.search(cond)
-            for line in attribute_lines:
-                cond = [('product_tmpl_id', '=', line.product_tmpl_id.id),
-                        ('manual_code', '=', False)]
-                products = product_obj.search(cond)
-                for product in products:
-                    if product.reference_mask:
-                        render_default_code(product, product.reference_mask)
+        # Rewrite reference on all product variants affected
+        for product in self.mapped('product_ids').filtered(
+                lambda x: x.product_tmpl_id.reference_mask and not
+                x.manual_code):
+            render_default_code(product, product.reference_mask)
         return result

product_variant_default_code/tests/__init__.py

@@ -0,0 +1,3 @@
+# -*- encoding: utf-8 -*-
+
+from . import test_variant_default_code

product_variant_default_code/tests/test_variant_default_code.py

@@ -0,0 +1,125 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 Tecnativa - David Vidal
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo.exceptions import UserError
+from odoo.tests import common
+
+
+class TestVariantDefaultCode(common.SavepointCase):
+
+    @classmethod
+    def setUpClass(cls):
+        super(TestVariantDefaultCode, cls).setUpClass()
+        cls.attr1 = cls.env['product.attribute'].create({'name': 'TSize'})
+        cls.attr2 = cls.env['product.attribute'].create({'name': 'TColor'})
+        cls.attr1_1 = cls.env['product.attribute.value'].create({
+            'name': 'L', 'attribute_id': cls.attr1.id
+        })
+        cls.attr1_2 = cls.env['product.attribute.value'].create({
+            'name': 'XL', 'attribute_id': cls.attr1.id
+        })
+        cls.attr2_1 = cls.env['product.attribute.value'].create({
+            'name': 'Red', 'attribute_id': cls.attr2.id
+        })
+        cls.attr2_2 = cls.env['product.attribute.value'].create({
+            'name': 'Green', 'attribute_id': cls.attr2.id
+        })
+        cls.template1 = cls.env['product.template'].create({
+            'name': 'Jacket',
+            'attribute_line_ids':  [
+                (0, 0, {'attribute_id': cls.attr1.id,
+                        'value_ids': [(6, 0, [cls.attr1_1.id, cls.attr1_2.id])]
+                        }),
+                (0, 0, {'attribute_id': cls.attr2.id,
+                        'value_ids': [(6, 0, [cls.attr2_1.id, cls.attr2_2.id])]
+                        }),
+            ],
+        })
+        # This one with a preset reference mask
+        cls.template2 = cls.env['product.template'].create({
+            'name': 'Pants',
+            'attribute_line_ids': [
+                (0, 0, {'attribute_id': cls.attr1.id,
+                        'value_ids': [(6, 0, [cls.attr1_1.id, cls.attr1_2.id])]
+                        }),
+                (0, 0, {'attribute_id': cls.attr2.id,
+                        'value_ids': [(6, 0, [cls.attr2_1.id, cls.attr2_2.id])]
+                        }),
+            ],
+            'reference_mask': 'P01/[TSize][TColor]',
+        })
+
+    def test_01_check_default_codes(self):
+        # As no mask was set, a default one should be:
+        self.assertEqual(self.template1.reference_mask, '[TSize]-[TColor]')
+        # Check that variants code are generated according to rules
+        for product in self.template1.mapped('product_variant_ids'):
+            expected_code = (product.attribute_value_ids[0].name[0:2] +
+                             '-' + product.attribute_value_ids[1].name[0:2])
+            self.assertEqual(product.default_code, expected_code)
+
+    def test_02_check_default_codes_preexistent_mask(self):
+        for product in self.template2.mapped('product_variant_ids'):
+            expected_code = ('P01/' +
+                             product.attribute_value_ids[0].name[0:2] +
+                             product.attribute_value_ids[1].name[0:2])
+            self.assertEqual(product.default_code, expected_code)
+
+    def test_03_reset_reference_mask_to_default(self):
+        # Erase the previous mask: 'P01/[TSize][TColor]'
+        self.template2.reference_mask = ''
+        # Mask is set to default now:
+        self.assertEqual(self.template1.reference_mask, '[TSize]-[TColor]')
+
+    def test_04_custom_reference_mask(self):
+        self.template1.reference_mask = u'JKTÜ/[TColor]#[TSize]'
+        for product in self.template1.mapped('product_variant_ids'):
+            expected_code = (u'JKTÜ/' +
+                             product.attribute_value_ids[1].name[0:2] + '#' +
+                             product.attribute_value_ids[0].name[0:2])
+            self.assertEqual(product.default_code, expected_code)
+
+    def test_05_manual_code(self):
+        self.assertEqual(self.template1.product_variant_ids[0].manual_code,
+                         False)
+        self.template1.product_variant_ids[0].default_code = 'CANT-TOUCH-THIS'
+        self.template1.product_variant_ids[0].onchange_default_code()
+        self.assertEqual(self.template1.product_variant_ids[0].manual_code,
+                         True)
+        # Set a reference mask and check the other variants are changed
+        self.template1.reference_mask = 'J[TColor][TSize]'
+        for product in self.template1.mapped('product_variant_ids')[1:]:
+            expected_code = ('J' +
+                             product.attribute_value_ids[1].name[0:2] +
+                             product.attribute_value_ids[0].name[0:2])
+            self.assertEqual(product.default_code, expected_code)
+        # But this one isn't:
+        self.assertEqual(self.template1.product_variant_ids[0].default_code,
+                         'CANT-TOUCH-THIS')
+
+    def test_06_attribute_value_code_change_propagation(self):
+        self.attr1_1.attribute_code = 'OO'
+        # Check that the change spreads to every product
+        for product in self.attr1_1.mapped('product_ids'):
+            self.assertTrue('OO' in product.default_code)
+
+    def test_07_attribute_value_name_change(self):
+        self.attr1_1.name = 'Odoo'
+        self.attr1_1.onchange_name()
+        self.assertEqual(self.attr1_1.attribute_code, 'Od')
+        # Check that the change spreads to every product
+        for product in self.attr1_1.mapped('product_ids'):
+            self.assertTrue('Od' in product.default_code)
+
+    def test_08_sanitize_exception(self):
+        with self.assertRaises(UserError):
+            self.env['product.template'].create({
+                'name': 'Shirt',
+                'attribute_line_ids': [
+                    (0, 0, {'attribute_id': self.attr1.id,
+                            'value_ids': [(6, 0, [self.attr1_1.id])]
+                            }),
+                ],
+                'reference_mask': 'FAIL:[TSize][TWrongAttr]',
+            })

product_variant_default_code/views/product_attribute_value_view.xml

@@ -1,18 +1,11 @@
 <?xml version="1.0"?>
-<openerp>
-    <data>
-        <record id="variants_template_tree_view_inh_variantdefaultcode" model="ir.ui.view">
-            <field name="name">variants.template.tree.view.inh.variantdefaultcode</field>
-            <field name="model">product.attribute.value</field>
-            <field name="inherit_id" ref="product.variants_template_tree_view"/>
-            <field name="arch" type="xml">
-                <field name="name" position="after">
-                    <field name="attribute_code" />
-                </field>
+<odoo>
+
+        <record id="variants_tree_view_inh_variantdefaultcode"
+                model="ir.ui.view">
+            <field name="name">
+                variants.tree.view.inh.variantdefaultcode
             </field>
-        </record>
-        <record id="variants_tree_view_inh_variantdefaultcode" model="ir.ui.view">
-            <field name="name">variants.tree.view.inh.variantdefaultcode</field>
             <field name="model">product.attribute.value</field>
             <field name="inherit_id" ref="product.variants_tree_view"/>
             <field name="arch" type="xml">
@@ -21,5 +14,5 @@
                 </field>
             </field>
         </record>
-    </data>
-</openerp>
+
+</odoo>

product_variant_default_code/views/product_view.xml

@@ -1,19 +1,27 @@
 <?xml version="1.0"?>
-<openerp>
-    <data>
-        <record id="product_template_only_form_view_inh_variantdefaultcode" model="ir.ui.view">
-            <field name="name">product.template.only.form.view.inh.variantdefaultcode</field>
+<odoo>
+
+        <record id="product_template_only_form_view_inh_variantdefaultcode"
+                model="ir.ui.view">
+            <field name="name">
+                product.template.only.form.view.inh.variantdefaultcode
+            </field>
             <field name="model">product.template</field>
-            <field name="inherit_id" ref="product.product_template_only_form_view"/>
+            <field name="inherit_id"
+                   ref="product.product_template_only_form_view"/>
             <field name="arch" type="xml">
                 <field name="default_code" position="before">
                   <field name="reference_mask"
-                           modifiers="{'invisible': [['attribute_line_ids', '=', False]]}"/>
+                         attrs="{'invisible':
+                          [('attribute_line_ids', '=', [])]}"/>
                 </field>
             </field>
         </record>
-        <record id="product_normal_form_view_inh_variantdefaultcode" model="ir.ui.view">
-            <field name="name">product.normal.form.view.inh.variantdefaultcode</field>
+        <record id="product_normal_form_view_inh_variantdefaultcode"
+                model="ir.ui.view">
+            <field name="name">
+                product.normal.form.view.inh.variantdefaultcode
+            </field>
             <field name="model">product.product</field>
             <field name="inherit_id" ref="product.product_normal_form_view"/>
             <field name="arch" type="xml">
@@ -22,5 +30,5 @@
                 </field>
             </field>
         </record>
-    </data>
-</openerp>
+
+</odoo>