[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/>.
"""cubicweb.web.views.navigation unit tests
"""
from logilab.common.testlib import unittest_main, mock_object
from cubicweb.devtools.testlib import CubicWebTC
from cubicweb.web.views.navigation import PageNavigation, SortedNavigation
from cubicweb.web.views.ibreadcrumbs import BreadCrumbEntityVComponent
BreadCrumbEntityVComponent.visible = True
class NavigationTC(CubicWebTC):
def test_navigation_selection_whatever(self):
req = self.request()
rset = self.execute('Any X,N WHERE X name N')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
self.assertIsInstance(navcomp, PageNavigation)
req.set_search_state('W:X:Y:Z')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
self.assertIsInstance(navcomp, PageNavigation)
req.set_search_state('normal')
def test_navigation_selection_ordered(self):
req = self.request()
rset = self.execute('Any X,N ORDERBY N WHERE X name N')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
self.assertIsInstance(navcomp, SortedNavigation)
req.set_search_state('W:X:Y:Z')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
self.assertIsInstance(navcomp, SortedNavigation)
req.set_search_state('normal')
html = navcomp.render()
def test_navigation_selection_not_enough(self):
req = self.request()
rset = self.execute('Any X,N LIMIT 10 WHERE X name N')
navcomp = self.vreg['components'].select_or_none('navigation', req, rset=rset)
self.assertEquals(navcomp, None)
req.set_search_state('W:X:Y:Z')
navcomp = self.vreg['components'].select_or_none('navigation', req, rset=rset)
self.assertEquals(navcomp, None)
req.set_search_state('normal')
def test_navigation_selection_not_enough(self):
req = self.request()
rset = self.execute('Any N, COUNT(RDEF) GROUPBY N ORDERBY N WHERE RDEF relation_type RT, RT name N')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
self.assertIsInstance(navcomp, SortedNavigation)
req.set_search_state('W:X:Y:Z')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
self.assertIsInstance(navcomp, SortedNavigation)
def test_navigation_selection_wrong_boundary(self):
req = self.request()
rset = self.execute('Any X,N WHERE X name N')
req = self.request()
req.form['__start'] = 1000000
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
html = navcomp.render()
def test_sorted_navigation_1(self):
req = self.request()
rset = self.execute('Any RDEF ORDERBY RT WHERE RDEF relation_type RT')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
html = navcomp.render()
def test_sorted_navigation_2(self):
req = self.request()
rset = self.execute('Any RDEF ORDERBY RDEF WHERE RDEF relation_type RT')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
html = navcomp.render()
def test_sorted_navigation_3(self):
req = self.request()
rset = self.execute('CWAttribute RDEF ORDERBY RDEF')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
html = navcomp.render()
def test_sorted_navigation_4(self):
req = self.request()
rset = self.execute('Any RDEF ORDERBY N WHERE RDEF relation_type RT, RT name N')
navcomp = self.vreg['components'].select('navigation', req, rset=rset)
html = navcomp.render()
def test_sorted_navigation_5(self):
req = self.request()
rset = self.execute('Any N, COUNT(RDEF) GROUPBY N ORDERBY N WHERE RDEF relation_type RT, RT name N')
navcomp = self.vreg['components'].select('navigation', rset.req, rset=rset)
html = navcomp.render()
# XXX deactivate, contextual component has been removed
# class ContentNavigationTC(CubicWebTC):
# def test_component_context(self):
# view = mock_object(is_primary=lambda x: True)
# rset = self.execute('CWUser X LIMIT 1')
# req = self.request()
# objs = self.vreg['contentnavigation'].poss_visible_objects(
# req, rset=rset, view=view, context='navtop')
# # breadcrumbs should be in headers by default
# clsids = set(obj.id for obj in objs)
# self.failUnless('breadcrumbs' in clsids)
# objs = self.vreg['contentnavigation'].poss_visible_objects(
# req, rset=rset, view=view, context='navbottom')
# # breadcrumbs should _NOT_ be in footers by default
# clsids = set(obj.id for obj in objs)
# self.failIf('breadcrumbs' in clsids)
# self.execute('INSERT CWProperty P: P pkey "contentnavigation.breadcrumbs.context", '
# 'P value "navbottom"')
# # breadcrumbs should now be in footers
# req.cnx.commit()
# objs = self.vreg['contentnavigation'].poss_visible_objects(
# req, rset=rset, view=view, context='navbottom')
# clsids = [obj.id for obj in objs]
# self.failUnless('breadcrumbs' in clsids)
# objs = self.vreg['contentnavigation'].poss_visible_objects(
# req, rset=rset, view=view, context='navtop')
# clsids = [obj.id for obj in objs]
# self.failIf('breadcrumbs' in clsids)
if __name__ == '__main__':
unittest_main()