[entity] introduce a new 'adapters' registry
This changeset introduces the notion in adapters (as in Zope Component Architecture)
in a cubicweb way, eg using a specific registry of appobjects.
This allows nicer code structure, by avoid clutering entity classes and moving
code usually specific to a place of the ui (or something else) together with the
code that use the interface.
We don't use actual interface anymore, they are implied by adapters (which
may be abstract), whose reg id is an interface name.
Appobjects that used to 'implements(IFace)' should now be rewritten by:
* coding an IFaceAdapter(EntityAdapter) defining (implementing if desired)
the interface, usually with __regid__ = 'IFace'
* use "adaptable('IFace')" as selector instead
Also, the implements_adapter_compat decorator eases backward compatibility
with adapter's methods that may still be found on entities implementing
the interface.
Notice that unlike ZCA, we don't support automatic adapters chain (yagni?).
All interfaces defined in cubicweb have been turned into adapters, also
some new ones have been introduced to cleanup Entity / AnyEntity classes
namespace. At the end, the pluggable mixins mecanism should disappear in
favor of adapters as well.
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved.
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr
#
# This file is part of CubicWeb.
#
# CubicWeb is free software: you can redistribute it and/or modify it under the
# terms of the GNU Lesser General Public License as published by the Free
# Software Foundation, either version 2.1 of the License, or (at your option)
# any later version.
#
# CubicWeb 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 Lesser General Public License for more
# details.
#
# You should have received a copy of the GNU Lesser General Public License along
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>.
"""unittests for cw.web.formfields
"""
from logilab.common.testlib import TestCase, unittest_main, mock_object as mock
from yams.constraints import StaticVocabularyConstraint, SizeConstraint
from cubicweb.devtools import TestServerConfiguration
from cubicweb.devtools.testlib import CubicWebTC
from cubicweb.web.formwidgets import PasswordInput, TextArea, Select, Radio
from cubicweb.web.formfields import *
from cubicweb.web.views.forms import EntityFieldsForm
from cubes.file.entities import File
config = TestServerConfiguration('data')
config.bootstrap_cubes()
schema = config.load_schema()
class GuessFieldTC(TestCase):
def test_state_fields(self):
title_field = guess_field(schema['State'], schema['name'])
self.assertIsInstance(title_field, StringField)
self.assertEquals(title_field.required, True)
# synopsis_field = guess_field(schema['State'], schema['synopsis'])
# self.assertIsInstance(synopsis_field, StringField)
# self.assertIsInstance(synopsis_field.widget, TextArea)
# self.assertEquals(synopsis_field.required, False)
# self.assertEquals(synopsis_field.help, 'an abstract for this state')
description_field = guess_field(schema['State'], schema['description'])
self.assertIsInstance(description_field, RichTextField)
self.assertEquals(description_field.required, False)
self.assertEquals(description_field.format_field, None)
description_format_field = guess_field(schema['State'], schema['description_format'])
self.assertEquals(description_format_field, None)
description_format_field = guess_field(schema['State'], schema['description_format'], skip_meta_attr=False)
self.assertEquals(description_format_field.internationalizable, True)
self.assertEquals(description_format_field.sort, True)
# wikiid_field = guess_field(schema['State'], schema['wikiid'])
# self.assertIsInstance(wikiid_field, StringField)
# self.assertEquals(wikiid_field.required, False)
def test_cwuser_fields(self):
upassword_field = guess_field(schema['CWUser'], schema['upassword'])
self.assertIsInstance(upassword_field, StringField)
self.assertIsInstance(upassword_field.widget, PasswordInput)
self.assertEquals(upassword_field.required, True)
last_login_time_field = guess_field(schema['CWUser'], schema['last_login_time'])
self.assertIsInstance(last_login_time_field, DateTimeField)
self.assertEquals(last_login_time_field.required, False)
in_group_field = guess_field(schema['CWUser'], schema['in_group'])
self.assertIsInstance(in_group_field, RelationField)
self.assertEquals(in_group_field.required, True)
self.assertEquals(in_group_field.role, 'subject')
self.assertEquals(in_group_field.help, 'groups grant permissions to the user')
owned_by_field = guess_field(schema['CWUser'], schema['owned_by'], 'object')
self.assertIsInstance(owned_by_field, RelationField)
self.assertEquals(owned_by_field.required, False)
self.assertEquals(owned_by_field.role, 'object')
def test_file_fields(self):
data_format_field = guess_field(schema['File'], schema['data_format'])
self.assertEquals(data_format_field, None)
data_encoding_field = guess_field(schema['File'], schema['data_encoding'])
self.assertEquals(data_encoding_field, None)
data_name_field = guess_field(schema['File'], schema['data_name'])
self.assertEquals(data_name_field, None)
data_field = guess_field(schema['File'], schema['data'])
self.assertIsInstance(data_field, FileField)
self.assertEquals(data_field.required, True)
self.assertIsInstance(data_field.format_field, StringField)
self.assertIsInstance(data_field.encoding_field, StringField)
self.assertIsInstance(data_field.name_field, StringField)
def test_constraints_priority(self):
salesterm_field = guess_field(schema['Salesterm'], schema['reason'])
constraints = schema['reason'].rdef('Salesterm', 'String').constraints
self.assertEquals([c.__class__ for c in constraints],
[SizeConstraint, StaticVocabularyConstraint])
self.assertIsInstance(salesterm_field, StringField)
self.assertIsInstance(salesterm_field.widget, Select)
def test_bool_field_base(self):
field = guess_field(schema['CWAttribute'], schema['indexed'])
self.assertIsInstance(field, BooleanField)
self.assertEquals(field.required, False)
self.assertIsInstance(field.widget, Radio)
self.assertEquals(field.vocabulary(mock(_cw=mock(_=unicode))),
[(u'yes', '1'), (u'no', '')])
def test_bool_field_explicit_choices(self):
field = guess_field(schema['CWAttribute'], schema['indexed'],
choices=[(u'maybe', '1'), (u'no', '')])
self.assertIsInstance(field.widget, Radio)
self.assertEquals(field.vocabulary(mock(req=mock(_=unicode))),
[(u'maybe', '1'), (u'no', '')])
class MoreFieldsTC(CubicWebTC):
def test_rtf_format_field(self):
req = self.request()
req.use_fckeditor = lambda: False
e = self.vreg['etypes'].etype_class('State')(req)
form = EntityFieldsForm(req, entity=e)
description_field = guess_field(schema['State'], schema['description'])
description_format_field = description_field.get_format_field(form)
self.assertEquals(description_format_field.internationalizable, True)
self.assertEquals(description_format_field.sort, True)
# unlike below, initial is bound to form.form_field_format
self.assertEquals(description_format_field.value(form), 'text/html')
self.execute('INSERT CWProperty X: X pkey "ui.default-text-format", X value "text/rest", X for_user U WHERE U login "admin"')
self.commit()
self.assertEquals(description_format_field.value(form), 'text/rest')
class UtilsTC(TestCase):
def test_vocab_sort(self):
self.assertEquals(vocab_sort([('Z', 1), ('A', 2),
('Group 1', None), ('Y', 3), ('B', 4),
('Group 2', None), ('X', 5), ('C', 6)]),
[('A', 2), ('Z', 1),
('Group 1', None), ('B', 4), ('Y', 3),
('Group 2', None), ('C', 6), ('X', 5)]
)
if __name__ == '__main__':
unittest_main()