Merge lp:~abentley/launchpad/gmail-inline into lp:launchpad

[Aaron Bentley]

[Aaron Bentley (abentley)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

= Summary =
As seen in bug #401772, Gmail doesn't display diffs inline unless the
content-type is text/plain or the file extension is .txt.

== Proposed fix ==
Change the file extensions of generated diffs to be .txt. This will
appease Gmail, but clients which respect the text/x-diff content-type
will be unaffected.

== Pre-implementation notes ==
Pre-imp with Thumper

== Implementation details ==
None

== Tests ==
bin/test mail.tests -t test_generateEmail_with_diff -t
test_generateEmail_attaches_diff

== Demo and Q/A ==
Generate merge proposal emails and branch revision emails containing
diffs. Jam them into Gmail somehow. Possibly download the raw bytes
from staging, and use a Python script to resend to Gmail.

View them on Gmail. Observe whether they're displayed inline.

= Launchpad lint =

Checking for conflicts. and issues in doctests and templates.
Running jslint, xmllint, pyflakes, and pylint.
Using normal rules.

Linting changed files:
  lib/lp/code/mail/tests/test_branch.py
  lib/lp/code/mail/branchmergeproposal.py
  lib/lp/code/mail/tests/test_branchmergeproposal.py
  lib/lp/code/mail/branch.py
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org

iEYEARECAAYFAkpnX2MACgkQ0F+nu1YWqI2o1wCghdKG6QUdLZYG2yBXfP8Z35+R
A98AniLXLW0vp2sD5FrgHX2/9rsTNJrF
=HTT3
-----END PGP SIGNATURE-----

[Edwin Grubbs (edwin-grubbs)]

Hi Aaron,

This branch looks good, too.

merge-approved

-Edwin

review: Approve

=== modified file 'lib/lp/code/mail/branch.py'
--- lib/lp/code/mail/branch.py	2009-07-17 00:26:05 +0000
+++ lib/lp/code/mail/branch.py	2009-07-22 18:37:32 +0000
@@ -322,9 +322,10 @@
         """
         if not self._includeDiff(email):
             return
+        # Using .txt as a file extension makes Gmail display it inline.
         ctrl.addAttachment(
             self.diff, content_type='text/x-diff', inline=True,
-                filename='revision.diff')
+                filename='revision-diff.txt')
 
     @staticmethod
     def _format_user_address(user):

=== modified file 'lib/lp/code/mail/branchmergeproposal.py'
--- lib/lp/code/mail/branchmergeproposal.py	2009-07-17 00:26:05 +0000
+++ lib/lp/code/mail/branchmergeproposal.py	2009-07-22 18:37:32 +0000
@@ -175,9 +175,10 @@
 
     def _addAttachments(self, ctrl, email):
         if self.review_diff is not None:
+            # Using .txt as a file extension makes Gmail display it inline.
             ctrl.addAttachment(
                 self.review_diff.diff.text, content_type='text/x-diff',
-                inline=True, filename='review.diff')
+                inline=True, filename='review-diff.txt')
 
     def _generateTemplateParams(self):
         """For template params that don't change, calcualte just once."""

=== modified file 'lib/lp/code/mail/tests/test_branch.py'
--- lib/lp/code/mail/tests/test_branch.py	2009-07-17 00:26:05 +0000
+++ lib/lp/code/mail/tests/test_branch.py	2009-07-22 18:37:32 +0000
@@ -189,7 +189,7 @@
         diff = ctrl.attachments[0]
         self.assertEqual('hello', diff.get_payload(decode=True))
         self.assertEqual('text/x-diff', diff['Content-type'])
-        self.assertEqual('inline; filename="revision.diff"',
+        self.assertEqual('inline; filename="revision-diff.txt"',
                          diff['Content-disposition'])
         self.assertNotIn('hello', ctrl.body)
         self.assertNotIn('larger than your specified limit', ctrl.body)

=== modified file 'lib/lp/code/mail/tests/test_branchmergeproposal.py'
--- lib/lp/code/mail/tests/test_branchmergeproposal.py	2009-07-17 00:26:05 +0000
+++ lib/lp/code/mail/tests/test_branchmergeproposal.py	2009-07-22 18:37:32 +0000
@@ -178,7 +178,7 @@
         ctrl = mailer.generateEmail('[e-mail]', subscriber)
         (attachment,) = ctrl.attachments
         self.assertEqual('text/x-diff', attachment['Content-Type'])
-        self.assertEqual('inline; filename="review.diff"',
+        self.assertEqual('inline; filename="review-diff.txt"',
                          attachment['Content-Disposition'])
         self.assertEqual('Fake diff', attachment.get_payload(decode=True))