Merge PR #1618 into 12.0

Signed-off-by legalsylvain

module_analysis/README.rst

@@ -0,0 +1,182 @@
+===============
+Module Analysis
+===============
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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%2Fserver--tools-lightgray.png?logo=github
+    :target: https://github.com/OCA/server-tools/tree/12.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-12-0/server-tools-12-0-module_analysis
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/149/12.0
+    :alt: Try me on Runbot
+
+|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:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/installed_modules_by_types.png
+
+For that purpose, it adds new concepts
+
+* ``ir.module.author``, based on the value ``author`` present in the manifest
+  file.
+
+.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_authors.png
+
+* ``ir.module.type``, populated by default with Odoo and OCA values.
+
+.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/module_types.png
+
+Each installed modules have extra data in the 'Technical Data' tab :
+
+.. image:: https://raw.githubusercontent.com/OCA/server-tools/12.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.
+
+    .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/default_module_type_rules.png
+
+
+You can add your custom rules to identify the modules your team have
+developped for exemple,
+
+    .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/add_module_type_rules.png
+
+
+to update the data, you have to :
+
+* Go to 'Apps' / 'Update Apps List'
+
+* Check the box 'Analyse Installed modules'
+
+    .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/base_module_update.png
+
+This will update analysis of your installed modules.
+
+
+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-block:: 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' :
+
+    .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/config_parameters.png
+
+The list of folders and filename will be exclude from the analysis.
+You can change the default settings.
+
+Usage
+=====
+
+* Go to 'Apps' / 'Module Analysis' / 'Installed module by Types'
+
+Open the stats to analyse the detail of the code installed
+
+    .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.0/module_analysis/static/description/analysis_pivot.png
+
+    .. image:: https://raw.githubusercontent.com/OCA/server-tools/12.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 smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/server-tools/issues/new?body=module:%20module_analysis%0Aversion:%2012.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.
+
+This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/12.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,2 @@
+from . import models
+from . post_init_hook import analyse_installed_modules

module_analysis/__manifest__.py

@@ -0,0 +1,34 @@
+# 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)',
+    'website': "https://github.com/OCA/server-tools/",
+    'version': '12.0.1.0.0',
+    'license': 'AGPL-3',
+    'depends': [
+        'base',
+    ],
+    'data': [
+        'security/ir.model.access.csv',
+        'views/menu.xml',
+        'views/view_base_module_update.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_config_parameter.xml',
+        'data/ir_module_type.xml',
+        'data/ir_module_type_rule.xml',
+    ],
+    'external_dependencies': {
+        'python': ['pygount'],
+    },
+    'post_init_hook': 'analyse_installed_modules',
+    'installable': True,
+}

module_analysis/data/ir_config_parameter.xml

@@ -0,0 +1,20 @@
+<?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_module_type.xml

@@ -0,0 +1,18 @@
+<?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,42 @@
+<?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>