Merge PR OCA#3031 into 17.0

Signed-off-by legalsylvain

module_analysis/README.rst

@@ -0,0 +1,205 @@
+===============
+Module Analysis
+===============
+
+..
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:d00d83d918ced79270057ca2a185260375834ac2e4526c7c5cb0fa745158aca6
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/17.0/module_analysis
+    :alt: OCA/server-tools
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/server-tools-17-0/server-tools-17-0-module_analysis
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/server-tools&target_branch=17.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module allows you to know 'how much code' is running on your Odoo
+instance, group by 'Type' (Odoo Core, OCA, other...)
+
+This module can be usefull in the following cases :
+
+-  To analyse the size of your technical debt, regarding your Custom
+   modules
+-  To know the ratio between Odoo / OCA and Custom modules
+-  To evaluate the amount to pay to odoo to upgrade your custom code, or
+   the induced workload
+
+|image|
+
+For that purpose, it adds new concepts
+
+-  ``ir.module.author``, based on the value ``author`` present in the
+   manifest file.
+
+|image1|
+
+-  ``ir.module.type``, populated by default with Odoo and OCA values.
+
+|image2|
+
+Each installed modules have extra data in the 'Technical Data' tab :
+
+|image3|
+
+.. |image| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/installed_modules_by_types.png
+.. |image1| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_authors.png
+.. |image2| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_types.png
+.. |image3| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/module_form.png
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Installation
+============
+
+To use this module, you have to install the ``pygount`` python librairy.
+
+``pip install pygount``
+
+Configuration
+=============
+
+-  Go to Apps / Module Analysis / Modules Types Rules
+
+The Module types Rules are usefull to get the Type of a module, based on
+it information.
+
+This module comes with default rules.
+
+   |image4|
+
+You can add your custom rules to identify the modules your team have
+developped for exemple,
+
+   |image5|
+
+to update the data manually, you have to :
+
+-  Go to 'Settings' / 'Technical' / 'Scheduled Actions'
+-  Run manually the action : 'Update Module Analysis'
+
+This will update analysis of your installed modules.
+
+to update the data automatically, you have to :
+
+-  Go to 'Settings' / 'Technical' / 'Scheduled Actions'
+-  Configure the action 'Update Module Analysis' and activate it. (By
+   default, the cron is unactive and no analysis is done)
+
+Adding Extra data
+-----------------
+
+If you want to analyse other data, (for exemple, having the number of
+HTML files), create a custom modules and overload the module model :
+
+.. code:: python
+
+   from odoo import api, fields, models
+
+   class IrModuleModule(models.Model):
+      _inherit = 'ir.module.module'
+
+      xml_documentation_qty = fields.Integer(
+         string='Quantity of Comments in XML Files')
+
+     @api.model
+     def _get_analyse_settings(self):
+         res = super()._get_analyse_settings()
+         if not '.html' in res:
+             res['.html'] = {}
+         res['.html']['documentation'] 'xml_documentation_qty'
+         return res
+
+Exclude files and directories
+-----------------------------
+
+Two parameters are availaible in 'Settings' / 'Technical' / 'Parameters'
+'System Parameters' :
+
+   |image6|
+
+The list of folders and filename will be exclude from the analysis. You
+can change the default settings.
+
+.. |image4| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/default_module_type_rules.png
+.. |image5| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/add_module_type_rules.png
+.. |image6| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/config_parameters.png
+
+Usage
+=====
+
+-  Go to 'Apps' / 'Module Analysis' / 'Installed module by Types'
+
+Open the stats to analyse the detail of the code installed
+
+   |image7|
+
+   |image8|
+
+.. |image7| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/analysis_pivot.png
+.. |image8| image:: https://raw.githubusercontent.com/OCA/server-tools/17.0/module_analysis/static/description/analysis_pie.png
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
+In case of trouble, please check there if your issue has already been reported.
+If you spotted it first, help us to smash it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2017.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
+-------
+
+* GRAP
+
+Contributors
+------------
+
+-  Sylvain LE GAL (https://twitter.com/legalsylvain)
+
+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.
+
+.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
+    :target: https://github.com/legalsylvain
+    :alt: legalsylvain
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-legalsylvain|
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/17.0/module_analysis>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

module_analysis/__init__.py

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

module_analysis/__manifest__.py

@@ -0,0 +1,33 @@
+# Copyright (C) 2019-Today: GRAP (<http://www.grap.coop/>)
+# @author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+
+{
+    "name": "Module Analysis",
+    "summary": "Add analysis tools regarding installed modules"
+    " to know which installed modules comes from Odoo Core, OCA, or are"
+    " custom modules",
+    "author": "GRAP, Odoo Community Association (OCA)",
+    "maintainers": ["legalsylvain"],
+    "website": "https://github.com/OCA/server-tools",
+    "version": "17.0.1.0.1",
+    "license": "AGPL-3",
+    "depends": ["base"],
+    "data": [
+        "security/ir.model.access.csv",
+        "views/menu.xml",
+        "views/view_ir_module_author.xml",
+        "views/view_ir_module_type.xml",
+        "views/view_ir_module_type_rule.xml",
+        "views/view_ir_module_module.xml",
+        "data/ir_cron.xml",
+        "data/ir_config_parameter.xml",
+        "data/ir_module_type.xml",
+        "data/ir_module_type_rule.xml",
+        "data/ir_cron.xml",
+    ],
+    "external_dependencies": {
+        "python": ["pygount"],
+    },
+    "installable": True,
+}

module_analysis/data/ir_config_parameter.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+Copyright (C) 2019-Today: GRAP (<http://www.grap.coop/>)
+@author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+ -->
+<odoo noupdate="1">
+    <record id="parameter_exclude_directories" model="ir.config_parameter">
+        <field name="key">module_analysis.exclude_directories</field>
+        <field name="value">lib,demo,test,tests,doc,description</field>
+    </record>
+    <record id="parameter_exclude_files" model="ir.config_parameter">
+        <field name="key">module_analysis.exclude_files</field>
+        <field name="value">__openerp__.py,__manifest__.py</field>
+    </record>
+</odoo>

module_analysis/data/ir_cron.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+Copyright (C) 2021-Today: GRAP (<http://www.grap.coop/>)
+@author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+ -->
+<odoo noupdate="1">
+    <record id="cron_module_analysis" model="ir.cron">
+        <field name="name">Update Module Analysis</field>
+        <field name="active" eval="False" />
+        <field name="model_id" ref="base.model_ir_module_module" />
+        <field name="state">code</field>
+        <field name="code">model.cron_analyse_code()</field>
+        <field name="interval_number">1</field>
+        <field name="interval_type">days</field>
+        <field name="nextcall" eval="(DateTime.today()).strftime('%Y-%m-%d')" />
+        <field name="numbercall">-1</field>
+        <field name="user_id" ref="base.user_root" />
+    </record>
+</odoo>

module_analysis/data/ir_module_type.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+Copyright (C) 2019-Today: GRAP (<http://www.grap.coop/>)
+@author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+ -->
+<odoo>
+    <record id="module_type_odoo" model="ir.module.type">
+        <field name="name">Odoo Core</field>
+    </record>
+    <record id="module_type_oca" model="ir.module.type">
+        <field name="name">OCA</field>
+    </record>
+</odoo>

module_analysis/data/ir_module_type_rule.xml

@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+Copyright (C) 2019-Today: GRAP (<http://www.grap.coop/>)
+@author: Sylvain LE GAL (https://twitter.com/legalsylvain)
+License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl.html).
+ -->
+<odoo>
+    <!-- Odoo Rules -->
+    <record id="module_type_rule_odoo_a" model="ir.module.type.rule">
+        <field name="sequence">1</field>
+        <field name="module_domain">[('author_ids', 'ilike', 'Odoo S.A')]</field>
+        <field name="module_type_id" ref="module_type_odoo" />
+    </record>
+    <record id="module_type_rule_odoo_b" model="ir.module.type.rule">
+        <field name="sequence">2</field>
+        <field name="module_domain">[('author_ids', 'ilike', 'OpenERP SA')]</field>
+        <field name="module_type_id" ref="module_type_odoo" />
+    </record>
+    <record id="module_type_rule_odoo_c" model="ir.module.type.rule">
+        <field name="sequence">3</field>
+        <field name="module_domain">[('author_ids', '=', 'Odoo SA')]</field>
+        <field name="module_type_id" ref="module_type_odoo" />
+    </record>
+    <record id="module_type_rule_odoo_d" model="ir.module.type.rule">
+        <field name="sequence">4</field>
+        <field name="module_domain">[('author_ids', '=', 'Odoo')]</field>
+        <field name="module_type_id" ref="module_type_odoo" />
+    </record>
+    <!-- OCA Rules -->
+    <record id="module_type_rule_oca_a" model="ir.module.type.rule">
+        <field name="sequence">100</field>
+        <field
+            name="module_domain"
+        >[('author_ids', '=', 'Odoo Community Association (OCA)')]</field>
+        <field name="module_type_id" ref="module_type_oca" />
+    </record>
+</odoo>