diff --git a/crm_exception/README.rst b/crm_exception/README.rst new file mode 100644 index 00000000..e8adda9f --- /dev/null +++ b/crm_exception/README.rst @@ -0,0 +1,101 @@ +============= +CRM Exception +============= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:364c4bbd2fab4ca9a0a3ba481b31aec7efb3fcd15f8a93bfa77ca92cb9f67d11 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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%2Fcrm-lightgray.png?logo=github + :target: https://github.com/OCA/crm/tree/16.0/crm_exception + :alt: OCA/crm +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/crm-16-0/crm-16-0-crm_exception + :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/crm&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module allows you to attach several customizable exceptions to your opportunities. +You can also define an exception rule to be applied to specific CRM stages. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +**To configure CRM exception rule:** + +#. Create a new exception rule. +#. Select "Lead" in the "Apply On" field (the 'stage_ids' field will be displayed). +#. Choose the CRM stage to which you want to apply the exception rule. +#. Specify the exception type and define the condition, then save the rule. + +**Note:** +If you don't specify a CRM stage for stage_ids (leave it blank), the rule will be checked at every stage. + +Known issues / Roadmap +====================== + +**No Exception checking in the create function.** + +Adding exception checking to the create function would trigger an Odoo Client Error +related to JavaScript (Error: Component is destroyed) when attempting to create a new opportunity +in the pipeline's kanban view and clicking the edit button. + +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 to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Quartile Limited + +Contributors +~~~~~~~~~~~~ + +* `Quartile `__: + + * Aung Ko Ko Lin + +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/crm `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/crm_exception/__init__.py b/crm_exception/__init__.py new file mode 100644 index 00000000..0650744f --- /dev/null +++ b/crm_exception/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/crm_exception/__manifest__.py b/crm_exception/__manifest__.py new file mode 100644 index 00000000..6f723b93 --- /dev/null +++ b/crm_exception/__manifest__.py @@ -0,0 +1,19 @@ +# Copyright 2023 Quartile Limited +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +{ + "name": "CRM Exception", + "version": "16.0.1.0.0", + "category": "Customer Relationship Management", + "author": "Quartile Limited, Odoo Community Association (OCA)", + "website": "https://github.com/OCA/crm", + "depends": ["crm", "base_exception"], + "license": "AGPL-3", + "data": [ + "views/crm_lead_views.xml", + "views/base_exception_views.xml", + ], + "demo": [ + "demo/crm_exception_demo.xml", + ], + "installable": True, +} diff --git a/crm_exception/demo/crm_exception_demo.xml b/crm_exception/demo/crm_exception_demo.xml new file mode 100644 index 00000000..a4164def --- /dev/null +++ b/crm_exception/demo/crm_exception_demo.xml @@ -0,0 +1,12 @@ + + + + No Customer + No Customer + 80 + crm.lead + if not self.partner_id: + failed=True + + + diff --git a/crm_exception/models/__init__.py b/crm_exception/models/__init__.py new file mode 100644 index 00000000..8b074c01 --- /dev/null +++ b/crm_exception/models/__init__.py @@ -0,0 +1,2 @@ +from . import exception_rule +from . import crm_lead diff --git a/crm_exception/models/crm_lead.py b/crm_exception/models/crm_lead.py new file mode 100644 index 00000000..c984b53c --- /dev/null +++ b/crm_exception/models/crm_lead.py @@ -0,0 +1,38 @@ +# Copyright 2023 Quartile Limited +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import api, models +from odoo.osv import expression + + +class CrmLead(models.Model): + _inherit = ["crm.lead", "base.exception"] + _name = "crm.lead" + _order = "main_exception_id asc, name desc" + + def write(self, vals): + result = super().write(vals) + # To avoid a recursive call, write() + if "exception_ids" in vals: + return result + self._check_exception() + return result + + @api.model + def _reverse_field(self): + return "crm_lead_ids" + + def _rule_domain(self): + rule_domain = super()._rule_domain() + if self.stage_id: + rule_domain = expression.AND( + [ + rule_domain, + [ + "|", + ("stage_ids", "in", tuple(self.stage_id.ids)), + ("stage_ids", "=", False), + ], + ] + ) + return rule_domain diff --git a/crm_exception/models/exception_rule.py b/crm_exception/models/exception_rule.py new file mode 100644 index 00000000..a7ab6d9e --- /dev/null +++ b/crm_exception/models/exception_rule.py @@ -0,0 +1,17 @@ +# Copyright 2023 Quartile Limited +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class ExceptionRule(models.Model): + _inherit = "exception.rule" + + crm_lead_ids = fields.Many2many(comodel_name="crm.lead", string="Opportunities") + model = fields.Selection( + selection_add=[ + ("crm.lead", "Lead"), + ], + ondelete={"crm.lead": "cascade"}, + ) + stage_ids = fields.Many2many(comodel_name="crm.stage") diff --git a/crm_exception/readme/CONFIGURE.rst b/crm_exception/readme/CONFIGURE.rst new file mode 100644 index 00000000..a9cd6d55 --- /dev/null +++ b/crm_exception/readme/CONFIGURE.rst @@ -0,0 +1,9 @@ +**To configure CRM exception rule:** + +#. Create a new exception rule. +#. Select "Lead" in the "Apply On" field (the 'stage_ids' field will be displayed). +#. Choose the CRM stage to which you want to apply the exception rule. +#. Specify the exception type and define the condition, then save the rule. + +**Note:** +If you don't specify a CRM stage for stage_ids (leave it blank), the rule will be checked at every stage. diff --git a/crm_exception/readme/CONTRIBUTORS.rst b/crm_exception/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..cd4e44ca --- /dev/null +++ b/crm_exception/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `Quartile `__: + + * Aung Ko Ko Lin diff --git a/crm_exception/readme/DESCRIPTION.rst b/crm_exception/readme/DESCRIPTION.rst new file mode 100644 index 00000000..330a13cc --- /dev/null +++ b/crm_exception/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +This module allows you to attach several customizable exceptions to your opportunities. +You can also define an exception rule to be applied to specific CRM stages. diff --git a/crm_exception/readme/ROADMAP.rst b/crm_exception/readme/ROADMAP.rst new file mode 100644 index 00000000..2eaf611d --- /dev/null +++ b/crm_exception/readme/ROADMAP.rst @@ -0,0 +1,5 @@ +**No Exception checking in the create function.** + +Adding exception checking to the create function would trigger an Odoo Client Error +related to JavaScript (Error: Component is destroyed) when attempting to create a new opportunity +in the pipeline's kanban view and clicking the edit button. diff --git a/crm_exception/readme/USAGE.rst b/crm_exception/readme/USAGE.rst new file mode 100644 index 00000000..0c37a65a --- /dev/null +++ b/crm_exception/readme/USAGE.rst @@ -0,0 +1,4 @@ +To use this module: + +Define the stage_ids in exception rules if you want to check only for a specific CRM stage. +If you don't define it, all rules related to CRM will be checked for every stage. diff --git a/crm_exception/static/description/index.html b/crm_exception/static/description/index.html new file mode 100644 index 00000000..bba5a603 --- /dev/null +++ b/crm_exception/static/description/index.html @@ -0,0 +1,446 @@ + + + + + + +CRM Exception + + + +
+

CRM Exception

+ + +

Beta License: AGPL-3 OCA/crm Translate me on Weblate Try me on Runboat

+

This module allows you to attach several customizable exceptions to your opportunities. +You can also define an exception rule to be applied to specific CRM stages.

+

Table of contents

+ +
+

Configuration

+

To configure CRM exception rule:

+
    +
  1. Create a new exception rule.
    2. +
  2. Select “Lead” in the “Apply On” field (the ‘stage_ids’ field will be displayed).
    3. +
  3. Choose the CRM stage to which you want to apply the exception rule.
    4. +
  4. Specify the exception type and define the condition, then save the rule.
    5. +
+

Note: +If you don’t specify a CRM stage for stage_ids (leave it blank), the rule will be checked at every stage.

+
+
+

Known issues / Roadmap

+

No Exception checking in the create function.

+

Adding exception checking to the create function would trigger an Odoo Client Error +related to JavaScript (Error: Component is destroyed) when attempting to create a new opportunity +in the pipeline’s kanban view and clicking the edit button.

+
+
+

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 to smash it by providing a detailed and welcomed +feedback.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Quartile Limited
    • +
+
+
+

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

+

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

+
+
+
+ + diff --git a/crm_exception/tests/__init__.py b/crm_exception/tests/__init__.py new file mode 100644 index 00000000..1db86825 --- /dev/null +++ b/crm_exception/tests/__init__.py @@ -0,0 +1 @@ +from . import test_crm_exception diff --git a/crm_exception/tests/test_crm_exception.py b/crm_exception/tests/test_crm_exception.py new file mode 100644 index 00000000..2b42d60e --- /dev/null +++ b/crm_exception/tests/test_crm_exception.py @@ -0,0 +1,48 @@ +# Copyright 2023 Quartile Limited +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo.exceptions import ValidationError +from odoo.tests import TransactionCase + + +class TestCrmLeadProbability(TransactionCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.stage_new = cls.env.ref("crm.stage_lead1") + cls.stage_qualified = cls.env.ref("crm.stage_lead2") + cls.stage_proposition = cls.env.ref("crm.stage_lead3") + cls.stage_won = cls.env.ref("crm.stage_lead4") + cls.opportunity = cls.env.ref("crm.crm_case_13") + cls.crm_exception = cls.env.ref("crm_exception.crm_excep_no_partner") + cls.crm_exception.active = True + cls.partner_id = cls.env.ref("base.res_partner_2") + + def test_crm_exception(self): + self.assertEqual(self.opportunity.stage_id, self.stage_new) + # Test exception without assigning stage_ids in exception_rule + with self.assertRaises(ValidationError): + self.opportunity.stage_id = self.stage_qualified.id + with self.assertRaises(ValidationError): + self.opportunity.stage_id = self.stage_proposition.id + with self.assertRaises(ValidationError): + self.opportunity.stage_id = self.stage_won.id + + # Test ignore_exception. + self.opportunity.ignore_exception = True + self.opportunity.stage_id = self.stage_qualified.id + self.opportunity.stage_id = self.stage_proposition.id + self.opportunity.stage_id = self.stage_won.id + + def test_crm_exception_with_stage_ids(self): + # Check exception only for qualified and won stages + self.crm_exception.write( + {"stage_ids": [(4, self.stage_qualified.id), (4, self.stage_won.id)]} + ) + with self.assertRaises(ValidationError): + self.opportunity.stage_id = self.stage_qualified.id + self.opportunity.stage_id = self.stage_proposition.id + with self.assertRaises(ValidationError): + self.opportunity.stage_id = self.stage_won.id + self.opportunity.partner_id = self.partner_id.id + self.opportunity.stage_id = self.stage_won.id diff --git a/crm_exception/views/base_exception_views.xml b/crm_exception/views/base_exception_views.xml new file mode 100644 index 00000000..9599ac56 --- /dev/null +++ b/crm_exception/views/base_exception_views.xml @@ -0,0 +1,17 @@ + + + + exception.rule.form + exception.rule + + + + + + + + diff --git a/crm_exception/views/crm_lead_views.xml b/crm_exception/views/crm_lead_views.xml new file mode 100644 index 00000000..95dc6486 --- /dev/null +++ b/crm_exception/views/crm_lead_views.xml @@ -0,0 +1,16 @@ + + + + crm.lead.form.inherit + crm.lead + + + + + + + + diff --git a/setup/crm_exception/odoo/addons/crm_exception b/setup/crm_exception/odoo/addons/crm_exception new file mode 120000 index 00000000..7b08c5ec --- /dev/null +++ b/setup/crm_exception/odoo/addons/crm_exception @@ -0,0 +1 @@ +../../../../crm_exception \ No newline at end of file diff --git a/setup/crm_exception/setup.py b/setup/crm_exception/setup.py new file mode 100644 index 00000000..28c57bb6 --- /dev/null +++ b/setup/crm_exception/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)