[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.
# -*- coding: iso-8859-1 -*-
# 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/>.
"""
"""
import re
from logilab.common.testlib import unittest_main
from cubicweb.devtools.testlib import CubicWebTC
from cubicweb.sobjects.supervising import SendMailOp, SupervisionMailOp
class SupervisingTC(CubicWebTC):
def setup_database(self):
req = self.request()
req.create_entity('Card', title=u"une news !", content=u"cubicweb c'est beau")
req.create_entity('Card', title=u"une autre news !", content=u"cubicweb c'est beau")
req.create_entity('Bookmark', title=u"un signet !", path=u"view?vid=index")
req.create_entity('Comment', content=u"Yo !")
self.execute('SET C comments B WHERE B title "une autre news !", C content "Yo !"')
self.vreg.config.global_set_option('supervising-addrs', 'test@logilab.fr')
def test_supervision(self):
# do some modification
user = self.execute('INSERT CWUser X: X login "toto", X upassword "sosafe", X in_group G '
'WHERE G name "users"').get_entity(0, 0)
self.execute('SET X last_login_time NOW WHERE X eid %(x)s', {'x': user.eid})
self.execute('DELETE Card B WHERE B title "une news !"')
self.execute('SET X bookmarked_by U WHERE X is Bookmark, U eid %(x)s', {'x': user.eid})
self.execute('SET X content "duh?" WHERE X is Comment')
self.execute('DELETE X comments Y WHERE Y is Card, Y title "une autre news !"')
# check only one supervision email operation
session = self.session
sentops = [op for op in session.pending_operations
if isinstance(op, SupervisionMailOp)]
self.assertEquals(len(sentops), 1)
# check view content
op = sentops[0]
view = sentops[0]._get_view()
self.assertEquals(view.recipients(), ['test@logilab.fr'])
self.assertEquals(view.subject(), '[data supervision] changes summary')
data = view.render(changes=session.transaction_data.get('pendingchanges')).strip()
data = re.sub('#\d+', '#EID', data)
data = re.sub('/\d+', '/EID', data)
self.assertTextEquals('''user admin has made the following change(s):
* added cwuser #EID (toto)
http://testing.fr/cubicweb/cwuser/toto
* added relation in_group from cwuser #EID to cwgroup #EID
* deleted card #EID (une news !)
* added relation bookmarked_by from bookmark #EID to cwuser #EID
* updated comment #EID (#EID)
http://testing.fr/cubicweb/comment/EID
* deleted relation comments from comment #EID to card #EID''',
data)
# check prepared email
op._prepare_email()
self.assertEquals(len(op.to_send), 1)
self.assert_(op.to_send[0][0])
self.assertEquals(op.to_send[0][1], ['test@logilab.fr'])
self.commit()
# some other changes #######
user.cw_adapt_to('IWorkflowable').fire_transition('deactivate')
sentops = [op for op in session.pending_operations
if isinstance(op, SupervisionMailOp)]
self.assertEquals(len(sentops), 1)
# check view content
op = sentops[0]
view = sentops[0]._get_view()
data = view.render(changes=session.transaction_data.get('pendingchanges')).strip()
data = re.sub('#\d+', '#EID', data)
data = re.sub('/\d+', '/EID', data)
self.assertTextEquals('''user admin has made the following change(s):
* changed state of cwuser #EID (toto)
from state activated to state deactivated
http://testing.fr/cubicweb/cwuser/toto''',
data)
def test_nonregr1(self):
session = self.session
# do some unlogged modification
self.execute('SET X last_login_time NOW WHERE X eid %(x)s', {'x': session.user.eid})
self.commit() # no crash
if __name__ == '__main__':
unittest_main()