Browse Source

Merge pull request #274 from jarroyomorales/11.0-add_reporting_engine_context

[ADD] reporting-context
pull/265/merge
Pedro M. Baeza 6 years ago
committed by GitHub
parent
commit
4ac5ae16a3
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 89
      report_context/README.rst
  2. 2
      report_context/__init__.py
  3. 21
      report_context/__manifest__.py
  4. 1
      report_context/controllers/__init__.py
  5. 18
      report_context/controllers/main.py
  6. 10
      report_context/data/config_parameter.xml
  7. 1
      report_context/models/__init__.py
  8. 36
      report_context/models/ir_actions_report.py
  9. 1
      report_context/readme/CONTRIBUTORS.rst
  10. 2
      report_context/readme/DESCRIPTION.rst
  11. 18
      report_context/readme/USAGE.rst
  12. BIN
      report_context/static/description/icon.png
  13. 436
      report_context/static/description/index.html
  14. 1
      report_context/tests/__init__.py
  15. 47
      report_context/tests/test_report_context.py
  16. 18
      report_context/views/ir_actions_report.xml

89
report_context/README.rst

@ -0,0 +1,89 @@
==============
Report Context
==============
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! 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%2Freporting--engine-lightgray.png?logo=github
:target: https://github.com/OCA/reporting-engine/tree/11.0/report_context
:alt: OCA/reporting-engine
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-report_context
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
:target: https://runbot.odoo-community.org/runbot/143/11.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
This module adds a context variable to reports. A possible use for this
context could be hiding some fields or many other configuration options.
**Table of contents**
.. contents::
:local:
Usage
=====
To configure this module, you need to:
* Enter Odoo in debug mode.
* To add a specific context to a report, you should go to Settings ->
Reporting -> Reporting and look for the report you want to edit on the
list. You will see that now they contain a new field called Context Value
, where you will be able to add all the desired context parameters.
* Go to Settings -> Parameters -> System Parameters. On the system
parameters list, look for report.default.context, which is a Python
dictionary variable where you can add a context that will be common for
all reports.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_context%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
~~~~~~~
* Creu Blanca
Contributors
~~~~~~~~~~~~
* Jaime Arroyo <jaime.arroyo@creublanca.es>
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/reporting-engine <https://github.com/OCA/reporting-engine/tree/11.0/report_context>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

2
report_context/__init__.py

@ -0,0 +1,2 @@
from . import controllers
from . import models

21
report_context/__manifest__.py

@ -0,0 +1,21 @@
# Copyright 2019 Creu Blanca
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
{
'name': 'Report Context',
'summary': """
Adding context to reports""",
'version': '11.0.1.0.0',
'license': 'AGPL-3',
'author': 'Creu Blanca,Odoo Community Association (OCA)',
'website': 'https://github.com/OCA/reporting-engine',
'depends': [
'web',
],
'data': [
'views/ir_actions_report.xml',
'data/config_parameter.xml',
],
'demo': [
],
}

1
report_context/controllers/__init__.py

@ -0,0 +1 @@
from . import main

18
report_context/controllers/main.py

@ -0,0 +1,18 @@
# Copyright 2019 Creu Blanca
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
from odoo.addons.web.controllers import main as report
from odoo.http import route, request
import json
class ReportController(report.ReportController):
@route()
def report_routes(self, reportname, docids=None, converter=None, **data):
report = request.env['ir.actions.report']._get_report_from_name(
reportname)
original_context = json.loads(data.get('context', '{}'))
data['context'] = json.dumps(report.with_context(
original_context
)._get_context())
return super().report_routes(
reportname, docids=docids, converter=converter, **data)

10
report_context/data/config_parameter.xml

@ -0,0 +1,10 @@
<?xml version="1.0" encoding="utf-8"?>
<odoo>
<data noupdate="1">
<record id="report_default_context"
model="ir.config_parameter" forcecreate="True">
<field name="key">report.default.context</field>
<field name="value">{}</field>
</record>
</data>
</odoo>

1
report_context/models/__init__.py

@ -0,0 +1 @@
from . import ir_actions_report

36
report_context/models/ir_actions_report.py

@ -0,0 +1,36 @@
# Copyright 2019 Creu Blanca
# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
from odoo.tools.safe_eval import safe_eval
from odoo import api, fields, models
class IrActionsReport(models.Model):
_inherit = 'ir.actions.report'
context = fields.Char(
string='Context Value', default={},
required=True,
help="Context dictionary as Python expression, empty by default "
"(Default: {})")
def _get_context(self):
self.ensure_one()
context = self.env['ir.config_parameter'].sudo().get_param(
'report.default.context', '{}')
# We must transform it to a dictionary
context = safe_eval(context or '{}')
report_context = safe_eval(self.context or '{}')
context.update(report_context)
context.update(self.env.context)
return context
@api.multi
def render(self, res_ids, data=None):
return super(IrActionsReport, self.with_context(
self._get_context())).render(res_ids, data=data)
@api.noguess
def report_action(self, docids, data=None, config=True):
return super(IrActionsReport, self.with_context(
self._get_context()
)).report_action(docids, data=data, config=config)

1
report_context/readme/CONTRIBUTORS.rst

@ -0,0 +1 @@
* Jaime Arroyo <jaime.arroyo@creublanca.es>

2
report_context/readme/DESCRIPTION.rst

@ -0,0 +1,2 @@
This module adds a context variable to reports. A possible use for this
context could be hiding some fields or many other configuration options.

18
report_context/readme/USAGE.rst

@ -0,0 +1,18 @@
To configure this module, you need to:
* Enter Odoo in debug mode.
* To add a specific context to a report, you should go to Settings ->
Reporting -> Reporting and look for the report you want to edit on the
list. You will see that now they contain a new field called Context Value
, where you will be able to add all the desired context parameters.
* Go to Settings -> Parameters -> System Parameters. On the system
parameters list, look for report.default.context, which is a Python
dictionary variable where you can add a context that will be common for
all reports.
It can also be added on the developer side using::
<record id="model_name.report_id" model="ir.actions.report">
<field name="context">YOUR CONTEXT HERE</field>
</record>

BIN
report_context/static/description/icon.png

After

Width: 128  |  Height: 128  |  Size: 9.2 KiB

436
report_context/static/description/index.html

@ -0,0 +1,436 @@
<?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>Report Context</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="report-context">
<h1 class="title">Report Context</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/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" href="https://github.com/OCA/reporting-engine/tree/11.0/report_context"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-11-0/reporting-engine-11-0-report_context"><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/143/11.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>This module adds a context variable to reports. A possible use for this
context could be hiding some fields or many other configuration options.</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="#bug-tracker" id="id2">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id3">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id4">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id5">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id6">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id1">Usage</a></h1>
<p>To configure this module, you need to:</p>
<ul class="simple">
<li>Enter Odoo in debug mode.</li>
<li>To add a specific context to a report, you should go to Settings -&gt;
Reporting -&gt; Reporting and look for the report you want to edit on the
list. You will see that now they contain a new field called Context Value
, where you will be able to add all the desired context parameters.</li>
<li>Go to Settings -&gt; Parameters -&gt; System Parameters. On the system
parameters list, look for report.default.context, which is a Python
dictionary variable where you can add a context that will be common for
all reports.</li>
</ul>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id2">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/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/reporting-engine/issues/new?body=module:%20report_context%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="#id3">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id4">Authors</a></h2>
<ul class="simple">
<li>Creu Blanca</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id5">Contributors</a></h2>
<ul class="simple">
<li>Jaime Arroyo &lt;<a class="reference external" href="mailto:jaime.arroyo&#64;creublanca.es">jaime.arroyo&#64;creublanca.es</a>&gt;</li>
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id6">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/reporting-engine/tree/11.0/report_context">OCA/reporting-engine</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>

1
report_context/tests/__init__.py

@ -0,0 +1 @@
from . import test_report_context

47
report_context/tests/test_report_context.py

@ -0,0 +1,47 @@
# Copyright 2019 Creu Blanca
# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl.html).
from odoo.tests.common import TransactionCase
class TestReportContext(TransactionCase):
def test_report_01(self):
company = self.browse_ref('base.main_company')
report = self.browse_ref('web.action_report_internalpreview')
self.env['ir.config_parameter'].sudo().set_param(
'report.default.context', '{"test_parameter": 1}')
report.write({'context': '{"test_parameter": 2}'})
action = report.with_context(test_parameter=3).report_action(company)
self.assertEqual(3, action['context']['test_parameter'])
def test_report_02(self):
company = self.browse_ref('base.main_company')
report = self.browse_ref('web.action_report_internalpreview')
self.env['ir.config_parameter'].sudo().set_param(
'report.default.context', '{"test_parameter": 1}')
report.write({'context': '{"test_parameter": 2}'})
action = report.report_action(company)
self.assertEqual(2, action['context']['test_parameter'])
def test_report_03(self):
company = self.browse_ref('base.main_company')
report = self.browse_ref('web.action_report_internalpreview')
self.env['ir.config_parameter'].sudo().set_param(
'report.default.context', '{"test_parameter": 1}')
action = report.with_context(test_parameter=3).report_action(company)
self.assertEqual(3, action['context']['test_parameter'])
def test_report_04(self):
company = self.browse_ref('base.main_company')
report = self.browse_ref('web.action_report_internalpreview')
report.write({'context': '{"test_parameter": 2}'})
action = report.report_action(company)
self.assertEqual(2, action['context']['test_parameter'])
def test_report_05(self):
company = self.browse_ref('base.main_company')
report = self.browse_ref('web.action_report_internalpreview')
self.env['ir.config_parameter'].sudo().set_param(
'report.default.context', '{"test_parameter": 1}')
action = report.report_action(company)
self.assertEqual(1, action['context']['test_parameter'])

18
report_context/views/ir_actions_report.xml

@ -0,0 +1,18 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Copyright 2019 Creu Blanca
License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
<odoo>
<record model="ir.ui.view" id="ir_actions_report_form_view">
<field name="name">ir.actions.report.context.form</field>
<field name="model">ir.actions.report</field>
<field name="inherit_id" ref="base.act_report_xml_view"/>
<field name="arch" type="xml">
<field name="print_report_name" position="after">
<field name="context"/>
</field>
</field>
</record>
</odoo>
Loading…
Cancel
Save