diff --git a/contract_forecast/README.rst b/contract_forecast/README.rst new file mode 100644 index 00000000..b85d6cac --- /dev/null +++ b/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 `_. +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 `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* ACSONE SA/NV + +Contributors +~~~~~~~~~~~~ + +* Souheil Bejaoui + + +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 `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/contract_forecast/__init__.py b/contract_forecast/__init__.py new file mode 100644 index 00000000..cc6b6354 --- /dev/null +++ b/contract_forecast/__init__.py @@ -0,0 +1,2 @@ +from . import models +from .hooks import post_init_hook diff --git a/contract_forecast/__manifest__.py b/contract_forecast/__manifest__.py new file mode 100644 index 00000000..afa38589 --- /dev/null +++ b/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", +} diff --git a/contract_forecast/hooks.py b/contract_forecast/hooks.py new file mode 100644 index 00000000..be5c513e --- /dev/null +++ b/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() diff --git a/contract_forecast/models/__init__.py b/contract_forecast/models/__init__.py new file mode 100644 index 00000000..9fd5685c --- /dev/null +++ b/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 diff --git a/contract_forecast/models/contract.py b/contract_forecast/models/contract.py new file mode 100644 index 00000000..a4ab408d --- /dev/null +++ b/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, + } diff --git a/contract_forecast/models/contract_line.py b/contract_forecast/models/contract_line.py new file mode 100644 index 00000000..f89d0080 --- /dev/null +++ b/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 diff --git a/contract_forecast/models/contract_line_forecast_period.py b/contract_forecast/models/contract_line_forecast_period.py new file mode 100644 index 00000000..56a31c62 --- /dev/null +++ b/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 diff --git a/contract_forecast/models/res_company.py b/contract_forecast/models/res_company.py new file mode 100644 index 00000000..1adbadf6 --- /dev/null +++ b/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" + ) diff --git a/contract_forecast/readme/CONTRIBUTORS.rst b/contract_forecast/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..16f45059 --- /dev/null +++ b/contract_forecast/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Souheil Bejaoui + diff --git a/contract_forecast/readme/DESCRIPTION.rst b/contract_forecast/readme/DESCRIPTION.rst new file mode 100644 index 00000000..0592fec7 --- /dev/null +++ b/contract_forecast/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module add the possibility to analyse contract forecast. \ No newline at end of file diff --git a/contract_forecast/security/contract_line_forecast_period.xml b/contract_forecast/security/contract_line_forecast_period.xml new file mode 100644 index 00000000..deb68801 --- /dev/null +++ b/contract_forecast/security/contract_line_forecast_period.xml @@ -0,0 +1,17 @@ + + + + + + + contract.line.forecast.period user access + + + + + + + + + diff --git a/contract_forecast/static/description/index.html b/contract_forecast/static/description/index.html new file mode 100644 index 00000000..2336055c --- /dev/null +++ b/contract_forecast/static/description/index.html @@ -0,0 +1,419 @@ + + + + + + +Contract Forecast + + + +
+

Contract Forecast

+ + +

Beta License: AGPL-3 OCA/contract Translate me on Weblate Try me on Runbot

+

This module add the possibility to analyse contract forecast.

+

Table of contents

+ +
+

Bug Tracker

+

Bugs are tracked on GitHub 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.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • ACSONE SA/NV
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+Odoo Community Association +

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 project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/contract_forecast/tests/__init__.py b/contract_forecast/tests/__init__.py new file mode 100644 index 00000000..60071c1e --- /dev/null +++ b/contract_forecast/tests/__init__.py @@ -0,0 +1 @@ +from . import test_contract_line_forecast_period diff --git a/contract_forecast/tests/test_contract_line_forecast_period.py b/contract_forecast/tests/test_contract_line_forecast_period.py new file mode 100644 index 00000000..c729e250 --- /dev/null +++ b/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) diff --git a/contract_forecast/views/contract.xml b/contract_forecast/views/contract.xml new file mode 100644 index 00000000..aed2940a --- /dev/null +++ b/contract_forecast/views/contract.xml @@ -0,0 +1,30 @@ + + + + + + + account.analytic.account.form (in + contract_forcast) + + account.analytic.account + + + + + + + + + + diff --git a/contract_forecast/views/contract_line_forecast_period.xml b/contract_forecast/views/contract_line_forecast_period.xml new file mode 100644 index 00000000..8fe5d85a --- /dev/null +++ b/contract_forecast/views/contract_line_forecast_period.xml @@ -0,0 +1,58 @@ + + + + + + + + contract.line.forecast.period.search (in + contract_forecast) + + contract.line.forecast.period + + + + + + + + + + + + + + contract.line.forecast.period.tree (in + contract_forecast) + + contract.line.forecast.period + + + + + + + + + + + + + contract.line.forecast.period.tree (in + contract_forecast) + + contract.line.forecast.period + + + + + + + + + + diff --git a/setup/contract_forecast/.eggs/README.txt b/setup/contract_forecast/.eggs/README.txt new file mode 100644 index 00000000..5d016688 --- /dev/null +++ b/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. + diff --git a/setup/contract_forecast/odoo/addons/contract_forecast b/setup/contract_forecast/odoo/addons/contract_forecast new file mode 120000 index 00000000..f79c4fb1 --- /dev/null +++ b/setup/contract_forecast/odoo/addons/contract_forecast @@ -0,0 +1 @@ +../../../../contract_forecast \ No newline at end of file diff --git a/setup/contract_forecast/setup.py b/setup/contract_forecast/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/contract_forecast/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)