From 03ed78e7e0521384d80a4c268f3bd1416760b48b Mon Sep 17 00:00:00 2001 From: Kazuhiko Shiozaki <kazuhiko@nexedi.com> Date: Tue, 26 Jan 2010 15:48:55 +0000 Subject: [PATCH] initial implementation of the new Payment Rule. git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@31989 20353a03-c40f-0410-a6d1-a30d3c3de9de --- .../DocumentTemplateItem/PaymentRule.py | 141 ++++++++++++++++++ .../allowed_content_types.xml | 8 + .../bt/template_document_id_list | 1 + ...late_portal_type_allowed_content_type_list | 6 + 4 files changed, 156 insertions(+) create mode 100644 bt5/erp5_simulation/DocumentTemplateItem/PaymentRule.py diff --git a/bt5/erp5_simulation/DocumentTemplateItem/PaymentRule.py b/bt5/erp5_simulation/DocumentTemplateItem/PaymentRule.py new file mode 100644 index 0000000000..895cb3a822 --- /dev/null +++ b/bt5/erp5_simulation/DocumentTemplateItem/PaymentRule.py @@ -0,0 +1,141 @@ +############################################################################## +# +# Copyright (c) 2010 Nexedi SARL 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. +# +############################################################################## +""" +XXX This file is experimental for new simulation implementation, and +will replace PaymentRule. +""" + +import zope.interface +from AccessControl import ClassSecurityInfo +from Products.ERP5Type import Permissions, PropertySheet, interfaces +from Products.ERP5.Document.Predicate import Predicate +from Products.ERP5.mixin.rule import RuleMixin +from Products.ERP5.mixin.movement_collection_updater import \ + MovementCollectionUpdaterMixin +from Products.ERP5.mixin.movement_generator import MovementGeneratorMixin +from Products.ERP5.MovementCollectionDiff import _getPropertyAndCategoryList + +# XXX this class should be moved to Rule.py once new simulation is fully +# integrated. +class Rule(RuleMixin, MovementCollectionUpdaterMixin, Predicate): + # Declarative security + security = ClassSecurityInfo() + security.declareObjectProtected(Permissions.AccessContentsInformation) + + # Declarative interfaces + zope.interface.implements(interfaces.IRule, + interfaces.IDivergenceController, + interfaces.IMovementCollectionUpdater,) + + # Default Properties + property_sheets = ( + PropertySheet.Base, + PropertySheet.XMLObject, + PropertySheet.CategoryCore, + PropertySheet.DublinCore, + PropertySheet.Task, + PropertySheet.Predicate, + PropertySheet.Reference, + PropertySheet.Version, + PropertySheet.Rule + ) + + security.declareProtected(Permissions.View, 'getDivergenceList') + def getDivergenceList(self, movement): + """ + Returns a list of divergences of the movements provided + in delivery_or_movement. + + movement -- a movement, a delivery, a simulation movement, + or a list thereof + """ + if movement.getDelivery() is None: + return [] + result_list = [] + for divergence_tester in self._getDivergenceTesterList( + exclude_quantity=False): + result = divergence_tester.explain(movement) + if isinstance(result, (list, tuple)): # for compatibility + result_list.extend(result) + elif result is not None: + result_list.append(result) + return result_list + +class PaymentRule(Rule): + """ + Payment Rule generates payment simulation movement from invoice + transaction simulation movements. + """ + # CMF Type Definition + meta_type = 'ERP5 Payment Rule' + portal_type = 'Payment Rule' + + def _getMovementGenerator(self): + """ + Return the movement generator to use in the expand process + """ + return PaymentRuleMovementGenerator() + + def _getMovementGeneratorContext(self, context): + """ + Return the movement generator context to use for expand + """ + return context + + def _getMovementGeneratorMovementList(self): + """ + Return the movement lists to provide to the movement generator + """ + return [] + + def _isProfitAndLossMovement(self, movement): + # For a kind of trade rule, a profit and loss movement lacks source + # or destination. + return (movement.getSource() is None or movement.getDestination() is None) + +class PaymentRuleMovementGenerator(MovementGeneratorMixin): + def getGeneratedMovementList(self, context, movement_list=None, + rounding=False): + """ + Input movement list comes from parent. + + XXX This implementation using Business Path, not Payment Condition. + """ + ret = [] + for input_movement, business_path in self \ + ._getInputMovementAndPathTupleList(context): + kw = self._getPropertyAndCategoryList(input_movement, business_path) + kw.update({'order':None,'delivery':None}) + simulation_movement = context.newContent( + portal_type=RuleMixin.movement_type, + temp_object=True, + **kw) + ret.append(simulation_movement) + return ret + + def _getInputMovementList(self, context): + return [context.getParentValue(),] diff --git a/bt5/erp5_simulation/PortalTypeAllowedContentTypeTemplateItem/allowed_content_types.xml b/bt5/erp5_simulation/PortalTypeAllowedContentTypeTemplateItem/allowed_content_types.xml index 93ebc40153..5f08651fa6 100644 --- a/bt5/erp5_simulation/PortalTypeAllowedContentTypeTemplateItem/allowed_content_types.xml +++ b/bt5/erp5_simulation/PortalTypeAllowedContentTypeTemplateItem/allowed_content_types.xml @@ -31,6 +31,14 @@ <item>String Divergence Tester</item> <item>Variation Divergence Tester</item> </portal_type> + <portal_type id="Payment Rule"> + <item>Category Membership Divergence Tester</item> + <item>DateTime Divergence Tester</item> + <item>Float Divergence Tester</item> + <item>Net Converted Quantity Divergence Tester</item> + <item>String Divergence Tester</item> + <item>Variation Divergence Tester</item> + </portal_type> <portal_type id="Solver Process"> <item>Destination Replacement Solver</item> <item>Production Reduction Solver</item> diff --git a/bt5/erp5_simulation/bt/template_document_id_list b/bt5/erp5_simulation/bt/template_document_id_list index 70b9d11d73..ac50f95404 100644 --- a/bt5/erp5_simulation/bt/template_document_id_list +++ b/bt5/erp5_simulation/bt/template_document_id_list @@ -2,4 +2,5 @@ DeliveryRule InvoiceTransactionRule InvoicingRule OrderRule +PaymentRule TradeModelRule \ No newline at end of file diff --git a/bt5/erp5_simulation/bt/template_portal_type_allowed_content_type_list b/bt5/erp5_simulation/bt/template_portal_type_allowed_content_type_list index bf645369cb..db79a431d2 100644 --- a/bt5/erp5_simulation/bt/template_portal_type_allowed_content_type_list +++ b/bt5/erp5_simulation/bt/template_portal_type_allowed_content_type_list @@ -22,6 +22,12 @@ Order Rule | Float Divergence Tester Order Rule | Net Converted Quantity Divergence Tester Order Rule | String Divergence Tester Order Rule | Variation Divergence Tester +Payment Rule | Category Membership Divergence Tester +Payment Rule | DateTime Divergence Tester +Payment Rule | Float Divergence Tester +Payment Rule | Net Converted Quantity Divergence Tester +Payment Rule | String Divergence Tester +Payment Rule | Variation Divergence Tester Solver Process | Destination Replacement Solver Solver Process | Production Reduction Solver Solver Process | Quantity Accept Solver -- 2.30.9