From dbcf01e6310bf3dc72499beb8f4161fb82143388 Mon Sep 17 00:00:00 2001 From: Mikel Lindsaar Date: Thu, 8 Apr 2010 12:47:17 +1000 Subject: Removing quoting.rb, upgrade to 2.1.3.6, changing all utf-8 references to UTF-8, updating tests where incorrect encoding --- actionmailer/CHANGELOG | 6 ++ actionmailer/actionmailer.gemspec | 2 +- actionmailer/lib/action_mailer/base.rb | 23 ++++--- actionmailer/lib/action_mailer/old_api.rb | 4 +- actionmailer/lib/action_mailer/test_case.rb | 6 +- actionmailer/test/old_base/mail_service_test.rb | 81 ++++++++++++++----------- actionmailer/test/old_base/url_test.rb | 5 +- actionmailer/test/test_helper_test.rb | 2 +- 8 files changed, 70 insertions(+), 59 deletions(-) (limited to 'actionmailer') diff --git a/actionmailer/CHANGELOG b/actionmailer/CHANGELOG index 605b18d7e9..697e0887ed 100644 --- a/actionmailer/CHANGELOG +++ b/actionmailer/CHANGELOG @@ -5,6 +5,12 @@ ActionMailer::Base.register_interceptor calls Mail.register_interceptor ActionMailer::Base.register_observer calls Mail.register_observer +* Removed quoting.rb and refactored for Mail to take responsibility of all quoting and auto encoding requirements for the header. + +* Fixed several tests which had incorrect encoding. + +* Changed all utf-8 to UTF-8 for consistency + * Whole new API added with tests. See base.rb for full details. Old API is deprecated. diff --git a/actionmailer/actionmailer.gemspec b/actionmailer/actionmailer.gemspec index e2724fcadb..852cc704c6 100644 --- a/actionmailer/actionmailer.gemspec +++ b/actionmailer/actionmailer.gemspec @@ -20,6 +20,6 @@ Gem::Specification.new do |s| s.has_rdoc = true s.add_dependency('actionpack', version) - s.add_dependency('mail', '~> 2.1.5.5') + s.add_dependency('mail', '~> 2.1.5.6') s.add_dependency('text-format', '~> 1.0.0') end diff --git a/actionmailer/lib/action_mailer/base.rb b/actionmailer/lib/action_mailer/base.rb index af7255ae4f..5dbe1738a1 100644 --- a/actionmailer/lib/action_mailer/base.rb +++ b/actionmailer/lib/action_mailer/base.rb @@ -207,7 +207,7 @@ module ActionMailer #:nodoc: # scores instead of hyphens, so Content-Transfer-Encoding: # becomes :content_transfer_encoding. The defaults set by Action Mailer are: # * :mime_version => "1.0" - # * :charset => "utf-8", + # * :charset => "UTF-8", # * :content_type => "text/plain", # * :parts_order => [ "text/plain", "text/enriched", "text/html" ] # @@ -264,7 +264,7 @@ module ActionMailer #:nodoc: # (i.e. multiple parts are assembled from templates which specify the content type in their # filenames) this variable controls how the parts are ordered. class Base < AbstractController::Base - include DeliveryMethods, Quoting + include DeliveryMethods abstract! include AbstractController::Logger @@ -286,7 +286,7 @@ module ActionMailer #:nodoc: class_attribute :default_params self.default_params = { :mime_version => "1.0", - :charset => "utf-8", + :charset => "UTF-8", :content_type => "text/plain", :parts_order => [ "text/plain", "text/enriched", "text/html" ] }.freeze @@ -531,7 +531,7 @@ module ActionMailer #:nodoc: # Quote fields headers[:subject] ||= default_i18n_subject - quote_fields!(headers, charset) + set_fields!(headers, charset) # Render the templates and blocks responses, explicit_order = collect_responses_and_parts_order(headers, &block) @@ -577,15 +577,14 @@ module ActionMailer #:nodoc: I18n.t(:subject, :scope => [:actionmailer, mailer_scope, action_name], :default => action_name.humanize) end - # TODO: Move this into Mail - def quote_fields!(headers, charset) #:nodoc: + def set_fields!(headers, charset) #:nodoc: m = @_message - m.subject ||= quote_if_necessary(headers.delete(:subject), charset) if headers[:subject] - m.to ||= quote_address_if_necessary(headers.delete(:to), charset) if headers[:to] - m.from ||= quote_address_if_necessary(headers.delete(:from), charset) if headers[:from] - m.cc ||= quote_address_if_necessary(headers.delete(:cc), charset) if headers[:cc] - m.bcc ||= quote_address_if_necessary(headers.delete(:bcc), charset) if headers[:bcc] - m.reply_to ||= quote_address_if_necessary(headers.delete(:reply_to), charset) if headers[:reply_to] + m.subject ||= headers.delete(:subject) if headers[:subject] + m.to ||= headers.delete(:to) if headers[:to] + m.from ||= headers.delete(:from) if headers[:from] + m.cc ||= headers.delete(:cc) if headers[:cc] + m.bcc ||= headers.delete(:bcc) if headers[:bcc] + m.reply_to ||= headers.delete(:reply_to) if headers[:reply_to] end def collect_responses_and_parts_order(headers) #:nodoc: diff --git a/actionmailer/lib/action_mailer/old_api.rb b/actionmailer/lib/action_mailer/old_api.rb index 7c59a8ae50..24c6ec8eda 100644 --- a/actionmailer/lib/action_mailer/old_api.rb +++ b/actionmailer/lib/action_mailer/old_api.rb @@ -147,8 +147,8 @@ module ActionMailer def create_mail m = @_message - quote_fields!({:subject => subject, :to => recipients, :from => from, - :bcc => bcc, :cc => cc, :reply_to => reply_to}, charset) + set_fields!({:subject => subject, :to => recipients, :from => from, + :bcc => bcc, :cc => cc, :reply_to => reply_to}, charset) m.mime_version = mime_version unless mime_version.nil? m.date = sent_on.to_time rescue sent_on if sent_on diff --git a/actionmailer/lib/action_mailer/test_case.rb b/actionmailer/lib/action_mailer/test_case.rb index 7c4033a125..d4874c6dbf 100644 --- a/actionmailer/lib/action_mailer/test_case.rb +++ b/actionmailer/lib/action_mailer/test_case.rb @@ -8,7 +8,7 @@ module ActionMailer end class TestCase < ActiveSupport::TestCase - include Quoting, TestHelper + include TestHelper setup :initialize_test_deliveries setup :set_expected_mail @@ -48,11 +48,11 @@ module ActionMailer private def charset - "utf-8" + "UTF-8" end def encode(subject) - quoted_printable(subject, charset) + Mail::Encodings.q_value_encode(subject, charset) end def read_fixture(action) diff --git a/actionmailer/test/old_base/mail_service_test.rb b/actionmailer/test/old_base/mail_service_test.rb index 9eb067554f..b584245cb2 100644 --- a/actionmailer/test/old_base/mail_service_test.rb +++ b/actionmailer/test/old_base/mail_service_test.rb @@ -105,7 +105,7 @@ class TestMailer < ActionMailer::Base sent_on Time.local(2004, 12, 12) cc "Foo áëô îü " bcc "Foo áëô îü " - charset "utf-8" + charset "UTF-8" body "åœö blah" end @@ -131,7 +131,7 @@ class TestMailer < ActionMailer::Base recipients recipient subject "Foo áëô îü" from "test@example.com" - charset "utf-8" + charset "UTF-8" part "text/plain" do |p| p.body = "blah" @@ -316,18 +316,15 @@ class TestMailer < ActionMailer::Base end class ActionMailerTest < Test::Unit::TestCase - include ActionMailer::Quoting - def encode( text, charset="utf-8" ) - quoted_printable( text, charset ) + def encode( text, charset="UTF-8" ) + Mail::Encodings.q_value_encode( text, charset ) end - def new_mail( charset="utf-8" ) + def new_mail( charset="UTF-8" ) mail = Mail.new + mail.charset = charset mail.mime_version = "1.0" - if charset - mail.content_type ["text", "plain", { "charset" => charset }] - end mail end @@ -671,14 +668,14 @@ class ActionMailerTest < Test::Unit::TestCase def test_unquote_quoted_printable_subject msg = <", "iso-8859-1" - expected.cc = quote_address_if_necessary "Grytøyr ", "iso-8859-1" - expected.bcc = quote_address_if_necessary "Grytøyr ", "iso-8859-1" + expected.from = "Grytøyr " + expected.cc = "Grytøyr " + expected.bcc = "Grytøyr " expected.date = Time.local 2004, 12, 12 created = nil @@ -774,13 +771,13 @@ EOF def test_utf8_body_is_not_quoted @recipient = "Foo áëô îü " - expected = new_mail "utf-8" - expected.to = quote_address_if_necessary @recipient, "utf-8" - expected.subject = "testing utf-8 body" + expected = new_mail "UTF-8" + expected.to = @recipient + expected.subject = "testing UTF-8 body" expected.body = "åœö blah" - expected.from = quote_address_if_necessary @recipient, "utf-8" - expected.cc = quote_address_if_necessary @recipient, "utf-8" - expected.bcc = quote_address_if_necessary @recipient, "utf-8" + expected.from = @recipient + expected.cc = @recipient + expected.bcc = @recipient expected.date = Time.local 2004, 12, 12 created = TestMailer.utf8_body @recipient @@ -789,18 +786,21 @@ EOF def test_multiple_utf8_recipients @recipient = ["\"Foo áëô îü\" ", "\"Example Recipient\" "] - expected = new_mail "utf-8" - expected.to = quote_address_if_necessary @recipient, "utf-8" - expected.subject = "testing utf-8 body" + expected = new_mail "UTF-8" + expected.to = @recipient + expected.subject = "testing UTF-8 body" expected.body = "åœö blah" - expected.from = quote_address_if_necessary @recipient.first, "utf-8" - expected.cc = quote_address_if_necessary @recipient, "utf-8" - expected.bcc = quote_address_if_necessary @recipient, "utf-8" + expected.from = @recipient.first + expected.cc = @recipient + expected.bcc = @recipient expected.date = Time.local 2004, 12, 12 created = TestMailer.utf8_body @recipient - assert_match(/\nFrom: =\?utf-8\?Q\?Foo_.*?\?= \r/, created.encoded) - assert_match(/\nTo: =\?utf-8\?Q\?Foo_.*?\?= , \r\n\tExample Recipient ") + assert_match(/#{to_regexp}/m, created.encoded) end def test_receive_decodes_base64_encoded_mail @@ -864,12 +864,19 @@ EOF def test_multipart_with_utf8_subject mail = TestMailer.multipart_with_utf8_subject(@recipient) - assert_match(/\nSubject: =\?utf-8\?Q\?Foo_.*?\?=/, mail.encoded) + regex = Regexp.escape('Subject: =?UTF-8?Q?Foo_=C3=A1=C3=AB=C3=B4_=C3=AE=C3=BC=?=') + assert_match(/#{regex}/, mail.encoded) + string = "Foo áëô îü" + string.force_encoding('UTF-8') if string.respond_to?(:force_encoding) + assert_match(string, mail.subject.decoded) end def test_implicitly_multipart_with_utf8 mail = TestMailer.implicitly_multipart_with_utf8 - assert_match(/\nSubject: =\?utf-8\?Q\?Foo_.*?\?=/, mail.encoded) + regex = Regexp.escape('Subject: =?UTF-8?Q?Foo_=C3=A1=C3=AB=C3=B4_=C3=AE=C3=BC=?=') + assert_match(/#{regex}/, mail.encoded) + string.force_encoding('UTF-8') if string.respond_to?(:force_encoding) + assert_match(string, mail.subject.decoded) end def test_explicitly_multipart_messages @@ -909,11 +916,11 @@ EOF assert_equal "1.0", mail.mime_version.to_s assert_equal "multipart/alternative", mail.mime_type assert_equal "text/plain", mail.parts[0].mime_type - assert_equal "utf-8", mail.parts[0].charset + assert_equal "UTF-8", mail.parts[0].charset assert_equal "text/html", mail.parts[1].mime_type - assert_equal "utf-8", mail.parts[1].charset + assert_equal "UTF-8", mail.parts[1].charset assert_equal "application/x-yaml", mail.parts[2].mime_type - assert_equal "utf-8", mail.parts[2].charset + assert_equal "UTF-8", mail.parts[2].charset end def test_implicitly_multipart_messages_with_custom_order @@ -1044,13 +1051,13 @@ EOF mail = FunkyPathMailer.multipart_with_template_path_with_dots(@recipient) assert_equal 2, mail.parts.length assert "text/plain", mail.parts[1].mime_type - assert "utf-8", mail.parts[1].charset + assert "UTF-8", mail.parts[1].charset end def test_custom_content_type_attributes mail = TestMailer.custom_content_type_attributes assert_match %r{format=flowed}, mail.content_type - assert_match %r{charset=utf-8}, mail.content_type + assert_match %r{charset=UTF-8}, mail.content_type end def test_return_path_with_create diff --git a/actionmailer/test/old_base/url_test.rb b/actionmailer/test/old_base/url_test.rb index 17b383cc2a..6895fb230e 100644 --- a/actionmailer/test/old_base/url_test.rb +++ b/actionmailer/test/old_base/url_test.rb @@ -29,13 +29,12 @@ class UrlTestMailer < ActionMailer::Base end class ActionMailerUrlTest < Test::Unit::TestCase - include ActionMailer::Quoting - def encode( text, charset="utf-8" ) + def encode( text, charset="UTF-8" ) quoted_printable( text, charset ) end - def new_mail( charset="utf-8" ) + def new_mail( charset="UTF-8" ) mail = Mail.new mail.mime_version = "1.0" if charset diff --git a/actionmailer/test/test_helper_test.rb b/actionmailer/test/test_helper_test.rb index 3a38a91c28..c23a9e7e3c 100644 --- a/actionmailer/test/test_helper_test.rb +++ b/actionmailer/test/test_helper_test.rb @@ -34,7 +34,7 @@ class TestHelperMailerTest < ActionMailer::TestCase end def test_charset_is_utf_8 - assert_equal "utf-8", charset + assert_equal "UTF-8", charset end def test_encode -- cgit v1.2.3