Add Resource Measures Consistency Constraint for ZODB Property Sheets

git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@40898 20353a03-c40f-0410-a6d1-a30d3c3de9de

product/ERP5/Document/ResourceMeasuresConsistencyConstraint.py

+##############################################################################
+#
+# Copyright (c) 2008 Nexedi SA and Contributors. All Rights Reserved.
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability 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
+# garantees 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.
+#
+##############################################################################
+
+from Products.ERP5Type.mixin.constraint import ConstraintMixin
+from Products.ERP5Type import PropertySheet
+
+class ResourceMeasuresConsistencyConstraint(ConstraintMixin):
+  """
+  Check that measures defined on a resource are not meaningless.
+
+  Choosing quantity units for a resource without defining measures is
+  tolerated, for compatibility, although conversion between units
+  won't be possible.
+
+  This is only relevant for ZODB Property Sheets (filesystem Property
+  Sheets rely on Products.ERP5.Constraint.ResourceMeasuresConsistency
+  instead).
+  """
+  meta_type = 'ERP5 Resource Measures Consistency Constraint'
+  portal_type = 'Resource Measures Consistency Constraint'
+
+  property_sheets = (PropertySheet.SimpleItem,
+                     PropertySheet.Predicate,
+                     PropertySheet.Reference,
+                     PropertySheet.ResourceMeasuresConsistencyConstraint)
+
+  def checkConsistency(self, obj, fixit=0):
+    """
+    Check the object's consistency
+    """
+    if not self.test(obj):
+      return []
+
+    error_list = []
+    portal = obj.getPortalObject()
+
+    error = lambda msg, **kw: error_list.append(
+      self._generateError(obj, self._getMessage(msg), mapping=kw))
+
+    getCategoryValue = portal.portal_categories.getCategoryValue
+    display = lambda *args, **kw: \
+      getCategoryValue(*args, **kw).getCompactLogicalPath()
+
+    top = lambda relative_url: relative_url.split('/', 1)[0]
+
+    quantity_map = {}
+    metric_type_set = set()
+
+    for measure in obj.getMeasureList():
+      metric_type = measure.getMetricType()
+      if metric_type:
+        quantity = top(metric_type)
+        default_or_generic = quantity_map.setdefault(quantity, [0, 0])
+        if measure.getDefaultMetricType():
+          default_or_generic[0] += 1
+        if quantity == metric_type:
+          default_or_generic[1] += 1
+
+        if not measure.getConvertedQuantityUnit():
+          error('message_measure_no_quantity_unit',
+                metric_type=display(metric_type, 'metric_type'))
+        elif not measure.asCatalogRowList():
+          error('message_measure_no_quantity',
+                metric_type=display(metric_type, 'metric_type'))
+        if metric_type in metric_type_set:
+          error('message_duplicate_metric_type',
+                metric_type=display(metric_type, 'metric_type'))
+        else:
+          metric_type_set.add(metric_type)
+      #else:
+      # pass # we don't care about undefined measures
+
+    for i, quantity_unit in enumerate(obj.getQuantityUnitList()):
+      quantity = top(quantity_unit)
+      default, generic = quantity_map.get(quantity, (0, 0))
+      if (default or generic) > 1:
+        error('message_duplicate_default_measure',
+              quantity_unit=display(quantity_unit, 'quantity_unit'))
+      elif not (default or generic):
+        if i:
+          pass # tolerate quantity units without any measure associated to them
+        else: # management unit: check we can create an implicit measure
+          if getCategoryValue(quantity, 'metric_type') is None:
+            error('message_missing_metric_type', metric_type=quantity)
+
+    return error_list

product/ERP5/PropertySheet/ResourceMeasuresConsistencyConstraint.py

+##############################################################################
+#
+# Copyright (c) 2010 Nexedi SARL and Contributors. All Rights Reserved.
+#                    Arnaud Fontaine <arnaud.fontaine@nexedi.com>
+#
+# WARNING: This program as such is intended to be used by professional
+# programmers who take the whole responsability 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
+# garantees 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.
+#
+##############################################################################
+
+class ResourceMeasuresConsistencyConstraint:
+    """
+    Define an Resource Measures Consistency Constraint for ZODB
+    Property Sheets
+    """
+    _properties = (
+        {   'id': 'message_measure_no_quantity_unit',
+            'type': 'string',
+            'description' : "Error message when the measure doesn't have a "\
+                            "valid quantity_unit",
+            'default': "Measure for metric_type '${metric_type}' doesn't "\
+                       "have a valid quantity_unit" },
+        {   'id': 'message_measure_no_quantity',
+            'type': 'string',
+            'description' : "Error message when the measure doesn't have a "\
+                            "valid quantity value",
+            'default': "Measure for metric_type '${metric_type}' doesn't "\
+                       "have a valid quantity value" },
+        {   'id': 'message_duplicate_metric_type',
+            'type': 'string',
+            'description' : 'Error message when several measures have the '\
+                            'same metric_type',
+            'default': "Several measures have the same metric_type "\
+                       "'${metric_type}'" },
+        {   'id': 'message_duplicate_default_measure',
+            'type': 'string',
+            'description' : 'Error message when several measures are '\
+                            'associated to the same unit',
+            'default': "Several measures are associated to the same unit "\
+                       "'${quantity_unit}'" },
+        {   'id': 'message_missing_metric_type',
+            'type': 'string',
+            'description' : "Error message when the metric category doesn't "\
+                            "exist",
+            'default': "Implicit measure for the management unit can't be "\
+                       "created because 'metric_type/${metric_type}' "\
+                       "category doesn't exist" },
+        )