From 0535e659ffd3bf24e57d296e71871fddba5f4de7 Mon Sep 17 00:00:00 2001
From: Timo Stollenwerk <contact@timostollenwerk.net>
Date: Mon, 30 Jan 2012 13:30:46 +0100
Subject: [PATCH] Refactor the comment creator/author_name to comply with the
 Plone core convention to store the username on the creator attribute and not
 the fullname.

---
 CHANGES.txt                                           |  9 +++++++++
 plone/app/discussion/browser/comments.pt              | 10 +++++-----
 plone/app/discussion/browser/comments.py              |  3 +--
 plone/app/discussion/comment.py                       | 11 +++++------
 plone/app/discussion/interfaces.py                    |  2 +-
 .../app/discussion/tests/functional_test_comments.txt |  1 +
 plone/app/discussion/tests/test_catalog.py            | 11 +++++------
 plone/app/discussion/tests/test_comment.py            |  8 ++++----
 plone/app/discussion/tests/test_indexers.py           | 11 ++++++-----
 plone/app/discussion/tests/test_tool.py               |  3 ++-
 10 files changed, 39 insertions(+), 30 deletions(-)

diff --git a/CHANGES.txt b/CHANGES.txt
index 67e8253..3082180 100644
--- a/CHANGES.txt
+++ b/CHANGES.txt
@@ -1,6 +1,15 @@
 Changelog
 =========
 
+2.2.0 (unreleased)
+------------------
+
+- Refactor the comment creator/author_name to comply with the Plone core
+  convention to store the username on the creator attribute and not the
+  fullname.
+  [timo]
+
+
 2.1.8 (unreleased)
 ------------------
 
diff --git a/plone/app/discussion/browser/comments.pt b/plone/app/discussion/browser/comments.pt
index ac38d1a..d986816 100644
--- a/plone/app/discussion/browser/comments.pt
+++ b/plone/app/discussion/browser/comments.pt
@@ -48,7 +48,7 @@
                               border="0"
                               height="32"
                               tal:attributes="src portrait_url;
-                                              alt reply/Creator" />
+                                              alt reply/author_name" />
                     </a>
                     <img src="defaultUser.gif"
                          alt=""
@@ -56,20 +56,20 @@
                          height="32"
                          tal:condition="not: has_author_link"
                          tal:attributes="src portrait_url;
-                                         alt reply/Creator" />
+                                         alt reply/author_name" />
                 </div>
 
                 <div class="documentByLine" i18n:domain="plone.app.discussion">
                     <tal:name>
                         <a href=""
                            tal:condition="has_author_link"
-                           tal:content="reply/Creator"
+                           tal:content="reply/author_name"
                            tal:attributes="href author_home_url">
                             Poster Name
                         </a>
                         <span tal:condition="not: has_author_link"
-                              tal:replace="reply/Creator" />
-                        <span tal:condition="not: reply/Creator">Anonymous</span>
+                              tal:replace="reply/author_name" />
+                        <span tal:condition="not: reply/author_name">Anonymous</span>
                     </tal:name>
                     <tal:posted i18n:translate="label_says">says:</tal:posted>
                     <div class="commentDate"
diff --git a/plone/app/discussion/browser/comments.py b/plone/app/discussion/browser/comments.py
index cacb7c2..743e00e 100644
--- a/plone/app/discussion/browser/comments.py
+++ b/plone/app/discussion/browser/comments.py
@@ -179,7 +179,6 @@ class CommentForm(extensible.ExtensibleForm, form.Form):
         if portal_membership.isAnonymousUser() and \
            settings.anonymous_comments:
             # Anonymous Users
-            comment.creator = author_name
             comment.author_name = author_name
             comment.author_email = author_email
             comment.user_notification = user_notification
@@ -198,7 +197,7 @@ class CommentForm(extensible.ExtensibleForm, form.Form):
                 fullname = unicode(fullname, 'utf-8')
             if email and isinstance(email, str):
                 email = unicode(email, 'utf-8')
-            comment.creator = fullname
+            comment.creator = username
             comment.author_username = username
             comment.author_name = fullname
             comment.author_email = email
diff --git a/plone/app/discussion/comment.py b/plone/app/discussion/comment.py
index 14822fd..78baf8b 100644
--- a/plone/app/discussion/comment.py
+++ b/plone/app/discussion/comment.py
@@ -45,7 +45,7 @@ from OFS.role import RoleManager
 
 COMMENT_TITLE = _(
     u"comment_title",
-    default=u"${creator} on ${content}")
+    default=u"${author_name} on ${content}")
 
 MAIL_NOTIFICATION_MESSAGE = _(
     u"mail_notification_message",
@@ -154,19 +154,18 @@ class Comment(CatalogAware, WorkflowAware, DynamicType, Traversable,
         if self.title:
             return self.title
 
-        if not self.creator:
-            creator = translate(Message(_(u"label_anonymous",
+        if not self.author_name:
+            author_name = translate(Message(_(u"label_anonymous",
                                           default=u"Anonymous")))
         else:
-            creator = self.creator
-            creator = creator
+            author_name = self.author_name
 
         # Fetch the content object (the parent of the comment is the
         # conversation, the parent of the conversation is the content object).
         content = aq_base(self.__parent__.__parent__)
         title = translate(
             Message(COMMENT_TITLE,
-                    mapping={'creator': creator,
+                    mapping={'author_name': author_name,
                              'content': safe_unicode(content.Title())}))
         return title
 
diff --git a/plone/app/discussion/interfaces.py b/plone/app/discussion/interfaces.py
index 92560cd..2965289 100644
--- a/plone/app/discussion/interfaces.py
+++ b/plone/app/discussion/interfaces.py
@@ -157,7 +157,7 @@ class IComment(Interface):
                                              "email."),
                                      required=False)
 
-    creator = schema.TextLine(title=_(u"Author name (for display)"))
+    creator = schema.TextLine(title=_(u"Username of the commenter"))
     creation_date = schema.Date(title=_(u"Creation date"))
     modification_date = schema.Date(title=_(u"Modification date"))
 
diff --git a/plone/app/discussion/tests/functional_test_comments.txt b/plone/app/discussion/tests/functional_test_comments.txt
index a4856d4..5e59aed 100644
--- a/plone/app/discussion/tests/functional_test_comments.txt
+++ b/plone/app/discussion/tests/functional_test_comments.txt
@@ -353,6 +353,7 @@ View the collection listing.
     <Link text='Anonymous on Doc1' url='http://nohost/plone/doc1/++conversation++default/...'>
     >>> browser.getLink('Anonymous on Doc1', index=1)
     <Link text='Anonymous on Doc1' url='http://nohost/plone/doc1/++conversation++default/...'>
+    >>> open('/tmp/testbrowser.html', 'w').write(browser.contents)
     >>> browser.getLink(tarek_fullname + ' on Doc1')
     <Link text='Tarek Ziad\xc3\xa9 on Doc1' url='http://nohost/plone/doc1/++conversation++default/...'>
     >>> browser.getLink(jim_fullname + ' on Doc1')
diff --git a/plone/app/discussion/tests/test_catalog.py b/plone/app/discussion/tests/test_catalog.py
index dd117c4..36466d3 100644
--- a/plone/app/discussion/tests/test_catalog.py
+++ b/plone/app/discussion/tests/test_catalog.py
@@ -63,7 +63,7 @@ class ConversationCatalogTest(unittest.TestCase):
         comment1 = createObject('plone.Comment')
         comment1.title = 'Comment 1'
         comment1.text = 'Comment text'
-        comment1.creator = 'Jim'
+        comment1.creator = 'jim'
         comment1.author_username = 'Jim'
         comment1.creation_date = datetime(2006, 9, 17, 14, 18, 12)
         comment1.modification_date = datetime(2006, 9, 17, 14, 18, 12)
@@ -89,7 +89,6 @@ class ConversationCatalogTest(unittest.TestCase):
         comment2 = createObject('plone.Comment')
         comment2.title = 'Comment 2'
         comment2.text = 'Comment text'
-        comment2.creator = 'Emma'
         new_comment2_id = self.conversation.addComment(comment2)
 
         comment2 = self.portal.doc1.restrictedTraverse(
@@ -112,7 +111,6 @@ class ConversationCatalogTest(unittest.TestCase):
         comment2 = createObject('plone.Comment')
         comment2.title = 'Comment 2'
         comment2.text = 'Comment text'
-        comment2.creator = 'Emma'
         comment2.creation_date = datetime(2009, 9, 17, 14, 18, 12)
         comment2.modification_date = datetime(2009, 9, 17, 14, 18, 12)
         new_comment2_id = self.conversation.addComment(comment2)
@@ -159,7 +157,7 @@ class ConversationCatalogTest(unittest.TestCase):
         comment2 = createObject('plone.Comment')
         comment2.title = 'Comment 2'
         comment2.text = 'Comment text'
-        comment2.creator = 'Emma'
+        comment2.creator = 'emma'
         comment2.author_username = 'Emma'
         new_comment2_id = self.conversation.addComment(comment2)
 
@@ -225,7 +223,8 @@ class CommentCatalogTest(unittest.TestCase):
 
         comment1 = createObject('plone.Comment')
         comment1.text = 'Comment text'
-        comment1.creator = 'Jim'
+        comment1.creator = 'jim'
+        comment1.author_name = 'Jim'
         new_comment1_id = conversation.addComment(comment1)
         self.comment_id = new_comment1_id
 
@@ -263,7 +262,7 @@ class CommentCatalogTest(unittest.TestCase):
         self.assertEqual(self.comment_brain.review_state, 'published')
 
     def test_creator(self):
-        self.assertEqual(self.comment_brain.Creator, 'Jim')
+        self.assertEqual(self.comment_brain.Creator, 'jim')
 
     def test_in_response_to(self):
         """Make sure in_response_to returns the title or id of the content
diff --git a/plone/app/discussion/tests/test_comment.py b/plone/app/discussion/tests/test_comment.py
index 980dfd5..d83d3cb 100644
--- a/plone/app/discussion/tests/test_comment.py
+++ b/plone/app/discussion/tests/test_comment.py
@@ -98,7 +98,7 @@ class CommentTest(unittest.TestCase):
     def test_title(self):
         conversation = IConversation(self.portal.doc1)
         comment1 = createObject('plone.Comment')
-        comment1.creator = "Jim Fulton"
+        comment1.author_name = "Jim Fulton"
         conversation.addComment(comment1)
         self.assertEqual("Jim Fulton on Document 1", comment1.Title())
 
@@ -114,14 +114,14 @@ class CommentTest(unittest.TestCase):
                           type_name='Document')
         conversation = IConversation(self.portal.doc_sp_chars)
         comment1 = createObject('plone.Comment')
-        comment1.creator = u"Tarek Ziadé"
+        comment1.author_name = u"Tarek Ziadé"
         conversation.addComment(comment1)
         self.assertEqual(u"Tarek Ziadé on Document äüö", comment1.Title())
 
     def test_creator(self):
         comment1 = createObject('plone.Comment')
-        comment1.creator = "Jim"
-        self.assertEqual("Jim", comment1.Creator())
+        comment1.creator = "jim"
+        self.assertEqual("jim", comment1.Creator())
 
     def test_type(self):
         comment1 = createObject('plone.Comment')
diff --git a/plone/app/discussion/tests/test_indexers.py b/plone/app/discussion/tests/test_indexers.py
index 27f7bff..a12e97f 100644
--- a/plone/app/discussion/tests/test_indexers.py
+++ b/plone/app/discussion/tests/test_indexers.py
@@ -49,7 +49,7 @@ class ConversationIndexersTest(unittest.TestCase):
 
         comment1 = createObject('plone.Comment')
         comment1.text = 'Comment Text'
-        comment1.creator = "Jim"
+        comment1.creator = "jim"
         comment1.author_username = "Jim"
         comment1.creation_date = datetime(2006, 9, 17, 14, 18, 12)
         comment1.modification_date = datetime(2006, 9, 17, 14, 18, 12)
@@ -57,7 +57,7 @@ class ConversationIndexersTest(unittest.TestCase):
 
         comment2 = createObject('plone.Comment')
         comment2.text = 'Comment Text'
-        comment2.creator = "Emma"
+        comment2.creator = "emma"
         comment2.author_username = "Emma"
         comment2.creation_date = datetime(2007, 12, 13, 4, 18, 12)
         comment2.modification_date = datetime(2007, 12, 13, 4, 18, 12)
@@ -65,7 +65,7 @@ class ConversationIndexersTest(unittest.TestCase):
 
         comment3 = createObject('plone.Comment')
         comment3.text = 'Comment Text'
-        comment3.creator = "Lukas"
+        comment3.creator = "lukas"
         comment3.author_username = "Lukas"
         comment3.creation_date = datetime(2009, 4, 12, 11, 12, 12)
         comment3.modification_date = datetime(2009, 4, 12, 11, 12, 12)
@@ -124,7 +124,8 @@ class CommentIndexersTest(unittest.TestCase):
 
         comment = createObject('plone.Comment')
         comment.text = 'Lorem ipsum dolor sit amet.'
-        comment.creator = "Jim"
+        comment.creator = "jim"
+        comment.author_name = "Jim"
         comment.creation_date = datetime(2006, 9, 17, 14, 18, 12)
         comment.modification_date = datetime(2008, 3, 12, 7, 32, 52)
 
@@ -170,7 +171,7 @@ class CommentIndexersTest(unittest.TestCase):
                                 DelegatingIndexerFactory))
 
     def test_creator(self):
-        self.assertEqual(catalog.creator(self.comment)(), ('Jim'))
+        self.assertEqual(catalog.creator(self.comment)(), ('jim'))
 
     def test_in_response_to(self):
         # make sure in_response_to returns the title or id of the content
diff --git a/plone/app/discussion/tests/test_tool.py b/plone/app/discussion/tests/test_tool.py
index 783bdca..86a71b5 100644
--- a/plone/app/discussion/tests/test_tool.py
+++ b/plone/app/discussion/tests/test_tool.py
@@ -28,7 +28,8 @@ class ToolTest(unittest.TestCase):
 
         # Add a comment.
         comment = createObject('plone.Comment')
-        comment.creator = 'Jim'
+        comment.creator = 'jim'
+        comment.author_name = "Jim"
         comment.text = 'Comment text'
 
         conversation.addComment(comment)