[17.0][MIG] web_domain_field: Migration to 17.0

web_domain_field/README.rst

@@ -0,0 +1,162 @@
+================
+Web Domain Field
+================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:38caddd3efd0bf3c90c5b3a84068ef6e757e1bb72698ee16451a62c210e7a154
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/17.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-17-0/web-17-0-web_domain_field
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+.. warning::
+
+   This module is deprecated. If you want to use this functionality you
+   can assign a unserialised domain to a fields.Binary,
+   `example <https://github.com/OCA/OCB/blob/16.0/addons/account/models/account_tax.py#L1308>`__
+
+This technical addon allows developers to specify a field domain in a
+view using the value of another field in that view, rather than as a
+static XML attribute.
+
+**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.
+
+.. code:: xml
+
+   <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.
+
+.. code:: xml
+
+   <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.
+
+.. code:: 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)]
+           )
+
+.. note::
+
+   You do not actually need this module to craft a dynamic domain. Odoo
+   comes with its own
+   `py.js <https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js>`__
+   web library to parse expressions such as domains. py.js supports more
+   complex expressions than just static lists.
+
+   Here is an example of a conditional domain based on the value of
+   another field:
+
+   .. code:: python
+
+      (order_id or partner_id) and [('id', 'in', allowed_picking_ids)]
+      or [('state', '=', 'done'), ('picking_type_id.code', '=', 'outgoing')]
+
+   For OCA modules, this method is preferred over adding this module as
+   an additional dependency.
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_domain_field%0Aversion:%2017.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
+-------
+
+* ACSONE SA/NV
+
+Contributors
+------------
+
+-  Laurent Mignon <[email protected]>
+-  Denis Roussel <[email protected]>
+-  Raf Ven <[email protected]>
+
+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/web <https://github.com/OCA/web/tree/17.0/web_domain_field>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

web_domain_field/__manifest__.py

@@ -0,0 +1,23 @@
+# Copyright 2017 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Web Domain Field",
+    "summary": """
+        Use computed field as domain""",
+    "version": "17.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/web",
+    "depends": ["web"],
+    "data": [],
+    "assets": {
+        "web.assets_backend": [
+            "/web_domain_field/static/lib/js/*.js",
+        ],
+        "web.qunit_suite_tests": [
+            "/web_domain_field/static/tests/**/*.js",
+        ],
+    },
+    "installable": True,
+}

web_domain_field/i18n/it.po

@@ -0,0 +1,14 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.0\n"
+"Report-Msgid-Bugs-To: \n"
+"Last-Translator: Automatically generated\n"
+"Language-Team: none\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"

web_domain_field/i18n/web_domain_field.pot

@@ -0,0 +1,13 @@
+# Translation of Odoo Server.
+# This file contains the translation of the following modules:
+#
+msgid ""
+msgstr ""
+"Project-Id-Version: Odoo Server 16.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"

web_domain_field/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["whool"]
+build-backend = "whool.buildapi"

web_domain_field/readme/CONTRIBUTORS.md

@@ -0,0 +1,3 @@
+- Laurent Mignon \<<[email protected]>\>
+- Denis Roussel \<<[email protected]>\>
+- Raf Ven \<<[email protected]>\>

web_domain_field/readme/DESCRIPTION.md

@@ -0,0 +1,8 @@
+> [!WARNING]
+> This module is deprecated. If you want to use this functionality you
+> can assign a unserialised domain to a fields.Binary,
+> [example](https://github.com/OCA/OCB/blob/16.0/addons/account/models/account_tax.py#L1308)
+
+This technical addon allows developers to specify a field domain in a
+view using the value of another field in that view, rather than as a
+static XML attribute.

web_domain_field/readme/USAGE.md

@@ -0,0 +1,71 @@
+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.
+
+``` xml
+<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.
+
+``` xml
+<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.
+
+``` 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)]
+        )
+```
+
+> [!NOTE]
+> You do not actually need this module to craft a dynamic domain. Odoo
+> comes with its own
+> [py.js](https://github.com/odoo/odoo/tree/16.0/addons/web/static/lib/py.js)
+> web library to parse expressions such as domains. py.js supports more
+> complex expressions than just static lists.
+>
+> Here is an example of a conditional domain based on the value of
+> another field:
+>
+> ``` python
+> (order_id or partner_id) and [('id', 'in', allowed_picking_ids)]
+> or [('state', '=', 'done'), ('picking_type_id.code', '=', 'outgoing')]
+> ```
+>
+> For OCA modules, this method is preferred over adding this module as
+> an additional dependency.