Less magical templated view model: make custom template views responsible for

knowing their template's name.

4 files changed, 232 insertions, 87 deletions

diff --git a/repoze/bfg/tests/fixtureapp/configure.zcml b/repoze/bfg/tests/fixtureapp/configure.zcml
index 0e91afbc0..f08cd58ad 100644
--- a/repoze/bfg/tests/fixtureapp/configure.zcml
+++ b/repoze/bfg/tests/fixtureapp/configure.zcml
@@ -1,14 +1,20 @@
 <configure xmlns="http://namespaces.zope.org/zope"
-    xmlns:browser="http://namespaces.repoze.org/browser"
+    xmlns:bfg="http://namespaces.repoze.org/bfg"
 	           i18n_domain="repoze.bfg">
 
   <include package="repoze.bfg" />
 
-  <browser:page
+  <bfg:view
+      for=".models.IFixture"
+      factory=".views.FixtureView"
+      permission="repoze.view"
+      />
+
+  <bfg:view
       for=".models.IFixture"
-      class=".views.FixtureView"
       template="templates/fixture.pt"
       permission="repoze.view"
+      name="fixture.html"
       />
 
 </configure>
diff --git a/repoze/bfg/tests/test_template.py b/repoze/bfg/tests/test_template.py
index 322810fb4..59dce3efa 100644
--- a/repoze/bfg/tests/test_template.py
+++ b/repoze/bfg/tests/test_template.py
@@ -19,8 +19,7 @@ class Base(PlacelessSetup):
         here = os.path.abspath(os.path.dirname(__file__))
         return os.path.join(here, 'fixtures', name)
         
-
-class PageTemplateFileTests(unittest.TestCase, Base):
+class Z3CPTTemplateFactoryTests(unittest.TestCase, Base):
     def setUp(self):
         Base.setUp(self)
 
@@ -28,76 +27,90 @@ class PageTemplateFileTests(unittest.TestCase, Base):
         Base.tearDown(self)
 
     def _getTargetClass(self):
-        from repoze.bfg.template import PageTemplateFile
-        return PageTemplateFile
+        from repoze.bfg.template import Z3CPTTemplateFactory
+        return Z3CPTTemplateFactory
 
     def _makeOne(self, *arg, **kw):
         klass = self._getTargetClass()
         return klass(*arg, **kw)
 
-    def test_render(self):
+    def test_instance_conforms_to_IView(self):
+        from zope.interface.verify import verifyObject
+        from repoze.bfg.interfaces import IView
+        path = self._getTemplatePath('minimal.pt')
+        verifyObject(IView, self._makeOne(path))
+
+    def test_class_conforms_to_IView(self):
+        from zope.interface.verify import verifyClass
+        from repoze.bfg.interfaces import IView
+        verifyClass(IView, self._getTargetClass())
+
+    def test_class_conforms_to_ITemplateFactory(self):
+        from zope.interface.verify import verifyObject
+        from repoze.bfg.interfaces import ITemplateFactory
+        verifyObject(ITemplateFactory, self._getTargetClass())
+
+    def test_call(self):
         self._zcmlConfigure()
         minimal = self._getTemplatePath('minimal.pt')
         instance = self._makeOne(minimal)
-        result = instance.render()
+        result = instance()
         from webob import Response
         self.failUnless(isinstance(result, Response))
         self.assertEqual(result.app_iter, ['<div>\n</div>'])
         self.assertEqual(result.status, '200 OK')
         self.assertEqual(len(result.headerlist), 2)
-        
-class ViewPageTemplateFileTests(unittest.TestCase, Base):
-    def setUp(self):
-        Base.setUp(self)
 
-    def tearDown(self):
-        Base.tearDown(self)
-
-    def _getTargetClass(self):
-        from repoze.bfg.template import ViewPageTemplateFile
-        return ViewPageTemplateFile
-
-    def _makeOne(self, *arg, **kw):
-        klass = self._getTargetClass()
-        return klass(*arg, **kw)
-
-    def test_render(self):
-        self._zcmlConfigure()
-        f = DummyPageTemplateFile()
-        instance = self._makeOne(f)
-        class View:
-            context = 'context'
-            request = 'request'
-        view = View()
-        template = instance.render(view)
-        args, kw = template(foo='bar')
-        self.assertEqual(kw['request'], 'request')
-        self.assertEqual(kw['options'], {'foo':'bar'})
-        self.assertEqual(kw['context'], 'context')
-        self.assertEqual(kw['view'], view)
-
-class TemplateViewTests(unittest.TestCase, Base):
+class RenderTemplateTests(unittest.TestCase, Base):
     def setUp(self):
         Base.setUp(self)
 
     def tearDown(self):
         Base.tearDown(self)
 
-    def _getTargetClass(self):
-        from repoze.bfg.template import TemplateView
-        return TemplateView
+    def _getFUT(self):
+        from repoze.bfg.template import render_template
+        return render_template
 
-    def _makeOne(self, *arg, **kw):
-        klass = self._getTargetClass()
-        return klass(*arg, **kw)
+    def test_nonabs_unregistered(self):
+        self._zcmlConfigure()
+        from zope.component import queryUtility
+        from repoze.bfg.interfaces import IView
+        minimal = self._getTemplatePath('minimal.pt')
+        self.assertEqual(queryUtility(IView, minimal), None)
+        view = DummyView()
+        render = self._getFUT()
+        result = render(view, minimal)
+        from webob import Response
+        self.failUnless(isinstance(result, Response))
+        self.assertEqual(result.app_iter, ['<div>\n</div>'])
+        self.assertEqual(result.status, '200 OK')
+        self.assertEqual(len(result.headerlist), 2)
+        from repoze.bfg.template import Z3CPTTemplateFactory
+        self.failUnless(isinstance(queryUtility(IView, minimal),
+                                   Z3CPTTemplateFactory))
 
-    def test_call(self):
-        view = self._makeOne(None, None)
-        _marker = ()
-        view.index = lambda *arg, **kw: _marker
-        result = view('foo')
-        self.assertEqual(result, _marker)
+    def test_nonabs_registered(self):
+        self._zcmlConfigure()
+        from zope.component import getGlobalSiteManager
+        from zope.component import queryUtility
+        from repoze.bfg.template import Z3CPTTemplateFactory
+        from repoze.bfg.interfaces import IView
+        minimal = self._getTemplatePath('minimal.pt')
+        utility = Z3CPTTemplateFactory(minimal)
+        gsm = getGlobalSiteManager()
+        gsm.registerUtility(utility, IView, name=minimal)
+        view = DummyView()
+        render = self._getFUT()
+        result = render(view, minimal)
+        from webob import Response
+        self.failUnless(isinstance(result, Response))
+        self.assertEqual(result.app_iter, ['<div>\n</div>'])
+        self.assertEqual(result.status, '200 OK')
+        self.assertEqual(len(result.headerlist), 2)
+        self.assertEqual(queryUtility(IView, minimal), utility)
+        
+class DummyView:
+    context = 'context'
+    request = 'request'
         
-class DummyPageTemplateFile:
-    def render(self, *arg, **kw):
-        return arg, kw
diff --git a/repoze/bfg/tests/test_view.py b/repoze/bfg/tests/test_view.py
new file mode 100644
index 000000000..7d87b9c83
--- /dev/null
+++ b/repoze/bfg/tests/test_view.py
@@ -0,0 +1,64 @@
+import unittest
+
+from zope.component.testing import PlacelessSetup
+
+class Base(PlacelessSetup):
+    def setUp(self):
+        PlacelessSetup.setUp(self)
+
+    def tearDown(self):
+        PlacelessSetup.tearDown(self)
+
+    def _zcmlConfigure(self):
+        import repoze.bfg
+        import zope.configuration.xmlconfig
+        zope.configuration.xmlconfig.file('configure.zcml', package=repoze.bfg)
+
+    def _getTemplatePath(self, name):
+        import os
+        here = os.path.abspath(os.path.dirname(__file__))
+        return os.path.join(here, 'fixtures', name)
+
+class ViewTests(unittest.TestCase):
+    def _getTargetClass(self):
+        from repoze.bfg.view import View
+        return View
+
+    def _makeOne(self, *arg, **kw):
+        klass = self._getTargetClass()
+        return klass(*arg, **kw)
+
+    def test_call(self):
+        view = self._makeOne(None, None)
+        self.assertRaises(NotImplementedError, view)
+
+class TemplateViewTests(unittest.TestCase, Base):
+    def setUp(self):
+        Base.setUp(self)
+
+    def tearDown(self):
+        Base.tearDown(self)
+
+    def _getTargetClass(self):
+        from repoze.bfg.view import TemplateView
+        return TemplateView
+
+    def _makeOne(self, *arg, **kw):
+        klass = self._getTargetClass()
+        return klass(*arg, **kw)
+
+    def test_call(self):
+        self._zcmlConfigure()
+        view = self._makeOne(None, None)
+        view.template = self._getTemplatePath('minimal.pt')
+        result = view(foo='foo')
+        from webob import Response
+        self.failUnless(isinstance(result, Response))
+        self.assertEqual(result.app_iter, ['<div>\n</div>'])
+        self.assertEqual(result.status, '200 OK')
+        self.assertEqual(len(result.headerlist), 2)
+        
+    def test_call_no_template(self):
+        self._zcmlConfigure()
+        view = self._makeOne(None, None)
+        self.assertRaises(ValueError, view)
diff --git a/repoze/bfg/tests/test_zcml.py b/repoze/bfg/tests/test_zcml.py
index bcb065d9e..11f392f78 100644
--- a/repoze/bfg/tests/test_zcml.py
+++ b/repoze/bfg/tests/test_zcml.py
@@ -2,7 +2,7 @@ import unittest
 
 from zope.component.testing import PlacelessSetup
 
-class TestPageDirective(unittest.TestCase, PlacelessSetup):
+class TestViewDirective(unittest.TestCase, PlacelessSetup):
     def setUp(self):
         PlacelessSetup.setUp(self)
 
@@ -10,8 +10,8 @@ class TestPageDirective(unittest.TestCase, PlacelessSetup):
         PlacelessSetup.tearDown(self)
 
     def _getFUT(self):
-        from repoze.bfg.zcml import page
-        return page
+        from repoze.bfg.zcml import view
+        return view
 
     def test_no_class_or_template(self):
         f = self._getFUT()
@@ -29,45 +29,107 @@ class TestPageDirective(unittest.TestCase, PlacelessSetup):
     def test_only_template(self):
         f = self._getFUT()
         context = DummyContext()
-        f(context, 'repoze.view', None, template='minimal.pt')
+        class IFoo:
+            pass
+        f(context, 'repoze.view', IFoo, template='minimal.pt')
         actions = context.actions
+        from repoze.bfg.interfaces import IView
         from repoze.bfg.interfaces import IRequest
         from repoze.bfg.interfaces import IViewFactory
         from zope.component.zcml import handler
-        expected0 = ('view', None, '', IRequest, IViewFactory)
-        expected1 = handler
-        self.assertEqual(actions[0]['discriminator'], expected0)
-        self.assertEqual(actions[0]['callable'], expected1)
-        self.assertEqual(actions[0]['args'][0], 'registerAdapter')
-        import types
-        self.failUnless(isinstance(actions[0]['args'][1], types.FunctionType))
-        self.assertEqual(actions[0]['args'][2], (None, IRequest))
-        self.assertEqual(actions[0]['args'][3], IViewFactory)
-        self.assertEqual(actions[0]['args'][4], '')
-        self.assertEqual(actions[0]['args'][5], None)
-
-    def test_template_and_class(self):
+        from zope.component.interface import provideInterface
+
+        self.assertEqual(len(actions), 3)
+
+        regutil_discriminator = ('utility', IView, context.path('minimal.pt'))
+        regutil = actions[0]
+        self.assertEqual(regutil['discriminator'], regutil_discriminator)
+        self.assertEqual(regutil['callable'], handler)
+        self.assertEqual(regutil['args'][0], 'registerUtility')
+        self.assertEqual(regutil['args'][1].template.filename,
+                         context.path('minimal.pt'))
+        self.assertEqual(regutil['args'][2], IView)
+        self.assertEqual(regutil['args'][3], context.path('minimal.pt'))
+
+        provide = actions[1]
+        self.assertEqual(provide['discriminator'], None)
+        self.assertEqual(provide['callable'], provideInterface)
+        self.assertEqual(provide['args'][0], '')
+        self.assertEqual(provide['args'][1], IFoo)
+        
+        regadapt = actions[2]
+        regadapt_discriminator = ('view', IFoo, '', IRequest, IViewFactory)
+        self.assertEqual(regadapt['discriminator'], regadapt_discriminator)
+        self.assertEqual(regadapt['callable'], handler)
+        self.assertEqual(regadapt['args'][0], 'registerAdapter')
+        self.assertEqual(regadapt['args'][1].template,
+                         context.path('minimal.pt'))
+        self.assertEqual(regadapt['args'][2], (IFoo, IRequest))
+        self.assertEqual(regadapt['args'][3], IViewFactory)
+        self.assertEqual(regadapt['args'][4], '')
+        self.assertEqual(regadapt['args'][5], None)
+
+    def test_only_factory(self):
         f = self._getFUT()
         context = DummyContext()
-        f(context, 'repoze.view', None, template='minimal.pt',
-          class_=DummyViewClass)
+        class IFoo:
+            pass
+        f(context, 'repoze.view', IFoo, factory=Dummy)
         actions = context.actions
         from repoze.bfg.interfaces import IRequest
         from repoze.bfg.interfaces import IViewFactory
         from zope.component.zcml import handler
-        expected0 = ('view', None, '', IRequest, IViewFactory)
-        expected1 = handler
-        self.assertEqual(actions[0]['discriminator'], expected0)
-        self.assertEqual(actions[0]['callable'], expected1)
-        self.assertEqual(actions[0]['args'][0], 'registerAdapter')
-        import types
-        self.failUnless(isinstance(actions[0]['args'][1], types.FunctionType))
-        self.assertEqual(actions[0]['args'][2], (None, IRequest))
-        self.assertEqual(actions[0]['args'][3], IViewFactory)
-        self.assertEqual(actions[0]['args'][4], '')
-        self.assertEqual(actions[0]['args'][5], None)
-
-class DummyViewClass:
+        from zope.component.interface import provideInterface
+
+        self.assertEqual(len(actions), 2)
+
+        provide = actions[0]
+        self.assertEqual(provide['discriminator'], None)
+        self.assertEqual(provide['callable'], provideInterface)
+        self.assertEqual(provide['args'][0], '')
+        self.assertEqual(provide['args'][1], IFoo)
+        
+        regadapt = actions[1]
+        regadapt_discriminator = ('view', IFoo, '', IRequest, IViewFactory)
+        self.assertEqual(regadapt['discriminator'], regadapt_discriminator)
+        self.assertEqual(regadapt['callable'], handler)
+        self.assertEqual(regadapt['args'][0], 'registerAdapter')
+        self.assertEqual(regadapt['args'][1], Dummy)
+        self.assertEqual(regadapt['args'][2], (IFoo, IRequest))
+        self.assertEqual(regadapt['args'][3], IViewFactory)
+        self.assertEqual(regadapt['args'][4], '')
+        self.assertEqual(regadapt['args'][5], None)
+
+    def test_template_and_factory_raises(self):
+        f = self._getFUT()
+        context = DummyContext()
+        from zope.configuration.exceptions import ConfigurationError
+        self.assertRaises(ConfigurationError, f, context, 'repoze.view', None,
+                          Dummy, 'minimal.html', 'minimal.pt')
+
+class TestTemplateViewFactory(unittest.TestCase):
+    def _getTargetClass(self):
+        from repoze.bfg.zcml import TemplateViewFactory
+        return TemplateViewFactory
+
+    def _makeOne(self, template):
+        return self._getTargetClass()(template)
+
+    def test_instance_conforms_to_IViewFactory(self):
+        from zope.interface.verify import verifyObject
+        from repoze.bfg.interfaces import IViewFactory
+        verifyObject(IViewFactory, self._makeOne('a'))
+
+    def test_call(self):
+        context = DummyContext()
+        template = context.path('minimal.pt')
+        factory = self._makeOne(template)
+        view = factory(None, None)
+        from repoze.bfg.view import TemplateView
+        self.failUnless(isinstance(view, TemplateView))
+        
+
+class Dummy:
     pass
 
 class DummyContext: