[z3-checkins] r20254 - in z3/Five/branch/Five-1.3: . tests

efge at codespeak.net efge at codespeak.net
Fri Nov 25 19:45:08 CET 2005


Author: efge
Date: Fri Nov 25 19:45:08 2005
New Revision: 20254

Added:
   z3/Five/branch/Five-1.3/monkey.py   (contents, props changed)
Modified:
   z3/Five/branch/Five-1.3/CHANGES.txt
   z3/Five/branch/Five-1.3/__init__.py
   z3/Five/branch/Five-1.3/tests/event.txt
Log:
Merged 20253 from 1.2 branch:

Made Five send a ContainerModifiedEvent when appropriate.

This event is new in very recent Zope 3.2, so a monkey patch of Zope 3
is needed until 3.2 final is released or stiched in Zope 2.



Modified: z3/Five/branch/Five-1.3/CHANGES.txt
==============================================================================
--- z3/Five/branch/Five-1.3/CHANGES.txt	(original)
+++ z3/Five/branch/Five-1.3/CHANGES.txt	Fri Nov 25 19:45:08 2005
@@ -10,6 +10,8 @@
 
 * Cleaned up security test.
 
+* Made Five send a ContainerModifiedEvent when appropriate.
+
 Five 1.3b3 (2005-11-19)
 =======================
 

Modified: z3/Five/branch/Five-1.3/__init__.py
==============================================================================
--- z3/Five/branch/Five-1.3/__init__.py	(original)
+++ z3/Five/branch/Five-1.3/__init__.py	Fri Nov 25 19:45:08 2005
@@ -18,8 +18,12 @@
 import Acquisition
 from Globals import INSTANCE_HOME
 
+import monkey # BBB: goes away when Zope 3.2 >= r40368 is stiched in
 import zcml
 
+# trigger monkey patches
+monkey.monkeyPatch()
+
 # public API provided by Five
 # usage: from Products.Five import <something>
 from browser import BrowserView

Added: z3/Five/branch/Five-1.3/monkey.py
==============================================================================
--- (empty file)
+++ z3/Five/branch/Five-1.3/monkey.py	Fri Nov 25 19:45:08 2005
@@ -0,0 +1,71 @@
+##############################################################################
+#
+# Copyright (c) 2005 Zope Corporation and Contributors.
+# All Rights Reserved.
+#
+# This software is subject to the provisions of the Zope Public License,
+# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
+# THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
+# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
+# FOR A PARTICULAR PURPOSE.
+#
+##############################################################################
+"""Bad monkey!
+
+BBB: goes away when Zope 3.2 >= r40368 is stiched in
+
+$Id$
+"""
+def monkeyPatch():
+    """Trigger all monkey patches needed to make Five work.
+
+    Monkey patches are kept to a minimum level.
+    """
+    zope3_monkey()
+
+def zope3_monkey():
+    """Fix Zope 3 to have the proper ContainerModifiedEvent that has
+    been added for 3.2.
+    """
+    try:
+        from zope.app.container.contained import notifyContainerModified
+    except ImportError:
+        pass
+    else:
+        return
+
+    # BBB: goes away when Zope 3.2 >= r40368 is stiched in
+
+    from zope.event import notify
+    from zope.interface import implements
+    import zope.app.container.contained
+    import zope.app.container.interfaces
+    from zope.app.event.objectevent import ObjectModifiedEvent
+    from zope.app.event.interfaces import IObjectModifiedEvent
+
+    class IContainerModifiedEvent(IObjectModifiedEvent):
+        """The container has been modified.
+
+        This event is specific to "containerness" modifications, which
+        means addition, removal or reordering of sub-objects.
+        """
+
+    zope.app.container.interfaces.IContainerModifiedEvent = \
+        IContainerModifiedEvent
+
+
+    class ContainerModifiedEvent(ObjectModifiedEvent):
+        """The container has been modified."""
+        implements(IContainerModifiedEvent)
+
+    zope.app.container.contained.ContainerModifiedEvent = \
+        ContainerModifiedEvent
+
+
+    def notifyContainerModified(object, *descriptions):
+        """Notify that the container was modified."""
+        notify(ContainerModifiedEvent(object, *descriptions))
+
+    zope.app.container.contained.notifyContainerModified = \
+        notifyContainerModified

Modified: z3/Five/branch/Five-1.3/tests/event.txt
==============================================================================
--- z3/Five/branch/Five-1.3/tests/event.txt	(original)
+++ z3/Five/branch/Five-1.3/tests/event.txt	Fri Nov 25 19:45:08 2005
@@ -105,6 +105,7 @@
   ObjectWillBeAddedEvent sub
   ObjectAddedEvent sub
   old manage_afterAdd sub sub folder
+  ContainerModifiedEvent folder
   'sub'
   >>> sub = folder.sub
   >>> ob = MyContent('dog')
@@ -112,6 +113,7 @@
   ObjectWillBeAddedEvent dog
   ObjectAddedEvent dog
   old manage_afterAdd dog dog sub
+  ContainerModifiedEvent sub
   'dog'
 
 And when we rename the subfolder, manage_beforeDelete is also called
@@ -126,6 +128,7 @@
   old manage_afterAdd marine marine folder
   ObjectMovedEvent dog
   old manage_afterAdd dog marine folder
+  ContainerModifiedEvent folder
 
 Same thing for clone::
 
@@ -137,6 +140,7 @@
   old manage_afterAdd tank tank folder
   ObjectAddedEvent dog
   old manage_afterAdd dog tank folder
+  ContainerModifiedEvent folder
   ObjectClonedEvent tank
   old manage_afterClone tank tank
   ObjectClonedEvent dog
@@ -161,6 +165,7 @@
   ObjectWillBeAddedEvent lassie
   ObjectAddedEvent lassie
   old manage_afterAdd lassie lassie folder
+  ContainerModifiedEvent folder
   'lassie'
 
 And when we delete the object, manage_beforeDelete is also called and
@@ -170,6 +175,7 @@
   ObjectWillBeRemovedEvent lassie
   old manage_beforeDelete lassie lassie folder
   ObjectRemovedEvent lassie
+  ContainerModifiedEvent folder
 
 The old behavior happens for a move or a copy, with events too.
 For a move::
@@ -179,6 +185,7 @@
   ObjectWillBeAddedEvent blueberry
   ObjectAddedEvent blueberry
   old manage_afterAdd blueberry blueberry folder
+  ContainerModifiedEvent folder
   'blueberry'
   >>> cp = folder.manage_cutObjects('blueberry')
   >>> folder.manage_pasteObjects(cp)
@@ -186,6 +193,7 @@
   old manage_beforeDelete blueberry blueberry folder
   ObjectMovedEvent blueberry
   old manage_afterAdd blueberry blueberry folder
+  ContainerModifiedEvent folder
   [{'new_id': 'blueberry', 'id': 'blueberry'}]
 
 Old behavior with events for a copy::
@@ -196,6 +204,7 @@
   ObjectWillBeAddedEvent copy_of_blueberry
   ObjectAddedEvent copy_of_blueberry
   old manage_afterAdd copy_of_blueberry copy_of_blueberry folder
+  ContainerModifiedEvent folder
   ObjectClonedEvent copy_of_blueberry
   old manage_afterClone copy_of_blueberry copy_of_blueberry
   [{'new_id': 'copy_of_blueberry', 'id': 'blueberry'}]
@@ -207,6 +216,7 @@
   old manage_beforeDelete copy_of_blueberry copy_of_blueberry folder
   ObjectMovedEvent myrtille
   old manage_afterAdd myrtille myrtille folder
+  ContainerModifiedEvent folder
 
 Old behavior with events for a clone::
 
@@ -215,6 +225,7 @@
   ObjectWillBeAddedEvent strawberry
   ObjectAddedEvent strawberry
   old manage_afterAdd strawberry strawberry folder
+  ContainerModifiedEvent folder
   ObjectClonedEvent strawberry
   old manage_afterClone strawberry strawberry
   >>> res.getId()
@@ -227,12 +238,14 @@
   ObjectWillBeAddedEvent luckyluke
   ObjectAddedEvent luckyluke
   old manage_afterAdd luckyluke luckyluke btfolder
+  ContainerModifiedEvent btfolder
   'luckyluke'
 
   >>> btfolder.manage_delObjects('luckyluke')
   ObjectWillBeRemovedEvent luckyluke
   old manage_beforeDelete luckyluke luckyluke btfolder
   ObjectRemovedEvent luckyluke
+  ContainerModifiedEvent btfolder
 
 Here is what happens for a tree of objects. Let's create a simple one::
 
@@ -241,6 +254,7 @@
   ObjectWillBeAddedEvent subfolder
   ObjectAddedEvent subfolder
   old manage_afterAdd subfolder subfolder folder
+  ContainerModifiedEvent folder
   'subfolder'
   >>> subfolder = folder.subfolder
   >>> ob = MyContent('donald')
@@ -248,6 +262,7 @@
   ObjectWillBeAddedEvent donald
   ObjectAddedEvent donald
   old manage_afterAdd donald donald subfolder
+  ContainerModifiedEvent subfolder
   'donald'
 
 Renaming a tree of objects. Note that manage_beforeDelete is called
@@ -262,6 +277,7 @@
   old manage_afterAdd pluto pluto folder
   ObjectMovedEvent donald
   old manage_afterAdd donald pluto folder
+  ContainerModifiedEvent folder
 
 Cloning a tree of objects::
 
@@ -273,6 +289,7 @@
   old manage_afterAdd mickey mickey folder
   ObjectAddedEvent donald
   old manage_afterAdd donald mickey folder
+  ContainerModifiedEvent folder
   ObjectClonedEvent mickey
   old manage_afterClone mickey mickey
   ObjectClonedEvent donald
@@ -290,9 +307,10 @@
   >>> app = MyApp('')
   >>> root['app'] = app
   >>> folder = MyNewFolder('folder')
-  >>> app._setObject('folder', folder)
+  >>> app._setObject('folder', folder) # doctest: +NORMALIZE_WHITESPACE
   ObjectWillBeAddedEvent folder
   ObjectAddedEvent folder
+  ContainerModifiedEvent
   'folder'
   >>> folder = app.folder
 
@@ -300,10 +318,12 @@
   >>> folder._setObject('dogbert', ob)
   ObjectWillBeAddedEvent dogbert
   ObjectAddedEvent dogbert
+  ContainerModifiedEvent folder
   'dogbert'
   >>> folder.manage_delObjects('dogbert')
   ObjectWillBeRemovedEvent dogbert
   ObjectRemovedEvent dogbert
+  ContainerModifiedEvent folder
 
 Now move::
 
@@ -311,11 +331,13 @@
   >>> folder._setObject('dilbert', ob)
   ObjectWillBeAddedEvent dilbert
   ObjectAddedEvent dilbert
+  ContainerModifiedEvent folder
   'dilbert'
   >>> cp = folder.manage_cutObjects('dilbert')
   >>> folder.manage_pasteObjects(cp)
   ObjectWillBeMovedEvent dilbert
   ObjectMovedEvent dilbert
+  ContainerModifiedEvent folder
   [{'new_id': 'dilbert', 'id': 'dilbert'}]
 
 And copy::
@@ -325,6 +347,7 @@
   ObjectCopiedEvent copy_of_dilbert
   ObjectWillBeAddedEvent copy_of_dilbert
   ObjectAddedEvent copy_of_dilbert
+  ContainerModifiedEvent folder
   ObjectClonedEvent copy_of_dilbert
   [{'new_id': 'copy_of_dilbert', 'id': 'dilbert'}]
 
@@ -333,6 +356,7 @@
   >>> folder.manage_renameObject('copy_of_dilbert', 'wally')
   ObjectWillBeMovedEvent copy_of_dilbert
   ObjectMovedEvent wally
+  ContainerModifiedEvent folder
 
 Or copy using manage_clone::
 
@@ -340,6 +364,7 @@
   ObjectCopiedEvent phb
   ObjectWillBeAddedEvent phb
   ObjectAddedEvent phb
+  ContainerModifiedEvent folder
   ObjectClonedEvent phb
   >>> res.getId()
   'phb'
@@ -350,13 +375,16 @@
   >>> btfolder._setObject('alice', ob)
   ObjectWillBeAddedEvent alice
   ObjectAddedEvent alice
+  ContainerModifiedEvent btfolder
   'alice'
   >>> btfolder.manage_renameObject('alice', 'rabbit')
   ObjectWillBeMovedEvent alice
   ObjectMovedEvent rabbit
+  ContainerModifiedEvent btfolder
   >>> btfolder.manage_delObjects('rabbit')
   ObjectWillBeRemovedEvent rabbit
   ObjectRemovedEvent rabbit
+  ContainerModifiedEvent btfolder
 
 Now for a tree of objects. Let's create a simple one::
 
@@ -364,12 +392,14 @@
   >>> folder._setObject('subfolder', subfolder)
   ObjectWillBeAddedEvent subfolder
   ObjectAddedEvent subfolder
+  ContainerModifiedEvent folder
   'subfolder'
   >>> subfolder = folder.subfolder
   >>> ob = MyNewContent('mel')
   >>> subfolder._setObject('mel', ob)
   ObjectWillBeAddedEvent mel
   ObjectAddedEvent mel
+  ContainerModifiedEvent subfolder
   'mel'
 
 Renaming a tree of objects::
@@ -379,6 +409,7 @@
   ObjectWillBeMovedEvent mel
   ObjectMovedEvent firefly
   ObjectMovedEvent mel
+  ContainerModifiedEvent folder
 
 Cloning a tree of objects::
 
@@ -388,6 +419,7 @@
   ObjectWillBeAddedEvent mel
   ObjectAddedEvent serenity
   ObjectAddedEvent mel
+  ContainerModifiedEvent folder
   ObjectClonedEvent serenity
   ObjectClonedEvent mel
   >>> res.getId()
@@ -400,23 +432,34 @@
   ObjectWillBeAddedEvent ofolder
   ObjectAddedEvent ofolder
   old manage_afterAdd ofolder ofolder
+  ContainerModifiedEvent
   'ofolder'
   >>> ob1 = MyNewContent('ob1')
   >>> ofolder._setObject('ob1', ob1)
   ObjectWillBeAddedEvent ob1
   ObjectAddedEvent ob1
+  ContainerModifiedEvent ofolder
   'ob1'
   >>> ob2 = MyNewContent('ob2')
   >>> ofolder._setObject('ob2', ob2)
   ObjectWillBeAddedEvent ob2
   ObjectAddedEvent ob2
+  ContainerModifiedEvent ofolder
   'ob2'
   >>> ofolder.manage_renameObject('ob1', 'ob4')
   ObjectWillBeMovedEvent ob1
   ObjectMovedEvent ob4
+  ContainerModifiedEvent ofolder
   >>> ofolder.objectIds()
   ['ob4', 'ob2']
 
+When subobjects are reordered, an event about the container is sent::
+
+  >>> ofolder.moveObjectsUp('ob2')
+  ContainerModifiedEvent ofolder
+  1
+  >>> ofolder.objectIds()
+  ['ob2', 'ob4']
 
 Now cleanup::
 


More information about the z3-checkins mailing list