[REF] sale_margin_delivered: Preparate module to Dropshipping compati…

…bility
OCA · rrebollo · Jul 9, 2018 · Nov 13, 2018 · Jan 14, 2019 · Apr 15, 2019
commit fe8825f322966d76fa07696fb49399ddb0989526
diff --git a/sale_margin_delivered/README.rst b/sale_margin_delivered/README.rst
@@ -30,11 +30,23 @@ Sale Margin Delivered
 
 Computes sale order lines margins for the delivered items.
 
+This module takes in consideration Outgoing and Returns.
+
 **Table of contents**
 
 .. contents::
    :local:
 
+Use Cases / Context
+===================
+
+This module has been developed to be able to show delivered margins on sale order lines.
+
+If you need this module for those reasons, these might interest you too:
+
+- sale_margin_delivered_dropshipping
+- sale_report_delivered
+
 Configuration
 =============
 
@@ -111,10 +123,13 @@ promote its widespread use.
 .. |maintainer-sergio-teruel| image:: https://github.com/sergio-teruel.png?size=40px
     :target: https://github.com/sergio-teruel
     :alt: sergio-teruel
+.. |maintainer-Shide| image:: https://github.com/Shide.png?size=40px
+    :target: https://github.com/Shide
+    :alt: Shide
 
-Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
+Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
 
-|maintainer-sergio-teruel| 
+|maintainer-sergio-teruel| |maintainer-Shide| 
 
 This module is part of the `OCA/margin-analysis <https://github.com/OCA/margin-analysis/tree/16.0/sale_margin_delivered>`_ project on GitHub.
 

diff --git a/sale_margin_delivered/__manifest__.py b/sale_margin_delivered/__manifest__.py
@@ -11,5 +11,5 @@
     "data": ["views/sale_margin_delivered_view.xml"],
     "installable": True,
     "development_status": "Production/Stable",
-    "maintainers": ["sergio-teruel"],
+    "maintainers": ["sergio-teruel", "Shide"],
 }
diff --git a/sale_margin_delivered/i18n/es.po b/sale_margin_delivered/i18n/es.po
@@ -6,8 +6,8 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Odoo Server 16.0\n"
 "Report-Msgid-Bugs-To: \n"
-"POT-Creation-Date: 2024-06-14 12:15+0000\n"
-"PO-Revision-Date: 2024-06-14 14:17+0200\n"
+"POT-Creation-Date: 2024-06-19 07:32+0000\n"
+"PO-Revision-Date: 2024-06-19 09:33+0200\n"
 "Last-Translator: \n"
 "Language-Team: \n"
 "Language: es\n"
@@ -22,11 +22,19 @@ msgstr ""
 msgid ""
 "Average Unit Cost of delivered products.\n"
 "\n"
-"Formula: Value Delivered / Quantity Delivered"
+"Formula: Value Delivered / Quantity Delivered\n"
+"\n"
+"When using the FIFO method, the value of this field may not match the actual cost of the product delivered.\n"
+"There may also be differences with the costing of the Sales from Deliveries report, because when the sales order is created, it is not known exactly which units will actually be delivered to calculate their cost.\n"
+"This is because when the sales order is created, it is not known which units will actually be delivered to calculate their actual cost. You do not have this information until you validate the corresponding delivery note."
 msgstr ""
 "Promedio del Coste Unitario de los productos entregados.\n"
 "\n"
-"Fórmula: Valor entregado / Cantidad Entregada"
+"Fórmula: Valor entregado / Cantidad Entregada\n"
+"\n"
+"Cuando se usa el método FIFO el valor de este campo puede no coincidir con el coste real del producto entregado.\n"
+"Puede haber también diferencias con el cálculo del coste del informe \"Ventas desde albaranes\".\n"
+"El motivo es que al hacer el pedido de venta no se sabe todavía qué unidades serán las realmente entregadas para calcular su coste real. No se tendrá este dato hasta validar el albarán de entrega correspondiente."
 
 #. module: sale_margin_delivered
 #: model_terms:ir.ui.view,arch_db:sale_margin_delivered.view_order_form

diff --git a/sale_margin_delivered/i18n/sale_margin_delivered.pot b/sale_margin_delivered/i18n/sale_margin_delivered.pot
@@ -6,6 +6,8 @@ msgid ""
 msgstr ""
 "Project-Id-Version: Odoo Server 16.0\n"
 "Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: 2024-06-19 07:32+0000\n"
+"PO-Revision-Date: 2024-06-19 07:32+0000\n"
 "Last-Translator: \n"
 "Language-Team: \n"
 "MIME-Version: 1.0\n"
@@ -18,7 +20,11 @@ msgstr ""
 msgid ""
 "Average Unit Cost of delivered products.\n"
 "\n"
-"Formula: Value Delivered / Quantity Delivered"
+"Formula: Value Delivered / Quantity Delivered\n"
+"\n"
+"When using the FIFO method, the value of this field may not match the actual cost of the product delivered.\n"
+"There may also be differences with the costing of the Sales from Deliveries report, because when the sales order is created, it is not known exactly which units will actually be delivered to calculate their cost.\n"
+"This is because when the sales order is created, it is not known which units will actually be delivered to calculate their actual cost. You do not have this information until you validate the corresponding delivery note."
 msgstr ""
 
 #. module: sale_margin_delivered

diff --git a/sale_margin_delivered/models/sale_margin.py b/sale_margin_delivered/models/sale_margin.py
@@ -28,9 +28,33 @@ class SaleOrderLine(models.Model):
         compute="_compute_margin_delivered",
         store=True,
         help="Average Unit Cost of delivered products.\n\n"
-        "Formula: Value Delivered / Quantity Delivered",
+        "Formula: Value Delivered / Quantity Delivered\n\n"
+        "When using the FIFO method, the value of this field may not match the "
+        "actual cost of the product delivered.\n"
+        "There may also be differences with the costing of the Sales from "
+        "Deliveries report, because when the sales order is created, it is not known "
+        "exactly which units will actually be delivered to calculate their cost.\n"
+        "This is because when the sales order is created, it is not known which "
+        "units will actually be delivered to calculate their actual cost. You do not "
+        "have this information until you validate the corresponding delivery note.",
     )
 
+    def _get_delivered_margin_valuation_layers(self):
+        """Gets all Valuation Layers that should be considered for
+        Delivered Margin calculation."""
+        self.ensure_one()
+        valuation_layers = self.env["stock.valuation.layer"]
+        for move in self.move_ids.filtered(lambda m: m.state == "done"):
+            if move.picking_code == "outgoing":
+                # Outgoing moves have 1 valuation layer and are always negative
+                valuation_layers |= move.stock_valuation_layer_ids
+            elif move.picking_code == "incoming" and move.to_refund:
+                # Incoming moves have 2 valuation layers. Use positive one
+                valuation_layers |= move.stock_valuation_layer_ids.filtered(
+                    lambda vl: vl.quantity > 0
+                )
+        return valuation_layers
+
     @api.depends(
         "margin",
         "qty_delivered",
@@ -39,6 +63,10 @@ class SaleOrderLine(models.Model):
         "move_ids.stock_valuation_layer_ids.quantity",
     )
     def _compute_margin_delivered(self):
+        """Computes the Delivered Margin of the Lines.
+
+        It is calculated based on the Valuation Layers of each Line.
+        """
         digits = self.env["decimal.precision"].precision_get("Product Price")
         self.margin_delivered = 0.0
         self.margin_delivered_percent = 0.0
@@ -51,22 +79,11 @@ def _compute_margin_delivered(self):
                     line.price_subtotal - (price * line.qty_delivered)
                 )
                 line.purchase_price_delivery = price
-                continue
             else:
-                moves = line.move_ids.filtered(
-                    lambda x: (
-                        x.state == "done"
-                        and (
-                            x.picking_code == "outgoing"
-                            or (x.picking_code == "incoming" and x.to_refund)
-                        )
-                    )
-                )
-                # Qty and Value Delivered is negative when outgoing
-                value_delivered = sum(moves.mapped("stock_valuation_layer_ids.value"))
+                valuation_layers = line._get_delivered_margin_valuation_layers()
+                value_delivered = sum(valuation_layers.mapped("value"))
                 qty_delivered = (
-                    sum(moves.mapped("stock_valuation_layer_ids.quantity"))
-                    or -line.qty_delivered
+                    sum(valuation_layers.mapped("quantity")) or -line.qty_delivered
                 )
                 # purchase_price_delivery always will be positive because division of same signs
                 line.purchase_price_delivery = tools.float_round(

diff --git a/sale_margin_delivered/readme/CONTEXT.rst b/sale_margin_delivered/readme/CONTEXT.rst
@@ -0,0 +1,6 @@
+This module has been developed to be able to show delivered margins on sale order lines.
+
+If you need this module for those reasons, these might interest you too:
+
+- sale_margin_delivered_dropshipping
+- sale_report_delivered
diff --git a/sale_margin_delivered/readme/DESCRIPTION.rst b/sale_margin_delivered/readme/DESCRIPTION.rst
@@ -1 +1,3 @@
 Computes sale order lines margins for the delivered items.
+
+This module takes in consideration Outgoing and Returns.
diff --git a/sale_margin_delivered/static/description/index.html b/sale_margin_delivered/static/description/index.html
@@ -8,10 +8,11 @@
 
 /*
 :Author: David Goodger (goodger@python.org)
-:Id: $Id: html4css1.css 8954 2022-01-20 10:10:25Z milde $
+:Id: $Id: html4css1.css 9511 2024-01-13 09:50:07Z milde $
 :Copyright: This stylesheet has been placed in the public domain.
 
 Default cascading style sheet for the HTML output of Docutils.
+Despite the name, some widely supported CSS2 features are used.
 
 See https://docutils.sourceforge.io/docs/howto/html-stylesheets.html for how to
 customize this style sheet.
@@ -274,7 +275,7 @@
   margin-left: 2em ;
   margin-right: 2em }
 
-pre.code .ln { color: grey; } /* line numbers */
+pre.code .ln { color: gray; } /* 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 }
@@ -300,7 +301,7 @@
 span.pre {
   white-space: pre }
 
-span.problematic {
+span.problematic, pre.problematic {
   color: red }
 
 span.section-subtitle {
@@ -370,27 +371,38 @@ <h1 class="title">Sale Margin Delivered</h1>
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external image-reference" 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 image-reference" href="https://github.com/OCA/margin-analysis/tree/16.0/sale_margin_delivered"><img alt="OCA/margin-analysis" src="https://img.shields.io/badge/github-OCA%2Fmargin--analysis-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/margin-analysis-16-0/margin-analysis-16-0-sale_margin_delivered"><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/margin-analysis&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>Computes sale order lines margins for the delivered items.</p>
+<p>This module takes in consideration Outgoing and Returns.</p>
 <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="toc-entry-1">Configuration</a></li>
-<li><a class="reference internal" href="#usage" id="toc-entry-2">Usage</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>
+<li><a class="reference internal" href="#use-cases-context" id="toc-entry-1">Use Cases / Context</a></li>
+<li><a class="reference internal" href="#configuration" id="toc-entry-2">Configuration</a></li>
+<li><a class="reference internal" href="#usage" id="toc-entry-3">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-4">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-5">Credits</a><ul>
+<li><a class="reference internal" href="#authors" id="toc-entry-6">Authors</a></li>
+<li><a class="reference internal" href="#contributors" id="toc-entry-7">Contributors</a></li>
+<li><a class="reference internal" href="#maintainers" id="toc-entry-8">Maintainers</a></li>
 </ul>
 </li>
 </ul>
 </div>
+<div class="section" id="use-cases-context">
+<h1><a class="toc-backref" href="#toc-entry-1">Use Cases / Context</a></h1>
+<p>This module has been developed to be able to show delivered margins on sale order lines.</p>
+<p>If you need this module for those reasons, these might interest you too:</p>
+<ul class="simple">
+<li>sale_margin_delivered_dropshipping</li>
+<li>sale_report_delivered</li>
+</ul>
+</div>
 <div class="section" id="configuration">
-<h1><a class="toc-backref" href="#toc-entry-1">Configuration</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-2">Configuration</a></h1>
 <p>To grant Sales Margin view privileges to a user, go to <em>Settings &gt; Users &amp;
 Companies &gt; Users</em>, select the user and set <em>Show Sale Margin</em> on.</p>
 </div>
 <div class="section" id="usage">
-<h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-3">Usage</a></h1>
 <ol class="arabic simple">
 <li>Go to <em>Sales &gt; Orders &gt; Quotations</em>.</li>
 <li>Create a new <em>Sales Order</em> and add a line with an stockable product. Set a
@@ -409,23 +421,23 @@ <h1><a class="toc-backref" href="#toc-entry-2">Usage</a></h1>
 order line.</p>
 </div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-3">Bug Tracker</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-4">Bug Tracker</a></h1>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/margin-analysis/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 to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/margin-analysis/issues/new?body=module:%20sale_margin_delivered%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="#toc-entry-4">Credits</a></h1>
+<h1><a class="toc-backref" href="#toc-entry-5">Credits</a></h1>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-5">Authors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-6">Authors</a></h2>
 <ul class="simple">
 <li>Tecnativa</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-7">Contributors</a></h2>
 <ul class="simple">
 <li><a class="reference external" href="https://www.tecnativa.com">Tecnativa</a>:<ul>
 <li>Sergio Teruel</li>
@@ -439,14 +451,16 @@ <h2><a class="toc-backref" href="#toc-entry-6">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-7">Maintainers</a></h2>
+<h2><a class="toc-backref" href="#toc-entry-8">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>
+<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>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainer</a>:</p>
-<p><a class="reference external image-reference" href="https://github.com/sergio-teruel"><img alt="sergio-teruel" src="https://github.com/sergio-teruel.png?size=40px" /></a></p>
+<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
+<p><a class="reference external image-reference" href="https://github.com/sergio-teruel"><img alt="sergio-teruel" src="https://github.com/sergio-teruel.png?size=40px" /></a> <a class="reference external image-reference" href="https://github.com/Shide"><img alt="Shide" src="https://github.com/Shide.png?size=40px" /></a></p>
 <p>This module is part of the <a class="reference external" href="https://github.com/OCA/margin-analysis/tree/16.0/sale_margin_delivered">OCA/margin-analysis</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>
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		Computes sale order lines margins for the delivered items.

		This module takes in consideration Outgoing and Returns.