Merge pull request #1128 from onesteinbv/11_mig_onchange_helper

[11.0][MIG] onchange_helper

onchange_helper/README.rst

@@ -0,0 +1,63 @@
+.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png
+   :target: https://www.gnu.org/licenses/agpl
+   :alt: License: AGPL-3
+
+===============
+Onchange Helper
+===============
+
+This is a technical module. Its goal is to ease the play of onchange method directly called from Python code.
+
+Usage
+=====
+
+To use this module, you need to:
+
+* depend on this module
+* call `yourmodel.play_onchanges(values, ['field'])`
+
+Example if you want to create a sale order and you want to get the values relative to partner_id field (as if you fill the field from UI)
+
+    `vals = {'partner_id': 1}`
+
+    `vals = self.env['sale.order'].play_onchanges(vals, ['partner_id'])`
+
+Then, `vals` will be updated with partner_invoice_id, partner_shipping_id, pricelist_id, etc...
+
+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 smashing it by providing a detailed and welcomed feedback.
+
+Credits
+=======
+
+Images
+------
+
+* Odoo Community Association: `Icon <https://odoo-community.org/logo.png>`_.
+
+Contributors
+------------
+
+* Guewen Baconnier <guewen.baconnier@camptocamp.com>
+* Florian da Costa <florian.dacosta@akretion.com>
+* Andrea Stirpe <a.stirpe@onestein.nl>
+
+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.

onchange_helper/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import models

onchange_helper/__manifest__.py

@@ -0,0 +1,13 @@
+# Copyright 2016-2017 Akretion (http://www.akretion.com)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+{'name': 'Onchange Helper',
+ 'version': '11.0.1.0.0',
+ 'summary': 'Technical module that ease execution of onchange in Python code',
+ 'author': 'Akretion,Camptocamp,Odoo Community Association (OCA)',
+ 'website': 'https://github.com/OCA/server-tools',
+ 'license': 'AGPL-3',
+ 'category': 'Generic Modules',
+ 'depends': ['base'],
+ 'installable': True,
+ }

onchange_helper/i18n/de.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * onchange_helper
+# 
+# Translators:
+# Niki Waibel <niki.waibel@gmail.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-06-01 14:59+0000\n"
+"PO-Revision-Date: 2017-06-01 14:59+0000\n"
+"Last-Translator: Niki Waibel <niki.waibel@gmail.com>, 2017\n"
+"Language-Team: German (https://www.transifex.com/oca/teams/23907/de/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: de\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: onchange_helper
+#: model:ir.model,name:onchange_helper.model_ir_rule
+msgid "ir.rule"
+msgstr "ir.rule"

onchange_helper/i18n/es.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * onchange_helper
+# 
+# Translators:
+# Fernando Lara <gennesis45@gmail.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-06-01 14:59+0000\n"
+"PO-Revision-Date: 2017-06-01 14:59+0000\n"
+"Last-Translator: Fernando Lara <gennesis45@gmail.com>, 2017\n"
+"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: es\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: onchange_helper
+#: model:ir.model,name:onchange_helper.model_ir_rule
+msgid "ir.rule"
+msgstr "ir.regla"

onchange_helper/i18n/hr.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * onchange_helper
+# 
+# Translators:
+# OCA Transbot <transbot@odoo-community.org>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-06-01 14:59+0000\n"
+"PO-Revision-Date: 2017-06-01 14:59+0000\n"
+"Last-Translator: OCA Transbot <transbot@odoo-community.org>, 2017\n"
+"Language-Team: Croatian (https://www.transifex.com/oca/teams/23907/hr/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: hr\n"
+"Plural-Forms: nplurals=3; plural=n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<=4 && (n%100<10 || n%100>=20) ? 1 : 2;\n"
+
+#. module: onchange_helper
+#: model:ir.model,name:onchange_helper.model_ir_rule
+msgid "ir.rule"
+msgstr "ir.rule"

onchange_helper/i18n/sl.po

@@ -0,0 +1,24 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * onchange_helper
+# 
+# Translators:
+# OCA Transbot <transbot@odoo-community.org>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-06-01 14:59+0000\n"
+"PO-Revision-Date: 2017-06-01 14:59+0000\n"
+"Last-Translator: OCA Transbot <transbot@odoo-community.org>, 2017\n"
+"Language-Team: Slovenian (https://www.transifex.com/oca/teams/23907/sl/)\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Language: sl\n"
+"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n%100==4 ? 2 : 3);\n"
+
+#. module: onchange_helper
+#: model:ir.model,name:onchange_helper.model_ir_rule
+msgid "ir.rule"
+msgstr "ir.rule"

onchange_helper/models/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import base

onchange_helper/models/base.py

@@ -0,0 +1,51 @@
+# Copyright 2016-2017 Akretion (http://www.akretion.com)
+# Copyright 2016-2017 Camptocamp (http://www.camptocamp.com/)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo import api, models
+
+
+def get_new_values(model, record, on_change_result):
+    vals = on_change_result.get('value', {})
+    new_values = {}
+    for fieldname, value in vals.items():
+        if fieldname not in record:
+            column = model._fields[fieldname]
+            if value and column.type == 'many2one':
+                value = value[0]  # many2one are tuple (id, name)
+            new_values[fieldname] = value
+    return new_values
+
+
+@api.model
+def play_onchanges(self, values, onchange_fields):
+    onchange_specs = self._onchange_spec()
+    # we need all fields in the dict even the empty ones
+    # otherwise 'onchange()' will not apply changes to them
+    all_values = values.copy()
+    for field in self._fields:
+        if field not in all_values:
+            all_values[field] = False
+
+    # we work on a temporary record
+    new_record = self.new(all_values)
+
+    new_values = {}
+    for field in onchange_fields:
+        onchange_values = new_record.onchange(all_values,
+                                              field, onchange_specs)
+        new_values.update(get_new_values(self, values, onchange_values))
+        all_values.update(new_values)
+
+    res = {f: v for f, v in all_values.items()
+           if f in values or f in new_values}
+    return res
+
+
+class Base(models.AbstractModel):
+    _inherit = 'base'
+
+    def _setup_complete(self):
+        if not hasattr(models.BaseModel, 'play_onchanges'):
+            setattr(models.BaseModel, 'play_onchanges', play_onchanges)
+        return super(Base, self)._setup_complete()

onchange_helper/tests/__init__.py

@@ -0,0 +1,3 @@
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from . import test_onchange_helper

onchange_helper/tests/test_onchange_helper.py

@@ -0,0 +1,28 @@
+# Copyright 2017 Onestein (<http://www.onestein.eu>)
+# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).
+
+from odoo.tests.common import TransactionCase
+
+
+class TestOnchangeHelper(TransactionCase):
+
+    def test01_partner_parent(self):
+        main_partner = self.env.ref('base.main_partner')
+        input_vals = dict(partner_id=main_partner.id)
+        updated_vals = self.env['res.partner'].play_onchanges(
+            input_vals,
+            ['parent_id']
+        )
+        self.assertIn('commercial_partner_id', updated_vals)
+        self.assertIn('display_name', updated_vals)
+        self.assertIn('partner_id', updated_vals)
+
+    def test02_partner_country(self):
+        partner_demo = self.env.ref('base.partner_demo')
+        input_vals = {'partner_id': partner_demo.id}
+        updated_vals = self.env['res.partner'].play_onchanges(
+            input_vals,
+            ['country_id']
+        )
+        self.assertIn('contact_address', updated_vals)
+        self.assertIn('partner_id', updated_vals)