erp5_simulation: Simple Quantity Solver

bt5/erp5_simulation/DocumentTemplateItem/portal_components/document.erp5.QuantityDeliverySolver.py

+# -*- coding: utf-8 -*-
+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsibility of assessing all potential
+# consequences resulting from its eventual inadequacies and bugs
+# End users who are looking for a ready-to-use solution with commercial
+# guarantees and support are strongly adviced to contract a Free Software
+# Service Company
+#
+# This program is Free Software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+##############################################################################
+
+import zope.interface
+from AccessControl import ClassSecurityInfo
+from Products.ERP5Type import Permissions, PropertySheet
+from Products.ERP5Type.XMLObject import XMLObject
+from erp5.component.interface.IDeliverySolver import IDeliverySolver
+
+@zope.interface.implementer(IDeliverySolver,)
+class QuantityDeliverySolver(XMLObject):
+  """
+  The Quantity solver reduces delivered quantity by reducing the quantity of
+  simulation movements from the last order.
+  """
+  meta_type = 'ERP5 Quantity Delivery Solver'
+  portal_type = 'Quantity Delivery Solver'
+  add_permission = Permissions.AddPortalContent
+  isIndexable = 0 # We do not want to fill the catalog with objects on which we need no reporting
+
+  # Declarative security
+  security = ClassSecurityInfo()
+  security.declareObjectProtected(Permissions.AccessContentsInformation)
+
+  # Default Properties
+  property_sheets = ( PropertySheet.Base
+                    , PropertySheet.XMLObject
+                    , PropertySheet.CategoryCore
+                    , PropertySheet.DublinCore
+                    , PropertySheet.DeliverySolver
+                    )
+
+  # IDeliverySolver Implementation
+  security.declareProtected(Permissions.AccessContentsInformation, 'getTotalQuantity')
+  def getTotalQuantity(self):
+    """
+      Move this to mixin
+    """
+    total_quantity = 0
+    for movement in self.getDeliveryValueList():
+      total_quantity += movement.getQuantity()
+    return total_quantity
+
+  security.declareProtected(Permissions.ModifyPortalContent, 'setTotalQuantity')
+  def setTotalQuantity(self, new_quantity, activate_kw=None):
+    """
+    Affect the difference of quantity to different simulation movements
+
+    """
+    result = []
+    remaining_quantity = self.getTotalQuantity() - new_quantity
+    simulation_movement_list = self._getSimulationMovementList()
+    for movement in simulation_movement_list:
+      movement.edit(quantity=new_quantity, activate_kw=activate_kw)
+      if remaining_quantity:
+        result.append((movement, remaining_quantity))
+    return result
+
+  def _getSimulationMovementList(self):
+    """
+    Returns a list of simulation movement sorted from the last order.
+    """
+    simulation_movement_list = self.getDeliveryValueList()
+    if len(simulation_movement_list) > 1:
+      return sorted(simulation_movement_list,
+        key=lambda x:x.getExplanationValue().getStartDate(), reverse=True)
+    else:
+      return simulation_movement_list

bt5/erp5_simulation/DocumentTemplateItem/portal_components/document.erp5.QuantityDeliverySolver.xml

+<?xml version="1.0"?>
+<ZopeData>
+  <record id="1" aka="AAAAAAAAAAE=">
+    <pickle>
+      <global name="Document Component" module="erp5.portal_type"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>default_reference</string> </key>
+            <value> <string>QuantityDeliverySolver</string> </value>
+        </item>
+        <item>
+            <key> <string>default_source_reference</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>description</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>id</string> </key>
+            <value> <string>document.erp5.QuantityDeliverySolver</string> </value>
+        </item>
+        <item>
+            <key> <string>portal_type</string> </key>
+            <value> <string>Document Component</string> </value>
+        </item>
+        <item>
+            <key> <string>sid</string> </key>
+            <value>
+              <none/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_error_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>text_content_warning_message</string> </key>
+            <value>
+              <tuple/>
+            </value>
+        </item>
+        <item>
+            <key> <string>version</string> </key>
+            <value> <string>erp5</string> </value>
+        </item>
+        <item>
+            <key> <string>workflow_history</string> </key>
+            <value>
+              <persistent> <string encoding="base64">AAAAAAAAAAI=</string> </persistent>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="2" aka="AAAAAAAAAAI=">
+    <pickle>
+      <global name="PersistentMapping" module="Persistence.mapping"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>data</string> </key>
+            <value>
+              <dictionary>
+                <item>
+                    <key> <string>component_validation_workflow</string> </key>
+                    <value>
+                      <persistent> <string encoding="base64">AAAAAAAAAAM=</string> </persistent>
+                    </value>
+                </item>
+              </dictionary>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+  <record id="3" aka="AAAAAAAAAAM=">
+    <pickle>
+      <global name="WorkflowHistoryList" module="Products.ERP5Type.Workflow"/>
+    </pickle>
+    <pickle>
+      <dictionary>
+        <item>
+            <key> <string>_log</string> </key>
+            <value>
+              <list>
+                <dictionary>
+                  <item>
+                      <key> <string>action</string> </key>
+                      <value> <string>validate</string> </value>
+                  </item>
+                  <item>
+                      <key> <string>validation_state</string> </key>
+                      <value> <string>validated</string> </value>
+                  </item>
+                </dictionary>
+              </list>
+            </value>
+        </item>
+      </dictionary>
+    </pickle>
+  </record>
+</ZopeData>

bt5/erp5_simulation/bt/template_document_id_list

@@ -3,12 +3,14 @@ document.erp5.AdoptSolver
 document.erp5.CategoryMembershipEquivalenceTester
 document.erp5.DateTimeEquivalenceTester
 document.erp5.FIFODeliverySolver
+document.erp5.FilteredCategoryMembershipEquivalenceTester
 document.erp5.FloatEquivalenceTester
 document.erp5.ItemListSplitSolver
 document.erp5.LIFODeliverySolver
 document.erp5.MinimisePriceDeliverySolver
 document.erp5.MovementSplitSolver
 document.erp5.NetConvertedQuantityEquivalenceTester
+document.erp5.QuantityDeliverySolver
 document.erp5.QuantitySplitMoveSolver
 document.erp5.QuantitySplitSolver
 document.erp5.SolverDecision
@@ -18,4 +20,3 @@ document.erp5.StringEquivalenceTester
 document.erp5.TradeModelSolver
 document.erp5.UnifySolver
 document.erp5.VariationEquivalenceTester
\ No newline at end of file
-document.erp5.FilteredCategoryMembershipEquivalenceTester