Commit 3d558289 authored by Arnaud Fontaine's avatar Arnaud Fontaine

Add TALES Constraint for ZODB Property Sheets and its test


git-svn-id: https://svn.erp5.org/repos/public/erp5/trunk@40847 20353a03-c40f-0410-a6d1-a30d3c3de9de
parent 570d0a7c
##############################################################################
#
# Copyright (c) 2006-2010 Nexedi SARL and Contributors. All Rights Reserved.
# Jerome Perrin <jerome@nexedi.com>
# 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
# guarantees and support are strongly advised 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 sys
from Products.ERP5Type.mixin.constraint import ConstraintMixin
from Products.ERP5Type import PropertySheet
from zLOG import LOG, PROBLEM
from ZODB.POSException import ConflictError
import Products.PageTemplates.Expressions
# this gets the CompilerError class wherever it is defined (which is
# different depending on the Zope version
CompilerError = Products.PageTemplates.Expressions.getEngine().getCompilerError()
class TALESConstraint(ConstraintMixin):
"""
This constraint uses an arbitrary TALES expression on the context of the
object; if this expression is evaluated as False, the object will be
considered in an inconsistent state.
This is only relevant for ZODB Property Sheets (filesystem Property
Sheets rely on Products.ERP5Type.Constraint.TALESConstraint
instead).
For example, if we would like to check whether the expression
'python: object.getTitle() != 'foo'' is False, then we would create
a 'TALES Constraint' within that Property Sheet and set 'Expression'
to 'python: object.getTitle() != 'foo'', then set the 'Predicate' if
necessary (known as 'condition' for filesystem Property Sheets).
For readability, please don't abuse this constraint to evaluate complex
things. If necessary, write your own constraint class.
"""
meta_type = 'ERP5 TALES Constraint'
portal_type = 'TALES Constraint'
property_sheets = (PropertySheet.SimpleItem,
PropertySheet.Predicate,
PropertySheet.Reference,
PropertySheet.TALESConstraint)
def checkConsistency(self, obj, fixit=0):
"""
Check that the Expression does not contain an error and is not
evaluated to False
"""
if not self.test(obj):
return []
expression_text = self.getExpression()
try:
if not self._getExpressionValue(obj, expression_text):
return [self._generateError(obj,
self._getMessage('message_expression_false'))]
except (ConflictError, CompilerError):
raise
except Exception, e:
LOG('ERP5Type', PROBLEM, 'TALESConstraint error on "%s" on %s' %
(expression_text, obj), error=sys.exc_info())
return [self._generateError(obj,
self._getMessage('message_expression_error'),
mapping=dict(error=str(e)))]
return []
##############################################################################
#
# 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 TALESConstraint:
"""
Define a TALES Constraint for ZODB Property Sheets
"""
_properties = (
# TALES Expression
{ 'id': 'expression',
'type': 'string',
'description' : 'TALES Expression' },
{ 'id': 'message_expression_false',
'type': 'string',
'description' : 'Error message when the Expression is false',
'default': 'Expression was false' },
{ 'id': 'message_expression_error',
'type': 'string',
'description' : 'Error message when there is an error while '\
'evaluating an Expression',
'default': 'Error while evaluating expression: ${error}' },
)
...@@ -24,3 +24,4 @@ from ContentExistenceConstraint import ContentExistenceConstraint ...@@ -24,3 +24,4 @@ from ContentExistenceConstraint import ContentExistenceConstraint
from CategoryMembershipArityConstraint import CategoryMembershipArityConstraint from CategoryMembershipArityConstraint import CategoryMembershipArityConstraint
from CategoryRelatedMembershipArityConstraint import \ from CategoryRelatedMembershipArityConstraint import \
CategoryRelatedMembershipArityConstraint CategoryRelatedMembershipArityConstraint
from TALESConstraint import TALESConstraint
...@@ -450,6 +450,15 @@ class TestZodbPropertySheet(ERP5TypeTestCase): ...@@ -450,6 +450,15 @@ class TestZodbPropertySheet(ERP5TypeTestCase):
constraint_portal_type=('Test Migration',), constraint_portal_type=('Test Migration',),
constraint_base_category=('gender',)) constraint_base_category=('gender',))
def _newTALESConstraint(self):
"""
Create a new TALES Constraint within test Property Sheet
"""
self.test_property_sheet.newContent(
reference='test_tales_constraint',
portal_type='TALES Constraint',
expression='python: object.getTitle() == "my_tales_constraint_title"')
def afterSetUp(self): def afterSetUp(self):
""" """
Create a test Property Sheet (and its properties) Create a test Property Sheet (and its properties)
...@@ -500,6 +509,9 @@ class TestZodbPropertySheet(ERP5TypeTestCase): ...@@ -500,6 +509,9 @@ class TestZodbPropertySheet(ERP5TypeTestCase):
# test Property Sheet # test Property Sheet
self._newCategoryRelatedMembershipArityConstraint() self._newCategoryRelatedMembershipArityConstraint()
# Create a TALES Constraint in the test Property Sheet
self._newTALESConstraint()
# Create all the test Properties # Create all the test Properties
for operation_type in ('change', 'delete', 'assign'): for operation_type in ('change', 'delete', 'assign'):
self._newStandardProperty(operation_type) self._newStandardProperty(operation_type)
...@@ -972,6 +984,16 @@ class TestZodbPropertySheet(ERP5TypeTestCase): ...@@ -972,6 +984,16 @@ class TestZodbPropertySheet(ERP5TypeTestCase):
self.assertEquals([], constraint.checkConsistency(self.test_module)) self.assertEquals([], constraint.checkConsistency(self.test_module))
def testTALESConstraint(self):
"""
Take the test module and check whether the TALES Constraint is
there. Until the title of Test Module has been set to the expected
value, the constraint should fail
"""
self._checkConstraint('test_tales_constraint',
self.test_module.setTitle,
'my_tales_constraint_title')
TestZodbPropertySheet = skip("ZODB Property Sheets code is not enabled yet")( TestZodbPropertySheet = skip("ZODB Property Sheets code is not enabled yet")(
TestZodbPropertySheet) TestZodbPropertySheet)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment