From 24760d54a0e4cf387ecc74cfd1b312181742df7e Mon Sep 17 00:00:00 2001 From: Raf Ven Date: Thu, 27 Jan 2022 11:09:44 +0100 Subject: [PATCH] [MIG] web_domain_field: Migration to 15.0 --- web_domain_field/README.rst | 80 ++- web_domain_field/__manifest__.py | 9 +- web_domain_field/i18n/es.po | 0 web_domain_field/readme/CONTRIBUTORS.rst | 3 + web_domain_field/readme/DESCRIPTION.rst | 3 + web_domain_field/readme/USAGE.rst | 51 ++ .../static/description/index.html | 475 ++++++++++++++++++ web_domain_field/views/web_domain_field.xml | 15 - 8 files changed, 592 insertions(+), 44 deletions(-) delete mode 100644 web_domain_field/i18n/es.po create mode 100644 web_domain_field/readme/CONTRIBUTORS.rst create mode 100644 web_domain_field/readme/DESCRIPTION.rst create mode 100644 web_domain_field/readme/USAGE.rst create mode 100644 web_domain_field/static/description/index.html delete mode 100644 web_domain_field/views/web_domain_field.xml diff --git a/web_domain_field/README.rst b/web_domain_field/README.rst index a14831b6f..4195b46e6 100644 --- a/web_domain_field/README.rst +++ b/web_domain_field/README.rst @@ -1,11 +1,42 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ================ Web Domain Field ================ +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github + :target: https://github.com/OCA/web/tree/15.0/web_domain_field + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-15-0/web-15-0-web_domain_field + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/162/15.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +When you define a view you can specify on the relational fields a domain +attribute. This attribute is evaluated as filter to apply when displaying +existing records for selection. + +**Table of contents** + +.. contents:: + :local: + +Usage +===== + When you define a view you can specify on the relational fields a domain attribute. This attribute is evaluated as filter to apply when displaying existing records for selection. @@ -59,49 +90,44 @@ The field used as domain must provide the domain as a JSON encoded string. [('type', '=', 'product'), ('name', 'like', rec.name)] ) - -Usage -===== - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/162/10.0 - - - Bug Tracker =========== -Bugs are tracked on `GitHub 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. +Bugs are tracked on `GitHub 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 `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* ACSONE SA/NV Contributors ------------- +~~~~~~~~~~~~ * Laurent Mignon * Denis Roussel +* Raf Ven -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. 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. +This module is part of the `OCA/web `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/web_domain_field/__manifest__.py b/web_domain_field/__manifest__.py index 0bdf8547c..a120e074c 100644 --- a/web_domain_field/__manifest__.py +++ b/web_domain_field/__manifest__.py @@ -5,11 +5,16 @@ "name": "Web Domain Field", "summary": """ Use computed field as domain""", - "version": "14.0.1.0.0", + "version": "15.0.1.0.0", "license": "AGPL-3", "author": "ACSONE SA/NV,Odoo Community Association (OCA)", "website": "https://github.com/OCA/web", "depends": ["web"], - "data": ["views/web_domain_field.xml"], + "data": [], + "assets": { + "web.assets_backend": [ + "/web_domain_field/static/lib/js/*.js", + ], + }, "installable": True, } diff --git a/web_domain_field/i18n/es.po b/web_domain_field/i18n/es.po deleted file mode 100644 index e69de29bb..000000000 diff --git a/web_domain_field/readme/CONTRIBUTORS.rst b/web_domain_field/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..1294ec29e --- /dev/null +++ b/web_domain_field/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Laurent Mignon +* Denis Roussel +* Raf Ven diff --git a/web_domain_field/readme/DESCRIPTION.rst b/web_domain_field/readme/DESCRIPTION.rst new file mode 100644 index 000000000..5aa1b96f3 --- /dev/null +++ b/web_domain_field/readme/DESCRIPTION.rst @@ -0,0 +1,3 @@ +When you define a view you can specify on the relational fields a domain +attribute. This attribute is evaluated as filter to apply when displaying +existing records for selection. diff --git a/web_domain_field/readme/USAGE.rst b/web_domain_field/readme/USAGE.rst new file mode 100644 index 000000000..b9c04da19 --- /dev/null +++ b/web_domain_field/readme/USAGE.rst @@ -0,0 +1,51 @@ +When you define a view you can specify on the relational fields a domain +attribute. This attribute is evaluated as filter to apply when displaying +existing records for selection. + +.. code-block:: xml + + + +The value provided for the domain attribute must be a string representing a +valid Odoo domain. This string is evaluated on the client side in a +restricted context where we can reference as right operand the values of +fields present into the form and a limited set of functions. + +In this context it's hard to build complex domain and we are facing to some +limitations as: + + * The syntax to include in your domain a criteria involving values from a + x2many field is complex. + * The right side of domain in case of x2many can involve huge amount of ids + (performance problem). + * Domains computed by an onchange on an other field are not recomputed when + you modify the form and don't modify the field triggering the onchange. + * It's not possible to extend an existing domain. You must completely redefine + the domain in your specialized addon + * etc... + +In order to mitigate these limitations this new addon allows you to use the +value of a field as domain of an other field in the xml definition of your +view. + +.. code-block:: xml + + + + +The field used as domain must provide the domain as a JSON encoded string. + +.. code-block:: python + + product_id_domain = fields.Char( + compute="_compute_product_id_domain", + readonly=True, + store=False, + ) + + @api.depends('name') + def _compute_product_id_domain(self): + for rec in self: + rec.product_id_domain = json.dumps( + [('type', '=', 'product'), ('name', 'like', rec.name)] + ) diff --git a/web_domain_field/static/description/index.html b/web_domain_field/static/description/index.html new file mode 100644 index 000000000..37ca8312d --- /dev/null +++ b/web_domain_field/static/description/index.html @@ -0,0 +1,475 @@ + + + + + + +Web Domain Field + + + +
+

Web Domain Field

+ + +

Beta License: AGPL-3 OCA/web Translate me on Weblate Try me on Runbot

+

When you define a view you can specify on the relational fields a domain +attribute. This attribute is evaluated as filter to apply when displaying +existing records for selection.

+

Table of contents

+ +
+

Usage

+

When you define a view you can specify on the relational fields a domain +attribute. This attribute is evaluated as filter to apply when displaying +existing records for selection.

+
+<field name="product_id" domain="[('type','=','product')]"/>
+
+

The value provided for the domain attribute must be a string representing a +valid Odoo domain. This string is evaluated on the client side in a +restricted context where we can reference as right operand the values of +fields present into the form and a limited set of functions.

+

In this context it’s hard to build complex domain and we are facing to some +limitations as:

+
+
    +
  • The syntax to include in your domain a criteria involving values from a +x2many field is complex.
    • +
  • The right side of domain in case of x2many can involve huge amount of ids +(performance problem).
    • +
  • Domains computed by an onchange on an other field are not recomputed when +you modify the form and don’t modify the field triggering the onchange.
    • +
  • It’s not possible to extend an existing domain. You must completely redefine +the domain in your specialized addon
    • +
  • etc…
    • +
+
+

In order to mitigate these limitations this new addon allows you to use the +value of a field as domain of an other field in the xml definition of your +view.

+
+<field name="product_id_domain" invisible="1"/>
+<field name="product_id" domain="product_id_domain"/>
+
+

The field used as domain must provide the domain as a JSON encoded string.

+
+product_id_domain = fields.Char(
+    compute="_compute_product_id_domain",
+    readonly=True,
+    store=False,
+)
+
+@api.multi
+@api.depends('name')
+def _compute_product_id_domain(self):
+    for rec in self:
+        rec.product_id_domain = json.dumps(
+            [('type', '=', 'product'), ('name', 'like', rec.name)]
+        )
+
+
+
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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/web project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/web_domain_field/views/web_domain_field.xml b/web_domain_field/views/web_domain_field.xml deleted file mode 100644 index 7102c526b..000000000 --- a/web_domain_field/views/web_domain_field.xml +++ /dev/null @@ -1,15 +0,0 @@ - - -