Merge pull request #420 from OCA/18.0

Syncing from upstream OCA/connector (18.0)

README.md

@@ -17,7 +17,13 @@ connector
 
 [//]: # (addons)
 
-This part will be replaced when running the oca-gen-addons-table script from OCA/maintainer-tools.
+Available addons
+----------------
+addon | version | maintainers | summary
+--- | --- | --- | ---
+[component](component/) | 18.0.1.0.0 | [![guewen](https://github.com/guewen.png?size=30px)](https://github.com/guewen) | Add capabilities to register and use decoupled components, as an alternative to model classes
+[component_event](component_event/) | 18.0.1.0.0 |  | Components Events
+[test_component](test_component/) | 18.0.1.0.0 | [![guewen](https://github.com/guewen.png?size=30px)](https://github.com/guewen) | Automated tests for Components, do not install.
 
 [//]: # (end addons)
 

component/README.rst

@@ -0,0 +1,167 @@
+==========
+Components
+==========
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:2785951ba7cf6288c667291264099df031ca3d90d9c79c04a2d5cddec6c85641
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png
+    :target: https://odoo-community.org/page/development-status
+    :alt: Production/Stable
+.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
+    :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
+    :alt: License: LGPL-3
+.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fconnector-lightgray.png?logo=github
+    :target: https://github.com/OCA/connector/tree/18.0/component
+    :alt: OCA/connector
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/connector-18-0/connector-18-0-component
+    :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/connector&target_branch=18.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+This module implements a component system and is a base block for the
+Connector Framework. It can be used without using the full Connector
+though.
+
+Documentation: http://odoo-connector.com/
+
+You may also want to check the `Introduction to Odoo
+Components <https://dev.to/guewen/introduction-to-odoo-components-bn0>`__
+by @guewen.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Usage
+=====
+
+As a developer, you have access to a component system. You can find the
+documentation in the code or on http://odoo-connector.com
+
+In a nutshell, you can create components:
+
+::
+
+   from odoo.addons.component.core import Component
+
+   class MagentoPartnerAdapter(Component):
+       _name = 'magento.partner.adapter'
+       _inherit = 'magento.adapter'
+
+       _usage = 'backend.adapter'
+       _collection = 'magento.backend'
+       _apply_on = ['res.partner']
+
+And later, find the component you need at runtime (dynamic dispatch at
+component level):
+
+::
+
+   def run(self, external_id):
+       backend_adapter = self.component(usage='backend.adapter')
+       external_data = backend_adapter.read(external_id)
+
+In order for tests using components to work, you will need to use the
+base class provided by \`odoo.addons.component.tests.common\`:
+
+-  TransactionComponentCase
+
+There are also some specific base classes for testing the component
+registry, using the ComponentRegistryCase as a base class. See the
+docstrings in tests/common.py.
+
+Changelog
+=========
+
+16.0.1.0.0 (2022-10-04)
+-----------------------
+
+-  [MIGRATION] from 15.0
+
+15.0.1.0.0 (2021-11-25)
+-----------------------
+
+-  [MIGRATION] from 14.0
+
+14.0.1.0.0 (2020-10-22)
+-----------------------
+
+-  [MIGRATION] from 13.0
+
+13.0.1.0.0 (2019-10-23)
+-----------------------
+
+-  [MIGRATION] from 12.0
+
+12.0.1.0.0 (2018-10-02)
+-----------------------
+
+-  [MIGRATION] from 11.0 branched at rev. 324e006
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/connector/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/connector/issues/new?body=module:%20component%0Aversion:%2018.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
+-------
+
+* Camptocamp
+
+Contributors
+------------
+
+-  Guewen Baconnier <[email protected]>
+-  Laurent Mignon <[email protected]>
+-  Simone Orsi <[email protected]>
+-  Thien Vo <[email protected]>
+
+Other credits
+-------------
+
+The migration of this module from 17.0 to 18.0 was financially supported
+by Camptocamp.
+
+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-guewen| image:: https://github.com/guewen.png?size=40px
+    :target: https://github.com/guewen
+    :alt: guewen
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-guewen| 
+
+This module is part of the `OCA/connector <https://github.com/OCA/connector/tree/18.0/component>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

component/__init__.py

@@ -0,0 +1,5 @@
+from . import core
+
+from . import components
+from . import builder
+from . import models

component/__manifest__.py

@@ -0,0 +1,22 @@
+# Copyright 2017 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+{
+    "name": "Components",
+    "summary": "Add capabilities to register and use decoupled components,"
+    " as an alternative to model classes",
+    "version": "18.0.1.0.0",
+    "author": "Camptocamp," "Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/connector",
+    "license": "LGPL-3",
+    "category": "Generic Modules",
+    "depends": ["base"],
+    "external_dependencies": {
+        "python": [
+            "cachetools",
+        ]
+    },
+    "installable": True,
+    "development_status": "Production/Stable",
+    "maintainers": ["guewen"],
+}

component/builder.py

@@ -0,0 +1,97 @@
+# Copyright 2019 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+"""
+
+Components Builder
+==================
+
+Build the components at the build of a registry.
+
+"""
+
+import odoo
+from odoo import models
+
+from .core import DEFAULT_CACHE_SIZE, ComponentRegistry, _component_databases
+
+
+class ComponentBuilder(models.AbstractModel):
+    """Build the component classes
+
+    And register them in a global registry.
+
+    Every time an Odoo registry is built, the know components are cleared and
+    rebuilt as well.  The Component classes are built using the same mechanism
+    than Odoo's Models: a final class is created, taking every Components with
+    a ``_name`` and applying Components with an ``_inherits`` upon them.
+
+    The final Component classes are registered in global registry.
+
+    This class is an Odoo model, allowing us to hook the build of the
+    components at the end of the Odoo's registry loading, using
+    ``_register_hook``. This method is called after all modules are loaded, so
+    we are sure that we have all the components Classes and in the correct
+    order.
+
+    """
+
+    _name = "component.builder"
+    _description = "Component Builder"
+
+    _components_registry_cache_size = DEFAULT_CACHE_SIZE
+
+    def _register_hook(self):
+        # This method is called by Odoo when the registry is built,
+        # so in case the registry is rebuilt (cache invalidation, ...),
+        # we have to to rebuild the components. We use a new
+        # registry so we have an empty cache and we'll add components in it.
+        components_registry = self._init_global_registry()
+        self.build_registry(components_registry)
+        components_registry.ready = True
+
+    def _init_global_registry(self):
+        components_registry = ComponentRegistry(
+            cachesize=self._components_registry_cache_size
+        )
+        _component_databases[self.env.cr.dbname] = components_registry
+        return components_registry
+
+    def build_registry(self, components_registry, states=None, exclude_addons=None):
+        if not states:
+            states = ("installed", "to upgrade")
+        # lookup all the installed (or about to be) addons and generate
+        # the graph, so we can load the components following the order
+        # of the addons' dependencies
+        graph = odoo.modules.graph.Graph()
+        graph.add_module(self.env.cr, "base")
+
+        query = "SELECT name " "FROM ir_module_module " "WHERE state IN %s "
+        params = [tuple(states)]
+        if exclude_addons:
+            query += " AND name NOT IN %s "
+            params.append(tuple(exclude_addons))
+        self.env.cr.execute(query, params)
+
+        module_list = [name for (name,) in self.env.cr.fetchall() if name not in graph]
+        graph.add_modules(self.env.cr, module_list)
+
+        for module in graph:
+            self.load_components(module.name, components_registry=components_registry)
+
+    def load_components(self, module, components_registry=None):
+        """Build every component known by MetaComponent for an odoo module
+
+        The final component (composed by all the Component classes in this
+        module) will be pushed into the registry.
+
+        :param module: the name of the addon for which we want to load
+                       the components
+        :type module: str | unicode
+        :param registry: the registry in which we want to put the Component
+        :type registry: :py:class:`~.core.ComponentRegistry`
+        """
+        components_registry = (
+            components_registry or _component_databases[self.env.cr.dbname]
+        )
+        components_registry.load_components(module)

component/components/__init__.py

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

component/components/base.py

@@ -0,0 +1,15 @@
+# Copyright 2017 Camptocamp SA
+# License LGPL-3.0 or later (http://www.gnu.org/licenses/lgpl.html)
+
+from ..core import AbstractComponent
+
+
+class BaseComponent(AbstractComponent):
+    """This is the base component for every component
+
+    It is implicitely inherited by all components.
+
+    All your base are belong to us
+    """
+
+    _name = "base"