From: W. Trevor King <wking@drexel.edu>
Date: Sat, 25 Jul 2009 11:26:19 +0000 (-0400)
Subject: Renamed Comment.From and .time_string to .author and .date respectively.
X-Git-Tag: 1.0.0~62^2~46^2~9^2~15
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=9afbe4e78f7a332401ec03008ff66faa5c11e297;p=be.git

Renamed Comment.From and .time_string to .author and .date respectively.

Now they conform to the
  libbe.settings_object.setting_name_to_attr_name()
standard.

I fixed the references I found in
  becommands/comment.py
  interfaces/xml/be-mbox-to-xml
  interfaces/xml/be-xml-to-mbox
but there may have been some references or files that slipped through.
---

diff --git a/becommands/comment.py b/becommands/comment.py
index fc30a26..7bbee2c 100644
--- a/becommands/comment.py
+++ b/becommands/comment.py
@@ -38,7 +38,7 @@ def execute(args, manipulate_encodings=True):
     >>> print comment.body
     This is a comment about a
     <BLANKLINE>
-    >>> comment.From == bd.user_id
+    >>> comment.author == bd.user_id
     True
     >>> comment.time <= int(time.time())
     True
@@ -121,7 +121,7 @@ def execute(args, manipulate_encodings=True):
     if options.XML == False:
         new = parent.new_reply(body=body)
         if options.author != None:
-            new.From = options.author
+            new.author = options.author
         if options.alt_id != None:
             new.alt_id = options.alt_id
         if options.content_type != None:
diff --git a/interfaces/xml/be-mbox-to-xml b/interfaces/xml/be-mbox-to-xml
index 57de719..dc6a1c5 100755
--- a/interfaces/xml/be-mbox-to-xml
+++ b/interfaces/xml/be-mbox-to-xml
@@ -28,6 +28,7 @@ from libbe.encoding import get_encoding, set_IO_stream_encodings
 from mailbox import mbox, Message  # the mailbox people really want an on-disk copy
 from time import asctime, gmtime
 import types
+from xml.sax.saxutils import escape
 
 DEFAULT_ENCODING = get_encoding()
 set_IO_stream_encodings(DEFAULT_ENCODING)
@@ -40,7 +41,7 @@ def comment_message_to_xml(message, fields=None):
     new_fields = {}
     new_fields[u'alt-id'] = message[u'message-id']
     new_fields[u'in-reply-to'] = message[u'in-reply-to']
-    new_fields[u'from'] = message[u'from']
+    new_fields[u'author'] = message[u'from']
     new_fields[u'date'] = message[u'date']
     new_fields[u'content-type'] = message.get_content_type()
     for k,v in new_fields.items():
@@ -77,12 +78,12 @@ def comment_message_to_xml(message, fields=None):
     if message.is_multipart():
         ret = []
         alt_id = fields[u'alt-id']
-        from_str = fields[u'from']
+        from_str = fields[u'author']
         date = fields[u'date']
         for m in message.walk():
             if m == message:
                 continue
-            fields[u'from'] = from_str
+            fields[u'author'] = from_str
             fields[u'date'] = date
             if len(ret) > 0: # we've added one part already
                 fields.pop(u'alt-id') # don't pass alt-id to other parts
diff --git a/interfaces/xml/be-xml-to-mbox b/interfaces/xml/be-xml-to-mbox
index ea77c34..c630447 100755
--- a/interfaces/xml/be-xml-to-mbox
+++ b/interfaces/xml/be-xml-to-mbox
@@ -129,7 +129,7 @@ class Comment (LimitedAttrDict):
               u"alt-id",
               u"short-name",
               u"in-reply-to",
-              u"from",
+              u"author",
               u"date",
               u"content-type",
               u"body"]
@@ -137,7 +137,7 @@ class Comment (LimitedAttrDict):
         if bug == None:
             bug = Bug()
             bug[u"uuid"] = u"no-uuid"
-        name,addr = email.utils.parseaddr(self["from"])
+        name,addr = email.utils.parseaddr(self["author"])
         print "From %s %s" % (addr, rfc2822_to_asctime(self["date"]))
         if "uuid" in self:     id = self["uuid"]
         elif "alt-id" in self: id = self["alt-id"]
@@ -145,7 +145,7 @@ class Comment (LimitedAttrDict):
         if id != None:
             print "Message-ID: <%s@%s>" % (id, DEFAULT_DOMAIN)
         print "Date: %s" % self["date"]
-        print "From: %s" % self["from"]
+        print "From: %s" % self["author"]
         subject = ""
         if "short-name" in self:
             subject += self["short-name"]+u": "
diff --git a/libbe/comment.py b/libbe/comment.py
index 3249e8b..0d2fb57 100644
--- a/libbe/comment.py
+++ b/libbe/comment.py
@@ -162,9 +162,9 @@ class Comment(Tree, settings_object.SavedSettingsObject):
                          doc="Alternate ID for linking imported comments.  Internally comments are linked (via In-reply-to) to the parent's UUID.  However, these UUIDs are generated internally, so Alt-id is provided as a user-controlled linking target.")
     def alt_id(): return {}
 
-    @_versioned_property(name="From",
+    @_versioned_property(name="Author",
                          doc="The author of the comment")
-    def From(): return {}
+    def author(): return {}
 
     @_versioned_property(name="In-reply-to",
                          doc="UUID for parent comment or bug")
@@ -178,17 +178,17 @@ class Comment(Tree, settings_object.SavedSettingsObject):
 
     @_versioned_property(name="Date",
                          doc="An RFC 2822 timestamp for comment creation")
-    def time_string(): return {}
+    def date(): return {}
 
     def _get_time(self):
-        if self.time_string == None:
+        if self.date == None:
             return None
-        return utility.str_to_time(self.time_string)
+        return utility.str_to_time(self.date)
     def _set_time(self, value):
-        self.time_string = utility.time_to_str(value)
+        self.date = utility.time_to_str(value)
     time = property(fget=_get_time,
                     fset=_set_time,
-                    doc="An integer version of .time_string")
+                    doc="An integer version of .date")
 
     def _get_comment_body(self):
         if self.rcs != None and self.sync_with_disk == True:
@@ -258,7 +258,7 @@ class Comment(Tree, settings_object.SavedSettingsObject):
                 self.uuid = uuid_gen()
             self.time = int(time.time()) # only save to second precision
             if self.rcs != None:
-                self.From = self.rcs.get_user_id()
+                self.author = self.rcs.get_user_id()
             self.in_reply_to = in_reply_to
             self.body = body
 
@@ -282,12 +282,12 @@ class Comment(Tree, settings_object.SavedSettingsObject):
         """
         >>> comm = Comment(bug=None, body="Some\\ninsightful\\nremarks\\n")
         >>> comm.uuid = "0123"
-        >>> comm.time_string = "Thu, 01 Jan 1970 00:00:00 +0000"
+        >>> comm.date = "Thu, 01 Jan 1970 00:00:00 +0000"
         >>> print comm.xml(indent=2, shortname="com-1")
           <comment>
             <uuid>0123</uuid>
             <short-name>com-1</short-name>
-            <from></from>
+            <author></author>
             <date>Thu, 01 Jan 1970 00:00:00 +0000</date>
             <content-type>text/plain</content-type>
             <body>Some
@@ -309,8 +309,8 @@ class Comment(Tree, settings_object.SavedSettingsObject):
                 ("alt-id", self.alt_id),
                 ("short-name", shortname),
                 ("in-reply-to", self.in_reply_to),
-                ("from", self._setting_attr_string("From")),
-                ("date", self.time_string),
+                ("author", self._setting_attr_string("author")),
+                ("date", self.date),
                 ("content-type", self.content_type),
                 ("body", body)]
         lines = ["<comment>"]
@@ -328,11 +328,11 @@ class Comment(Tree, settings_object.SavedSettingsObject):
         <alt-id> fields.
         >>> commA = Comment(bug=None, body="Some\\ninsightful\\nremarks\\n")
         >>> commA.uuid = "0123"
-        >>> commA.time_string = "Thu, 01 Jan 1970 00:00:00 +0000"
+        >>> commA.date = "Thu, 01 Jan 1970 00:00:00 +0000"
         >>> xml = commA.xml(shortname="com-1")
         >>> commB = Comment()
         >>> commB.from_xml(xml)
-        >>> attrs=['uuid','alt_id','in_reply_to','From','time_string','content_type','body']
+        >>> attrs=['uuid','alt_id','in_reply_to','author','date','content_type','body']
         >>> for attr in attrs: # doctest: +ELLIPSIS
         ...     if getattr(commB, attr) != getattr(commA, attr):
         ...         estr = "Mismatch on %s: '%s' should be '%s'"
@@ -342,15 +342,15 @@ class Comment(Tree, settings_object.SavedSettingsObject):
         Mismatch on alt_id: '0123' should be 'None'
         >>> print commB.alt_id
         0123
-        >>> commA.From
-        >>> commB.From
+        >>> commA.author
+        >>> commB.author
         """
         if type(xml_string) == types.UnicodeType:
             xml_string = xml_string.strip().encode("unicode_escape")
         comment = ElementTree.XML(xml_string)
         if comment.tag != "comment":
             raise InvalidXML(comment, "root element must be <comment>")
-        tags=['uuid','alt-id','in-reply-to','from','date','content-type','body']
+        tags=['uuid','alt-id','in-reply-to','author','date','content-type','body']
         uuid = None
         body = None
         for child in comment.getchildren():
@@ -368,10 +368,6 @@ class Comment(Tree, settings_object.SavedSettingsObject):
                 if child.tag == "body":
                     body = text
                     continue # don't set the bug's body yet.
-                elif child.tag == 'from':
-                    attr_name = "From"
-                elif child.tag == 'date':
-                    attr_name = 'time_string'
                 else:
                     attr_name = child.tag.replace('-','_')
                 setattr(self, attr_name, text)
@@ -389,7 +385,7 @@ class Comment(Tree, settings_object.SavedSettingsObject):
     def string(self, indent=0, shortname=None):
         """
         >>> comm = Comment(bug=None, body="Some\\ninsightful\\nremarks\\n")
-        >>> comm.time_string = "Thu, 01 Jan 1970 00:00:00 +0000"
+        >>> comm.date = "Thu, 01 Jan 1970 00:00:00 +0000"
         >>> print comm.string(indent=2, shortname="com-1")
           --------- Comment ---------
           Name: com-1
@@ -405,8 +401,8 @@ class Comment(Tree, settings_object.SavedSettingsObject):
         lines = []
         lines.append("--------- Comment ---------")
         lines.append("Name: %s" % shortname)
-        lines.append("From: %s" % (self._setting_attr_string("From")))
-        lines.append("Date: %s" % self.time_string)
+        lines.append("From: %s" % (self._setting_attr_string("author")))
+        lines.append("Date: %s" % self.date)
         lines.append("")
         if self.content_type.startswith("text/"):
             lines.extend((self.body or "").splitlines())
@@ -421,8 +417,8 @@ class Comment(Tree, settings_object.SavedSettingsObject):
         """
         >>> comm = Comment(bug=None, body="Some insightful remarks")
         >>> comm.uuid = "com-1"
-        >>> comm.time_string = "Thu, 20 Nov 2008 15:55:11 +0000"
-        >>> comm.From = "Jane Doe <jdoe@example.com>"
+        >>> comm.date = "Thu, 20 Nov 2008 15:55:11 +0000"
+        >>> comm.author = "Jane Doe <jdoe@example.com>"
         >>> print comm
         --------- Comment ---------
         Name: com-1
@@ -506,7 +502,7 @@ class Comment(Tree, settings_object.SavedSettingsObject):
           name_map = {}
           for shortname,comment in comm.comment_shortnames(bug_shortname):
               name_map[comment.uuid] = shortname
-          comm.sort(key=lambda c : c.From) # your sort
+          comm.sort(key=lambda c : c.author) # your sort
           comm.string_thread(name_map=name_map)
 
         >>> a = Comment(bug=None, uuid="a", body="Insightful remarks")