NeoAnd/knowledge
1
0
Fork 0
mirror of https://github.com/OCA/knowledge.git synced 2025-07-13 15:34:49 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

[IMP] document_page_approval: black, isort

Browse Source
This commit is contained in:
flachica 2020-07-04 19:11:38 +02:00 committed by Bhavesh Heliconia
parent e1727575df
commit 8d8c8ac32a
9 changed files with 416 additions and 332 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
document_page_approval/__manifest__.py
View File

@ -2,28 +2,25 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{
'name': 'Document Page Approval',
'version': '12.0.1.0.0',
"name": "Document Page Approval",
"version": "12.0.1.0.0",
"author": "Savoir-faire Linux, Odoo Community Association (OCA)",
"website": "http://www.savoirfairelinux.com",
"license": "AGPL-3",
'category': 'Knowledge Management',
'depends': [
'document_page',
'mail',
"category": "Knowledge Management",
"depends": ["document_page", "mail",],
"data": [
"data/email_template.xml",
"views/document_page_approval.xml",
"security/document_page_security.xml",
"security/ir.model.access.csv",
],
'data': [
'data/email_template.xml',
'views/document_page_approval.xml',
'security/document_page_security.xml',
'security/ir.model.access.csv',
"images": [
"images/category.png",
"images/page_history_list.png",
"images/page_history.png",
],
'images': [
'images/category.png',
'images/page_history_list.png',
'images/page_history.png',
],
'post_init_hook': 'post_init_hook',
'uninstall_hook': 'uninstall_hook',
'installable': True,
"post_init_hook": "post_init_hook",
"uninstall_hook": "uninstall_hook",
"installable": True,
}

16
document_page_approval/data/email_template.xml
View File

@ -1,13 +1,16 @@
<?xml version="1.0"?>
<?xml version="1.0" ?>
<odoo>
<!-- If user wants to make upgrade-proof customizations to email templates, he should edit ir.model.data and check noupdate himself -->
<record id="email_template_new_draft_need_approval" model="mail.template">
<field name="name">Automated new draft need approval Notification Mail</field>
<field name="email_from">${object.create_uid.company_id.email or 'noreply@localhost.com'}</field>
<field name="subject">New version of ${object.display_name} needs your approval</field>
<field name="model_id" ref="model_document_page_history"/>
<field name="auto_delete" eval="True"/>
<field
name="email_from"
>${object.create_uid.company_id.email or 'noreply@localhost.com'}</field>
<field
name="subject"
>New version of ${object.display_name} needs your approval</field>
<field name="model_id" ref="model_document_page_history" />
<field name="auto_delete" eval="True" />
<field name="lang">${object.create_uid.partner_id.lang}</field>
<field name="body_html">
<![CDATA[
@ -39,5 +42,4 @@ ${object.diff|safe}
]]>
</field>
</record>
</odoo>

16
document_page_approval/hooks.py
View File

@ -1,25 +1,25 @@
# Copyright 2018 Ivan Todorovich (<ivan.todorovich@gmail.com>)
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
import logging
_logger = logging.getLogger(__name__)
def post_init_hook(cr, registry): # pragma: no cover
# Set all pre-existing pages history to approved
_logger.info('Setting history to approved.')
cr.execute("""
_logger.info("Setting history to approved.")
cr.execute(
"""
UPDATE document_page_history
SET state='approved',
approved_uid=create_uid,
approved_date=create_date
WHERE state IS NULL OR state = 'draft'
""")
"""
)
def uninstall_hook(cr, registry): # pragma: no cover
# Remove unapproved pages
_logger.info('Deleting unapproved Change Requests.')
cr.execute(
"DELETE FROM document_page_history "
"WHERE state != 'approved'"
)
_logger.info("Deleting unapproved Change Requests.")
cr.execute("DELETE FROM document_page_history " "WHERE state != 'approved'")

9
document_page_approval/i18n/document_page_approval.pot
View File

@ -262,21 +262,24 @@ msgstr ""
#. module: document_page_approval
#: code:addons/document_page_approval/models/document_page_history.py:102
#, python-format
msgid "You are not authorized to do this. \n"
msgid "You are not authorized to do this.
\n"
"Only approvers with these groups can approve this: "
msgstr ""
#. module: document_page_approval
#: code:addons/document_page_approval/models/document_page_history.py:62
#, python-format
msgid "You are not authorized to do this. \n"
msgid "You are not authorized to do this.
\n"
"Only owners or approvers can reopen Change Requests."
msgstr ""
#. module: document_page_approval
#: code:addons/document_page_approval/models/document_page_history.py:79
#, python-format
msgid "You are not authorized to do this. \n"
msgid "You are not authorized to do this.
\n"
"Only owners or approvers can request approval."
msgstr ""

90
document_page_approval/models/document_page.py
View File

@ -2,77 +2,74 @@
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo import api, fields, models
from ast import literal_eval
from odoo import api, fields, models
class DocumentPage(models.Model):
"""Useful to know the state of a document."""
_inherit = 'document.page'
_inherit = "document.page"
history_ids = fields.One2many(
order='approved_date DESC',
domain=[('state', '=', 'approved')],
order="approved_date DESC", domain=[("state", "=", "approved")],
)
approved_date = fields.Datetime(
'Approved Date',
related='history_head.approved_date',
"Approved Date",
related="history_head.approved_date",
store=True,
index=True,
readonly=True,
)
approved_uid = fields.Many2one(
'res.users',
'Approved by',
related='history_head.approved_uid',
"res.users",
"Approved by",
related="history_head.approved_uid",
store=True,
index=True,
readonly=True,
)
approval_required = fields.Boolean(
'Require approval',
help='Require approval for changes on this page or its child pages.',
"Require approval",
help="Require approval for changes on this page or its child pages.",
)
approver_gid = fields.Many2one(
"res.groups",
"Approver group",
help='Users must also belong to the Approvers group',
help="Users must also belong to the Approvers group",
)
is_approval_required = fields.Boolean(
'Approval required',
help='If true, changes of this page require approval',
compute='_compute_is_approval_required',
"Approval required",
help="If true, changes of this page require approval",
compute="_compute_is_approval_required",
)
am_i_approver = fields.Boolean(
compute='_compute_am_i_approver'
)
am_i_approver = fields.Boolean(compute="_compute_am_i_approver")
approver_group_ids = fields.Many2many(
'res.groups',
string='Approver groups',
help='Groups that can approve changes to this document',
compute='_compute_approver_group_ids',
"res.groups",
string="Approver groups",
help="Groups that can approve changes to this document",
compute="_compute_approver_group_ids",
)
has_changes_pending_approval = fields.Boolean(
compute='_compute_has_changes_pending_approval',
string='Has changes pending approval'
compute="_compute_has_changes_pending_approval",
string="Has changes pending approval",
)
user_has_drafts = fields.Boolean(
compute='_compute_user_has_drafts',
string='User has drafts?',
compute="_compute_user_has_drafts", string="User has drafts?",
)
@api.multi
@api.depends('approval_required', 'parent_id.is_approval_required')
@api.depends("approval_required", "parent_id.is_approval_required")
def _compute_is_approval_required(self):
"""Check if the document required approval based on his parents."""
for page in self:
@ -82,7 +79,7 @@ class DocumentPage(models.Model):
page.is_approval_required = res
@api.multi
@api.depends('approver_gid', 'parent_id.approver_group_ids')
@api.depends("approver_gid", "parent_id.approver_group_ids")
def _compute_approver_group_ids(self):
"""Compute the approver groups based on his parents."""
for page in self:
@ -92,7 +89,7 @@ class DocumentPage(models.Model):
page.approver_group_ids = res
@api.multi
@api.depends('is_approval_required', 'approver_group_ids')
@api.depends("is_approval_required", "approver_group_ids")
def _compute_am_i_approver(self):
"""Check if the current user can approve changes to this page."""
for rec in self:
@ -106,11 +103,10 @@ class DocumentPage(models.Model):
if not self.is_approval_required:
return True
# if user belongs to 'Knowledge / Manager', he can approve anything
if user.has_group('document_page.group_document_manager'):
if user.has_group("document_page.group_document_manager"):
return True
# to approve, user must have approver rights
if not user.has_group(
'document_page_approval.group_document_approver_user'):
if not user.has_group("document_page_approval.group_document_approver_user"):
return False
# if there aren't any approver_groups_defined, user can approve
if not self.approver_group_ids:
@ -120,21 +116,21 @@ class DocumentPage(models.Model):
@api.multi
def _compute_has_changes_pending_approval(self):
history = self.env['document.page.history']
history = self.env["document.page.history"]
for rec in self:
changes = history.search_count([
('page_id', '=', rec.id),
('state', '=', 'to approve')])
rec.has_changes_pending_approval = (changes > 0)
changes = history.search_count(
[("page_id", "=", rec.id), ("state", "=", "to approve")]
)
rec.has_changes_pending_approval = changes > 0
@api.multi
def _compute_user_has_drafts(self):
history = self.env['document.page.history']
history = self.env["document.page.history"]
for rec in self:
changes = history.search_count([
('page_id', '=', rec.id),
('state', '=', 'draft')])
rec.user_has_drafts = (changes > 0)
changes = history.search_count(
[("page_id", "=", rec.id), ("state", "=", "draft")]
)
rec.user_has_drafts = changes > 0
@api.multi
def _create_history(self, vals):
@ -144,10 +140,10 @@ class DocumentPage(models.Model):
@api.multi
def action_changes_pending_approval(self):
self.ensure_one()
action = self.env.ref('document_page_approval.action_change_requests')
action = self.env.ref("document_page_approval.action_change_requests")
action = action.read()[0]
context = literal_eval(action['context'])
context['search_default_page_id'] = self.id
context['default_page_id'] = self.id
action['context'] = context
context = literal_eval(action["context"])
context["search_default_page_id"] = self.id
context["default_page_id"] = self.id
action["context"] = context
return action

169
document_page_approval/models/document_page_history.py
View File

@ -1,90 +1,84 @@
# Copyright (C) 2013 Savoir-faire Linux (<http://www.savoirfairelinux.com>).
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo.tools.translate import _
from odoo import api, fields, models
from odoo.exceptions import UserError
from odoo.tools.translate import _
class DocumentPageHistory(models.Model):
"""Useful to manage edition's workflow on a document."""
_name = 'document.page.history'
_inherit = ['document.page.history', 'mail.thread']
_name = "document.page.history"
_inherit = ["document.page.history", "mail.thread"]
state = fields.Selection([
('draft', 'Draft'),
('to approve', 'Pending Approval'),
('approved', 'Approved'),
('cancelled', 'Cancelled')],
'Status',
default='draft',
state = fields.Selection(
[
("draft", "Draft"),
("to approve", "Pending Approval"),
("approved", "Approved"),
("cancelled", "Cancelled"),
],
"Status",
default="draft",
readonly=True,
)
approved_date = fields.Datetime(
'Approved Date',
)
approved_date = fields.Datetime("Approved Date",)
approved_uid = fields.Many2one(
'res.users',
'Approved by',
)
approved_uid = fields.Many2one("res.users", "Approved by",)
is_approval_required = fields.Boolean(
related='page_id.is_approval_required',
string="Approval required",
related="page_id.is_approval_required", string="Approval required",
)
am_i_owner = fields.Boolean(
compute='_compute_am_i_owner'
)
am_i_owner = fields.Boolean(compute="_compute_am_i_owner")
am_i_approver = fields.Boolean(
related='page_id.am_i_approver',
related_sudo=False,
)
am_i_approver = fields.Boolean(related="page_id.am_i_approver", related_sudo=False,)
page_url = fields.Text(
compute='_compute_page_url',
string="URL",
)
page_url = fields.Text(compute="_compute_page_url", string="URL",)
@api.multi
def action_draft(self):
"""Set a change request as draft"""
for rec in self:
if not rec.state == 'cancelled':
raise UserError(
_('You need to cancel it before reopening.'))
if not rec.state == "cancelled":
raise UserError(_("You need to cancel it before reopening."))
if not (rec.am_i_owner or rec.am_i_approver):
raise UserError(
_('You are not authorized to do this.\r\n'
'Only owners or approvers can reopen Change Requests.'))
rec.write({'state': 'draft'})
_(
"You are not authorized to do this.\r\n"
"Only owners or approvers can reopen Change Requests."
)
)
rec.write({"state": "draft"})
@api.multi
def action_to_approve(self):
"""Set a change request as to approve"""
template = self.env.ref(
'document_page_approval.email_template_new_draft_need_approval')
"document_page_approval.email_template_new_draft_need_approval"
)
approver_gid = self.env.ref(
'document_page_approval.group_document_approver_user')
"document_page_approval.group_document_approver_user"
)
for rec in self:
if rec.state != 'draft':
raise UserError(
_("Can't approve pages in '%s' state.") % rec.state)
if rec.state != "draft":
raise UserError(_("Can't approve pages in '%s' state.") % rec.state)
if not (rec.am_i_owner or rec.am_i_approver):
raise UserError(
_('You are not authorized to do this.\r\n'
'Only owners or approvers can request approval.'))
_(
"You are not authorized to do this.\r\n"
"Only owners or approvers can request approval."
)
)
# request approval
if rec.is_approval_required:
rec.write({'state': 'to approve'})
rec.write({"state": "to approve"})
guids = [g.id for g in rec.page_id.approver_group_ids]
users = self.env['res.users'].search([
('groups_id', 'in', guids),
('groups_id', 'in', approver_gid.id)])
users = self.env["res.users"].search(
[("groups_id", "in", guids), ("groups_id", "in", approver_gid.id)]
)
rec.message_subscribe([u.id for u in users])
rec.message_post_with_template(template.id)
else:
@ -95,49 +89,49 @@ class DocumentPageHistory(models.Model):
def action_approve(self):
"""Set a change request as approved."""
for rec in self:
if rec.state not in ['draft', 'to approve']:
raise UserError(
_("Can't approve page in '%s' state.") % rec.state)
if rec.state not in ["draft", "to approve"]:
raise UserError(_("Can't approve page in '%s' state.") % rec.state)
if not rec.am_i_approver:
raise UserError(_(
'You are not authorized to do this.\r\n'
'Only approvers with these groups can approve this: '
) % ', '.join(
[g.display_name
for g in rec.page_id.approver_group_ids]))
raise UserError(
_(
"You are not authorized to do this.\r\n"
"Only approvers with these groups can approve this: "
)
% ", ".join(
[g.display_name for g in rec.page_id.approver_group_ids]
)
)
# Update state
rec.write({
'state': 'approved',
'approved_date': fields.datetime.now(),
'approved_uid': self.env.uid,
})
rec.write(
{
"state": "approved",
"approved_date": fields.datetime.now(),
"approved_uid": self.env.uid,
}
)
# Trigger computed field update
rec.page_id._compute_history_head()
# Notify state change
rec.message_post(
subtype='mt_comment',
body=_(
'Change request has been approved by %s.'
) % (self.env.user.name)
subtype="mt_comment",
body=_("Change request has been approved by %s.")
% (self.env.user.name),
)
# Notify followers a new version is available
rec.page_id.message_post(
subtype='mt_comment',
body=_(
'New version of the document %s approved.'
) % (rec.page_id.name)
subtype="mt_comment",
body=_("New version of the document %s approved.") % (rec.page_id.name),
)
@api.multi
def action_cancel(self):
"""Set a change request as cancelled."""
self.write({'state': 'cancelled'})
self.write({"state": "cancelled"})
for rec in self:
rec.message_post(
subtype='mt_comment',
body=_(
'Change request <b>%s</b> has been cancelled by %s.'
) % (rec.display_name, self.env.user.name)
subtype="mt_comment",
body=_("Change request <b>%s</b> has been cancelled by %s.")
% (rec.display_name, self.env.user.name),
)
@api.multi
@ -150,36 +144,31 @@ class DocumentPageHistory(models.Model):
def _compute_am_i_owner(self):
"""Check if current user is the owner"""
for rec in self:
rec.am_i_owner = (rec.create_uid == self.env.user)
rec.am_i_owner = rec.create_uid == self.env.user
@api.multi
def _compute_page_url(self):
"""Compute the page url."""
for page in self:
base_url = self.env['ir.config_parameter'].sudo().get_param(
'web.base.url',
default='http://localhost:8069'
base_url = (
self.env["ir.config_parameter"]
.sudo()
.get_param("web.base.url", default="http://localhost:8069")
)
page.page_url = (
'{}/web#db={}&id={}&view_type=form&'
'model=document.page.history').format(
base_url,
self.env.cr.dbname,
page.id
)
"{}/web#db={}&id={}&view_type=form&" "model=document.page.history"
).format(base_url, self.env.cr.dbname, page.id)
@api.multi
def _compute_diff(self):
"""Shows a diff between this version and the previous version"""
history = self.env['document.page.history']
history = self.env["document.page.history"]
for rec in self:
domain = [
('page_id', '=', rec.page_id.id),
('state', '=', 'approved')]
domain = [("page_id", "=", rec.page_id.id), ("state", "=", "approved")]
if rec.approved_date:
domain.append(('approved_date', '<', rec.approved_date))
prev = history.search(domain, limit=1, order='approved_date DESC')
domain.append(("approved_date", "<", rec.approved_date))
prev = history.search(domain, limit=1, order="approved_date DESC")
if prev:
rec.diff = self._get_diff(prev.id, rec.id)
else:

44
document_page_approval/security/document_page_security.xml
View File

@ -1,36 +1,36 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml version="1.0" encoding="utf-8" ?>
<odoo>
<record id="group_document_approver_user" model="res.groups">
<field name="name">Approver</field>
<field name="category_id" ref="knowledge.module_category_knowledge"/>
<field name="implied_ids" eval="[(4, ref('document_page.group_document_editor'))]"/>
<field name="category_id" ref="knowledge.module_category_knowledge" />
<field
name="implied_ids"
eval="[(4, ref('document_page.group_document_editor'))]"
/>
</record>
<record id="document_page.group_document_manager" model="res.groups">
<field name="implied_ids" eval="[(4, ref('group_document_approver_user'))]"/>
<field name="implied_ids" eval="[(4, ref('group_document_approver_user'))]" />
</record>
<record model="ir.rule" id="rule_change_request_global">
<field name="name">Change Request Global</field>
<field name="model_id" ref="model_document_page_history"/>
<field name="groups" eval="[(6, 0, [ref('knowledge.group_document_user')])]"/>
<field name="domain_force">['|',('state','=','approved'),('create_uid','=',user.id)]</field>
<field name="perm_read" eval="True"/>
<field name="perm_write" eval="True"/>
<field name="perm_unlink" eval="True"/>
<field name="perm_create" eval="True"/>
<field name="model_id" ref="model_document_page_history" />
<field name="groups" eval="[(6, 0, [ref('knowledge.group_document_user')])]" />
<field
name="domain_force"
>['|',('state','=','approved'),('create_uid','=',user.id)]</field>
<field name="perm_read" eval="True" />
<field name="perm_write" eval="True" />
<field name="perm_unlink" eval="True" />
<field name="perm_create" eval="True" />
</record>
<record model="ir.rule" id="rule_change_request_approver">
<field name="name">Change Request Approver</field>
<field name="model_id" ref="model_document_page_history"/>
<field name="groups" eval="[(6, 0, [ref('group_document_approver_user')])]"/>
<field name="model_id" ref="model_document_page_history" />
<field name="groups" eval="[(6, 0, [ref('group_document_approver_user')])]" />
<field name="domain_force">[('state','!=','draft')]</field>
<field name="perm_read" eval="True"/>
<field name="perm_write" eval="True"/>
<field name="perm_unlink" eval="True"/>
<field name="perm_create" eval="True"/>
<field name="perm_read" eval="True" />
<field name="perm_write" eval="True" />
<field name="perm_unlink" eval="True" />
<field name="perm_create" eval="True" />
</record>
</odoo>

103
document_page_approval/tests/test_document_page_approval.py
View File

@ -2,31 +2,35 @@ from odoo.tests import common
class TestDocumentPageApproval(common.TransactionCase):
def setUp(self):
super(TestDocumentPageApproval, self).setUp()
self.page_obj = self.env['document.page']
self.history_obj = self.env['document.page.history']
self.page_obj = self.env["document.page"]
self.history_obj = self.env["document.page.history"]
# demo
self.category1 = self.env.ref('document_page.demo_category1')
self.page1 = self.env.ref('document_page.demo_page1')
self.category1 = self.env.ref("document_page.demo_category1")
self.page1 = self.env.ref("document_page.demo_page1")
self.approver_gid = self.env.ref(
'document_page_approval.group_document_approver_user')
self.env.ref('base.user_root').write({
'groups_id': [(4, self.approver_gid.id)],
})
"document_page_approval.group_document_approver_user"
)
self.env.ref("base.user_root").write(
{"groups_id": [(4, self.approver_gid.id)],}
)
# demo_approval
self.category2 = self.page_obj.create({
'name': 'This category requires approval',
'type': 'category',
'approval_required': True,
'approver_gid': self.approver_gid.id,
})
self.page2 = self.page_obj.create({
'name': 'This page requires approval',
'parent_id': self.category2.id,
'content': 'This content will require approval',
})
self.category2 = self.page_obj.create(
{
"name": "This category requires approval",
"type": "category",
"approval_required": True,
"approver_gid": self.approver_gid.id,
}
)
self.page2 = self.page_obj.create(
{
"name": "This page requires approval",
"parent_id": self.category2.id,
"content": "This content will require approval",
}
)
def test_approval_required(self):
page = self.page2
@ -36,13 +40,12 @@ class TestDocumentPageApproval(common.TransactionCase):
def test_change_request_approve(self):
page = self.page2
chreq = self.history_obj.search([
('page_id', '=', page.id),
('state', '!=', 'approved')
])[0]
chreq = self.history_obj.search(
[("page_id", "=", page.id), ("state", "!=", "approved")]
)[0]
# It should automatically be in 'to approve' state
self.assertEqual(chreq.state, 'to approve')
self.assertEqual(chreq.state, "to approve")
self.assertNotEqual(chreq.content, page.content)
# who_am_i
@ -51,66 +54,66 @@ class TestDocumentPageApproval(common.TransactionCase):
# approve
chreq.action_approve()
self.assertEqual(chreq.state, 'approved')
self.assertEqual(chreq.state, "approved")
self.assertEqual(chreq.content, page.content)
# new changes should create change requests
page.write({'content': 'New content'})
self.assertNotEqual(page.content, 'New content')
chreq = self.history_obj.search([
('page_id', '=', page.id),
('state', '!=', 'approved')
])[0]
page.write({"content": "New content"})
self.assertNotEqual(page.content, "New content")
chreq = self.history_obj.search(
[("page_id", "=", page.id), ("state", "!=", "approved")]
)[0]
chreq.action_approve()
self.assertEqual(page.content, 'New content')
self.assertEqual(page.content, "New content")
def test_change_request_auto_approve(self):
page = self.page1
self.assertFalse(page.is_approval_required)
page.write({'content': 'New content'})
self.assertEqual(page.content, 'New content')
page.write({"content": "New content"})
self.assertEqual(page.content, "New content")
def test_change_request_from_scratch(self):
page = self.page2
# aprove everything
self.history_obj.search([
('page_id', '=', page.id),
('state', '!=', 'approved')
]).action_approve()
self.history_obj.search(
[("page_id", "=", page.id), ("state", "!=", "approved")]
).action_approve()
# new change request from scrath
chreq = self.history_obj.create({
'page_id': page.id,
'summary': 'Changed something',
'content': 'New content',
})
chreq = self.history_obj.create(
{
"page_id": page.id,
"summary": "Changed something",
"content": "New content",
}
)
self.assertEqual(chreq.state, 'draft')
self.assertEqual(chreq.state, "draft")
self.assertNotEqual(page.content, chreq.content)
self.assertNotEqual(page.approved_date, chreq.approved_date)
self.assertNotEqual(page.approved_uid, chreq.approved_uid)
chreq.action_to_approve()
self.assertEqual(chreq.state, 'to approve')
self.assertEqual(chreq.state, "to approve")
self.assertNotEqual(page.content, chreq.content)
self.assertNotEqual(page.approved_date, chreq.approved_date)
self.assertNotEqual(page.approved_uid, chreq.approved_uid)
chreq.action_cancel()
self.assertEqual(chreq.state, 'cancelled')
self.assertEqual(chreq.state, "cancelled")
self.assertNotEqual(page.content, chreq.content)
self.assertNotEqual(page.approved_date, chreq.approved_date)
self.assertNotEqual(page.approved_uid, chreq.approved_uid)
chreq.action_draft()
self.assertEqual(chreq.state, 'draft')
self.assertEqual(chreq.state, "draft")
self.assertNotEqual(page.content, chreq.content)
self.assertNotEqual(page.approved_date, chreq.approved_date)
self.assertNotEqual(page.approved_uid, chreq.approved_uid)
chreq.action_approve()
self.assertEqual(chreq.state, 'approved')
self.assertEqual(chreq.state, "approved")
self.assertEqual(page.content, chreq.content)
self.assertEqual(page.approved_date, chreq.approved_date)
self.assertEqual(page.approved_uid, chreq.approved_uid)
@ -122,6 +125,6 @@ class TestDocumentPageApproval(common.TransactionCase):
def test_get_page_url(self):
"""Test if page url exist."""
pages = self.env['document.page.history'].search([])
pages = self.env["document.page.history"].search([])
page = pages[0]
self.assertIsNotNone(page.page_url)

266
document_page_approval/views/document_page_approval.xml
View File

@ -1,124 +1,196 @@
<?xml version="1.0"?>
<?xml version="1.0" ?>
<odoo>
<!-- History Form View -->
<record id="wiki_history_form_inherit" model="ir.ui.view">
<field name="name">document.page.history.form</field>
<field name="model">document.page.history</field>
<field name="inherit_id" ref="document_page.wiki_history_form"/>
<field name="inherit_id" ref="document_page.wiki_history_form" />
<field name="arch" type="xml">
<sheet position="before">
<header>
<!-- draft -> to approve -->
<button name="action_to_approve" type="object" string="Send to Review" class="oe_highlight"
attrs="{'invisible':['|','|',('is_approval_required','=',False),('am_i_owner','=',False),('state', 'not in', ['draft'])]}"/>
<button
name="action_to_approve"
type="object"
string="Send to Review"
class="oe_highlight"
attrs="{'invisible':['|','|',('is_approval_required','=',False),('am_i_owner','=',False),('state', 'not in', ['draft'])]}"
/>
<!-- approve if i am approver -->
<button name="action_approve" type="object" string="Approve" class="oe_highlight"
attrs="{'invisible':['|','|',('is_approval_required','=',False),('am_i_approver','=',False),('state','not in',['draft','to approve'])]}"/>
<button
name="action_approve"
type="object"
string="Approve"
class="oe_highlight"
attrs="{'invisible':['|','|',('is_approval_required','=',False),('am_i_approver','=',False),('state','not in',['draft','to approve'])]}"
/>
<!-- approve if it's not required and i am owner -->
<button name="action_approve" type="object" string="Approve" class="oe_highlight"
attrs="{'invisible':['|','|',('is_approval_required','=',True),('am_i_owner','=',False),('state','not in',['draft', 'to approve'])]}"/>
<button
name="action_approve"
type="object"
string="Approve"
class="oe_highlight"
attrs="{'invisible':['|','|',('is_approval_required','=',True),('am_i_owner','=',False),('state','not in',['draft', 'to approve'])]}"
/>
<!-- cancel if i am owner or approver -->
<button name="action_cancel" type="object" string="Cancel"
attrs="{'invisible':['|','&amp;',('am_i_owner','=',False),('am_i_approver','=',False),('state','not in',['draft','to approve'])]}"/>
<button
name="action_cancel"
type="object"
string="Cancel"
attrs="{'invisible':['|','&amp;',('am_i_owner','=',False),('am_i_approver','=',False),('state','not in',['draft','to approve'])]}"
/>
<!-- reopen if i am owner or approver -->
<button name="action_draft" type="object" string="Back to draft"
attrs="{'invisible':['|','&amp;',('am_i_owner','=',False),('am_i_approver','=',False),('state','not in',['cancelled'])]}"/>
<button
name="action_draft"
type="object"
string="Back to draft"
attrs="{'invisible':['|','&amp;',('am_i_owner','=',False),('am_i_approver','=',False),('state','not in',['cancelled'])]}"
/>
<!-- cancel & reopen, if i am owner or approver -->
<button name="action_draft" type="object" string="Back to draft"
attrs="{'invisible':['|','&amp;',('am_i_owner','=',False),('am_i_approver','=',False),('state','not in',['to approve'])]}"/>
<field name="am_i_owner" invisible="1"/>
<field name="am_i_approver" invisible="1"/>
<field name="is_approval_required" invisible="1"/>
<field name="state" widget="statusbar" statusbar_visible="draft,approved" />
<button
name="action_draft"
type="object"
string="Back to draft"
attrs="{'invisible':['|','&amp;',('am_i_owner','=',False),('am_i_approver','=',False),('state','not in',['to approve'])]}"
/>
<field name="am_i_owner" invisible="1" />
<field name="am_i_approver" invisible="1" />
<field name="is_approval_required" invisible="1" />
<field
name="state"
widget="statusbar"
statusbar_visible="draft,approved"
/>
</header>
</sheet>
<xpath expr="//field[@name='create_uid']/parent::group" position="after">
<group>
<field name="approved_uid" readonly="1" attrs="{'invisible':[('state','not in',['approved'])]}"/>
<field name="approved_date" readonly="1" attrs="{'invisible':[('state','not in',['approved'])]}"/>
<field
name="approved_uid"
readonly="1"
attrs="{'invisible':[('state','not in',['approved'])]}"
/>
<field
name="approved_date"
readonly="1"
attrs="{'invisible':[('state','not in',['approved'])]}"
/>
</group>
</xpath>
<!-- Readonly fields -->
<field name="content" position="attributes"><attribute name="attrs">{'readonly': [('state', 'not in', ['draft'])]}</attribute></field>
<field name="page_id" position="attributes"><attribute name="attrs">{'readonly': [('state', 'not in', ['draft'])]}</attribute></field>
<field name="name" position="attributes"><attribute name="attrs">{'readonly': [('state', 'not in', ['draft'])]}</attribute></field>
<field name="summary" position="attributes"><attribute name="attrs">{'readonly': [('state', 'not in', ['draft'])]}</attribute></field>
<field name="content" position="attributes">
<attribute
name="attrs"
>{'readonly': [('state', 'not in', ['draft'])]}</attribute>
</field>
<field name="page_id" position="attributes">
<attribute
name="attrs"
>{'readonly': [('state', 'not in', ['draft'])]}</attribute>
</field>
<field name="name" position="attributes">
<attribute
name="attrs"
>{'readonly': [('state', 'not in', ['draft'])]}</attribute>
</field>
<field name="summary" position="attributes">
<attribute
name="attrs"
>{'readonly': [('state', 'not in', ['draft'])]}</attribute>
</field>
<!-- Chatter -->
<sheet position="after">
<div class="oe_chatter">
<field name="message_follower_ids" widget="mail_followers"/>
<field name="message_ids" widget="mail_thread"/>
<field name="message_follower_ids" widget="mail_followers" />
<field name="message_ids" widget="mail_thread" />
</div>
</sheet>
</field>
</record>
<!-- History Form View Manager Rights -->
<record id="wiki_history_form_inherit_manager" model="ir.ui.view">
<field name="name">document.page.history.form</field>
<field name="model">document.page.history</field>
<field name="inherit_id" ref="wiki_history_form_inherit"/>
<field name="groups_id" eval="[(6, 0, [ref('document_page.group_document_manager')])]"/>
<field name="inherit_id" ref="wiki_history_form_inherit" />
<field
name="groups_id"
eval="[(6, 0, [ref('document_page.group_document_manager')])]"
/>
<field name="arch" type="xml">
<!-- Readonly fields -->
<field name="name" position="attributes"><attribute name="attrs">{'readonly': False}</attribute></field>
<field name="summary" position="attributes"><attribute name="attrs">{'readonly': False}</attribute></field>
<field name="name" position="attributes">
<attribute name="attrs">{'readonly': False}</attribute>
</field>
<field name="summary" position="attributes">
<attribute name="attrs">{'readonly': False}</attribute>
</field>
</field>
</record>
<!-- Page Form View -->
<record id="wiki_form_inherit" model="ir.ui.view">
<field name="name">document.page.form</field>
<field name="model">document.page</field>
<field name="inherit_id" ref="document_page.view_wiki_form" />
<field name="arch" type="xml">
<sheet position="before">
<div class="alert alert-info" role="alert" style="margin-bottom:0px;"
attrs="{'invisible': [('has_changes_pending_approval','=',False)]}">
This document has <b>Changes Pending Approval</b>. You are viewing the last approved content.
<div
class="alert alert-info"
role="alert"
style="margin-bottom:0px;"
attrs="{'invisible': [('has_changes_pending_approval','=',False)]}"
>
This document has <b
>Changes Pending Approval</b>. You are viewing the last approved content.
</div>
<div class="alert alert-warning oe_edit_only" role="alert" style="margin-bottom:0px;"
attrs="{'invisible': [('is_approval_required','=',False)]}">
This document requires approval. If edited, you will create a new <b>Change Request</b>.
<div
class="alert alert-warning oe_edit_only"
role="alert"
style="margin-bottom:0px;"
attrs="{'invisible': [('is_approval_required','=',False)]}"
>
This document requires approval. If edited, you will create a new <b
>Change Request</b>.
</div>
<div class="alert alert-warning oe_edit_only" role="alert" style="margin-bottom:0px;"
attrs="{'invisible': [('user_has_drafts','=',False)]}">
<div
class="alert alert-warning oe_edit_only"
role="alert"
style="margin-bottom:0px;"
attrs="{'invisible': [('user_has_drafts','=',False)]}"
>
<b>You already have a Draft Change Request for this page.</b>
It is highly recommended that you edit that one instead of creating a new one.
</div>
<field name="is_approval_required" invisible="1"/>
<field name="has_changes_pending_approval" invisible="1"/>
<field name="user_has_drafts" invisible="1"/>
<field name="is_approval_required" invisible="1" />
<field name="has_changes_pending_approval" invisible="1" />
<field name="user_has_drafts" invisible="1" />
</sheet>
<button name="toggle_active" position="after">
<button class="oe_stat_button" name="action_changes_pending_approval" string="Change Requests" type="object"
attrs="{'invisible':[('has_changes_pending_approval','=',False),('user_has_drafts','=',False)]}" icon="fa-edit"/>
<button
class="oe_stat_button"
name="action_changes_pending_approval"
string="Change Requests"
type="object"
attrs="{'invisible':[('has_changes_pending_approval','=',False),('user_has_drafts','=',False)]}"
icon="fa-edit"
/>
</button>
<field name="content_uid" position="after">
<field name="approved_uid"/>
<field name="approved_uid" />
</field>
<field name="content_date" position="replace">
<field name="approved_date"/>
<field name="approved_date" />
</field>
<field name="history_ids" position="inside">
<tree>
<field name="id"/>
<field name="approved_date"/>
<field name="summary"/>
<field name="create_uid"/>
<field name="approved_uid"/>
<field name="id" />
<field name="approved_date" />
<field name="summary" />
<field name="create_uid" />
<field name="approved_uid" />
</tree>
</field>
</field>
</record>
<!-- Page Menu Form View -->
<record id="view_wiki_menu_form_inherit" model="ir.ui.view">
<field name="name">document.page.form</field>
@ -126,14 +198,16 @@
<field name="inherit_id" ref="document_page.view_wiki_menu_form" />
<field name="arch" type="xml">
<field name="content" position="before">
<group class="oe_read_only" attrs="{'invisible':[('type','!=','content')]}">
<group
class="oe_read_only"
attrs="{'invisible':[('type','!=','content')]}"
>
<field name="approved_date" />
<field name="approved_uid" />
</group>
</field>
</field>
</record>
<!-- Catgory Form View -->
<record id="view_category_form_inherit" model="ir.ui.view">
<field name="name">document.page.category.form</field>
@ -141,18 +215,19 @@
<field name="inherit_id" ref="document_page.view_category_form" />
<field name="arch" type="xml">
<field name="parent_id" position="after">
<field name="approval_required"/>
<field name="approver_gid"
attrs="{'invisible':[('approval_required','!=', True)], 'required':[('approval_required','=', True)]}"/>
<field name="approval_required" />
<field
name="approver_gid"
attrs="{'invisible':[('approval_required','!=', True)], 'required':[('approval_required','=', True)]}"
/>
</field>
</field>
</record>
<!-- History Tree view -->
<record id="view_wiki_history_tree_inherit" model="ir.ui.view">
<field name="name">document.page.history.tree</field>
<field name="model">document.page.history</field>
<field name="inherit_id" ref="document_page.view_wiki_history_tree"/>
<field name="inherit_id" ref="document_page.view_wiki_history_tree" />
<field name="arch" type="xml">
<tree position="attributes">
<attribute name="decoration-info">state=='draft'</attribute>
@ -160,52 +235,71 @@
<attribute name="decoration-muted">state=='cancelled'</attribute>
</tree>
<tree position="inside">
<field name="state"/>
<field name="approved_uid"/>
<field name="approved_date"/>
<field name="state" />
<field name="approved_uid" />
<field name="approved_date" />
</tree>
</field>
</record>
<!-- History Search view -->
<record id="view_wiki_history_filter" model="ir.ui.view">
<field name="name">document.page.history.search</field>
<field name="model">document.page.history</field>
<field name="inherit_id" ref="document_page.view_wiki_history_filter"/>
<field name="inherit_id" ref="document_page.view_wiki_history_filter" />
<field name="arch" type="xml">
<field name="page_id" position="before">
<field name="state"/>
<field name="state" />
</field>
<field name="create_uid" position="after">
<filter name="draft" string="Draft" domain="[('state','=','draft')]"/>
<filter name="pending" string="Pending Approval" domain="[('state','=','to approve')]"/>
<filter name="approved" string="Approved" domain="[('state','=','approved')]"/>
<filter name="cancelled" string="Cancelled" domain="[('state','=','cancelled')]"/>
<filter name="draft" string="Draft" domain="[('state','=','draft')]" />
<filter
name="pending"
string="Pending Approval"
domain="[('state','=','to approve')]"
/>
<filter
name="approved"
string="Approved"
domain="[('state','=','approved')]"
/>
<filter
name="cancelled"
string="Cancelled"
domain="[('state','=','cancelled')]"
/>
</field>
<filter name="group_by_author" position="before">
<filter name="group_state" string="State" context="{'group_by':'state'}" />
<filter
name="group_state"
string="State"
context="{'group_by':'state'}"
/>
</filter>
<filter name="group_by_author" position="after">
<filter name="group_approver" string="Approver" context="{'group_by':'approved_uid'}" />
<filter
name="group_approver"
string="Approver"
context="{'group_by':'approved_uid'}"
/>
</filter>
</field>
</record>
<!-- Change Requests Action -->
<record model="ir.actions.act_window" id="action_change_requests">
<field name="name">Change Requests</field>
<field name="res_model">document.page.history</field>
<field name="view_type">form</field>
<field name="view_mode">tree,form</field>
<field name="context">{'search_default_draft': 1, 'search_default_pending': 1}</field>
<field
name="context"
>{'search_default_draft': 1, 'search_default_pending': 1}</field>
</record>
<menuitem id="menu_page_change_requests"
<menuitem
id="menu_page_change_requests"
name="Change Requests"
parent="document_page.menu_wiki"
action="action_change_requests"
sequence="25"
groups="document_page.group_document_editor" />
groups="document_page.group_document_editor"
/>
</odoo>