Conjunto de mudanças 6471 no repositório publico

Timestamp:

09/06/2012 16:43:29 (9 anos atrás)

Autor:

mazza

Mensagem:

boxes: refatoracao para uma classe

Localização:

PortalInterlegis/produtos/il.portalinterlegis/src/il/portalinterlegis

Arquivos:

• browser/boxes.py (modificado) (4 diffs)
• tests/testintegration.py (movido) (movido de PortalInterlegis/produtos/il.portalinterlegis/src/il/portalinterlegis/tests/integrationtests.py) (6 diffs)
• tests/testunit.py (movido) (movido de PortalInterlegis/produtos/il.portalinterlegis/src/il/portalinterlegis/tests/unittests.py)

PortalInterlegis/produtos/il.portalinterlegis/src/il/portalinterlegis/browser/boxes.py

@@ -1 +1 @@
 from Products.CMFCore.interfaces import IFolderish
 from five import grok
-from persistent.dict import PersistentDict 
+from persistent.dict import PersistentDict
 from z3c.form import form, field, datamanager
 from z3c.form.interfaces import IDataManager
@@ -8 +8 @@
 from zope.interface import implements
 from zope.schema.interfaces import IField
-
+from zope.interface import Interface
 
 class PersistentDictionaryField(datamanager.DictionaryField):
@@ -15 +15 @@
 provideAdapter(PersistentDictionaryField)
 
-ALL_BOXES_KEY = 'il.portalinterlegis.boxes'
-def _build_box(box_schema, number):
+class BoxManager(object):
 
-    form_label = getattr(box_schema, 'form_label', None) \
-      or u'Edite os valore desta caixa'
-    
-    # the combination (form.EditForm, grok.View)
-    # is from https://mail.zope.org/pipermail/grok-dev/2008-July/005999.html
-    # (plone.directives.form.EditForm did not work well)
-    class BoxEditForm(form.EditForm, grok.View):
-        grok.context(IFolderish)
-        grok.name(_box_name_for_url(box_schema, number))
-        label = form_label
-        fields = field.Fields(box_schema)
-     
-        def getContent(self):
-            return box_content(self.context, box_schema, number)
-        
-    globals()['BoxEditForm_%s' % _box_key(box_schema, number)] = BoxEditForm
-    return BoxEditForm
+    ALL_BOXES_KEY = 'il.portalinterlegis.boxes'
 
-def box_content(context, box_schema, number):
-    annotations = IAnnotations(context)
-    boxes = _get_persistent_dict(annotations, ALL_BOXES_KEY)
-    return _get_persistent_dict(boxes, _box_key(box_schema, number))
+    def __init__(self, schema, label=None):
+        self.schema = schema
+        #TODO: improve this text
+        self.form_label = label or u'Edite os valore desta caixa'
 
-def _get_persistent_dict(dictionary, key):
+    def build_form(self, number):
+
+        # the combination (form.EditForm, grok.View)
+        # is from https://mail.zope.org/pipermail/grok-dev/2008-July/005999.html
+        # (plone.directives.form.EditForm did not work well)
+        class BoxEditForm(form.EditForm, grok.View):
+            grok.context(IFolderish)
+            grok.name(self._box_name_for_url(number))
+            label = self.form_label
+            fields = field.Fields(self.schema)
+
+            def getContent(form_self):
+                return self.box_content(form_self.context, number)
+
+        globals()['BoxEditForm_%s' % self._box_key(number)] = BoxEditForm
+        return BoxEditForm
+
+    def build_n_forms(self, max_number):
+        for number in range(1, max_number+1):
+            self.build_form(number)
+
+    def box_content(self, context, number): # maybe this method should be private
+        annotations = IAnnotations(context)
+        boxes = get_or_create_persistent_dict(annotations, BoxManager.ALL_BOXES_KEY)
+        return get_or_create_persistent_dict(boxes, self._box_key(number))
+
+    def _box_key(self, number):
+        return '%s_%s' % (self.schema.__name__, number)
+
+    def _box_name_for_url(self, number):
+        return 'box_%s' % self._box_key(number)
+
+
+def get_or_create_persistent_dict(dictionary, key):
     value = dictionary.get(key, None)
     if not value:
@@ -47 +63 @@
     return value
 
-def _box_key(box_schema, number):
-    return '%s_%s' % (box_schema.__name__, number)
+################################################################
+from interfaces import ISimpleBox
 
-def _box_name_for_url(box_schema, number):
-    return 'box_%s' % _box_key(box_schema, number)
-
-def build_n_boxes(box_schema, max_number):
-    for number in range(1, max_number+1):
-        _build_box(box_schema, number)
-
-################################################################        
-from interfaces import ISimpleBox
-    
-for box_schema in [ISimpleBox]:
-    build_n_boxes(box_schema, 2)
+# initialize all the boxes
+for s in [ISimpleBox,]:
+    BoxManager(s).build_n_forms(10)

PortalInterlegis/produtos/il.portalinterlegis/src/il/portalinterlegis/tests/testintegration.py

@@ -3 +3 @@
 import unittest2 as unittest
 from Products.CMFCore.utils import getToolByName
+from fixtures import IL_PORTALINTERLEGIS_INTEGRATION_TESTING
 from plone.testing.z2 import Browser
+from zExceptions import NotFound
 
-from fixtures import IL_PORTALINTERLEGIS_INTEGRATION_TESTING
-from il.portalinterlegis.browser.boxes import _box_name_for_url, box_content
+from il.portalinterlegis.browser.boxes import BoxManager
 from il.portalinterlegis.browser.interfaces import \
      IComunidadeLegislativa, IInformacao, ICapacitacao, ITecnologia, IComunicacao, \
      ISimpleBox
-import zExceptions
+
 
 class TestIntegracao(unittest.TestCase):
@@ -19 +20 @@
         self.portal = self.layer['portal']
         self.qi_tool = getToolByName(self.portal, 'portal_quickinstaller')
-    
+
     def browser(self, path=None):
         browser = Browser(self.app)
         browser.handleErrors = False
         browser.open(self.url(path))
-        return browser 
+        return browser
 
     def dom(self, browser):
         return lxml.html.fromstring(browser.contents)
-        
+
     def url(self, path=None):
         base = self.portal.absolute_url()
@@ -37 +38 @@
 
     def test_product_is_installed(self):
-        """ Validate that our products GS profile has been run and the product 
+        """ Validate that our products GS profile has been run and the product
             installed
         """
@@ -57 +58 @@
 
     def test_homes_marcadas_e_com_layout_home(self):
-        for id, marker in [('comunidade-legislativa', IComunidadeLegislativa), 
-                           ('informacao',          IInformacao), 
-                           ('capacitacao',         ICapacitacao), 
+        for id, marker in [('comunidade-legislativa', IComunidadeLegislativa),
+                           ('informacao',          IInformacao),
+                           ('capacitacao',         ICapacitacao),
                            ('tecnologia',          ITecnologia),
-                           ('comunicacao',         IComunicacao), 
+                           ('comunicacao',         IComunicacao),
                            ]:
             obj = self.portal[id]
@@ -68 +69 @@
 
     def test_box_content_is_empty_before_visiting_form(self):
-        self.assertEqual({}, box_content(self.portal, ISimpleBox, 1))
+        self.assertEqual({}, BoxManager(ISimpleBox).box_content(self.portal, 1))
 
     def test_using_box_form_creates_box_content(self):
-        box_schema = ISimpleBox
         context = self.portal
+        boxmanager = BoxManager(ISimpleBox)
 
         def use_box_form(title, subtitle, text, num):
-            browser = self.browser(_box_name_for_url(box_schema, num))
+            browser = self.browser(boxmanager._box_name_for_url(num))
             browser.getControl(name='form.widgets.title').value = title
             browser.getControl(name='form.widgets.subtitle').value = subtitle
@@ -84 +85 @@
         use_box_form('TIT_2', 'SUBTIT_2', 'TEXT_2', 2)
         self.assertEqual({'title': 'TIT_1', 'subtitle': 'SUBTIT_1', 'text': 'TEXT_1'},
-                         box_content(context, box_schema, 1))
+                         boxmanager.box_content(context, 1))
         self.assertEqual({'title': 'TIT_2', 'subtitle': 'SUBTIT_2', 'text': 'TEXT_2'},
-                         box_content(context, box_schema, 2))
-        
+                         boxmanager.box_content(context, 2))
+
     def test_box_forms_numbers_begin_from_1_not_zero(self):
-        with self.assertRaises(zExceptions.NotFound):
-            browser = self.browser(_box_name_for_url(ISimpleBox, 0))
+        with self.assertRaises(NotFound):
+            browser = self.browser(BoxManager(ISimpleBox)._box_name_for_url(0))
 
     def test_box_forms_are_limited(self):
-        with self.assertRaises(zExceptions.NotFound):
-            browser = self.browser(_box_name_for_url(ISimpleBox, 1000000))
+        with self.assertRaises(NotFound):
+            browser = self.browser(BoxManager(ISimpleBox)._box_name_for_url(1000000))
 
-            
+    def test_box_form_cannot_be_created_after_initialization(self):
+        BoxManager(ISimpleBox).build_form(99) # try to build a box form in an arbitrary moment
+        with self.assertRaises(NotFound):
+            browser = self.browser(BoxManager(ISimpleBox)._box_name_for_url(99))
+