Merge pull request #1407 from Tecnativa/11.0-mig-base_view_inheritance_extension

[11.0] [MIG] base_view_inheritance_extension: Migration to v11.0

base_view_inheritance_extension/README.rst

@@ -0,0 +1,123 @@
+=========================
+Extended view inheritance
+=========================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Beta
+.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/11.0/base_view_inheritance_extension
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-base_view_inheritance_extension
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/149/11.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module was written to make it simple to add custom operators for view
+inheritance.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+**Change a python dictionary (context for example)**
+
+
+.. code-block:: xml
+
+    <attribute name="$attribute" operation="python_dict" key="$key">
+        $new_value
+    </attribute>
+
+Note that views are subject to evaluation of xmlids anyways, so if you need
+to refer to some xmlid, say ``%(xmlid)s``.
+
+**Move an element in the view**
+
+.. code-block:: xml
+
+    <xpath expr="$xpath" position="move" target="$targetxpath" />
+
+This can also be used to wrap some element into another, create the target
+element first, then move the node youwant to wrap there.
+
+**Add to values in a list (states for example)**
+
+.. code-block:: xml
+
+    <attribute name="$attribute" operation="list_add">
+        $new_value(s)
+    </attribute>
+
+**Remove values from a list (states for example)**
+
+.. code-block:: xml
+
+    <attribute name="$attribute" operation="list_remove">
+        $remove_value(s)
+    </attribute>
+
+Known issues / Roadmap
+======================
+
+* add ``<attribute operation="json_dict" key="$key">$value</attribute>``
+* support ``<xpath expr="$xpath" position="move" target="xpath" target_position="position" />``
+* support an ``eval`` attribute for our new node types
+
+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 <https://github.com/OCA/server-tools/issues/new?body=module:%20base_view_inheritance_extension%0Aversion:%2011.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.
+
+Credits
+=======
+
+Authors
+~~~~~~~
+
+* Therp BV
+
+Contributors
+~~~~~~~~~~~~
+
+* Holger Brunn <hbrunn@therp.nl>
+* Ronald Portier <rportier@therp.nl>
+* Sergio Teruel <sergio.teruel@tecnativa.com>
+
+Maintainers
+~~~~~~~~~~~
+
+This module is maintained by the OCA.
+
+.. image:: https://odoo-community.org/logo.png
+   :alt: Odoo Community Association
+   :target: https://odoo-community.org
+
+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.
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/11.0/base_view_inheritance_extension>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

base_view_inheritance_extension/__init__.py

@@ -0,0 +1,2 @@
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+from . import models

base_view_inheritance_extension/__manifest__.py

@@ -0,0 +1,17 @@
+# Copyright 2016 Therp BV <https://therp.nl>
+# Copyright 2018 Tecnativa - Sergio Teruel
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+{
+    "name": "Extended view inheritance",
+    "version": "11.0.1.0.0",
+    "author": "Therp BV,Odoo Community Association (OCA)",
+    "license": "LGPL-3",
+    "category": "Hidden/Dependency",
+    "summary": "Adds more operators for view inheritance",
+    "depends": [
+        'base',
+    ],
+    "demo": [
+        "demo/ir_ui_view.xml",
+    ],
+}

base_view_inheritance_extension/demo/ir_ui_view.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<odoo>
+        <record id="view_partner_simple_form" model="ir.ui.view">
+            <field name="model">res.partner</field>
+            <field name="inherit_id" ref="base.view_partner_simple_form" />
+            <field name="arch" type="xml">
+                <xpath expr="." position="attributes">
+                    <attribute name="string">Partner form</attribute>
+                </xpath>
+                <field name="parent_id" position="attributes">
+                    <attribute name="context" operation="python_dict" key="default_name">'The company name'</attribute>
+                    <attribute name="context" operation="python_dict" key="default_company_id">context.get('company_id', context.get('company'))</attribute>
+                </field>
+                <!-- without operations, the standard handler should be called /-->
+                <field name="parent_id" position="attributes">
+                    <attribute name="name">parent_id</attribute>
+                </field>
+                <form position="inside">
+                    <notebook>
+                        <page string="Phone numbers" name="phone_book" />
+                    </notebook>
+                </form>
+                <xpath expr="//field[@name='phone']" position="move" target="//page[@name='phone_book']" />
+                <xpath expr="//field[@name='mobile']" position="move" target="//page[@name='phone_book']" />
+            </field>
+        </record>
+</odoo>

base_view_inheritance_extension/i18n/base_view_inheritance_extension.pot

@@ -0,0 +1,30 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#	* base_view_inheritance_extension
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: <>\n"
+"Language-Team: \n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr ""
+

base_view_inheritance_extension/i18n/ca.po

@@ -0,0 +1,37 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# Translators:
+# Marc Tormo i Bochaca <mtbochaca@gmail.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 9.0c\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-04-19 17:59+0000\n"
+"PO-Revision-Date: 2017-04-19 17:59+0000\n"
+"Last-Translator: Marc Tormo i Bochaca <mtbochaca@gmail.com>, 2017\n"
+"Language-Team: Catalan (https://www.transifex.com/oca/teams/23907/ca/)\n"
+"Language: ca\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr "Empresa de "
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr "ir.ui.view"
+
+#~ msgid "A new page"
+#~ msgstr "Una nova pàgina "

base_view_inheritance_extension/i18n/de.po

@@ -0,0 +1,34 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# 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-12-01 02:10+0000\n"
+"PO-Revision-Date: 2017-12-01 02:10+0000\n"
+"Last-Translator: Niki Waibel <niki.waibel@gmail.com>, 2017\n"
+"Language-Team: German (https://www.transifex.com/oca/teams/23907/de/)\n"
+"Language: de\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr "ir.ui.view"

base_view_inheritance_extension/i18n/es.po

@@ -0,0 +1,34 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# Translators:
+# Pedro M. Baeza <pedro.baeza@gmail.com>, 2017
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2017-12-01 02:10+0000\n"
+"PO-Revision-Date: 2017-12-01 02:10+0000\n"
+"Last-Translator: Pedro M. Baeza <pedro.baeza@gmail.com>, 2017\n"
+"Language-Team: Spanish (https://www.transifex.com/oca/teams/23907/es/)\n"
+"Language: es\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr "ir.ui.view"

base_view_inheritance_extension/i18n/hr.po

@@ -0,0 +1,35 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# Translators:
+# Bole <bole@dajmi5.com>, 2018
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2018-03-02 18:40+0000\n"
+"PO-Revision-Date: 2018-03-02 18:40+0000\n"
+"Last-Translator: Bole <bole@dajmi5.com>, 2018\n"
+"Language-Team: Croatian (https://www.transifex.com/oca/teams/23907/hr/)\n"
+"Language: hr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \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: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr "Forma partnera"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr "Brojevi telefona"
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr "ir.ui.view"

base_view_inheritance_extension/i18n/it.po

@@ -0,0 +1,34 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# Translators:
+# Paolo Valier <paolo.valier@hotmail.it>, 2018
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 10.0\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2018-01-06 02:25+0000\n"
+"PO-Revision-Date: 2018-01-06 02:25+0000\n"
+"Last-Translator: Paolo Valier <paolo.valier@hotmail.it>, 2018\n"
+"Language-Team: Italian (https://www.transifex.com/oca/teams/23907/it/)\n"
+"Language: it\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr "Form Partner"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr "Numeri di telefono"
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr "ir.ui.view"

base_view_inheritance_extension/i18n/sl.po

@@ -0,0 +1,38 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# Translators:
+# Matjaž Mozetič <m.mozetic@matmoz.si>, 2016
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 9.0c\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2016-12-29 03:39+0000\n"
+"PO-Revision-Date: 2016-12-29 03:39+0000\n"
+"Last-Translator: Matjaž Mozetič <m.mozetic@matmoz.si>, 2016\n"
+"Language-Team: Slovenian (https://www.transifex.com/oca/teams/23907/sl/)\n"
+"Language: sl\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=4; plural=(n%100==1 ? 0 : n%100==2 ? 1 : n%100==3 || n"
+"%100==4 ? 2 : 3);\n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr "Partnerjev obrazec"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr ""
+
+#~ msgid "A new page"
+#~ msgstr "Nova stran"

base_view_inheritance_extension/i18n/tr.po

@@ -0,0 +1,37 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+# * base_view_inheritance_extension
+#
+# Translators:
+# Ahmet Altinisik <aaltinisik@altinkaya.com.tr>, 2016
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 9.0c\n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2016-12-29 03:39+0000\n"
+"PO-Revision-Date: 2016-12-29 03:39+0000\n"
+"Last-Translator: Ahmet Altinisik <aaltinisik@altinkaya.com.tr>, 2016\n"
+"Language-Team: Turkish (https://www.transifex.com/oca/teams/23907/tr/)\n"
+"Language: tr\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Partner form"
+msgstr "İş ortağı formu"
+
+#. module: base_view_inheritance_extension
+#: model:ir.ui.view,arch_db:base_view_inheritance_extension.view_partner_simple_form
+msgid "Phone numbers"
+msgstr ""
+
+#. module: base_view_inheritance_extension
+#: model:ir.model,name:base_view_inheritance_extension.model_ir_ui_view
+msgid "ir.ui.view"
+msgstr "ir.ui.view"
+
+#~ msgid "A new page"
+#~ msgstr "Yeni bir sayfa"

base_view_inheritance_extension/models/__init__.py

@@ -0,0 +1,2 @@
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+from . import ir_ui_view

base_view_inheritance_extension/models/ir_ui_view.py

@@ -0,0 +1,167 @@
+# Copyright 2016 Therp BV <https://therp.nl>
+# Copyright 2018 Tecnativa - Sergio Teruel
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+from lxml import etree
+from odoo import api, models, tools
+from odoo.tools.safe_eval import safe_eval
+
+
+class UnquoteObject(str):
+    def __getattr__(self, name):
+        return UnquoteObject('%s.%s' % (self, name))
+
+    def __repr__(self):
+        return self
+
+    def __call__(self, *args, **kwargs):
+        return UnquoteObject(
+            '%s(%s)' % (
+                self,
+                ','.join(
+                    [
+                        UnquoteObject(
+                            a if not isinstance(a, str)
+                            else "'%s'" % a
+                        )
+                        for a in args
+                    ] +
+                    [
+                        '%s=%s' % (UnquoteObject(k), v)
+                        for (k, v) in kwargs.items()
+                    ]
+                )
+            )
+        )
+
+
+class UnquoteEvalObjectContext(tools.misc.UnquoteEvalContext):
+    def __missing__(self, key):
+        return UnquoteObject(key)
+
+
+class IrUiView(models.Model):
+    _inherit = 'ir.ui.view'
+
+    @api.model
+    def apply_inheritance_specs(self, source, specs_tree, inherit_id):
+        for specs, handled_by in self._iter_inheritance_specs(specs_tree):
+            source = handled_by(source, specs, inherit_id)
+        return source
+
+    @api.model
+    def _iter_inheritance_specs(self, spec):
+        if spec.tag == 'data':
+            for child in spec:
+                for node, handler in self._iter_inheritance_specs(child):
+                    yield node, handler
+            return
+        if spec.get('position') == 'attributes':
+            if all(not c.get('operation') for c in spec):
+                yield spec, self._get_inheritance_handler(spec)
+                return
+            for child in spec:
+                node = etree.Element(spec.tag, **spec.attrib)
+                node.insert(0, child)
+                yield node, self._get_inheritance_handler_attributes(
+                    child
+                )
+            return
+        yield spec, self._get_inheritance_handler(spec)
+
+    @api.model
+    def _get_inheritance_handler(self, node):
+        handler = super(IrUiView, self).apply_inheritance_specs
+        if hasattr(
+            self, 'inheritance_handler_%s' % node.tag
+        ):
+            handler = getattr(
+                self,
+                'inheritance_handler_%s' % node.tag
+            )
+        return handler
+
+    @api.model
+    def _get_inheritance_handler_attributes(self, node):
+        handler = super(IrUiView, self).apply_inheritance_specs
+        if hasattr(
+            self, 'inheritance_handler_attributes_%s' % node.get('operation')
+        ):
+            handler = getattr(
+                self,
+                'inheritance_handler_attributes_%s' % node.get('operation')
+            )
+        return handler
+
+    @api.model
+    def inheritance_handler_attributes_python_dict(
+        self, source, specs, inherit_id
+    ):
+        """Implement
+        <$node position="attributes">
+            <attribute name="$attribute" operation="python_dict" key="$key">
+                $keyvalue
+            </attribute>
+        </$node>"""
+        node = self.locate_node(source, specs)
+        for attribute_node in specs:
+            python_dict = safe_eval(
+                node.get(attribute_node.get('name')) or '{}',
+                UnquoteEvalObjectContext(),
+                nocopy=True
+            )
+            python_dict[attribute_node.get('key')] = UnquoteObject(
+                attribute_node.text
+            )
+            node.attrib[attribute_node.get('name')] = str(python_dict)
+        return source
+
+    @api.model
+    def inheritance_handler_xpath(self, source, specs, inherit_id):
+        if not specs.get('position') == 'move':
+            return super(IrUiView, self).apply_inheritance_specs(
+                source, specs, inherit_id
+            )
+        node = self.locate_node(source, specs)
+        target_node = self.locate_node(
+            source, etree.Element(specs.tag, expr=specs.get('target'))
+        )
+        target_node.append(node)
+        return source
+
+    @api.model
+    def inheritance_handler_attributes_list_add(
+        self, source, specs, inherit_id
+    ):
+        """Implement
+        <$node position="attributes">
+            <attribute name="$attribute" operation="list_add">
+                $new_value
+            </attribute>
+        </$node>"""
+        node = self.locate_node(source, specs)
+        for attribute_node in specs:
+            attribute_name = attribute_node.get('name')
+            old_value = node.get(attribute_name) or ''
+            new_value = old_value + ',' + attribute_node.text
+            node.attrib[attribute_name] = new_value
+        return source
+
+    @api.model
+    def inheritance_handler_attributes_list_remove(
+        self, source, specs, inherit_id
+    ):
+        """Implement
+        <$node position="attributes">
+            <attribute name="$attribute" operation="list_remove">
+                $value_to_remove
+            </attribute>
+        </$node>"""
+        node = self.locate_node(source, specs)
+        for attribute_node in specs:
+            attribute_name = attribute_node.get('name')
+            old_values = (node.get(attribute_name) or '').split(',')
+            remove_values = attribute_node.text.split(',')
+            new_values = [x for x in old_values if x not in remove_values]
+            node.attrib[attribute_name] = ','.join(
+                [_f for _f in new_values if _f])
+        return source

base_view_inheritance_extension/readme/CONTRIBUTORS.rst

@@ -0,0 +1,3 @@
+* Holger Brunn <hbrunn@therp.nl>
+* Ronald Portier <rportier@therp.nl>
+* Sergio Teruel <sergio.teruel@tecnativa.com>

base_view_inheritance_extension/readme/DESCRIPTION.rst

@@ -0,0 +1,2 @@
+This module was written to make it simple to add custom operators for view
+inheritance.

base_view_inheritance_extension/readme/ROADMAP.rst

@@ -0,0 +1,3 @@
+* add ``<attribute operation="json_dict" key="$key">$value</attribute>``
+* support ``<xpath expr="$xpath" position="move" target="xpath" target_position="position" />``
+* support an ``eval`` attribute for our new node types

base_view_inheritance_extension/readme/USAGE.rst

@@ -0,0 +1,36 @@
+**Change a python dictionary (context for example)**
+
+
+.. code-block:: xml
+
+    <attribute name="$attribute" operation="python_dict" key="$key">
+        $new_value
+    </attribute>
+
+Note that views are subject to evaluation of xmlids anyways, so if you need
+to refer to some xmlid, say ``%(xmlid)s``.
+
+**Move an element in the view**
+
+.. code-block:: xml
+
+    <xpath expr="$xpath" position="move" target="$targetxpath" />
+
+This can also be used to wrap some element into another, create the target
+element first, then move the node youwant to wrap there.
+
+**Add to values in a list (states for example)**
+
+.. code-block:: xml
+
+    <attribute name="$attribute" operation="list_add">
+        $new_value(s)
+    </attribute>
+
+**Remove values from a list (states for example)**
+
+.. code-block:: xml
+
+    <attribute name="$attribute" operation="list_remove">
+        $remove_value(s)
+    </attribute>

base_view_inheritance_extension/static/description/index.html

@@ -0,0 +1,461 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
+<title>Extended view inheritance</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="extended-view-inheritance">
+<h1 class="title">Extended view inheritance</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/server-tools/tree/11.0/base_view_inheritance_extension"><img alt="OCA/server-tools" src="https://img.shields.io/badge/github-OCA%2Fserver--tools-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/server-tools-11-0/server-tools-11-0-base_view_inheritance_extension"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/149/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p>This module was written to make it simple to add custom operators for view
+inheritance.</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#usage" id="id1">Usage</a></li>
+<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="usage">
+<h1><a class="toc-backref" href="#id1">Usage</a></h1>
+<p><strong>Change a python dictionary (context for example)</strong></p>
+<pre class="code xml literal-block">
+<span class="nt">&lt;attribute</span> <span class="na">name=</span><span class="s">&quot;$attribute&quot;</span> <span class="na">operation=</span><span class="s">&quot;python_dict&quot;</span> <span class="na">key=</span><span class="s">&quot;$key&quot;</span><span class="nt">&gt;</span>
+    $new_value
+<span class="nt">&lt;/attribute&gt;</span>
+</pre>
+<p>Note that views are subject to evaluation of xmlids anyways, so if you need
+to refer to some xmlid, say <tt class="docutils literal">%(xmlid)s</tt>.</p>
+<p><strong>Move an element in the view</strong></p>
+<pre class="code xml literal-block">
+<span class="nt">&lt;xpath</span> <span class="na">expr=</span><span class="s">&quot;$xpath&quot;</span> <span class="na">position=</span><span class="s">&quot;move&quot;</span> <span class="na">target=</span><span class="s">&quot;$targetxpath&quot;</span> <span class="nt">/&gt;</span>
+</pre>
+<p>This can also be used to wrap some element into another, create the target
+element first, then move the node youwant to wrap there.</p>
+<p><strong>Add to values in a list (states for example)</strong></p>
+<pre class="code xml literal-block">
+<span class="nt">&lt;attribute</span> <span class="na">name=</span><span class="s">&quot;$attribute&quot;</span> <span class="na">operation=</span><span class="s">&quot;list_add&quot;</span><span class="nt">&gt;</span>
+    $new_value(s)
+<span class="nt">&lt;/attribute&gt;</span>
+</pre>
+<p><strong>Remove values from a list (states for example)</strong></p>
+<pre class="code xml literal-block">
+<span class="nt">&lt;attribute</span> <span class="na">name=</span><span class="s">&quot;$attribute&quot;</span> <span class="na">operation=</span><span class="s">&quot;list_remove&quot;</span><span class="nt">&gt;</span>
+    $remove_value(s)
+<span class="nt">&lt;/attribute&gt;</span>
+</pre>
+</div>
+<div class="section" id="known-issues-roadmap">
+<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
+<ul class="simple">
+<li>add <tt class="docutils literal">&lt;attribute <span class="pre">operation=&quot;json_dict&quot;</span> <span class="pre">key=&quot;$key&quot;&gt;$value&lt;/attribute&gt;</span></tt></li>
+<li>support <tt class="docutils literal">&lt;xpath <span class="pre">expr=&quot;$xpath&quot;</span> <span class="pre">position=&quot;move&quot;</span> <span class="pre">target=&quot;xpath&quot;</span> <span class="pre">target_position=&quot;position&quot;</span> /&gt;</tt></li>
+<li>support an <tt class="docutils literal">eval</tt> attribute for our new node types</li>
+</ul>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/server-tools/issues">GitHub Issues</a>.
+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
+<a class="reference external" href="https://github.com/OCA/server-tools/issues/new?body=module:%20base_view_inheritance_extension%0Aversion:%2011.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#id4">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#id5">Authors</a></h2>
+<ul class="simple">
+<li>Therp BV</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
+<ul class="simple">
+<li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li>
+<li>Ronald Portier &lt;<a class="reference external" href="mailto:rportier&#64;therp.nl">rportier&#64;therp.nl</a>&gt;</li>
+<li>Sergio Teruel &lt;<a class="reference external" href="mailto:sergio.teruel&#64;tecnativa.com">sergio.teruel&#64;tecnativa.com</a>&gt;</li>
+</ul>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<p>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.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/server-tools/tree/11.0/base_view_inheritance_extension">OCA/server-tools</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

base_view_inheritance_extension/tests/__init__.py

@@ -0,0 +1,2 @@
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+from . import test_base_view_inheritance_extension

base_view_inheritance_extension/tests/test_base_view_inheritance_extension.py

@@ -0,0 +1,112 @@
+# Copyright 2016 Therp BV <http://therp.nl>
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html).
+from lxml import etree
+from odoo.tests.common import TransactionCase
+
+
+class TestBaseViewInheritanceExtension(TransactionCase):
+
+    def test_base_view_inheritance_extension(self):
+        view_id = self.env.ref('base.view_partner_simple_form').id
+        fields_view_get = self.env['res.partner'].fields_view_get(
+            view_id=view_id
+        )
+        view = etree.fromstring(fields_view_get['arch'])
+        # verify normal attributes work
+        self.assertEqual(view.xpath('//form')[0].get('string'), 'Partner form')
+        # verify our extra context key worked
+        self.assertTrue(
+            'default_name' in
+            view.xpath('//field[@name="parent_id"]')[0].get('context')
+        )
+        self.assertTrue(
+            "context.get('company_id', context.get('company'))" in
+            view.xpath('//field[@name="parent_id"]')[0].get('context')
+        )
+        # verify we moved the child_ids field
+        self.assertEqual(
+            view.xpath('//field[@name="mobile"]')[0].getparent(),
+            view.xpath('//page[@name="phone_book"]')[0]
+        )
+
+    def test_list_add(self):
+        view_model = self.env['ir.ui.view']
+        inherit_id = self.env.ref('base.view_partner_form').id
+        source = etree.fromstring(
+            """\
+            <form>
+                <button name="test" states="draft,open"/>
+            </form>
+            """
+        )
+        # extend with single value
+        specs = etree.fromstring(
+            """\
+            <button name="test" position="attributes">
+                <attribute
+                    name="states"
+                    operation="list_add"
+                    >valid</attribute>
+            </button>
+            """
+        )
+        modified_source = \
+            view_model.inheritance_handler_attributes_list_add(
+                source, specs, inherit_id
+            )
+        button_node = modified_source.xpath('//button[@name="test"]')[0]
+        self.assertEqual(
+            button_node.attrib['states'],
+            'draft,open,valid'
+        )
+        # extend with list of values
+        specs = etree.fromstring(
+            """\
+            <button name="test" position="attributes">
+                <attribute
+                    name="states"
+                    operation="list_add"
+                    >payable,paid</attribute>
+            </button>
+            """
+        )
+        modified_source = \
+            view_model.inheritance_handler_attributes_list_add(
+                source, specs, inherit_id
+            )
+        button_node = modified_source.xpath('//button[@name="test"]')[0]
+        self.assertEqual(
+            button_node.attrib['states'],
+            'draft,open,valid,payable,paid'
+        )
+
+    def test_list_remove(self):
+        view_model = self.env['ir.ui.view']
+        inherit_id = self.env.ref('base.view_partner_form').id
+        source = etree.fromstring(
+            """\
+            <form>
+                <button name="test" states="draft,open,valid,payable,paid"/>
+            </form>
+            """
+        )
+        # remove list of values
+        specs = etree.fromstring(
+            """\
+            <button name="test" position="attributes">
+                <attribute
+                    name="states"
+                    operation="list_remove"
+                    >open,payable</attribute>
+            </button>
+            """
+        )
+        modified_source = \
+            view_model.inheritance_handler_attributes_list_remove(
+                source, specs, inherit_id
+            )
+        button_node = modified_source.xpath('//button[@name="test"]')[0]
+        self.assertEqual(
+            button_node.attrib['states'],
+            'draft,valid,paid'
+        )