Merge lp:~justizin/zope.copypastemove/lp_98385 into lp:zope.copypastemove

[Tres Seaver]

Fix lp:98385

[Tres Seaver (tseaver)]

I will merge with a couple of tweaks:

- We really prefer not to add any dependencies, even testing dependencies, on
  the 'zope.app' packages from outside that namespace. As it turns out, the
  'zope.container' package provides all these features anywa, which allows me
  to use the new test with a trivial tweak.

- The 'renameItem' methods should *all* return the newName: I'm updating the
  one for ordered containers to do so.

=== modified file 'setup.py'
--- setup.py	2010-05-05 16:58:38 +0000
+++ setup.py	2010-05-20 02:19:23 +0000
@@ -47,6 +47,7 @@
           test=['zope.principalannotation',
                 'zope.testing',
                 'zope.traversing',
+                'zope.app.container',
                 ]),
       install_requires=['setuptools',
                         'zope.annotation',
 
=== modified file 'src/zope/copypastemove/__init__.py'
--- src/zope/copypastemove/__init__.py	2010-05-19 10:48:49 +0000
+++ src/zope/copypastemove/__init__.py	2010-05-20 02:19:23 +0000
@@ -445,6 +445,7 @@
     to 'bar':
 
       >>> renamer.renameItem('foo', 'bar')
+      u'bar'
       >>> container['foo'] is foo
       Traceback (most recent call last):
       KeyError: 'foo'
@@ -473,6 +474,9 @@
         self.container = container
 
     def renameItem(self, oldName, newName):
+        return self._renameItem(oldName, newName)
+
+    def _renameItem(self, oldName, newName):
         object = self.container.get(oldName)
         if object is None:
             raise ItemNotFoundError(self.container, oldName)
@@ -481,7 +485,7 @@
         if newName in self.container:
             raise DuplicationError("%s is already in use" % newName)
 
-        mover.moveTo(self.container, newName)
+        return mover.moveTo(self.container, newName)
 
 
 class OrderedContainerItemRenamer(ContainerItemRenamer):
@@ -518,14 +522,14 @@
     the order is preserved:
 
       >>> container.items()
-      [('I', 'Item 1'), ('2', 'Item 2'), ('3', 'Item 3')]
+      [(u'I', 'Item 1'), ('2', 'Item 2'), ('3', 'Item 3')]
 
     Renaming the other two items also preserves the origina order:
 
       >>> renamer.renameItem('2', 'II')
       >>> renamer.renameItem('3', 'III')
       >>> container.items()
-      [('I', 'Item 1'), ('II', 'Item 2'), ('III', 'Item 3')]
+      [(u'I', 'Item 1'), (u'II', 'Item 2'), (u'III', 'Item 3')]
 
     As with the standard renamer, trying to rename a non-existent item raises
     an error:
@@ -548,7 +552,7 @@
 
     def renameItem(self, oldName, newName):
         order = list(self.container.keys())
-        super(OrderedContainerItemRenamer, self).renameItem(oldName, newName)
+        newName = self._renameItem(oldName, newName)
         order[order.index(oldName)] = newName
         self.container.updateOrder(order)
 
 
=== modified file 'src/zope/copypastemove/tests/test_rename.py'
--- src/zope/copypastemove/tests/test_rename.py	2010-05-19 10:48:49 +0000
+++ src/zope/copypastemove/tests/test_rename.py	2010-05-20 02:19:23 +0000
@@ -57,11 +57,70 @@
     eventtesting.setUp()
     container_setup.setUp()
 
+
+def doctest_namechooser_rename_preserve_order():
+    """Test for OrderedContainerItemRenamer.renameItem
+
+    This is a regression test for
+    http://www.zope.org/Collectors/Zope3-dev/658
+
+    Also: https://bugs.launchpad.net/zope.copypastemove/+bug/98385
+
+        >>> from zope.component import adapts, provideAdapter
+        >>> from zope.copypastemove import ObjectMover
+        >>> provideAdapter(ObjectMover)
+
+    There's an ordered container
+
+        >>> from zope.app.container.ordered import OrderedContainer
+        >>> container = OrderedContainer()
+
+        >>> from zope.app.container.contained import Contained
+        >>> class Obj(Contained):
+        ...     def __init__(self, title):
+        ...         self.title = title
+        ...     def __repr__(self):
+        ...         return self.title
+        >>> container['foo'] = Obj('Foo')
+        >>> container['bar'] = Obj('Bar')
+        >>> container['baz'] = Obj('Baz')
+
+    with a custom name chooser
+
+        >>> from zope.interface import implements, Interface
+        >>> from zope.app.container.interfaces import INameChooser
+        >>> class IMyContainer(Interface): pass
+        >>> class MyNameChooser(object):
+        ...     adapts(IMyContainer)
+        ...     implements(INameChooser)
+        ...     def __init__(self, container):
+        ...         self.container = container
+        ...     def chooseName(self, name, obj):
+        ...         return name.encode('rot-13')
+        >>> provideAdapter(MyNameChooser)
+
+        >>> from zope.interface import alsoProvides
+        >>> alsoProvides(container, IMyContainer)
+
+    OrderedContainerItemRenamer renames and preserves the order of items
+
+        >>> from zope.copypastemove import OrderedContainerItemRenamer
+        >>> renamer = OrderedContainerItemRenamer(container)
+        >>> renamer.renameItem('bar', 'quux')
+
+        >>> list(container.keys())
+        ['foo', 'dhhk', 'baz']
+        >>> list(container.values())
+        [Foo, Bar, Baz]
+
+    """
+
 def test_suite():
     return unittest.TestSuite((
             unittest.makeSuite(RenamerTest),
             DocTestSuite('zope.copypastemove',
                          setUp=setUp, tearDown=testing.tearDown),
+            DocTestSuite(setUp=setUp, tearDown=testing.tearDown),
             ))
 
 if __name__=='__main__':