[19.0][MIG] contract_forecast

contract_forecast/README.rst

@@ -0,0 +1,136 @@
+.. image:: https://odoo-community.org/readme-banner-image
+   :target: https://odoo-community.org/get-involved?utm_source=readme
+   :alt: Odoo Community Association
+
+=================
+Contract Forecast
+=================
+
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! This file is generated by oca-gen-addon-readme !!
+   !! changes will be overwritten.                   !!
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:b6a80d9d2f3ccac7d2f85b5edbea96e5c5e5b115564bb079c40015a5e68eded7
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+.. |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/license-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%2Fcontract-lightgray.png?logo=github
+    :target: https://github.com/OCA/contract/tree/19.0/contract_forecast
+    :alt: OCA/contract
+.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
+    :target: https://translation.odoo-community.org/projects/contract-19-0/contract-19-0-contract_forecast
+    :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/contract&target_branch=19.0
+    :alt: Try me on Runboat
+
+|badge1| |badge2| |badge3| |badge4| |badge5|
+
+The contract_forecast module enhances the **Contract** module by
+generating and managing **forecast periods** for each contract line. It
+automatically calculates future invoicing amounts and dates, allowing
+companies to better anticipate and report on expected revenues.
+
+Forecasts are visible directly from the contract in a **pivot view** or
+**list view**.
+
+## Features
+
+- Generate forecast periods based on the contract's invoicing rules.
+- View forecasts grouped by invoice date.
+- Automatic regeneration of forecast periods when contract data changes
+  (product, quantity, price, dates, etc.).
+- Company-wide configuration to enable or disable forecasts.
+- Configurable forecast interval and period type (monthly or yearly).
+- Forecast period data includes:
+
+  - Start and end dates
+  - Expected invoice date
+  - Quantity, unit price, discount, and subtotal (untaxed)
+
+- Clean handling of auto-renewing and manually-ended contracts.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+Configuration
+=============
+
+Go **General Settings** under the **Contract Forecast** section:
+
+- **Enable Contract Forecast**: Enable or disable forecasting for the
+  company.
+- **Number of Contract Forecast Periods**: Define how many future
+  periods are generated.
+- **Forecast Period Type**: Choose between **Monthly** or **Yearly**
+  periods.
+
+Usage
+=====
+
+1. Open a **Contract**.
+2. Click on the **Forecast** button to access the generated forecast
+   periods.
+3. Forecasts can be analyzed through:
+
+   - **Pivot view** (grouped by Invoice Date)
+   - **Tree view** (detailed forecast lines)
+
+Forecast periods are regenerated automatically when relevant fields are
+modified (e.g., quantity, price, dates).
+
+Bug Tracker
+===========
+
+Bugs are tracked on `GitHub Issues <https://github.com/OCA/contract/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/contract/issues/new?body=module:%20contract_forecast%0Aversion:%2019.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
+-------
+
+* ACSONE SA/NV
+
+Contributors
+------------
+
+- Souheil Bejaoui <souheil.bejaoui@acsone.eu>
+
+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-sbejaoui| image:: https://github.com/sbejaoui.png?size=40px
+    :target: https://github.com/sbejaoui
+    :alt: sbejaoui
+
+Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+
+|maintainer-sbejaoui| 
+
+This module is part of the `OCA/contract <https://github.com/OCA/contract/tree/19.0/contract_forecast>`_ project on GitHub.
+
+You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

contract_forecast/__init__.py

@@ -0,0 +1,2 @@
+from . import models
+from .hooks import post_init_hook

contract_forecast/__manifest__.py

@@ -0,0 +1,21 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Contract Forecast",
+    "version": "19.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV,Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/contract",
+    "depends": ["contract_line_successor", "queue_job"],
+    "data": [
+        "data/queue_job_channel.xml",
+        "data/queue_job_functions.xml",
+        "security/contract_line_forecast_period.xml",
+        "views/res_config_settings.xml",
+        "views/contract_line_forecast_period.xml",
+        "views/contract.xml",
+    ],
+    "maintainers": ["sbejaoui"],
+    "post_init_hook": "post_init_hook",
+}

contract_forecast/data/queue_job_channel.xml

@@ -0,0 +1,6 @@
+<odoo>
+    <record id="contract_forecast_queue_channel" model="queue.job.channel">
+        <field name="name">CONTRACT_FORECAST</field>
+        <field name="parent_id" ref="queue_job.channel_root" />
+    </record>
+</odoo>

contract_forecast/data/queue_job_functions.xml

@@ -0,0 +1,7 @@
+<odoo>
+    <record id="job_function_generate_forecast_periods" model="queue.job.function">
+        <field name="model_id" ref="contract.model_contract_contract" />
+        <field name="method">_generate_forecast_periods</field>
+        <field name="channel_id" ref="contract_forecast_queue_channel" />
+    </record>
+</odoo>

contract_forecast/hooks.py

@@ -0,0 +1,23 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import logging
+
+_logger = logging.getLogger(__name__)
+
+
+def post_init_hook(env):
+    """Generate contract line forecast periods"""
+    _logger.info(
+        "Post init hook for module contract_forecast: "
+        "Generate contract line forecast periods"
+    )
+    offset = 0
+    while True:
+        contract_lines = env["contract.line"].search(
+            [("is_canceled", "=", False)], limit=100, offset=offset
+        )
+        contract_lines.with_delay()._generate_forecast_periods()
+        if len(contract_lines) < 100:
+            break
+        offset += 100