[IMP] stock_picking_backorder_reason: Allow to cancel backorder transparently

As user does not want to have necessarily a reason wizard to cancel the backorder,
add a parameter that allows to bypass that wizard.

Author: rousseldenis

stock_picking_backorder_reason/README.rst

@@ -2,10 +2,13 @@
 Stock Picking Backorder Reason
 ==============================
 
-.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+.. 
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
    !! This file is generated by oca-gen-addon-readme !!
    !! changes will be overwritten.                   !!
    !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+   !! source digest: sha256:0f8a117f9f235fddba6560b3452a7791aeec955054a578c8ecae4e01ec899376
+   !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
     :target: https://odoo-community.org/page/development-status
@@ -19,11 +22,11 @@ Stock Picking Backorder Reason
 .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
     :target: https://translation.odoo-community.org/projects/stock-logistics-workflow-16-0/stock-logistics-workflow-16-0-stock_picking_backorder_reason
     :alt: Translate me on Weblate
-.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
-    :target: https://runbot.odoo-community.org/runbot/154/16.0
-    :alt: Try me on Runbot
+.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
+    :target: https://runboat.odoo-community.org/builds?repo=OCA/stock-logistics-workflow&target_branch=16.0
+    :alt: Try me on Runboat
 
-|badge1| |badge2| |badge3| |badge4| |badge5| 
+|badge1| |badge2| |badge3| |badge4| |badge5|
 
 This module allows to help user defining a backorder reason when it is
 launched on picking validation. This reason will be written on picking chatter level.
@@ -71,7 +74,7 @@ Bug Tracker
 
 Bugs are tracked on `GitHub Issues <https://github.com/OCA/stock-logistics-workflow/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
+If you spotted it first, help us to smash it by providing a detailed and welcomed
 `feedback <https://github.com/OCA/stock-logistics-workflow/issues/new?body=module:%20stock_picking_backorder_reason%0Aversion:%2016.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.

stock_picking_backorder_reason/models/stock_picking.py

@@ -2,6 +2,7 @@
 # License LGPL-3.0 or later (https://www.gnu.org/licenses/lgpl).
 
 from odoo import _, api, fields, models
+from odoo.fields import Command
 
 
 class StockPicking(models.Model):
@@ -41,7 +42,35 @@ def _compute_backorder_reason_strategy(self):
     def _check_backorder_reason(self):
         return self.filtered("picking_type_id.backorder_reason")
 
+    def _action_backorder_transparent_cancel(self):
+        return (
+            self.env["stock.backorder.reason.choice"]
+            .new(
+                {
+                    "picking_ids": [Command.set(self.ids)],
+                    "choice_line_ids": [
+                        Command.create({"picking_id": pick_id}) for pick_id in self.ids
+                    ],
+                }
+            )
+            .apply()
+        )
+
     def _action_backorder_reason(self, show_transfers=False):
+        if self.is_transparent_backorder_cancel:
+            return (
+                self.env["stock.backorder.reason.choice"]
+                .new(
+                    {
+                        "picking_ids": [Command.set(self.ids)],
+                        "choice_line_ids": [
+                            Command.create({"picking_id": pick_id})
+                            for pick_id in self.ids
+                        ],
+                    }
+                )
+                .apply()
+            )
         view = self.env.ref(
             "stock_picking_backorder_reason.stock_backorder_choice_view_form"
         )
@@ -60,13 +89,27 @@ def _action_backorder_reason(self, show_transfers=False):
             ),
         }
 
+    def _check_transparent_cancel(self):
+        return self.filtered(lambda p: p.is_transparent_backorder_cancel)
+
     def _pre_action_done_hook(self):
         if not self.env.context.get("skip_backorder_reason"):
             # Check if backorder is needed and then if reason is needed
             pickings_with_backorder = self._check_backorder()
+            pickings_with_transparent_cancel = self._check_transparent_cancel()
+            if pickings_with_transparent_cancel:
+                return self._action_backorder_transparent_cancel()
             pickings_with_reason = pickings_with_backorder._check_backorder_reason()
             if pickings_with_reason:
                 return pickings_with_reason._action_backorder_reason(
                     show_transfers=self._should_show_transfers()
                 )
         return super()._pre_action_done_hook()
+
+    @property
+    def is_transparent_backorder_cancel(self):
+        return bool(
+            self.picking_type_id.backorder_reason
+            and self.picking_type_id.backorder_reason_transparent_cancel
+            and self.backorder_reason_strategy == "cancel"
+        )

stock_picking_backorder_reason/models/stock_picking_type.py

@@ -27,6 +27,10 @@ class StockPickingType(models.Model):
         help="Check this in order to consider pickings in this type as "
         "Purchase ones for backorder reason cancellation.",
     )
+    backorder_reason_transparent_cancel = fields.Boolean(
+        help="If this is checked and if the partner strategy is 'Cancel', "
+        "nothing will be shown to the user and the backorder will be cancelled."
+    )
 
     @api.depends("backorder_reason")
     def _compute_backorder_reason_sale(self):

stock_picking_backorder_reason/static/description/index.html

@@ -1,20 +1,19 @@
-<?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: http://docutils.sourceforge.net/" />
+<meta name="generator" content="Docutils: https://docutils.sourceforge.io/" />
 <title>Stock Picking Backorder Reason</title>
 <style type="text/css">
 
 /*
 :Author: David Goodger ([email protected])
-:Id: $Id: html4css1.css 7952 2016-07-26 18:15:59Z milde $
+:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z 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
+See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
 */
 
@@ -366,8 +365,10 @@ <h1 class="title">Stock Picking Backorder Reason</h1>
 <!-- !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 !! This file is generated by oca-gen-addon-readme !!
 !! changes will be overwritten.                   !!
+!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+!! source digest: sha256:0f8a117f9f235fddba6560b3452a7791aeec955054a578c8ecae4e01ec899376
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
-<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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/tree/16.0/stock_picking_backorder_reason"><img alt="OCA/stock-logistics-workflow" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--workflow-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/stock-logistics-workflow-16-0/stock-logistics-workflow-16-0-stock_picking_backorder_reason"><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/154/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
+<p><a class="reference external image-reference" 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 image-reference" href="http://www.gnu.org/licenses/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/stock-logistics-workflow/tree/16.0/stock_picking_backorder_reason"><img alt="OCA/stock-logistics-workflow" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--workflow-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/stock-logistics-workflow-16-0/stock-logistics-workflow-16-0-stock_picking_backorder_reason"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/stock-logistics-workflow&amp;target_branch=16.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
 <p>This module allows to help user defining a backorder reason when it is
 launched on picking validation. This reason will be written on picking chatter level.</p>
 <p>A reason can have several backorder strategy to apply:</p>
@@ -384,19 +385,19 @@ <h1 class="title">Stock Picking Backorder Reason</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#configuration" id="id1">Configuration</a></li>
-<li><a class="reference internal" href="#known-issues-roadmap" id="id2">Known issues / Roadmap</a></li>
-<li><a class="reference internal" href="#bug-tracker" id="id3">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="id4">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="id5">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="id6">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="id7">Maintainers</a></li>
+<li><a class="reference internal" href="#configuration" id="toc-entry-1">Configuration</a></li>
+<li><a class="reference internal" href="#known-issues-roadmap" id="toc-entry-2">Known issues / Roadmap</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-3">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-4">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-5">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-6">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-7">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#id1">Configuration</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
 <ol class="arabic simple">
 <li>Go to Inventory &gt; Configuration &gt; Operation Types</li>
 <li>Select the one you want to activate the feature and check the
@@ -424,38 +425,38 @@ <h1><a class="toc-backref" href="#id1">Configuration</a></h1>
 </ol>
 </div>
 <div class="section" id="known-issues-roadmap">
-<h1><a class="toc-backref" href="#id2">Known issues / Roadmap</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Known issues / Roadmap</a></h1>
 <ul class="simple">
 <li>For the time being, options are set on wizard level. One may want to have
 the granularity on line one.</li>
 </ul>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#id3">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/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
+If you spotted it first, help us to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/issues/new?body=module:%20stock_picking_backorder_reason%0Aversion:%2016.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="#id4">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#id5">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
 <ul class="simple">
 <li>ACSONE SA/NV</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#id6">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 <ul class="simple">
 <li>Jacques-Etienne Baudoux &lt;<a class="reference external" href="mailto:je&#64;bcim.be">je&#64;bcim.be</a>&gt;</li>
 <li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt;</li>
 <li>Denis Roussel &lt;<a class="reference external" href="mailto:denis.roussel&#64;acsone.eu">denis.roussel&#64;acsone.eu</a>&gt;</li>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#id7">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">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

stock_picking_backorder_reason/tests/test_sale_backorder_reason.py

@@ -58,3 +58,15 @@ def test_sale_picking_backorder_create_backorder_partner_create(self):
         self.sale_backorder = "create"
 
         self._check_backorder_behavior()
+
+    def test_sale_picking_backorder_partner_cancel_transparent(self):
+        """
+        In this case, we test a partner that has his backorder policy
+        set to 'Cancel', the picking type activated for backorder reason
+        and the transparent action in case of cancel activated too.
+        """
+        self.picking.picking_type_id.backorder_reason_transparent_cancel = True
+        self.partner.sale_reason_backorder_strategy = "cancel"
+        result = self.picking.button_validate()
+        self.assertTrue(result is True)
+        self.assertFalse(self.picking.backorder_ids)

stock_picking_backorder_reason/views/stock_picking_type.xml

@@ -24,6 +24,10 @@
                         name="backorder_reason_purchase"
                         attrs="{'invisible': [('backorder_reason', '=', False)]}"
                     />
+                    <field
+                        name="backorder_reason_transparent_cancel"
+                        attrs="{'invisible': [('backorder_reason', '=', False)]}"
+                    />
                 </group>
             </group>
         </field>

stock_picking_backorder_reason/wizards/stock_backorder_reason_choice.py

@@ -68,23 +68,28 @@ def apply(self):
             # Set the reason on each picking
             pickings.message_post(body=wizard._get_message())
             keep_backorder_pickings = self.env["stock.picking"].browse()
-            if wizard.backorder_action_to_do == "create":
-                keep_backorder_pickings = pickings
-            elif wizard.backorder_action_to_do == "use_partner_option":
-                keep_backorder_pickings = pickings.filtered(
-                    lambda picking: picking.backorder_reason_strategy == "create"
-                )
-            elif not wizard.backorder_action_to_do:
-                # Let do the normal way
-                return pickings.with_context(
-                    skip_backorder_reason=True
-                )._pre_action_done_hook()
-            pickings_to_cancel = pickings - keep_backorder_pickings
-            if keep_backorder_pickings:
-                backorder_wizard = confirmation_obj.create(
-                    wizard._prepare_backorder_confirmation(keep_backorder_pickings)
-                )
-                backorder_wizard.with_context(skip_backorder_reason=True).process()
+            if all(
+                picking.is_transparent_backorder_cancel for picking in self.picking_ids
+            ):
+                pickings_to_cancel = self.picking_ids
+            else:
+                if wizard.backorder_action_to_do == "create":
+                    keep_backorder_pickings = pickings
+                elif wizard.backorder_action_to_do == "use_partner_option":
+                    keep_backorder_pickings = pickings.filtered(
+                        lambda picking: picking.backorder_reason_strategy == "create"
+                    )
+                elif not wizard.backorder_action_to_do:
+                    # Let do the normal way
+                    return pickings.with_context(
+                        skip_backorder_reason=True
+                    )._pre_action_done_hook()
+                pickings_to_cancel = pickings - keep_backorder_pickings
+                if keep_backorder_pickings:
+                    backorder_wizard = confirmation_obj.create(
+                        wizard._prepare_backorder_confirmation(keep_backorder_pickings)
+                    )
+                    backorder_wizard.with_context(skip_backorder_reason=True).process()
 
             if pickings_to_cancel:
                 backorder_wizard = confirmation_obj.with_context(