[12.0][ADD] - Add new addon: contract_forecast

contract_forecast/README.rst

@@ -0,0 +1,74 @@
+=================
+Contract Forecast
+=================
+
+.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! 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%2Fcontract-lightgray.png?logo=github
+    :target: https://github.com/OCA/contract/tree/12.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-12-0/contract-12-0-contract_forecast
+    :alt: Translate me on Weblate
+.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
+    :target: https://runbot.odoo-community.org/runbot/110/12.0
+    :alt: Try me on Runbot
+
+|badge1| |badge2| |badge3| |badge4| |badge5| 
+
+This module add the possibility to analyse contract forecast.
+
+**Table of contents**
+
+.. contents::
+   :local:
+
+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 smashing it by providing a detailed and welcomed
+`feedback <https://github.com/OCA/contract/issues/new?body=module:%20contract_forecast%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
+~~~~~~~
+
+* 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.
+
+This module is part of the `OCA/contract <https://github.com/OCA/contract/tree/12.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,20 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+{
+    "name": "Contract Forecast",
+    "description": """
+    Contract forecast""",
+    "version": "12.0.1.0.0",
+    "license": "AGPL-3",
+    "author": "ACSONE SA/NV," "Odoo Community Association (OCA)",
+    "website": "https://github.com/OCA/contract",
+    "depends": ["base", "contract", "queue_job", "product_contract"],
+    "data": [
+        "security/contract_line_forecast_period.xml",
+        "views/contract_line_forecast_period.xml",
+        "views/contract.xml",
+    ],
+    "external_dependencies": {"python": ["dateutil"]},
+    "post_init_hook": "post_init_hook",
+}

contract_forecast/hooks.py

@@ -0,0 +1,26 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+import logging
+
+from odoo import api
+from odoo.tools import SUPERUSER_ID
+
+_logger = logging.getLogger(__name__)
+
+
+def post_init_hook(cr, registry):
+    """
+    Generate contract line forecast periods
+    """
+    _logger.info(
+        "Post init hook for module post_init_hook: "
+        "Generate contract line forecast periods"
+    )
+    with api.Environment.manage():
+        env = api.Environment(cr, SUPERUSER_ID, {})
+        contract_lines = env["account.analytic.invoice.line"].search(
+            [('is_canceled', '=', False)]
+        )
+        for contract_line in contract_lines:
+            contract_line.with_delay()._generate_forecast_periods()

contract_forecast/models/__init__.py

@@ -0,0 +1,4 @@
+from . import contract
+from . import contract_line
+from . import contract_line_forecast_period
+from . import res_company

contract_forecast/models/contract.py

@@ -0,0 +1,21 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import _, api, models
+
+
+class AccountAnalyticAccount(models.Model):
+
+    _inherit = "account.analytic.account"
+
+    @api.multi
+    def action_show_contract_forecast(self):
+        self.ensure_one()
+        return {
+            "type": "ir.actions.act_window",
+            "name": _("Contract Forecast"),
+            "res_model": "contract.line.forecast.period",
+            "domain": [("contract_id", "=", self.id)],
+            "view_mode": "pivot,tree",
+            "context": self.env.context,
+        }

contract_forecast/models/contract_line.py

@@ -0,0 +1,145 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from dateutil.relativedelta import relativedelta
+from odoo import api, fields, models
+from odoo.addons.queue_job.job import job
+
+QUEUE_CHANNEL = "root.CONTRACT_FORECAST"
+
+
+class AccountAnalyticInvoiceLine(models.Model):
+
+    _inherit = "account.analytic.invoice.line"
+
+    forecast_period_ids = fields.One2many(
+        comodel_name="contract.line.forecast.period",
+        inverse_name="contract_line_id",
+        string="Forecast Periods",
+        required=False,
+    )
+
+    @api.multi
+    def _prepare_contract_line_forecast_period(
+        self, period_date_start, period_date_end, recurring_next_date
+    ):
+        self.ensure_one()
+        return {
+            "name": self._insert_markers(period_date_start, period_date_end),
+            "contract_id": self.contract_id.id,
+            "contract_line_id": self.id,
+            "product_id": self.product_id.id,
+            "date_start": period_date_start,
+            "date_end": period_date_end,
+            "date_invoice": recurring_next_date,
+            "discount": self.discount,
+            "price_unit": self.price_unit,
+            "quantity": self._get_quantity_to_invoice(
+                period_date_start, period_date_end, recurring_next_date
+            ),
+        }
+
+    @api.multi
+    def _get_contract_forecast_end_date(self):
+        self.ensure_one()
+        today = fields.Date.context_today(self)
+        return today + self.get_relative_delta(
+            self.contract_id.company_id.contract_forecast_rule_type,
+            self.contract_id.company_id.contract_forecast_interval,
+        )
+
+    @api.multi
+    def _get_generate_forecast_periods_criteria(self, period_date_end):
+        self.ensure_one()
+        if self.is_canceled or not self.active:
+            return False
+        contract_forecast_end_date = self._get_contract_forecast_end_date()
+        if not self.date_end:
+            return period_date_end <= contract_forecast_end_date
+        return (
+            period_date_end < self.date_end
+            and period_date_end <= contract_forecast_end_date
+        )
+
+    @api.multi
+    @job(default_channel=QUEUE_CHANNEL)
+    def _generate_forecast_periods(self):
+        values = []
+        for rec in self:
+            if rec.recurring_next_date:
+                last_date_invoiced = (
+                    rec.last_date_invoiced
+                    if rec.last_date_invoiced
+                    else rec.date_start
+                )
+                period_date_end = last_date_invoiced
+                recurring_next_date = rec.recurring_next_date
+                while rec._get_generate_forecast_periods_criteria(
+                    period_date_end
+                ):
+                    period_dates = rec._get_period_to_invoice(
+                        last_date_invoiced, recurring_next_date
+                    )
+                    period_date_start, period_date_end, recurring_next_date = (
+                        period_dates
+                    )
+                    values.append(
+                        rec._prepare_contract_line_forecast_period(
+                            period_date_start,
+                            period_date_end,
+                            recurring_next_date,
+                        )
+                    )
+                    last_date_invoiced = period_date_end
+                    recurring_next_date = (
+                        recurring_next_date
+                        + self.get_relative_delta(
+                            rec.recurring_rule_type, rec.recurring_interval
+                        )
+                    )
+        return self.env["contract.line.forecast.period"].create(values)
+
+    @api.multi
+    @job(default_channel=QUEUE_CHANNEL)
+    def _unlink_forecast_periods(self):
+        return self.mapped("forecast_period_ids").unlink()
+
+    @api.model
+    def create(self, values):
+        contract_lines = super(AccountAnalyticInvoiceLine, self).create(values)
+        for contract_line in contract_lines:
+            contract_line._generate_forecast_periods()
+        return contract_lines
+
+    @api.model
+    def _get_forecast_update_trigger_fields(self):
+        return [
+            "name",
+            "sequence",
+            "product_id",
+            "date_start",
+            "date_end",
+            "quantity",
+            "price_unit",
+            "discount",
+            "recurring_invoicing_type",
+            "recurring_next_date",
+            "recurring_rule_type",
+            "recurring_interval",
+            "is_canceled",
+            "active",
+        ]
+
+    @api.multi
+    def write(self, values):
+        res = super(AccountAnalyticInvoiceLine, self).write(values)
+        if any(
+            [
+                field in values
+                for field in self._get_forecast_update_trigger_fields()
+            ]
+        ):
+            for rec in self:
+                rec._unlink_forecast_periods()
+                rec._generate_forecast_periods()
+        return res

contract_forecast/models/contract_line_forecast_period.py

@@ -0,0 +1,83 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import api, fields, models
+from odoo.addons import decimal_precision as dp
+
+
+class ContractLineForecastPeriod(models.Model):
+
+    _name = "contract.line.forecast.period"
+    _description = "Contract Line Forecast Period"
+    _order = "date_invoice, sequence"
+
+    name = fields.Char(string="Name", required=True, readonly=True)
+    sequence = fields.Integer(
+        string="Sequence", related="contract_line_id.sequence", store=True
+    )
+    contract_id = fields.Many2one(
+        comodel_name="account.analytic.account",
+        string="Contract",
+        required=True,
+        readonly=True,
+        ondelete="cascade",
+        related="contract_line_id.contract_id",
+        store=True,
+        index=True,
+    )
+    contract_line_id = fields.Many2one(
+        comodel_name="account.analytic.invoice.line",
+        string="Contract Line",
+        required=True,
+        readonly=True,
+        ondelete="cascade",
+        index=True,
+    )
+    product_id = fields.Many2one(
+        comodel_name="product.product",
+        string="Product",
+        required=True,
+        readonly=True,
+        related="contract_line_id.product_id",
+        store=True,
+        index=True,
+    )
+    date_start = fields.Date(string="Date Start", required=True, readonly=True)
+    date_end = fields.Date(string="Date End", required=True, readonly=True)
+    date_invoice = fields.Date(
+        string="Invoice Date", required=True, readonly=True
+    )
+    quantity = fields.Float(default=1.0, required=True)
+    price_unit = fields.Float(string='Unit Price')
+    price_subtotal = fields.Float(
+        digits=dp.get_precision("Account"),
+        string="Amount Untaxed",
+        compute='_compute_price_subtotal',
+        store=True
+    )
+    discount = fields.Float(
+        string='Discount (%)',
+        digits=dp.get_precision('Discount'),
+        help='Discount that is applied in generated invoices.'
+        ' It should be less or equal to 100',
+    )
+    active = fields.Boolean(
+        string="Active",
+        related="contract_line_id.active",
+        store=True,
+        readonly=True,
+        default=True,
+    )
+
+    @api.multi
+    @api.depends('quantity', 'price_unit', 'discount')
+    def _compute_price_subtotal(self):
+        for line in self:
+            subtotal = line.quantity * line.price_unit
+            discount = line.discount / 100
+            subtotal *= 1 - discount
+            if line.contract_id.pricelist_id:
+                cur = line.contract_id.pricelist_id.currency_id
+                line.price_subtotal = cur.round(subtotal)
+            else:
+                line.price_subtotal = subtotal

contract_forecast/models/res_company.py

@@ -0,0 +1,16 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from odoo import fields, models
+
+
+class ResCompany(models.Model):
+
+    _inherit = "res.company"
+
+    contract_forecast_interval = fields.Integer(
+        string="Number of contract forecast Periods", default=12
+    )
+    contract_forecast_rule_type = fields.Selection(
+        [("monthly", "Month(s)"), ("yearly", "Year(s)")], default="monthly"
+    )

contract_forecast/readme/CONTRIBUTORS.rst

@@ -0,0 +1,2 @@
+* Souheil Bejaoui <souheil.bejaoui@acsone.eu>
+

contract_forecast/readme/DESCRIPTION.rst

@@ -0,0 +1 @@
+This module add the possibility to analyse contract forecast.

contract_forecast/security/contract_line_forecast_period.xml

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2019 ACSONE SA/NV
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+
+<odoo>
+
+    <record model="ir.model.access" id="contract_line_forecast_period_user_access">
+        <field name="name">contract.line.forecast.period user access</field>
+        <field name="model_id" ref="model_contract_line_forecast_period"/>
+        <field name="group_id" ref="base.group_user"/>
+        <field name="perm_read" eval="1"/>
+        <field name="perm_create" eval="1"/>
+        <field name="perm_write" eval="1"/>
+        <field name="perm_unlink" eval="1"/>
+    </record>
+
+</odoo>

contract_forecast/static/description/index.html

@@ -0,0 +1,419 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<meta name="generator" content="Docutils 0.14: http://docutils.sourceforge.net/" />
+<title>Contract Forecast</title>
+<style type="text/css">
+
+/*
+:Author: David Goodger (goodger@python.org)
+:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Copyright: This stylesheet has been placed in the public domain.
+
+Default cascading style sheet for the HTML output of Docutils.
+
+See http://docutils.sf.net/docs/howto/html-stylesheets.html for how to
+customize this style sheet.
+*/
+
+/* used to remove borders from tables and images */
+.borderless, table.borderless td, table.borderless th {
+  border: 0 }
+
+table.borderless td, table.borderless th {
+  /* Override padding for "table.docutils td" with "! important".
+     The right padding separates the table cells. */
+  padding: 0 0.5em 0 0 ! important }
+
+.first {
+  /* Override more specific margin styles with "! important". */
+  margin-top: 0 ! important }
+
+.last, .with-subtitle {
+  margin-bottom: 0 ! important }
+
+.hidden {
+  display: none }
+
+.subscript {
+  vertical-align: sub;
+  font-size: smaller }
+
+.superscript {
+  vertical-align: super;
+  font-size: smaller }
+
+a.toc-backref {
+  text-decoration: none ;
+  color: black }
+
+blockquote.epigraph {
+  margin: 2em 5em ; }
+
+dl.docutils dd {
+  margin-bottom: 0.5em }
+
+object[type="image/svg+xml"], object[type="application/x-shockwave-flash"] {
+  overflow: hidden;
+}
+
+/* Uncomment (and remove this text!) to get bold-faced definition list terms
+dl.docutils dt {
+  font-weight: bold }
+*/
+
+div.abstract {
+  margin: 2em 5em }
+
+div.abstract p.topic-title {
+  font-weight: bold ;
+  text-align: center }
+
+div.admonition, div.attention, div.caution, div.danger, div.error,
+div.hint, div.important, div.note, div.tip, div.warning {
+  margin: 2em ;
+  border: medium outset ;
+  padding: 1em }
+
+div.admonition p.admonition-title, div.hint p.admonition-title,
+div.important p.admonition-title, div.note p.admonition-title,
+div.tip p.admonition-title {
+  font-weight: bold ;
+  font-family: sans-serif }
+
+div.attention p.admonition-title, div.caution p.admonition-title,
+div.danger p.admonition-title, div.error p.admonition-title,
+div.warning p.admonition-title, .code .error {
+  color: red ;
+  font-weight: bold ;
+  font-family: sans-serif }
+
+/* Uncomment (and remove this text!) to get reduced vertical space in
+   compound paragraphs.
+div.compound .compound-first, div.compound .compound-middle {
+  margin-bottom: 0.5em }
+
+div.compound .compound-last, div.compound .compound-middle {
+  margin-top: 0.5em }
+*/
+
+div.dedication {
+  margin: 2em 5em ;
+  text-align: center ;
+  font-style: italic }
+
+div.dedication p.topic-title {
+  font-weight: bold ;
+  font-style: normal }
+
+div.figure {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+div.footer, div.header {
+  clear: both;
+  font-size: smaller }
+
+div.line-block {
+  display: block ;
+  margin-top: 1em ;
+  margin-bottom: 1em }
+
+div.line-block div.line-block {
+  margin-top: 0 ;
+  margin-bottom: 0 ;
+  margin-left: 1.5em }
+
+div.sidebar {
+  margin: 0 0 0.5em 1em ;
+  border: medium outset ;
+  padding: 1em ;
+  background-color: #ffffee ;
+  width: 40% ;
+  float: right ;
+  clear: right }
+
+div.sidebar p.rubric {
+  font-family: sans-serif ;
+  font-size: medium }
+
+div.system-messages {
+  margin: 5em }
+
+div.system-messages h1 {
+  color: red }
+
+div.system-message {
+  border: medium outset ;
+  padding: 1em }
+
+div.system-message p.system-message-title {
+  color: red ;
+  font-weight: bold }
+
+div.topic {
+  margin: 2em }
+
+h1.section-subtitle, h2.section-subtitle, h3.section-subtitle,
+h4.section-subtitle, h5.section-subtitle, h6.section-subtitle {
+  margin-top: 0.4em }
+
+h1.title {
+  text-align: center }
+
+h2.subtitle {
+  text-align: center }
+
+hr.docutils {
+  width: 75% }
+
+img.align-left, .figure.align-left, object.align-left, table.align-left {
+  clear: left ;
+  float: left ;
+  margin-right: 1em }
+
+img.align-right, .figure.align-right, object.align-right, table.align-right {
+  clear: right ;
+  float: right ;
+  margin-left: 1em }
+
+img.align-center, .figure.align-center, object.align-center {
+  display: block;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+table.align-center {
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.align-left {
+  text-align: left }
+
+.align-center {
+  clear: both ;
+  text-align: center }
+
+.align-right {
+  text-align: right }
+
+/* reset inner alignment in figures */
+div.align-right {
+  text-align: inherit }
+
+/* div.align-center * { */
+/*   text-align: left } */
+
+.align-top    {
+  vertical-align: top }
+
+.align-middle {
+  vertical-align: middle }
+
+.align-bottom {
+  vertical-align: bottom }
+
+ol.simple, ul.simple {
+  margin-bottom: 1em }
+
+ol.arabic {
+  list-style: decimal }
+
+ol.loweralpha {
+  list-style: lower-alpha }
+
+ol.upperalpha {
+  list-style: upper-alpha }
+
+ol.lowerroman {
+  list-style: lower-roman }
+
+ol.upperroman {
+  list-style: upper-roman }
+
+p.attribution {
+  text-align: right ;
+  margin-left: 50% }
+
+p.caption {
+  font-style: italic }
+
+p.credits {
+  font-style: italic ;
+  font-size: smaller }
+
+p.label {
+  white-space: nowrap }
+
+p.rubric {
+  font-weight: bold ;
+  font-size: larger ;
+  color: maroon ;
+  text-align: center }
+
+p.sidebar-title {
+  font-family: sans-serif ;
+  font-weight: bold ;
+  font-size: larger }
+
+p.sidebar-subtitle {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+p.topic-title {
+  font-weight: bold }
+
+pre.address {
+  margin-bottom: 0 ;
+  margin-top: 0 ;
+  font: inherit }
+
+pre.literal-block, pre.doctest-block, pre.math, pre.code {
+  margin-left: 2em ;
+  margin-right: 2em }
+
+pre.code .ln { color: grey; } /* line numbers */
+pre.code, code { background-color: #eeeeee }
+pre.code .comment, code .comment { color: #5C6576 }
+pre.code .keyword, code .keyword { color: #3B0D06; font-weight: bold }
+pre.code .literal.string, code .literal.string { color: #0C5404 }
+pre.code .name.builtin, code .name.builtin { color: #352B84 }
+pre.code .deleted, code .deleted { background-color: #DEB0A1}
+pre.code .inserted, code .inserted { background-color: #A3D289}
+
+span.classifier {
+  font-family: sans-serif ;
+  font-style: oblique }
+
+span.classifier-delimiter {
+  font-family: sans-serif ;
+  font-weight: bold }
+
+span.interpreted {
+  font-family: sans-serif }
+
+span.option {
+  white-space: nowrap }
+
+span.pre {
+  white-space: pre }
+
+span.problematic {
+  color: red }
+
+span.section-subtitle {
+  /* font-size relative to parent (h1..h6 element) */
+  font-size: 80% }
+
+table.citation {
+  border-left: solid 1px gray;
+  margin-left: 1px }
+
+table.docinfo {
+  margin: 2em 4em }
+
+table.docutils {
+  margin-top: 0.5em ;
+  margin-bottom: 0.5em }
+
+table.footnote {
+  border-left: solid 1px black;
+  margin-left: 1px }
+
+table.docutils td, table.docutils th,
+table.docinfo td, table.docinfo th {
+  padding-left: 0.5em ;
+  padding-right: 0.5em ;
+  vertical-align: top }
+
+table.docutils th.field-name, table.docinfo th.docinfo-name {
+  font-weight: bold ;
+  text-align: left ;
+  white-space: nowrap ;
+  padding-left: 0 }
+
+/* "booktabs" style (no vertical lines) */
+table.docutils.booktabs {
+  border: 0px;
+  border-top: 2px solid;
+  border-bottom: 2px solid;
+  border-collapse: collapse;
+}
+table.docutils.booktabs * {
+  border: 0px;
+}
+table.docutils.booktabs th {
+  border-bottom: thin solid;
+  text-align: left;
+}
+
+h1 tt.docutils, h2 tt.docutils, h3 tt.docutils,
+h4 tt.docutils, h5 tt.docutils, h6 tt.docutils {
+  font-size: 100% }
+
+ul.auto-toc {
+  list-style-type: none }
+
+</style>
+</head>
+<body>
+<div class="document" id="contract-forecast">
+<h1 class="title">Contract Forecast</h1>
+
+<!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! This file is generated by oca-gen-addon-readme !!
+!! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
+<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Beta" src="https://img.shields.io/badge/maturity-Beta-yellow.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/contract/tree/12.0/contract_forecast"><img alt="OCA/contract" src="https://img.shields.io/badge/github-OCA%2Fcontract-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/contract-12-0/contract-12-0-contract_forecast"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/110/12.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p>This module add the possibility to analyse contract forecast.</p>
+<p><strong>Table of contents</strong></p>
+<div class="contents local topic" id="contents">
+<ul class="simple">
+<li><a class="reference internal" href="#bug-tracker" id="id1">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="id2">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="id3">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="id4">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="id5">Maintainers</a></li>
+</ul>
+</li>
+</ul>
+</div>
+<div class="section" id="bug-tracker">
+<h1><a class="toc-backref" href="#id1">Bug Tracker</a></h1>
+<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/contract/issues">GitHub Issues</a>.
+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
+<a class="reference external" href="https://github.com/OCA/contract/issues/new?body=module:%20contract_forecast%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
+<p>Do not contact contributors directly about support or help with technical issues.</p>
+</div>
+<div class="section" id="credits">
+<h1><a class="toc-backref" href="#id2">Credits</a></h1>
+<div class="section" id="authors">
+<h2><a class="toc-backref" href="#id3">Authors</a></h2>
+<ul class="simple">
+<li>ACSONE SA/NV</li>
+</ul>
+</div>
+<div class="section" id="contributors">
+<h2><a class="toc-backref" href="#id4">Contributors</a></h2>
+<ul class="simple">
+<li>Souheil Bejaoui &lt;<a class="reference external" href="mailto:souheil.bejaoui&#64;acsone.eu">souheil.bejaoui&#64;acsone.eu</a>&gt;</li>
+</ul>
+</div>
+<div class="section" id="maintainers">
+<h2><a class="toc-backref" href="#id5">Maintainers</a></h2>
+<p>This module is maintained by the OCA.</p>
+<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
+<p>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.</p>
+<p>This module is part of the <a class="reference external" href="https://github.com/OCA/contract/tree/12.0/contract_forecast">OCA/contract</a> project on GitHub.</p>
+<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
+</div>
+</div>
+</div>
+</body>
+</html>

contract_forecast/tests/__init__.py

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

contract_forecast/tests/test_contract_line_forecast_period.py

@@ -0,0 +1,117 @@
+# Copyright 2019 ACSONE SA/NV
+# License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
+
+from dateutil.relativedelta import relativedelta
+
+from odoo.addons.contract.tests.test_contract import TestContractBase
+from odoo.fields import Date
+from odoo.tools import mute_logger
+
+
+class TestContractLineForecastPeriod(TestContractBase):
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def setUp(self):
+        self.env = self.env(
+            context=dict(self.env.context, test_queue_job_no_delay=True)
+        )
+        super(TestContractLineForecastPeriod, self).setUp()
+        self.line_vals["date_start"] = Date.context_today(self.acct_line)
+        self.line_vals["recurring_next_date"] = Date.context_today(
+            self.acct_line
+        )
+        self.acct_line = self.env["account.analytic.invoice.line"].create(
+            self.line_vals
+        )
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_creation(self):
+        self.acct_line.write(
+            {
+                'date_start': "2019-01-01",
+                'recurring_next_date': "2019-01-01",
+                'date_end': "2019-12-31",
+                'recurring_rule_type': "monthly",
+                'recurring_invoicing_type': 'pre-paid',
+            }
+        )
+        self.assertTrue(self.acct_line.forecast_period_ids)
+        self.assertEqual(len(self.acct_line.forecast_period_ids), 12)
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_1(self):
+        self.acct_line.write(
+            {
+                'date_start': "2019-01-01",
+                'recurring_next_date': "2019-01-01",
+                'date_end': "2019-12-31",
+                'recurring_rule_type': "yearly",
+                'recurring_invoicing_type': 'pre-paid',
+            }
+        )
+        self.assertTrue(self.acct_line.forecast_period_ids)
+        self.assertEqual(len(self.acct_line.forecast_period_ids), 1)
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_2(self):
+        self.acct_line.write(
+            {
+                'date_start': "2019-01-01",
+                'recurring_next_date': "2019-01-31",
+                'date_end': "2019-6-05",
+                'recurring_rule_type': "monthlylastday",
+                'recurring_invoicing_type': 'pre-paid',
+            }
+        )
+        self.assertTrue(self.acct_line.forecast_period_ids)
+        self.assertEqual(len(self.acct_line.forecast_period_ids), 6)
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_3(self):
+        self.assertEqual(self.acct_line.price_subtotal, 50)
+        self.acct_line.write({"price_unit": 50})
+        self.assertEqual(self.acct_line.price_subtotal, 25)
+        self.assertEqual(
+            self.acct_line.forecast_period_ids[0].price_subtotal, 25
+        )
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_4(self):
+        self.assertEqual(self.acct_line.price_subtotal, 50)
+        self.acct_line.write({"discount": 0})
+        self.assertEqual(self.acct_line.price_subtotal, 100)
+        self.assertEqual(
+            self.acct_line.forecast_period_ids[0].price_subtotal, 100
+        )
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_5(self):
+        self.acct_line.cancel()
+        self.assertFalse(self.acct_line.forecast_period_ids)
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_6(self):
+        self.acct_line.write(
+            {
+                'date_start': "2019-01-01",
+                'recurring_next_date': "2019-01-01",
+                'date_end': "2019-01-28",
+                'recurring_rule_type': "monthly",
+                'recurring_invoicing_type': 'pre-paid',
+            }
+        )
+        self.assertTrue(self.acct_line.forecast_period_ids)
+        self.assertEqual(len(self.acct_line.forecast_period_ids), 1)
+
+    @mute_logger("odoo.addons.queue_job.models.base")
+    def test_forecast_period_on_contract_line_update_6(self):
+        self.acct_line.write(
+            {
+                'date_start': "2019-01-01",
+                'recurring_next_date': "2019-02-01",
+                'date_end': "2019-01-28",
+                'recurring_rule_type': "monthly",
+                'recurring_invoicing_type': 'post-paid',
+            }
+        )
+        self.assertTrue(self.acct_line.forecast_period_ids)
+        self.assertEqual(len(self.acct_line.forecast_period_ids), 1)

contract_forecast/views/contract.xml

@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2019 ACSONE SA/NV
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+
+<odoo>
+
+    <record model="ir.ui.view" id="account_analytic_account_form_view">
+        <field name="name">account.analytic.account.form (in
+            contract_forcast)
+        </field>
+        <field name="model">account.analytic.account</field>
+        <field name="inherit_id"
+               ref="contract.account_analytic_account_recurring_form_form"/>
+        <field name="arch" type="xml">
+            <xpath expr="//div[@name='button_box']" position="inside">
+                <button class="oe_stat_button" type="object"
+                        icon="fa-area-chart"
+                        name="action_show_contract_forecast"
+                        help="Forecast">
+                    <div class="o_form_field o_stat_info">
+                        <span class="o_stat_text">Forecast
+                        </span>
+                    </div>
+                </button>
+            </xpath>
+        </field>
+    </record>
+
+
+</odoo>

contract_forecast/views/contract_line_forecast_period.xml

@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- Copyright 2019 ACSONE SA/NV
+     License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl). -->
+
+<odoo>
+
+
+    <record model="ir.ui.view" id="contract_line_forecast_period_search_view">
+        <field name="name">contract.line.forecast.period.search (in
+            contract_forecast)
+        </field>
+        <field name="model">contract.line.forecast.period</field>
+        <field name="arch" type="xml">
+            <search>
+                <field name="contract_id" string="Contract"/>
+                <group expand="0" string="Group By">
+                    <filter string="Date Start" name="groupby_date_start"
+                            context="{'group_by':'date_start'}"/>
+                    <filter string="Date End" name="groupby_date_end"
+                            context="{'group_by':'date_end'}"/>
+                    <filter string="Date Invoice" name="groupby_date_invoice"
+                            context="{'group_by':'date_invoice'}"/>
+                </group>
+            </search>
+        </field>
+    </record>
+
+    <record model="ir.ui.view" id="contract_line_forecast_period_tree_view">
+        <field name="name">contract.line.forecast.period.tree (in
+            contract_forecast)
+        </field>
+        <field name="model">contract.line.forecast.period</field>
+        <field name="arch" type="xml">
+            <tree editable="top" create="false" edit="false" delete="false">
+                <field name="name"/>
+                <field name="contract_id"/>
+                <field name="date_start"/>
+                <field name="date_end"/>
+                <field name="date_invoice"/>
+            </tree>
+        </field>
+    </record>
+
+    <record id="contract_line_forecast_period_pivot_view" model="ir.ui.view">
+        <field name="name">contract.line.forecast.period.tree (in
+            contract_forecast)
+        </field>
+        <field name="model">contract.line.forecast.period</field>
+        <field name="arch" type="xml">
+            <pivot string="Contract Forecast">
+                <field name="product_id" type="row"/>
+                <field name="date_invoice" type="col"/>
+                <field name="price_subtotal" type="measure"/>
+            </pivot>
+        </field>
+    </record>
+
+</odoo>

setup/contract_forecast/.eggs/README.txt

@@ -0,0 +1,6 @@
+This directory contains eggs that were downloaded by setuptools to build, test, and run plug-ins.
+
+This directory caches those eggs to prevent repeated downloads.
+
+However, it is safe to delete this directory.
+

setup/contract_forecast/odoo/addons/contract_forecast

@@ -0,0 +1 @@
+../../../../contract_forecast

setup/contract_forecast/setup.py

@@ -0,0 +1,6 @@
+import setuptools
+
+setuptools.setup(
+    setup_requires=['setuptools-odoo'],
+    odoo_addon=True,
+)