[MIG] web_environment_ribbon

web_environment_ribbon/README.rst

@@ -1,6 +1,8 @@
 .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
    :alt: License: AGPL-3
 
+======================
 Web Environment Ribbon
 ======================
 
@@ -30,14 +32,17 @@ 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/9.0
+
 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 smashing it by providing a detailed and
-welcomed feedback
-`here <https://github.com/OCA/web/issues/new?body=module:%20web_environment_ribbon%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
+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 smashing it by providing a detailed and welcomed feedback.
 
 Credits
 =======
@@ -47,6 +52,7 @@ Contributors
 
 * Francesco Apruzzese <cescoap@gmail.com>
 * Javi Melendez <javimelex@gmail.com>
+* Antonio Espinosa <antonio.espinosa@tecnativa.com>
 
 Maintainer
 ----------
@@ -61,4 +67,4 @@ 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 http://odoo-community.org.
+To contribute to this module, please visit https://odoo-community.org.

web_environment_ribbon/__init__.py

@@ -1,20 +1,4 @@
 # -*- coding: utf-8 -*-
-##############################################################################
-#
-#    Copyright (C) 2015 Francesco OpenCode Apruzzese (<cescoap@gmail.com>)
-#    All Rights Reserved
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU Affero General Public License as published
-#    by the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU Affero General Public License for more details.
-#
-#    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-##############################################################################
+# Copyright 2015 Francesco OpenCode Apruzzese <cescoap@gmail.com>
+# Copyright 2016 Antonio Espinosa <antonio.espinosa@tecnativa.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).

web_environment_ribbon/__openerp__.py

@@ -1,29 +1,15 @@
 # -*- coding: utf-8 -*-
-##############################################################################
-#
-#    Copyright (C) 2015 Francesco OpenCode Apruzzese (<cescoap@gmail.com>)
-#    All Rights Reserved
-#
-#    This program is free software: you can redistribute it and/or modify
-#    it under the terms of the GNU Affero General Public License as published
-#    by the Free Software Foundation, either version 3 of the License, or
-#    (at your option) any later version.
-#
-#    This program is distributed in the hope that it will be useful,
-#    but WITHOUT ANY WARRANTY; without even the implied warranty of
-#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-#    GNU Affero General Public License for more details.
-#
-#    You should have received a copy of the GNU Affero General Public License
-#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-#
-##############################################################################
+# Copyright 2015 Francesco OpenCode Apruzzese <cescoap@gmail.com>
+# Copyright 2016 Antonio Espinosa <antonio.espinosa@tecnativa.com>
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 
 {
     'name': "Web Environment Ribbon",
-    'version': '8.0.1.0.0',
+    'version': '9.0.1.0.0',
     'category': 'Web',
-    'author': 'Francesco OpenCode Apruzzese,Odoo Community Association (OCA)',
+    'author': 'Francesco OpenCode Apruzzese, '
+              'Tecnativa, '
+              'Odoo Community Association (OCA)',
     'website': 'https://it.linkedin.com/in/francescoapruzzese',
     'license': 'AGPL-3',
     "depends": [
@@ -36,5 +22,5 @@
     "update_xml": [],
     "demo_xml": [],
     "auto_install": False,
-    'installable': False
+    "installable": True
 }

web_environment_ribbon/data/ribbon_data.xml

@@ -1,24 +1,24 @@
 <?xml version="1.0" encoding="utf-8"?>
-<openerp>
-    <data noupdate="1">
+<!-- Copyright 2015 Francesco OpenCode Apruzzese <cescoap@gmail.com>
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo noupdate="1">
 
-        <!-- Add ribbon name default configuration parameter -->
-        <record id="default_ribbon_name" model="ir.config_parameter">
+<!-- Add ribbon name default configuration parameter -->
+<record id="default_ribbon_name" model="ir.config_parameter">
     <field name="key">ribbon.name</field>
     <field name="value">TEST</field>
-        </record>
+</record>
 
-        <!-- Add ribbon color configuration parameter -->
-        <record id="set_ribbon_color" model="ir.config_parameter">
+<!-- Add ribbon color configuration parameter -->
+<record id="set_ribbon_color" model="ir.config_parameter">
     <field name="key">ribbon.color</field>
     <field name="value">#f0f0f0</field>
-        </record>
+</record>
 
-        <!-- Add ribbon background color configuration parameter -->
-        <record id="set_ribbon_background_color" model="ir.config_parameter">
+<!-- Add ribbon background color configuration parameter -->
+<record id="set_ribbon_background_color" model="ir.config_parameter">
     <field name="key">ribbon.background.color</field>
     <field name="value">rgba(255,0,0,.6)</field>
-        </record>
+</record>
 
-    </data>
-</openerp>
+</odoo>

web_environment_ribbon/static/src/css/ribbon.css

@@ -1,3 +1,6 @@
+/* Copyright 2015 Francesco OpenCode Apruzzese <cescoap@gmail.com>
+ * License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). */
+
 .test-ribbon{
     width: 200px;
     top: 50px;

web_environment_ribbon/static/src/js/ribbon.js

@@ -1,32 +1,37 @@
-/******************************************************************************
-    Copyright (C) 2015 Akretion (http://www.akretion.com)
-    @author Sylvain Calador <sylvain.calador@akretion.com>
+/* Copyright 2015 Sylvain Calador <sylvain.calador@akretion.com>
+   Copyright 2015 Javi Melendez <javi.melendez@algios.com>
+   Copyright 2016 Antonio Espinosa <antonio.espinosa@tecnativa.com>
+ * License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). */
 
-    Copyright (C) 2016 Algi Open Source Solutions (http://www.algios.com)
-    @author Javi Melendez <javi.melendez@algios.com>
+odoo.define('web_environment_ribbon.ribbon', function(require) {
+"use strict";
 
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero General Public License as
-    published by the Free Software Foundation, either version 3 of the
-    License, or (at your option) any later version.
+var $ = require('$');
+var Model = require('web.Model');
+var core = require('web.core');
 
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU Affero General Public License for more details.
+var model = new Model('ir.config_parameter');
 
-    You should have received a copy of the GNU Affero General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-******************************************************************************/
-
-openerp.web_environment_ribbon = function(instance) {
+// 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; }
+    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; }
+    image.style.color = "rgb(255, 255, 255)";
+    image.style.color = strToTest;
+    return image.style.color !== "rgb(255, 255, 255)";
+}
 
-    var ribbon = $(document).find('.test-ribbon');
+core.bus.on('web_client_ready', null, function () {
+    var ribbon = $('.test-ribbon');
+    // If ribbon is found in DOM
+    if (ribbon.length) {
         ribbon.hide();
-
-    var model = new instance.web.Model('ir.config_parameter');
-
-    var res = model.call('get_param', ['ribbon.name']).then(
+        model.call('get_param', ['ribbon.name']).then(
             function (name) {
                 if (name && name != 'False') {
                     ribbon.html(name);
@@ -34,35 +39,23 @@ openerp.web_environment_ribbon = function(instance) {
                 }
             }
         );
-
         // Get ribbon color from system parameters
-    var res = model.call('get_param', ['ribbon.color']).then(
+        model.call('get_param', ['ribbon.color']).then(
             function (strColor) {
                 if (strColor && validStrColour(strColor)) {
                     ribbon.css('color', strColor);
                 }
             }
         );
-
         // Get ribbon background color from system parameters
-    var res = model.call('get_param', ['ribbon.background.color']).then(
+        model.call('get_param', ['ribbon.background.color']).then(
             function (strBackgroundColor) {
                 if (strBackgroundColor && validStrColour(strBackgroundColor)) {
                     ribbon.css('background-color', strBackgroundColor);
                 }
             }
         );
-    // 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; }
-        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; }
-        image.style.color = "rgb(255, 255, 255)";
-        image.style.color = strToTest;
-        return image.style.color !== "rgb(255, 255, 255)";
     }
-}
+});
+
+}); // odoo.define

web_environment_ribbon/view/base_view.xml

@@ -1,21 +1,26 @@
 <?xml version="1.0" encoding="utf-8"?>
-<openerp>
-<data>
+<!-- Copyright 2015 Francesco OpenCode Apruzzese <cescoap@gmail.com>
+     Copyright 2016 Antonio Espinosa <antonio.espinosa@tecnativa.com>
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+<odoo>
 
-    <!-- Load css for ribbons -->
-    <template id="assets_backend" name="ribbon_test assets" inherit_id="web.assets_backend">
+<!-- Load css for ribbons -->
+<template id="assets_backend" name="ribbon_test assets"
+          inherit_id="web.assets_backend">
     <xpath expr="." position="inside">
-            <link rel="stylesheet" href="/web_environment_ribbon/static/src/css/ribbon.css"/>
-            <script type="text/javascript" src="/web_environment_ribbon/static/src/js/ribbon.js"/>
+        <link rel="stylesheet"
+              href="/web_environment_ribbon/static/src/css/ribbon.css"/>
+        <script type="text/javascript"
+                src="/web_environment_ribbon/static/src/js/ribbon.js"/>
     </xpath>
-    </template>
+</template>
 
-    <!-- Add ribbon to page -->
-    <template id="body_with_ribbon_test" name="ribbon_test web.webclient_bootstrap" inherit_id="web.webclient_bootstrap">
-        <xpath expr="//div[@class='openerp openerp_webclient_container']" position="before">
+<!-- Add ribbon to page -->
+<template id="body_with_ribbon_test" name="ribbon_test web.webclient_bootstrap"
+          inherit_id="web.webclient_bootstrap">
+    <xpath expr="//div[@class='openerp openerp_webclient_container oe_webclient']" position="before">
         <div class="test-ribbon"/>
     </xpath>
-    </template>
+</template>
 
-</data>
-</openerp>
+</odoo>