From 8f1a806b8ed9f2e32840986637504265e5e7bfd8 Mon Sep 17 00:00:00 2001 From: tarteo Date: Tue, 2 Oct 2018 13:28:48 +0200 Subject: [PATCH] [MIG] web_environment_ribbon: Migration to 12.0 [MIG] web_environment_ribbon: Migration to 12.0 [FIX] Default value for ribbon.name if not exists [FIX] Hide ribbon when ribbon.name is false or not existing [FIX] Remove copyright flag on __init__ files [REM] Debugging logs [REM] Make quotes inconsistant again and change sequence of data files in manifest --- web_environment_ribbon/README.rst | 67 ++++++++++++++----- web_environment_ribbon/__init__.py | 4 -- web_environment_ribbon/__manifest__.py | 6 +- web_environment_ribbon/data/ribbon_data.xml | 30 ++++----- .../models/web_environment_ribbon_backend.py | 2 +- web_environment_ribbon/readme/CONFIGURE.rst | 8 +++ .../readme/CONTRIBUTORS.rst | 6 ++ web_environment_ribbon/readme/DESCRIPTION.rst | 1 + web_environment_ribbon/readme/USAGE.rst | 2 + .../static/src/js/ribbon.js | 22 ++++-- 10 files changed, 99 insertions(+), 49 deletions(-) create mode 100644 web_environment_ribbon/readme/CONFIGURE.rst create mode 100644 web_environment_ribbon/readme/CONTRIBUTORS.rst create mode 100644 web_environment_ribbon/readme/DESCRIPTION.rst create mode 100644 web_environment_ribbon/readme/USAGE.rst diff --git a/web_environment_ribbon/README.rst b/web_environment_ribbon/README.rst index 941c06f2..ff0bfe36 100644 --- a/web_environment_ribbon/README.rst +++ b/web_environment_ribbon/README.rst @@ -1,13 +1,37 @@ -.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png - :target: https://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 - ====================== Web Environment Ribbon ====================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/11.0/web_environment_ribbon + :alt: OCA/web +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/web-11-0/web-11-0-web_environment_ribbon + :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/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + Mark a Test Environment with a red ribbon on the top left corner in every page +**Table of contents** + +.. contents:: + :local: + Configuration ============= @@ -26,41 +50,48 @@ Usage To use this module, you need only to install it. After installation, a red ribbon will be visible on top left corner of every Odoo backend page -.. 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/11.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 ======= +Authors +~~~~~~~ + +* Francesco OpenCode Apruzzese +* Tecnativa + Contributors ------------- +~~~~~~~~~~~~ * Francesco Apruzzese * Javi Melendez * Antonio Espinosa * Thomas Binsfeld * Xavier Jiménez +* Dennis Sluijk + +Maintainers +~~~~~~~~~~~ -Maintainer ----------- +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_environment_ribbon/__init__.py b/web_environment_ribbon/__init__.py index 2a27329e..0650744f 100644 --- a/web_environment_ribbon/__init__.py +++ b/web_environment_ribbon/__init__.py @@ -1,5 +1 @@ -# Copyright 2015 Francesco OpenCode Apruzzese -# Copyright 2016 Antonio Espinosa -# Copyright 2017 Thomas Binsfeld -# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). from . import models diff --git a/web_environment_ribbon/__manifest__.py b/web_environment_ribbon/__manifest__.py index 663f9a48..5b6bd672 100644 --- a/web_environment_ribbon/__manifest__.py +++ b/web_environment_ribbon/__manifest__.py @@ -6,7 +6,7 @@ { 'name': "Web Environment Ribbon", - 'version': '11.0.1.0.2', + 'version': '12.0.1.0.0', 'category': 'Web', 'author': 'Francesco OpenCode Apruzzese, ' 'Tecnativa, ' @@ -17,11 +17,9 @@ 'web', ], "data": [ - 'view/base_view.xml', 'data/ribbon_data.xml', + 'view/base_view.xml', ], - "update_xml": [], - "demo_xml": [], "auto_install": False, 'installable': True } diff --git a/web_environment_ribbon/data/ribbon_data.xml b/web_environment_ribbon/data/ribbon_data.xml index 0ba37985..545b7271 100644 --- a/web_environment_ribbon/data/ribbon_data.xml +++ b/web_environment_ribbon/data/ribbon_data.xml @@ -3,22 +3,22 @@ License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). --> - - - ribbon.name - ({db_name})]]> - + + + ribbon.name + ({db_name})]]> + - - - ribbon.color - #f0f0f0 - + + + ribbon.color + #f0f0f0 + - - - ribbon.background.color - rgba(255,0,0,.6) - + + + ribbon.background.color + rgba(255,0,0,.6) + diff --git a/web_environment_ribbon/models/web_environment_ribbon_backend.py b/web_environment_ribbon/models/web_environment_ribbon_backend.py index 4506d43e..1be0df71 100644 --- a/web_environment_ribbon/models/web_environment_ribbon_backend.py +++ b/web_environment_ribbon/models/web_environment_ribbon_backend.py @@ -20,7 +20,7 @@ class WebEnvironmentRibbonBackend(models.AbstractModel): name_tmpl = self.env['ir.config_parameter'].sudo().get_param( 'ribbon.name') vals = self._prepare_ribbon_format_vals() - return name_tmpl.format(**vals) + return name_tmpl and name_tmpl.format(**vals) or name_tmpl @api.model def get_environment_ribbon(self): diff --git a/web_environment_ribbon/readme/CONFIGURE.rst b/web_environment_ribbon/readme/CONFIGURE.rst new file mode 100644 index 00000000..8542c72e --- /dev/null +++ b/web_environment_ribbon/readme/CONFIGURE.rst @@ -0,0 +1,8 @@ +* You can change the ribbon's name ("TEST") by editing the default system + parameter "ribbon.name" (in the menu Settings > Parameters > System + Parameters) To hide the ribbon, set this parameter to "False" or delete it. +* You can customize the ribbon color and background color through system + parameters: "ribbon.color", "ribbon.background.color". Fill with valid CSS + colors or just set to "False" to use default values. +* You can add the database name in the ribbon by adding "{db_name}" in the + system parameter "ribbon.name". diff --git a/web_environment_ribbon/readme/CONTRIBUTORS.rst b/web_environment_ribbon/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..bf02e7be --- /dev/null +++ b/web_environment_ribbon/readme/CONTRIBUTORS.rst @@ -0,0 +1,6 @@ +* Francesco Apruzzese +* Javi Melendez +* Antonio Espinosa +* Thomas Binsfeld +* Xavier Jiménez +* Dennis Sluijk diff --git a/web_environment_ribbon/readme/DESCRIPTION.rst b/web_environment_ribbon/readme/DESCRIPTION.rst new file mode 100644 index 00000000..c52ab9b5 --- /dev/null +++ b/web_environment_ribbon/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +Mark a Test Environment with a red ribbon on the top left corner in every page diff --git a/web_environment_ribbon/readme/USAGE.rst b/web_environment_ribbon/readme/USAGE.rst new file mode 100644 index 00000000..408d88cd --- /dev/null +++ b/web_environment_ribbon/readme/USAGE.rst @@ -0,0 +1,2 @@ +To use this module, you need only to install it. After installation, a red +ribbon will be visible on top left corner of every Odoo backend page diff --git a/web_environment_ribbon/static/src/js/ribbon.js b/web_environment_ribbon/static/src/js/ribbon.js index 2f577611..80a0973f 100644 --- a/web_environment_ribbon/static/src/js/ribbon.js +++ b/web_environment_ribbon/static/src/js/ribbon.js @@ -14,20 +14,28 @@ odoo.define('web_environment_ribbon.ribbon', function(require) { // Code from: http://jsfiddle.net/WK_of_Angmar/xgA5C/ function validStrColour(strToTest) { - if (strToTest === "") { return false; } - if (strToTest === "inherit") { return true; } - if (strToTest === "transparent") { return true; } + if (strToTest === "") { + return false; + } + if (strToTest === "inherit") { + return true; + } + if (strToTest === "transparent") { + return true; + } var image = document.createElement("img"); image.style.color = "rgb(0, 0, 0)"; image.style.color = strToTest; - if (image.style.color !== "rgb(0, 0, 0)") { return true; } + if (image.style.color !== "rgb(0, 0, 0)") { + return true; + } image.style.color = "rgb(255, 255, 255)"; image.style.color = strToTest; return image.style.color !== "rgb(255, 255, 255)"; } core.bus.on('web_client_ready', null, function () { - var ribbon = $('
'); + var ribbon = $('