[ADD] Training: server framework 101

.gitignore

@@ -127,3 +127,5 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+.vscode/

.vscode/settings.json

@@ -0,0 +1,17 @@
+{
+    "python.analysis.extraPaths": [
+        "/home/odoo/odoo",
+    ],
+     "ruff.exclude": [],
+    "ruff.lint.preview": true,
+    "ruff.lineLength": 80,
+    "ruff.configuration": "",
+    "ruff.enable": true,
+    "ruff.format.preview": true,
+    "ruff.lint.extendSelect": [
+        "ALL"
+    ],
+    "ruff.lint.ignore": [
+        "A","ARG","ANN","B","C901","D","DTZ","DOC","E501","ERA001","FBT","N","PD","PERF","PIE790","PLR","PT","Q","RSE102","RUF001","RUF012","S","SIM102","SIM108","SLF001","TID252","UP031","TRY003","TRY300","UP038","E713","SIM117","PGH003","RUF005","FIX","TD","TRY400","C408","PLW2901","PTH","EM102","INP001","CPY001","E266","PIE808","PLC2701","RUF100","FA100","FURB","C420","COM812","TRY002","B904","EM101","I001","UP006","UP007","RET","RUF021","E741","FAST","ASYNC","AIR","DJ","NPY","FA102"
+    ],
+}

awesome_dashboard/__manifest__.py

@@ -24,7 +24,11 @@
     'assets': {
         'web.assets_backend': [
             'awesome_dashboard/static/src/**/*',
+            ('remove', 'awesome_dashboard/static/src/dashboard/**/*'),
         ],
+        'awesome_dashboard.dashboard': [
+            'awesome_dashboard/static/src/dashboard/**/*',
+        ]
     },
     'license': 'AGPL-3'
 }

awesome_dashboard/static/src/dashboard/configurationDialog.js

@@ -0,0 +1,58 @@
+import { Component, xml, useState } from "@odoo/owl";
+import { Dialog } from "@web/core/dialog/dialog";
+import { CheckBox } from "@web/core/checkbox/checkbox";
+import { browser } from "@web/core/browser/browser";
+
+
+export class ConfigurationDialog extends Component {
+    static components = { Dialog, CheckBox };
+    static template = xml`
+        <Dialog>
+             <t t-foreach="items" t-as="item" t-key="item.id">
+                <CheckBox value="item.enabled" onChange="(ev) => this.onChange(ev, item)">
+                    <t t-esc="item.description"/>
+                </CheckBox>
+            </t>
+            <t t-set-slot="footer">
+                <button class="btn btn-primary" t-on-click="done">
+                    Done
+                </button>
+            </t>
+        </Dialog>
+    `;
+
+    static props = {
+        items: {Type: Array},
+        disabledItems: {Type: Array},
+        onUpdateConfiguration: {Type: Function}
+    }
+
+
+    setup() {
+        this.items = useState(this.props.items.map((item) => {
+            return {
+                ...item,
+                enabled: !this.props.disabledItems.includes(item.id),
+            }
+        }));
+    }
+
+    onChange(ev, item) {
+        item.enabled = ev
+        const newDisabledItems = Object.values(this.items).filter(
+            (item) => !item.enabled
+        ).map((item) => item.id)
+
+        browser.localStorage.setItem(
+            "disabledDashboardItems",
+            newDisabledItems,
+        );
+
+        this.props.onUpdateConfiguration(newDisabledItems);
+    }
+
+    done() {
+        this.props.close();
+    }
+}
+

awesome_dashboard/static/src/dashboard/dashboard.js

@@ -0,0 +1,50 @@
+/** @odoo-module **/
+
+import { Component, onWillStart, useState } from "@odoo/owl";
+import { registry } from "@web/core/registry";
+import { useService } from "@web/core/utils/hooks";
+import { Layout } from "@web/search/layout";
+import { DashboardItem } from "./dashboardItem";
+import { ConfigurationDialog } from "./configurationDialog";
+import { browser } from "@web/core/browser/browser";
+
+
+class AwesomeDashboard extends Component {
+    static template = "awesome_dashboard.AwesomeDashboard";
+    static components = { Layout, DashboardItem }
+
+    setup() {
+        this.action = useService("action");
+        this.statistics = useState(useService("awesome_dashboard.statistics"));
+        this.items = registry.category("data").get("awesome_dashboard.dashboardItems")
+        this.dialog = useService("dialog");
+        this.state = useState({disabledItems: browser.localStorage.getItem("disabledDashboardItems")?.split(",") || []})
+    }
+    getCustomers() {
+        this.action.doAction("base.action_partner_form");
+    }
+
+    async getLeads() {
+        this.action.doAction({
+            type: 'ir.actions.act_window',
+            name: 'Leads',
+            target: 'current',
+            res_model: 'crm.lead',
+            views: [[false, 'list'], [false, 'form']],
+        });
+    }
+
+    openConfiguration() {
+        this.dialog.add(ConfigurationDialog, {
+            items: this.items,
+            disabledItems: this.state.disabledItems,
+            onUpdateConfiguration: this.updateConfiguration.bind(this),
+        })
+    }
+
+    updateConfiguration(newDisabledItems) {
+        this.state.disabledItems = newDisabledItems;
+    }
+}
+
+registry.category("lazy_components").add("Dashboard", AwesomeDashboard);

awesome_dashboard/static/src/dashboard/dashboard.scss

@@ -0,0 +1,3 @@
+.o_dashboard {
+    background-color: gray;
+}

awesome_dashboard/static/src/dashboard/dashboard.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.AwesomeDashboard">
+        <Layout display="{controlPanel: {} }" className="'o_dashboard h-100'">
+            <t t-set-slot="layout-buttons">
+                <button class="btn btn-primary" t-on-click="getCustomers">Customers</button>
+                <button class="btn btn-primary" t-on-click="getLeads">Leads</button>
+            </t>
+            <t t-set-slot="control-panel-additional-actions">
+                <button t-on-click="openConfiguration" class="btn p-0 ms-1 border-0">
+                    <i class="fa fa-cog"></i>
+                </button>
+            </t>
+            <div class="d-flex flex-wrap" t-if="statistics.ready">
+                <t t-foreach="items" t-as="item" t-key="item.id">
+                    <DashboardItem  t-if="!state.disabledItems.includes(item.id)" size="item.size || 1">
+                        <t t-set="itemProp" t-value="item.props ? item.props(statistics) : {'data': statistics}"/>
+                        <t t-component="item.Component" t-props="itemProp" />
+                    </DashboardItem>
+                </t>
+            </div>
+        </Layout>
+    </t>
+
+</templates>

awesome_dashboard/static/src/dashboard/dashboardItem.js

@@ -0,0 +1,19 @@
+import { Component } from "@odoo/owl";
+
+export class DashboardItem extends Component {
+    static template = "awesome_dashboard.dashboardItem";
+
+    static props = {
+        id: {type: Number},
+        description: {type: String},
+        Component: {type: Object},
+        size: {type: Number, optional: true},
+        props: {type: Function, optional: true}
+    }
+    static defaultProps = {
+        size: 1,
+    }
+
+
+
+}

awesome_dashboard/static/src/dashboard/dashboardItem.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+
+    <t t-name="awesome_dashboard.dashboardItem">
+        <div class="card m-2 border-dark" t-att-style="'width: ' + (18 * props.size) + 'rem'">
+            <t t-slot="default"/>
+        </div>
+    </t>
+
+</templates>

awesome_dashboard/static/src/dashboard/dashboard_items.js

@@ -0,0 +1,64 @@
+import { NumberCard } from "./number_card/numberCard";
+import { PieChartCard } from "./pie_chart_card/pieChartCard";
+import { registry } from "@web/core/registry";
+
+
+export const items = [
+    {
+        id: "average_quantity",
+        description: "Average amount of t-shirt",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Average amount of t-shirt by order this month",
+            value: data.average_quantity,
+        })
+    },
+    {
+        id: "average_time",
+        description: "Average time for an order",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Average time for an order to go from 'new' to 'sent' or 'cancelled'",
+            value: data.average_time,
+        })
+    },
+    {
+        id: "number_new_orders",
+        description: "New orders this month",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Number of new orders this month",
+            value: data.nb_new_orders,
+        })
+    },
+    {
+        id: "cancelled_orders",
+        description: "Cancelled orders this month",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Number of cancelled orders this month",
+            value: data.nb_cancelled_orders,
+        })
+    },
+    {
+        id: "amount_new_orders",
+        description: "amount orders this month",
+        Component: NumberCard,
+        props: (data) => ({
+            title: "Total amount of new orders this month",
+            value: data.total_amount,
+        })
+    },
+    {
+        id: "pie_chart",
+        description: "Shirt orders by size",
+        Component: PieChartCard,
+        size: 2,
+        props: (data) => ({
+            label: "Shirt orders by size",
+            data: data.orders_by_size,
+        })
+    }
+]
+
+registry.category("data").add("awesome_dashboard.dashboardItems", items);

awesome_dashboard/static/src/dashboard/number_card/numberCard.js

@@ -0,0 +1,17 @@
+import { Component, xml } from "@odoo/owl";
+
+
+export class NumberCard extends Component {
+    static template = xml`
+        <t t-esc="props.title"/>
+        <div class="fs-1 fw-bold text-success text-center">
+            <t t-esc="props.value"/>
+        </div>
+    `;
+
+    static props = {
+        title: {type: String},
+        value: {type: String}
+    }
+}
+

awesome_dashboard/static/src/dashboard/pieChart.js

@@ -0,0 +1,41 @@
+import { Component, onWillStart, useRef, onMounted, onWillUnmount } from "@odoo/owl";
+import { loadJS } from "@web/core/assets";
+
+
+export class PieChart extends Component {
+    static template = "awesome_dashboard.PieChart";
+
+    static props = {
+        label: String,
+        data: Object,
+    };
+
+    setup() {
+        this.canvasRef = useRef("canvas");
+        onWillStart(() => loadJS(["/web/static/lib/Chart/Chart.js"]))
+        onMounted(() => {
+            this.renderChart()
+        })
+        // onWillUnmount(() => {
+        //     this.chart.destroy()
+        // })
+    }
+
+    renderChart() {
+        const labels = Object.keys(this.props.data);
+        const data = Object.values(this.props.data);
+        this.chart = new Chart(this.canvasRef.el, {
+            type: 'pie',
+            data: {
+                labels: labels,
+                datasets: [
+                    {
+                        label: this.props.label,
+                        data: data
+                    }
+                ]
+            },
+        });
+    }
+
+}

awesome_dashboard/static/src/dashboard/pieChart.xml

@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<templates xml:space="preserve">
+    <t t-name="awesome_dashboard.PieChart">
+        <div t-att-class="'h-100 ' + props.class" t-ref="root">
+            <div class="h-100 position-relative" t-ref="container">
+                <t t-esc="props.label" />
+                <canvas t-ref="canvas" />
+            </div>
+        </div>
+    </t>
+</templates>

awesome_dashboard/static/src/dashboard/pie_chart_card/pieChartCard.js

@@ -0,0 +1,15 @@
+import { Component, xml } from "@odoo/owl";
+import { PieChart } from "../pieChart";
+
+export class PieChartCard extends Component {
+    static template = xml`
+        <PieChart label="props.label" data="props.data"/>
+    `;
+    static components = { PieChart }
+
+    static props = {
+        label: {type: String},
+        data: {type: Object}
+    }
+}
+