[MIG] document_page_approval: Migration to 17.0

document_page/models/document_page_history.py

@@ -66,11 +66,5 @@ def _get_diff(self, v1, v2):
                 context=True,
             )
 
-    # TODO: Replace for _compute_display_name
     def name_get(self):
         return [(rec.id, "%s #%i" % (rec.page_id.name, rec.id)) for rec in self]
-
-    @api.depends("page_id")
-    def _compute_display_name(self):
-        for rec in self:
-            rec.display_name = rec.id, "%s #%i" % (rec.page_id.name, rec.id)

document_page_approval/README.rst

@@ -17,19 +17,19 @@ Document Page Approval
     :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
     :alt: License: AGPL-3
 .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github
-    :target: https://github.com/OCA/knowledge/tree/16.0/document_page_approval
+    :target: https://github.com/OCA/knowledge/tree/17.0/document_page_approval
     :alt: OCA/knowledge
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
-    :target: https://translation.odoo-community.org/projects/knowledge-16-0/knowledge-16-0-document_page_approval
+    :target: https://translation.odoo-community.org/projects/knowledge-17-0/knowledge-17-0-document_page_approval
     :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/knowledge&target_branch=16.0
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/knowledge&target_branch=17.0
     :alt: Try me on Runboat
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module adds a workflow to approve page modifications
-and show the approved version by default.
+This module adds a workflow to approve page modifications and show the
+approved version by default.
 
 **Table of contents**
 
@@ -41,61 +41,65 @@ Configuration
 
 To configure this module, you need to:
 
-#. Set a valid email address on the company settings.
-#. Go to Knowledge > Categories.
-#. Create a new page category and set an approver group.
-   Make sure users belonging to that group have valid email addresses.
+1. Set a valid email address on the company settings.
+2. Go to Knowledge > Categories.
+3. Create a new page category and set an approver group. Make sure users
+   belonging to that group have valid email addresses.
 
 Usage
 =====
 
 To use this module, you need to:
 
-#. Go to Knowledge > Pages
-#. Create a new page and choose the previously created category.
-#. A notification is sent to the approvers group with a link to the
-   page history to review.
-#. Depending on the review, the page history is approved or not.
-#. Users reading the page see the last approved version.
+1. Go to Knowledge > Pages
+2. Create a new page and choose the previously created category.
+3. A notification is sent to the approvers group with a link to the page
+   history to review.
+4. Depending on the review, the page history is approved or not.
+5. Users reading the page see the last approved version.
 
 Bug Tracker
 ===========
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/knowledge/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/knowledge/issues/new?body=module:%20document_page_approval%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+`feedback <https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_approval%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
-~~~~~~~
+-------
 
 * Savoir-faire Linux
 
 Contributors
-~~~~~~~~~~~~
+------------
 
-* Odoo SA <[email protected]>
-* Savoir-faire Linux <[email protected]>
-* Gervais Naoussi <[email protected]>
-* Maxime Chambreuil <[email protected]>
-* Iván Todorovich <[email protected]>
+-  Odoo SA <[email protected]>
 
-* `Tecnativa <https://www.tecnativa.com>`_:
+-  Savoir-faire Linux <support@savoirfairelinux.com>
 
-    * Victor M.M. Torres
-    * Víctor Martínez
+-  Gervais Naoussi <[email protected]>
 
-* `Guadaltech <https://www.guadaltech.es>`_:
+-  Maxime Chambreuil <[email protected]>
 
-  * Fernando La Chica <[email protected]>
+-  Iván Todorovich <[email protected]>
+
+-  `Tecnativa <https://www.tecnativa.com>`__:
+
+      -  Victor M.M. Torres
+      -  Víctor Martínez
+
+-  `Guadaltech <https://www.guadaltech.es>`__:
+
+   -  Fernando La Chica <[email protected]>
 
 Maintainers
-~~~~~~~~~~~
+-----------
 
 This module is maintained by the OCA.
 
@@ -107,6 +111,6 @@ 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/knowledge <https://github.com/OCA/knowledge/tree/16.0/document_page_approval>`_ project on GitHub.
+This module is part of the `OCA/knowledge <https://github.com/OCA/knowledge/tree/17.0/document_page_approval>`_ project on GitHub.
 
 You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

document_page_approval/__manifest__.py

@@ -3,7 +3,7 @@
 
 {
     "name": "Document Page Approval",
-    "version": "16.0.1.1.1",
+    "version": "17.0.1.0.0",
     "author": "Savoir-faire Linux, Odoo Community Association (OCA)",
     "website": "https://github.com/OCA/knowledge",
     "license": "AGPL-3",

document_page_approval/hooks.py

@@ -5,10 +5,10 @@
 _logger = logging.getLogger(__name__)
 
 
-def post_init_hook(cr, registry):  # pragma: no cover
+def post_init_hook(env):  # pragma: no cover
     # Set all pre-existing pages history to approved
     _logger.info("Setting history to approved.")
-    cr.execute(
+    env.cr.execute(
         """
         UPDATE document_page_history
         SET state='approved',
@@ -19,7 +19,7 @@ def post_init_hook(cr, registry):  # pragma: no cover
     )
 
 
-def uninstall_hook(cr, registry):  # pragma: no cover
+def uninstall_hook(env):  # pragma: no cover
     # Remove unapproved pages
     _logger.info("Deleting unapproved Change Requests.")
-    cr.execute("DELETE FROM document_page_history WHERE state != 'approved'")
+    env.cr.execute("DELETE FROM document_page_history WHERE state != 'approved'")

document_page_approval/models/document_page.py

@@ -19,7 +19,6 @@ class DocumentPage(models.Model):
         related="history_head.approved_date",
         store=True,
         index=True,
-        readonly=True,
     )
 
     approved_uid = fields.Many2one(
@@ -28,7 +27,6 @@ class DocumentPage(models.Model):
         related="history_head.approved_uid",
         store=True,
         index=True,
-        readonly=True,
     )
 
     approval_required = fields.Boolean(
@@ -137,8 +135,9 @@ def _create_history(self, vals):
 
     def action_changes_pending_approval(self):
         self.ensure_one()
-        action = self.env.ref("document_page_approval.action_change_requests")
-        action = action.sudo().read()[0]
+        action = self.env["ir.actions.act_window"]._for_xml_id(
+            "document_page_approval.action_change_requests"
+        )
         context = literal_eval(action["context"])
         context["search_default_page_id"] = self.id
         context["default_page_id"] = self.id

document_page_approval/models/document_page_history.py

@@ -22,7 +22,6 @@ class DocumentPageHistory(models.Model):
         ],
         "Status",
         default="draft",
-        readonly=True,
     )
 
     approved_date = fields.Datetime()
@@ -79,7 +78,7 @@ def action_to_approve(self):
                     [("groups_id", "in", guids), ("groups_id", "in", approver_gid.id)]
                 )
                 rec.message_subscribe(partner_ids=users.mapped("partner_id").ids)
-                rec.message_post_with_template(template.id)
+                rec.message_post_with_source(template)
             else:
                 # auto-approve if approval is not required
                 rec.action_approve()

document_page_approval/pyproject.toml

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

document_page_approval/readme/CONFIGURE.md

@@ -0,0 +1,6 @@
+To configure this module, you need to:
+
+1.  Set a valid email address on the company settings.
+2.  Go to Knowledge \> Categories.
+3.  Create a new page category and set an approver group. Make sure
+    users belonging to that group have valid email addresses.

document_page_approval/readme/CONTRIBUTORS.md

@@ -0,0 +1,18 @@
+- Odoo SA \<<[email protected]>\>
+
+- Savoir-faire Linux \<<[email protected]>\>
+
+- Gervais Naoussi \<<[email protected]>\>
+
+- Maxime Chambreuil \<<[email protected]>\>
+
+- Iván Todorovich \<<[email protected]>\>
+
+- [Tecnativa](https://www.tecnativa.com):
+
+  > - Victor M.M. Torres
+  > - Víctor Martínez
+
+- [Guadaltech](https://www.guadaltech.es):
+
+  - Fernando La Chica \<<[email protected]>\>

document_page_approval/readme/DESCRIPTION.md

@@ -0,0 +1,2 @@
+This module adds a workflow to approve page modifications and show the
+approved version by default.

document_page_approval/readme/USAGE.md

@@ -0,0 +1,8 @@
+To use this module, you need to:
+
+1.  Go to Knowledge \> Pages
+2.  Create a new page and choose the previously created category.
+3.  A notification is sent to the approvers group with a link to the
+    page history to review.
+4.  Depending on the review, the page history is approved or not.
+5.  Users reading the page see the last approved version.

document_page_approval/static/description/index.html

@@ -8,10 +8,11 @@
 
 /*
 :Author: David Goodger ([email protected])
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -274,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* 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 }
@@ -300,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -368,9 +369,9 @@ <h1 class="title">Document Page Approval</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! source digest: sha256:eaa85b29d79372636ce9dda9fbf87f567e6702f38a57385384a168b28a517ff5
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<p><a class="reference external image-reference" 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 image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/knowledge/tree/16.0/document_page_approval"><img alt="OCA/knowledge" src="https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/knowledge-16-0/knowledge-16-0-document_page_approval"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/knowledge&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>This module adds a workflow to approve page modifications
-and show the approved version by default.</p>
+<p><a class="reference external image-reference" 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 image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/knowledge/tree/17.0/document_page_approval"><img alt="OCA/knowledge" src="https://img.shields.io/badge/github-OCA%2Fknowledge-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/knowledge-17-0/knowledge-17-0-document_page_approval"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/knowledge&amp;target_branch=17.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
+<p>This module adds a workflow to approve page modifications and show the
+approved version by default.</p>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
@@ -391,8 +392,8 @@ <h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <ol class="arabic simple">
 <li>Set a valid email address on the company settings.</li>
 <li>Go to Knowledge &gt; Categories.</li>
-<li>Create a new page category and set an approver group.
-Make sure users belonging to that group have valid email addresses.</li>
+<li>Create a new page category and set an approver group. Make sure users
+belonging to that group have valid email addresses.</li>
 </ol>
 </div>
 <div class="section" id="usage">
@@ -401,8 +402,8 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 <ol class="arabic simple">
 <li>Go to Knowledge &gt; Pages</li>
 <li>Create a new page and choose the previously created category.</li>
-<li>A notification is sent to the approvers group with a link to the
-page history to review.</li>
+<li>A notification is sent to the approvers group with a link to the page
+history to review.</li>
 <li>Depending on the review, the page history is approved or not.</li>
 <li>Users reading the page see the last approved version.</li>
 </ol>
@@ -412,7 +413,7 @@ <h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/knowledge/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 to smash it by providing a detailed and welcomed
-<a class="reference external" href="https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_approval%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<a class="reference external" href="https://github.com/OCA/knowledge/issues/new?body=module:%20document_page_approval%0Aversion:%2017.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">
@@ -454,11 +455,13 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <div class="section" id="maintainers">
 <h2><a class="toc-backref" href="#toc-entry-7">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>
+<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/knowledge/tree/16.0/document_page_approval">OCA/knowledge</a> project on GitHub.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/knowledge/tree/17.0/document_page_approval">OCA/knowledge</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>