Merge lp:~thumper/launchpad/move-mailout-functions into lp:launchpad

[Tim Penhey]

Move functions from canonical.launchpad.mailout into lp.services.utils and lp.services.mail.sendmail.

A simple refactoring moving some functions from canonical.launchpad.mailout into lp.services.mail.

This makes the canonical.launchpad.mailout completely empty, so removes that module as well.

[Michael Hudson-Doyle (mwhudson)]

It looks good. Some minor pedantry:

1) I don't think the docstring of value_string should mention SQLObject any more.

2) The imports in lp.services.util are not properly sorted.

Yay for killing stuff in canonical.launchpad! Please land.

review: Approve

=== removed directory 'lib/canonical/launchpad/mailout'
=== removed file 'lib/canonical/launchpad/mailout/__init__.py'
--- lib/canonical/launchpad/mailout/__init__.py	2009-06-25 05:39:50 +0000
+++ lib/canonical/launchpad/mailout/__init__.py	1970-01-01 00:00:00 +0000
@@ -1,70 +0,0 @@
-# Copyright 2009 Canonical Ltd.  This software is licensed under the
-# GNU Affero General Public License version 3 (see the file LICENSE).
-
-from zope.security.proxy import isinstance as zope_isinstance
-from lazr.enum import BaseItem
-
-def value_string(item):
-    """Return a unicode string representing an SQLObject value."""
-    if item is None:
-        return '(not set)'
-    elif zope_isinstance(item, BaseItem):
-        return item.title
-    else:
-        return unicode(item)
-
-
-def text_delta(instance_delta, delta_names, state_names, interface):
-    """Return a textual delta for a Delta object.
-
-    A list of strings is returned.
-
-    Only modified members of the delta will be shown.
-
-    :param instance_delta: The delta to generate a textual representation of.
-    :param delta_names: The names of all members to show changes to.
-    :param state_names: The names of all members to show only the new state
-        of.
-    :param interface: The Zope interface that the input delta compared.
-    """
-    output = []
-    indent = ' ' * 4
-
-    # Fields for which we have old and new values.
-    for field_name in delta_names:
-        delta = getattr(instance_delta, field_name, None)
-        if delta is None:
-            continue
-        title = interface[field_name].title
-        old_item = value_string(delta['old'])
-        new_item = value_string(delta['new'])
-        output.append("%s%s: %s => %s" % (indent, title, old_item, new_item))
-    for field_name in state_names:
-        delta = getattr(instance_delta, field_name, None)
-        if delta is None:
-            continue
-        title = interface[field_name].title
-        if output:
-            output.append('')
-        output.append('%s changed to:\n\n%s' % (title, delta))
-    return '\n'.join(output)
-
-
-def append_footer(main, footer):
-    """Append a footer to an email, following signature conventions.
-
-    If there is no footer, do nothing.
-    If there is already a signature, append an additional footer.
-    If there is no existing signature, append '-- \n' and a footer.
-
-    :param main: The main content, which may have a signature.
-    :param footer: An additional footer to append.
-    :return: a new version of main that includes the footer.
-    """
-    if footer == '':
-        footer_separator = ''
-    elif '\n-- \n' in main:
-        footer_separator = '\n'
-    else:
-        footer_separator = '\n-- \n'
-    return ''.join((main, footer_separator, footer))

=== removed directory 'lib/canonical/launchpad/mailout/tests'
=== removed file 'lib/canonical/launchpad/mailout/tests/__init__.py'
=== modified file 'lib/lp/code/mail/codereviewcomment.py'
--- lib/lp/code/mail/codereviewcomment.py	2010-02-22 23:11:20 +0000
+++ lib/lp/code/mail/codereviewcomment.py	2010-03-18 22:56:30 +0000
@@ -7,11 +7,11 @@
 __metaclass__ = type
 
 
+from canonical.launchpad.webapp import canonical_url
+
 from lp.code.enums import CodeReviewNotificationLevel
-from canonical.launchpad.mail import format_address
-from canonical.launchpad.mailout import append_footer
 from lp.code.mail.branchmergeproposal import BMPMailer
-from canonical.launchpad.webapp import canonical_url
+from lp.services.mail.sendmail import append_footer, format_address
 
 
 def send(comment, event):

=== modified file 'lib/lp/services/mail/basemailer.py'
--- lib/lp/services/mail/basemailer.py	2009-09-04 05:02:48 +0000
+++ lib/lp/services/mail/basemailer.py	2010-03-18 22:56:30 +0000
@@ -11,11 +11,11 @@
 from smtplib import SMTPException
 
 from canonical.launchpad.helpers import get_email_template
-from canonical.launchpad.mailout import text_delta
 
 from lp.services.mail.notificationrecipientset import (
     NotificationRecipientSet)
 from lp.services.mail.sendmail import format_address, MailController
+from lp.services.utils import text_delta
 
 
 class BaseMailer:

=== modified file 'lib/lp/services/mail/sendmail.py'
--- lib/lp/services/mail/sendmail.py	2010-02-12 21:40:26 +0000
+++ lib/lp/services/mail/sendmail.py	2010-03-18 22:56:30 +0000
@@ -15,6 +15,7 @@
 """
 
 __all__ = [
+    'append_footer',
     'format_address',
     'get_msgid',
     'MailController',
@@ -91,6 +92,26 @@
             "Address contains carriage returns: %r" % (addr,))
 
 
+def append_footer(main, footer):
+    """Append a footer to an email, following signature conventions.
+
+    If there is no footer, do nothing.
+    If there is already a signature, append an additional footer.
+    If there is no existing signature, append '-- \n' and a footer.
+
+    :param main: The main content, which may have a signature.
+    :param footer: An additional footer to append.
+    :return: a new version of main that includes the footer.
+    """
+    if footer == '':
+        footer_separator = ''
+    elif '\n-- \n' in main:
+        footer_separator = '\n'
+    else:
+        footer_separator = '\n-- \n'
+    return ''.join((main, footer_separator, footer))
+
+
 def format_address(name, address):
     r"""Formats a name and address to be used as an email header.
 

=== modified file 'lib/lp/services/utils.py'
--- lib/lp/services/utils.py	2009-10-19 05:40:52 +0000
+++ lib/lp/services/utils.py	2010-03-18 22:56:30 +0000
@@ -7,9 +7,15 @@
 __metaclass__ = type
 __all__ = [
     'iter_split',
+    'text_delta',
+    'value_string',
     ]
 
 
+from lazr.enum import BaseItem
+from zope.security.proxy import isinstance as zope_isinstance
+
+
 def iter_split(string, splitter):
     """Iterate over ways to split 'string' in two with 'splitter'.
 
@@ -27,3 +33,52 @@
     tokens = string.split(splitter)
     for i in reversed(range(1, len(tokens) + 1)):
         yield splitter.join(tokens[:i]), splitter.join(tokens[i:])
+
+
+def value_string(item):
+    """Return a unicode string representing value.
+
+    This text is special cased for enumerated types.
+    """
+    if item is None:
+        return '(not set)'
+    elif zope_isinstance(item, BaseItem):
+        return item.title
+    else:
+        return unicode(item)
+
+
+def text_delta(instance_delta, delta_names, state_names, interface):
+    """Return a textual delta for a Delta object.
+
+    A list of strings is returned.
+
+    Only modified members of the delta will be shown.
+
+    :param instance_delta: The delta to generate a textual representation of.
+    :param delta_names: The names of all members to show changes to.
+    :param state_names: The names of all members to show only the new state
+        of.
+    :param interface: The Zope interface that the input delta compared.
+    """
+    output = []
+    indent = ' ' * 4
+
+    # Fields for which we have old and new values.
+    for field_name in delta_names:
+        delta = getattr(instance_delta, field_name, None)
+        if delta is None:
+            continue
+        title = interface[field_name].title
+        old_item = value_string(delta['old'])
+        new_item = value_string(delta['new'])
+        output.append("%s%s: %s => %s" % (indent, title, old_item, new_item))
+    for field_name in state_names:
+        delta = getattr(instance_delta, field_name, None)
+        if delta is None:
+            continue
+        title = interface[field_name].title
+        if output:
+            output.append('')
+        output.append('%s changed to:\n\n%s' % (title, delta))
+    return '\n'.join(output)