Merge pull request #930 from LasLabs/release/10.0/SMD-310-res_lang_uom_default

[ADD] base_locale_uom_default: Add default unit of measure by lang

base_locale_uom_default/README.rst

@@ -0,0 +1,73 @@
+.. image:: https://img.shields.io/badge/licence-LGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+   :alt: License: LGPL-3
+
+====================
+Locale - Default UoM
+====================
+
+This module adds a concept of a default unit of measure on languages, unique by
+unit category type.
+
+It also provides a method that can be used in fields to work from said defaults.
+
+Configuration
+=============
+
+Set default unit of measures in the `Languages` menu in settings.
+
+Usage
+=====
+
+Fields that want to implement the language default should use the provided method,
+such as in the below example::
+
+   class MyModel(models.Model):
+       _name = 'my.model'
+       time_uom_id = fields.Many2one(
+           string='Time Units',
+           comodel_name='product.uom',
+           default=lambda s: s.env['res.lang'].default_uom_by_category('Time'),
+       )
+
+.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+   :alt: Try me on Runbot
+   :target: https://runbot.odoo-community.org/runbot/149/10.0
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues
+<https://github.com/OCA/server-tools/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
+------------
+
+* Dave Lasley <dave@laslabs.com>
+
+Do not contact contributors directly about support or help with technical issues.
+
+Maintainer
+----------
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+This module is maintained by the OCA.
+
+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.
+
+To contribute to this module, please visit https://odoo-community.org.

base_locale_uom_default/__init__.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from . import models

base_locale_uom_default/__manifest__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+{
+    'name': 'Locale - Default UoM',
+    'summary': 'This provides settings to select default UoMs at the '
+               'language level.',
+    'version': '10.0.1.0.0',
+    'category': 'Extra Tools',
+    'website': 'https://laslabs.com/',
+    'author': 'LasLabs, '
+              'Odoo Community Association (OCA)',
+    'license': 'LGPL-3',
+    'application': False,
+    'installable': True,
+    'depends': [
+        'product',
+    ],
+    'data': [
+        'views/res_lang_view.xml',
+    ],
+    'demo': [
+        'demo/res_lang_demo.xml',
+    ],
+}

base_locale_uom_default/demo/res_lang_demo.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="base.lang_en" model="res.lang">
+        <field name="default_uom_ids" eval="[(6, 0, [
+                    ref('product.product_uom_unit'),
+                    ref('product.product_uom_hour'),
+                    ref('product.product_uom_lb'),
+                    ref('product.product_uom_inch'),
+                    ref('product.product_uom_floz'),
+                ])]" />
+    </record>
+
+</odoo>

base_locale_uom_default/models/__init__.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from . import res_lang

base_locale_uom_default/models/res_lang.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo import api, fields, models, _
+from odoo.exceptions import ValidationError
+
+
+class ResLang(models.Model):
+
+    _inherit = 'res.lang'
+
+    default_uom_ids = fields.Many2many(
+        string='Default Units',
+        comodel_name='product.uom',
+    )
+
+    @api.multi
+    @api.constrains('default_uom_ids')
+    def _check_default_uom_ids(self):
+        for record in self:
+            categories = set(record.default_uom_ids.mapped('category_id'))
+            if len(categories) != len(record.default_uom_ids):
+                raise ValidationError(_(
+                    'Only one default unit of measure per category may '
+                    'be selected.',
+                ))
+
+    @api.model
+    def default_uom_by_category(self, category_name, lang=None):
+        """Return the default UoM for language for the input UoM Category.
+
+        Args:
+            category_name (str): Name of the UoM category to get the default
+            for.
+            lang (ResLang or str, optional): Recordset or code of the language
+            to get the default for. Will use the current user language if
+            omitted.
+
+        Returns:
+            ProductUom: Unit of measure representing the default, if set.
+            Empty recordset otherwise.
+        """
+        if lang is None:
+            lang = self.env.user.lang
+        if isinstance(lang, basestring):
+            lang = self.env['res.lang'].search([
+                ('code', '=', lang),
+            ],
+                limit=1,
+            )
+        results = lang.default_uom_ids.filtered(
+            lambda r: r.category_id.name == category_name,
+        )
+        return results[:1]

base_locale_uom_default/tests/__init__.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from . import test_res_lang

base_locale_uom_default/tests/test_res_lang.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+# Copyright 2017 LasLabs Inc.
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl).
+
+from odoo.tests.common import TransactionCase
+from odoo.exceptions import ValidationError
+
+
+class TestResLang(TransactionCase):
+
+    def setUp(self):
+        super(TestResLang, self).setUp()
+        self.lang = self.env.ref('base.lang_en')
+        self.env.user.lang = self.lang.code
+        self.uom = self.env.ref('product.product_uom_dozen')
+        self.lang.default_uom_ids = [(6, 0, self.uom.ids)]
+
+    def test_check_default_uom_ids_fail(self):
+        """It should not allow multiple UoMs of the same category."""
+        with self.assertRaises(ValidationError):
+            self.lang.default_uom_ids = [
+                (4, self.env.ref('product.product_uom_unit').id),
+            ]
+
+    def test_check_default_uom_ids_pass(self):
+        """It should allow multiple UoMs of different categories."""
+        self.lang.default_uom_ids = [
+            (4, self.env.ref('product.product_uom_kgm').id),
+        ]
+        self.assertEqual(len(self.lang.default_uom_ids), 2)
+
+    def test_default_uom_by_category_exist(self):
+        """It should return the default UoM if existing."""
+        self.assertEqual(
+            self.env['res.lang'].default_uom_by_category('Unit'),
+            self.uom,
+        )
+
+    def test_default_uom_by_category_no_exist(self):
+        """It should return empty recordset when no default UoM."""
+        self.assertEqual(
+            self.env['res.lang'].default_uom_by_category('Volume'),
+            self.env['product.uom'].browse(),
+        )

base_locale_uom_default/views/res_lang_view.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8"?>
+<odoo>
+
+    <record id="res_lang_form" model="ir.ui.view">
+        <field name="name">Res Lang Form - Default UoMs</field>
+        <field name="model">res.lang</field>
+        <field name="inherit_id" ref="base.res_lang_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//field[@name='translatable']" position="after">
+                <field name="default_uom_ids" />
+            </xpath>
+        </field>
+    </record>
+
+</odoo>