[MIG] bi_view_editor: migration to 16.0

Author: huguesdk

bi_view_editor/__manifest__.py

@@ -9,9 +9,11 @@
     "license": "AGPL-3",
     "website": "https://github.com/OCA/reporting-engine",
     "category": "Productivity",
-    "version": "15.0.1.0.0",
+    "version": "16.0.1.0.0",
     "development_status": "Beta",
-    "depends": ["web"],
+    "depends": [
+        "web",
+    ],
     "external_dependencies": {
         "deb": ["graphviz"],
     },
@@ -22,16 +24,8 @@
     ],
     "assets": {
         "web.assets_backend": [
-            "bi_view_editor/static/src/css/bve.css",
-            "bi_view_editor/static/src/js/bi_view_editor.js",
-            "bi_view_editor/static/src/js/bi_view_editor.JoinNodeDialog.js",
-            "bi_view_editor/static/src/js/bi_view_editor.ModelList.js",
-            "bi_view_editor/static/src/js/bi_view_editor.FieldList.js",
-        ],
-        "web.assets_qweb": [
-            "bi_view_editor/static/src/xml/bi_view_editor.xml",
+            "bi_view_editor/static/src/components/**/*",
         ],
     },
     "uninstall_hook": "uninstall_hook",
-    "installable": True,
 }

bi_view_editor/models/bve_view.py

@@ -60,7 +60,7 @@ def _inverse_serialized_data(self):
             line_ids = self._sync_lines_and_data(bve_view.data)
             bve_view.write({"line_ids": line_ids})
 
-    name = fields.Char(required=True, copy=False, default="")
+    name = fields.Char(required=True, copy=False, translate=True)
     model_name = fields.Char(compute="_compute_model_name", store=True)
     note = fields.Text(string="Notes")
     state = fields.Selection(
@@ -388,35 +388,6 @@ def _compute_sql_query(self):
                 AsIs(from_str),
             )
 
-    def action_translations(self):
-        self.ensure_one()
-        if self.state != "created":
-            return
-        self = self.sudo()
-        model = self.env["ir.model"].sudo().search([("model", "=", self.model_name)])
-        IrTranslation = self.env["ir.translation"]
-        IrTranslation.translate_fields("ir.model", model.id)
-        for field in model.field_id:
-            IrTranslation.translate_fields("ir.model.fields", field.id)
-        return {
-            "name": "Translations",
-            "res_model": "ir.translation",
-            "type": "ir.actions.act_window",
-            "view_mode": "tree",
-            "view_id": self.env.ref("base.view_translation_dialog_tree").id,
-            "target": "current",
-            "flags": {"search_view": True, "action_buttons": True},
-            "domain": [
-                "|",
-                "&",
-                ("res_id", "in", model.field_id.ids),
-                ("name", "=", "ir.model.fields,field_description"),
-                "&",
-                ("res_id", "=", model.id),
-                ("name", "=", "ir.model,name"),
-            ],
-        }
-
     def action_create(self):
         self.ensure_one()
 
@@ -441,7 +412,10 @@ def action_create(self):
                     "name": self.name,
                     "model": self.model_name,
                     "state": "manual",
-                    "field_id": [(0, 0, f) for f in bve_fields._prepare_field_vals()],
+                    "field_id": [
+                        fields.Command.create(f)
+                        for f in bve_fields._prepare_field_vals()
+                    ],
                 }
             )
         )

bi_view_editor/models/bve_view_line.py

@@ -101,12 +101,16 @@ def _prepare_field_vals(self):
                 "complete_name": field.complete_name,
                 "model": line.bve_view_id.model_name,
                 "relation": field.relation,
+                # FIXME: this sets the en_US value from the current language's
+                # translation. instead, all translations should be set with
+                # their corresponding value.
                 "field_description": line.description,
                 "ttype": field.ttype,
                 "selection": field.selection,
                 "size": field.size,
                 "state": "manual",
                 "readonly": True,
+                "translate": field.translate,
                 "groups": [(6, 0, field.groups.ids)],
             }
             if vals["ttype"] == "monetary":

bi_view_editor/models/ir_model.py

@@ -212,7 +212,7 @@ def get_fields(self, model_id):
                     ("name", "not in", models.MAGIC_COLUMNS),
                     ("ttype", "not in", NO_BI_TTYPES),
                 ],
-                order="field_description desc",
+                order="field_description",
             )
         )
         fields_dict = list(map(dict_for_field, fields))

bi_view_editor/readme/CONTRIBUTORS.rst

@@ -7,3 +7,6 @@
 * Antonio Esposito <[email protected]>
 * Jordi Ballester Alomar <[email protected]>
 * Italo LOPES <[email protected]>
+* `Coop IT Easy SC <https://coopiteasy.be>`_:
+
+  * hugues de keyzer

bi_view_editor/readme/ROADMAP.rst

@@ -5,3 +5,7 @@
 * Data the user has no access to (e.g. in a multi company situation) can be
   viewed by making a view. Would be nice if models available to select when
   creating a view are limited to the ones that have intersecting groups.
+* As of Odoo 16, translations of the name of a BI View and of the field
+  descriptions do not work as expected: the translated strings are selected
+  (by the user's language) when the view is generated (and stored as their
+  ``en_US`` value) instead of when it is displayed.

bi_view_editor/static/src/css/bve.css renamed to bi_view_editor/static/src/components/bi_view_editor/bi_view_editor.css

@@ -91,14 +91,19 @@
 }
 
 .oe_form_field_bi_editor .body .left .class-list .class.readonly {
-    cursor: default;
+    cursor: inherit;
 }
 
 .oe_form_field_bi_editor .body .left .class-list .class:hover {
     background-color: #7c7bad;
     color: #fff;
 }
 
+.oe_form_field_bi_editor .body .left .class-list .class.readonly:hover {
+    background-color: inherit;
+    color: inherit;
+}
+
 .oe_form_field_bi_editor .body .left .class-list .field {
     font-weight: normal;
     padding-left: 20px;
@@ -134,13 +139,16 @@
     border: none;
     background-image: none;
     padding: 0;
-    cursor: pointer;
 }
 
 .oe_form_field_bi_editor .body .right .field-list tbody tr:hover {
     background-color: #ddd;
 }
 
+.oe_form_field_bi_editor .body .right .field-list tbody tr.readonly:hover {
+    background-color: inherit;
+}
+
 .oe_form_field_bi_editor .body .right .field-list tbody tr.join-node {
     background-color: #d2d2ff;
     text-align: center;
@@ -196,3 +204,7 @@
 .oe_bi_view_editor_join_node_dialog li {
     cursor: pointer;
 }
+
+.o_field_widget.o_field_BVEEditor {
+    width: 100%;
+}

bi_view_editor/static/src/components/bi_view_editor/bi_view_editor.esm.js

@@ -0,0 +1,217 @@
+/** @odoo-module **/
+
+/* Copyright 2015-2019 Onestein (<https://www.onestein.eu>)
+ * License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). */
+
+import {Component, onWillUpdateProps, useState} from "@odoo/owl";
+import {FIELD_DATA_TYPE, ModelList} from "./model_list.esm";
+import {FieldList} from "./field_list.esm";
+import {JoinNodeDialog} from "./join_node_dialog.esm";
+import {registry} from "@web/core/registry";
+import {standardFieldProps} from "@web/views/fields/standard_field_props";
+import {useService} from "@web/core/utils/hooks";
+
+export class BiViewEditor extends Component {
+    setup() {
+        this.state = useState({
+            models: [],
+            fields: [],
+            // This allows to access fields by their _id property in an
+            // efficient way. Since the fields array length is normally quite
+            // small, it would also be possible to use
+            // fields.find(element => element._id == field._id), but that
+            // would mean that this function would be defined in 3 places
+            // (deleteField(), setFieldProperty() and
+            // FieldList.setFieldProperty()), and using a common function
+            // would be quite similar to using this object.
+            fieldsByID: {},
+        });
+        this.orm = useService("orm");
+        this.dialogService = useService("dialog");
+        onWillUpdateProps((nextProps) => {
+            this.updateFields(nextProps.value);
+        });
+        this.updateFields(this.props.value);
+    }
+    get modelIDs() {
+        const model_ids = {};
+        for (const field of this.state.fields) {
+            model_ids[field.table_alias] = field.model_id;
+        }
+        return model_ids;
+    }
+    get modelData() {
+        const model_data = {};
+        for (const field of this.state.fields) {
+            model_data[field.table_alias] = {
+                model_id: field.model_id,
+                model_name: field.model_name,
+            };
+        }
+        return model_data;
+    }
+    _addField(field) {
+        field.row = typeof field.row === "undefined" ? false : field.row;
+        field.column = typeof field.column === "undefined" ? false : field.column;
+        field.measure = typeof field.measure === "undefined" ? false : field.measure;
+        field.list = typeof field.list === "undefined" ? true : field.list;
+        field._id = typeof field._id === "undefined" ? _.uniqueId("node_") : field._id;
+        if (field.join_node) {
+            field.join_left =
+                typeof field.join_left === "undefined" ? false : field.join_left;
+        }
+
+        let i = 0;
+        const name = field.name;
+        while (
+            this.state.fields.filter(function (item) {
+                return item.name === field.name;
+            }).length > 0
+        ) {
+            field.name = name + "_" + i;
+            i++;
+        }
+        this.state.fields.push(field);
+        this.state.fieldsByID[field._id] = field;
+    }
+    deleteField(field) {
+        this.state.fields.splice(
+            this.state.fields.findIndex((element) => {
+                return element._id === field._id;
+            }),
+            1
+        );
+        delete this.state.fieldsByID[field._id];
+        this.fieldDeleted();
+    }
+    setFieldProperty(field, property, value) {
+        this.state.fieldsByID[field._id][property] = value;
+        this.fieldUpdated();
+    }
+    setFields(fields) {
+        this.state.fields = [];
+        this.state.fieldsByID = {};
+        for (const field of fields) {
+            this._addField(field);
+        }
+    }
+    updateFields(value) {
+        if (value) {
+            this.setFields(JSON.parse(value));
+        }
+        this.updateModels();
+    }
+    updateModels() {
+        const model_ids = this.modelIDs;
+        this.orm
+            .call("ir.model", "get_models", model_ids ? [model_ids] : [])
+            .then((models) => {
+                this.state.models = models;
+            });
+    }
+    clear() {
+        if (this.props.readonly) {
+            return;
+        }
+        this.setFields([]);
+        this.updateValue();
+    }
+    fieldUpdated() {
+        this.updateValue();
+    }
+    fieldDeleted() {
+        this.orm
+            .call("bve.view", "get_clean_list", [this.state.fields])
+            .then((result) => {
+                this.updateFields(result);
+                this.updateValue();
+            });
+    }
+    getTableAlias(field) {
+        if (typeof field.table_alias === "undefined") {
+            const model_ids = this.modelIDs;
+            let n = 1;
+            while (typeof model_ids["t" + n] !== "undefined") {
+                n++;
+            }
+            return "t" + n;
+        }
+        return field.table_alias;
+    }
+    addFieldAndJoinNode(field, join_node) {
+        if (join_node.join_node === -1 || join_node.table_alias === -1) {
+            field.table_alias = this.getTableAlias(field);
+            if (join_node.join_node === -1) {
+                join_node.join_node = field.table_alias;
+            } else {
+                join_node.table_alias = field.table_alias;
+            }
+            this._addField(join_node);
+        } else {
+            field.table_alias = join_node.table_alias;
+        }
+
+        this._addField(field);
+        this.updateValue();
+    }
+    addField(field) {
+        const data = _.extend({}, field);
+        const field_data = this.state.fields;
+        this.orm
+            .call("ir.model", "get_join_nodes", [field_data, data])
+            .then((result) => {
+                if (result.length === 1) {
+                    this.addFieldAndJoinNode(data, result[0]);
+                } else if (result.length > 1) {
+                    this.dialogService.add(JoinNodeDialog, {
+                        choices: result,
+                        model_data: this.modelData,
+                        choiceSelected: (choice) => {
+                            this.addFieldAndJoinNode(data, choice);
+                        },
+                    });
+                } else {
+                    data.table_alias = this.getTableAlias(data);
+                    this._addField(data);
+                    this.updateValue();
+                }
+            });
+    }
+    fieldClicked(field) {
+        this.addField(field);
+    }
+    onDragOver(e) {
+        if (this.props.readonly) {
+            return;
+        }
+        const dragType = e.dataTransfer.types[0];
+        if (dragType === FIELD_DATA_TYPE) {
+            e.preventDefault();
+            e.dataTransfer.dropEffect = "copy";
+        }
+    }
+    onDrop(e) {
+        if (this.props.readonly) {
+            return;
+        }
+        const dragData = e.dataTransfer.getData(FIELD_DATA_TYPE);
+        if (dragData) {
+            e.preventDefault();
+            this.addField(JSON.parse(dragData));
+        }
+    }
+    updateValue() {
+        this.props.update(JSON.stringify(this.state.fields));
+        this.updateModels();
+    }
+}
+BiViewEditor.template = "bi_view_editor.Frame";
+BiViewEditor.components = {
+    ModelList,
+    FieldList,
+};
+BiViewEditor.props = {
+    ...standardFieldProps,
+};
+
+registry.category("fields").add("BVEEditor", BiViewEditor);