1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2008-2009 Nexedi SA and Contributors. All Rights Reserved.
# Rafael Monnerat <rafael@nexedi.com>
# Jean-Paul Smets <jp@nexedi.com>
#
# 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
#
##############################################################################
import zope.interface
from AccessControl import ClassSecurityInfo
from Products.ERP5.Document.Predicate import Predicate
from Products.ERP5Type.DivergenceMessage import DivergenceMessage
from Products.ERP5Type import Permissions, PropertySheet, interfaces
class FloatDivergenceTester(Predicate):
"""
The purpose of this divergence tester is to check the
consistency between delivery movement and simulation movement
for some specific properties.
"""
meta_type = 'ERP5 Float Divergence Tester'
portal_type = 'Float Divergence Tester'
add_permission = Permissions.AddPortalContent
isPortalContent = 1
isRADContent = 1
# Declarative security
security = ClassSecurityInfo()
security.declareObjectProtected(Permissions.AccessContentsInformation)
# Declarative properties
property_sheets = ( PropertySheet.Base
, PropertySheet.XMLObject
, PropertySheet.CategoryCore
, PropertySheet.DublinCore
, PropertySheet.DivergenceTester
, PropertySheet.SolverSelection
)
# Declarative interfaces
zope.interface.implements( interfaces.IDivergenceTester, )
def test(self, simulation_movement):
"""
Tests if simulation_movement is divergent. Returns False (0)
or True (1).
If decision_movement is a simulation movement, use
the recorded properties instead of the native ones.
simulation_movement -- a simulation movement
"""
return self.explain(simulation_movement) is not None
def explain(self, simulation_movement):
"""
Returns a single message which explain the nature of
the divergence of simulation_movement with its related
delivery movement.
If decision_movement is a simulation movement, use
the recorded properties instead of the native ones.
simulation_movement -- a simulation movement
NOTE: this approach is incompatible with previous
API which was returning a list.
NOTE: should we provide compatibility here ?
"""
tested_property = self.getTestedProperty()
delivery_mvt = simulation_movement.getDeliveryValue()
delivery_mvt_property = delivery_mvt.getProperty(tested_property)
if simulation_movement.isPropertyRecorded(tested_property):
simulation_mvt_property = simulation_movement.getRecordedProperty(tested_property)
if isinstance(simulation_mvt_property, (list, tuple)):
simulation_mvt_property = simulation_mvt_property[0]
else:
simulation_mvt_property = simulation_movement.getProperty(tested_property)
def getErrorMessage(message, mapping):
return DivergenceMessage(
# XXX do we still need divergence_scope ?
divergence_scope='property',
object_relative_url=delivery_mvt.getRelativeUrl(),
simulation_movement=simulation_movement,
decision_value=delivery_mvt_property,
prevision_value=simulation_mvt_property,
tested_property=tested_property,
message=message,
mapping=mapping
)
delta = delivery_mvt_property - simulation_mvt_property
# XXX we should use appropriate property sheets and getter methods
# for these properties.
absolute_tolerance_min = self.getProperty('quantity_range_min') or \
self.getProperty('quantity')
if absolute_tolerance_min is not None and \
delta < absolute_tolerance_min:
return getErrorMessage(
'The difference of ${prperty_name} between decision and prevision is less than ${value}.',
dict(property_name=tested_property,
value=absolute_tolerance_min))
absolute_tolerance_max = self.getProperty('quantity_range_max') or \
self.getProperty('quantity')
if absolute_tolerance_max is not None and \
delta > absolute_tolerance_max:
return getErrorMessage(
'The difference of ${prperty_name} between decision and prevision is larger than ${value}.',
dict(property_name=tested_property,
value=absolute_tolerance_max))
tolerance_base = self.getProperty('tolerance_base')
if tolerance_base == 'currency_precision':
try:
precision = simulation_movement.getSectionValue().getPriceCurrencyValue().getQuantityPrecision()
base = 10 ** -precision
except AttributeError:
base = None
elif tolerance_base == 'quantity':
base = simulation_mvt_property
else:
base = None
if base is not None:
relative_tolerance_min = self.getProperty('tolerance_range_min') or \
self.getProperty('tolerance')
if relative_tolerance_min is not None and \
delta < relative_tolerance_min * base:
if tolerance_base == 'price_currency':
return getErrorMessage(
'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the currency precision.',
dict(property_name=tested_property,
value=relative_tolerance_min))
else:
return getErrorMessage(
'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the prevision value.',
dict(property_name=tested_property,
value=relative_tolerance_min))
relative_tolerance_max = self.getProperty('tolerance_range_max') or \
self.getProperty('tolerance')
if relative_tolerance_max is not None and \
delta < relative_tolerance_max * base:
if tolerance_base == 'price_currency':
return getErrorMessage(
'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the currency precision.',
dict(property_name=tested_property,
value=relative_tolerance_max))
else:
return getErrorMessage(
'The difference of ${prperty_name} between decision and prevision is less than ${value} times of the prevision value.',
dict(property_name=tested_property,
value=relative_tolerance_max))
# XXX the followings are not treated yet:
# * decimal_alignment_enabled
# * decimal_rounding_option
# * decimal_exponent
def generateHashKey(self, movement):
"""
Returns a hash key which can be used to optimise the
matching algorithm between movements. The purpose
of this hash key is to reduce the size of lists of
movements which need to be compared using the compare
method (quadratic complexity).
If decision_movement is a simulation movement, use
the recorded properties instead of the native ones.
"""
raise NotImplementedError
def compare(self, prevision_movement, decision_movement):
"""
Returns True if simulation_movement and delivery_movement
match. Returns False else. The method is asymmetric and
the order of parameter matters. For example, a sourcing
rule may use a tester which makes sure that movements are
delivered no sooner than 2 weeks before production but
no later than the production date.
If decision_movement is a simulation movement, use
the recorded properties instead of the native ones.
prevision_movement -- a simulation movement (prevision)
decision_movement -- a delivery movement (decision)
"""
raise NotImplementedError
def update(self, prevision_movement, decision_movement):
"""
Updates decision_movement with properties from
prevision_movement so that next call to
compare returns True. This method is normally
invoked to copy properties from simulation movements
to delivery movements. It is also invoked to copy
properties from temp simulation movements of
Aggregated Amount Lists to pre-existing simulation
movements.
If decision_movement is a simulation movement, then
do not update recorded properties.
prevision_movement -- a simulation movement (prevision)
decision_movement -- a delivery movement (decision)
NOTE: recorded (forced) properties are not updated by
expand.
NOTE2: it is still unknown how to update properties from
a simulation movement to the relevant level of
delivery / line / cell.
"""
raise NotImplementedError
def accept(self, simulation_movement):
"""
Copies the properties handled by the divergence tester
from the related delivery movement to simulation_movement.
NOTE: the future existence of this method is still unknown
because it is likely to be implemented in TargetSolver
instead.
"""
raise NotImplementedError
def adopt(self, simulation_movement):
"""
Copies the properties handled by the divergence tester
from simulation_movement to the related delivery movement
NOTE: the future existence of this method is still unknown
because it is likely to be implemented in TargetSolver
instead.
"""
raise NotImplementedError