RubyGems - actionmailer - Versions diffs - 4.2.0.beta4 → 4.2.0.rc1 - Mend

actionmailer 4.2.0.beta4 → 4.2.0.rc1

Files changed (9) hide show

checksums.yaml +4 -4
data/CHANGELOG.md +30 -17
data/README.rdoc +21 -11
data/lib/action_mailer/base.rb +17 -11
data/lib/action_mailer/gem_version.rb +1 -1
data/lib/rails/generators/mailer/mailer_generator.rb +1 -0
data/lib/rails/generators/mailer/templates/application_mailer.rb +4 -0
data/lib/rails/generators/mailer/templates/mailer.rb +1 -2
metadata +22 -21

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bcb1c9b3e5d724b79972d86938bb122153250793
-  data.tar.gz: ddb546981d14586d13807d3ca1981b79762ce4a4
+  metadata.gz: 800efd649ee1a4c76b8156c66c3889abbecc3b02
+  data.tar.gz: cbd8ac503116232af6cbac98bc84ecf6700dfcf8
 SHA512:
-  metadata.gz: a09fc1e03f6b257904225ae25bfd2a02f99326e5deb03a90fd858a797fd5ba015b4d32e916f383ccd9cf41f335d4539e2084e39c05d914f9fc881fde4c87e643
-  data.tar.gz: b487d6808a402484d7d4f836a53503f5149bdcd1c94334ca98ecf6fbdb7716079aa13745c0a556c88fbcfd2af074681798e96de700586d23c6db70cbccc1413a
+  metadata.gz: be504a159dc18d224143486b07d77cfd4fdcc7847baaa1e6226fa84e02872c2fcb92cc9d5e67ed6b6114be0fcb21320e02f0772843fbe12251111879ce665d23
+  data.tar.gz: 18e6caed1d21195448f0932672367b560b4fe74ba52b081f3c95ea0b29e1e6541a76fc11c8f7050ab8d41aa047158b68c4804b48f6db2e1e2f17b9a944450d0d

data/CHANGELOG.md CHANGED

@@ -1,30 +1,42 @@
-*   Attachments can be added while rendering the mail template.
+*   `MailerGenerator` now generates layouts by default. The HTML mailer layout
+    now includes `<html>` and `<body>` tags which improve the spam rating in
+    some spam detection engines. Mailers now inherit from `ApplicationMailer`
+    which sets the default layout.
+    *Andy Jeffries*
+*   `link_to` and `url_for` now generate URLs by default in templates.
+    Passing `only_path: false` is no longer needed.
+    Fixes #16497 and #16589.
+    *Xavier Noria*, *Richard Schneeman*
+*   Attachments can now be added while rendering the mail template.
     Fixes #16974.
     *Christian Felder*
-*   Added `#deliver_later`, `#deliver_now` and deprecate `#deliver` in favour of
-    `#deliver_now`. `#deliver_later` will enqueue a job to render and deliver
-    the mail instead of delivering it right at that moment. The job is enqueued
-    using the new Active Job framework in Rails, and will use whatever queue is
-    configured for Rails.
+*   Add `#deliver_later` and `#deliver_now` methods and deprecate `#deliver` in
+    favor of `#deliver_now`. `#deliver_later` will enqueue a job to render and
+    deliver the mail instead of delivering it immediately. The job is enqueued
+    using the new Active Job framework in Rails and will use the queue that you
+    have configured in Rails.
     *DHH*, *Abdelkader Boudih*, *Cristian Bica*
-*   Make `ActionMailer::Previews` methods class methods. Previously they were
-    instance methods and `ActionMailer` tries to render a message when they
-    are called.
+*   `ActionMailer::Previews` are now class methods instead of instance methods.
     *Cristian Bica*
-*   Deprecate `*_path` helpers in email views. When used they generate
-    non-working links and are not the intention of most developers. Instead
-    we recommend to use `*_url` helper.
+*   Deprecate `*_path` helpers in email views. They generated broken links in
+    email views and were not the intention of most developers. The `*_url`
+    helper is recommended instead.
     *Richard Schneeman*
-*   Raise an exception when attachments are added after `mail` was called.
+*   Raise an exception when attachments are added after `mail` is called.
     This is a safeguard to prevent invalid emails.
     Fixes #16163.
@@ -33,10 +45,10 @@
 *   Add `config.action_mailer.show_previews` configuration option.
-    This config option can be used to enable the mail preview in environments
-    other than development (such as staging).
+    This configuration option can be used to enable the mail preview in
+    environments other than development (such as staging).
-    Defaults to `true` in development and false elsewhere.
+    Defaults to `true` in development and `false` elsewhere.
     *Leonard Garvey*
@@ -47,4 +59,5 @@
     *Yves Senn*
-Please check [4-1-stable](https://github.com/rails/rails/blob/4-1-stable/actionmailer/CHANGELOG.md) for previous changes.
+Please check [4-1-stable](https://github.com/rails/rails/blob/4-1-stable/actionmailer/CHANGELOG.md)
+for previous changes.

data/README.rdoc CHANGED

@@ -61,7 +61,7 @@ generated would look like this:
   Thank you for signing up!
-In order to send mails, you simply call the method and then call +deliver+ on the return value.
+In order to send mails, you simply call the method and then call +deliver_now+ on the return value.
 Calling the method returns a Mail Message object:
@@ -74,9 +74,17 @@ Or you can just chain the methods together like:
 == Setting defaults
-It is possible to set default values that will be used in every method in your Action Mailer class. To implement this functionality, you just call the public class method <tt>default</tt> which you get for free from <tt>ActionMailer::Base</tt>. This method accepts a Hash as the parameter. You can use any of the headers email messages have, like <tt>:from</tt> as the key. You can also pass in a string as the key, like "Content-Type", but Action Mailer does this out of the box for you, so you won't need to worry about that. Finally, it is also possible to pass in a Proc that will get evaluated when it is needed.
+It is possible to set default values that will be used in every method in your
+Action Mailer class. To implement this functionality, you just call the public
+class method +default+ which you get for free from <tt>ActionMailer::Base</tt>.
+This method accepts a Hash as the parameter. You can use any of the headers,
+email messages have, like +:from+ as the key. You can also pass in a string as
+the key, like "Content-Type", but Action Mailer does this out of the box for you,
+so you won't need to worry about that. Finally, it is also possible to pass in a
+Proc that will get evaluated when it is needed.
-Note that every value you set with this method will get overwritten if you use the same key in your mailer method.
+Note that every value you set with this method will get overwritten if you use the
+same key in your mailer method.
 Example:
@@ -87,10 +95,11 @@ Example:
 == Receiving emails
-To receive emails, you need to implement a public instance method called <tt>receive</tt> that takes an
-email object as its single parameter. The Action Mailer framework has a corresponding class method,
-which is also called <tt>receive</tt>, that accepts a raw, unprocessed email as a string, which it then turns
-into the email object and calls the receive instance method.
+To receive emails, you need to implement a public instance method called
++receive+ that takes an email object as its single parameter. The Action Mailer
+framework has a corresponding class method, which is also called +receive+, that
+accepts a raw, unprocessed email as a string, which it then turns into the email
+object and calls the receive instance method.
 Example:
@@ -111,13 +120,14 @@ Example:
     end
   end
-This Mailman can be the target for Postfix or other MTAs. In Rails, you would use the runner in the
-trivial case like this:
+This Mailman can be the target for Postfix or other MTAs. In Rails, you would use
+the runner in the trivial case like this:
   rails runner 'Mailman.receive(STDIN.read)'
-However, invoking Rails in the runner for each mail to be received is very resource intensive.  A single
-instance of Rails should be run within a daemon, if it is going to process more than just a limited amount of email.
+However, invoking Rails in the runner for each mail to be received is very
+resource intensive. A single instance of Rails should be run within a daemon, if
+it is going to process more than just a limited amount of email.
 == Configuration

data/lib/action_mailer/base.rb CHANGED

@@ -15,11 +15,17 @@ module ActionMailer
   #
   #   $ rails generate mailer Notifier
   #
-  # The generated model inherits from <tt>ActionMailer::Base</tt>. A mailer model defines methods
+  # The generated model inherits from <tt>ApplicationMailer</tt> which in turn
+  # inherits from <tt>ActionMailer::Base</tt>. A mailer model defines methods
   # used to generate an email message. In these methods, you can setup variables to be used in
   # the mailer views, options on the mail itself such as the <tt>:from</tt> address, and attachments.
   #
-  #   class Notifier < ActionMailer::Base
+  #   class ApplicationMailer < ActionMailer::Base
+  #     default from: 'from@exmaple.com'
+  #     layout 'mailer'
+  #   end
+  #
+  #   class Notifier < ApplicationMailer
   #     default from: 'no-reply@example.com',
   #             return_path: 'system@example.com'
   #
@@ -84,7 +90,7 @@ module ActionMailer
   # name as the method in your mailer model. For example, in the mailer defined above, the template at
   # <tt>app/views/notifier/welcome.text.erb</tt> would be used to generate the email.
   #
-  # Variables defined in the methods of your mailer model are accessible as instance variables in their
+  # Variables defined in the methods of your mailer model are accessible as instance variables in their
   # corresponding view.
   #
   # Emails by default are sent in plain text, so a sample view for our model example might look like this:
@@ -178,7 +184,7 @@ module ActionMailer
   #
   # Sending attachment in emails is easy:
   #
-  #   class ApplicationMailer < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     def welcome(recipient)
   #       attachments['free_book.pdf'] = File.read('path/to/file.pdf')
   #       mail(to: recipient, subject: "New account information")
@@ -194,7 +200,7 @@ module ActionMailer
   # If you need to send attachments with no content, you need to create an empty view for it,
   # or add an empty body parameter like this:
   #
-  #     class ApplicationMailer < ActionMailer::Base
+  #     class Notifier < ApplicationMailer
   #       def welcome(recipient)
   #         attachments['free_book.pdf'] = File.read('path/to/file.pdf')
   #         mail(to: recipient, subject: "New account information", body: "")
@@ -206,7 +212,7 @@ module ActionMailer
   # You can also specify that a file should be displayed inline with other HTML. This is useful
   # if you want to display a corporate logo or a photo.
   #
-  #   class ApplicationMailer < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     def welcome(recipient)
   #       attachments.inline['photo.png'] = File.read('path/to/photo.png')
   #       mail(to: recipient, subject: "Here is what we look like")
@@ -245,7 +251,7 @@ module ActionMailer
   # Action Mailer provides some intelligent defaults for your emails, these are usually specified in a
   # default method inside the class definition:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     default sender: 'system@example.com'
   #   end
   #
@@ -263,7 +269,7 @@ module ActionMailer
   # As you can pass in any header, you need to either quote the header as a string, or pass it in as
   # an underscored symbol, so the following will work:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     default 'Content-Transfer-Encoding' => '7bit',
   #             content_description: 'This is a description'
   #   end
@@ -271,7 +277,7 @@ module ActionMailer
   # Finally, Action Mailer also supports passing <tt>Proc</tt> objects into the default hash, so you
   # can define methods that evaluate as the message is being generated:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     default 'X-Special-Header' => Proc.new { my_method }
   #
   #     private
@@ -296,7 +302,7 @@ module ActionMailer
   # This may be useful, for example, when you want to add default inline attachments for all
   # messages sent out by a certain mailer class:
   #
-  #   class Notifier < ActionMailer::Base
+  #   class Notifier < ApplicationMailer
   #     before_action :add_inline_attachment!
   #
   #     def welcome
@@ -703,7 +709,7 @@ module ActionMailer
     # The main method that creates the message and renders the email templates. There are
     # two ways to call this method, with a block, or without a block.
     #
-    # It accepts a headers hash. This hash allows you to specify
+    # It accepts a headers hash. This hash allows you to specify
     # the most used headers in an email message, these are:
     #
     # * +:subject+ - The subject of the message, if this is omitted, Action Mailer will

data/lib/action_mailer/gem_version.rb CHANGED

@@ -8,7 +8,7 @@ module ActionMailer
     MAJOR = 4
     MINOR = 2
     TINY  = 0
-    PRE   = "beta4"
+    PRE   = "rc1"
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
   end

data/lib/rails/generators/mailer/mailer_generator.rb CHANGED

@@ -8,6 +8,7 @@ module Rails
       def create_mailer_file
         template "mailer.rb", File.join('app/mailers', class_path, "#{file_name}.rb")
+        template "application_mailer.rb", 'app/mailers/application_mailer.rb'
       end
       hook_for :template_engine, :test_framework

data/lib/rails/generators/mailer/templates/application_mailer.rb ADDED

@@ -0,0 +1,4 @@
+class ApplicationMailer < ActionMailer::Base
+  default from: "from@example.com"
+  layout 'mailer'
+end

data/lib/rails/generators/mailer/templates/mailer.rb CHANGED

@@ -1,6 +1,5 @@
 <% module_namespacing do -%>
-class <%= class_name %> < ActionMailer::Base
-  default from: "from@example.com"
+class <%= class_name %> < ApplicationMailer
 <% actions.each do |action| -%>
   # Subject can be set in your I18n file at config/locales/en.yml

metadata CHANGED

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionmailer
 version: !ruby/object:Gem::Version
-  version: 4.2.0.beta4
+  version: 4.2.0.rc1
 platform: ruby
 authors:
 - David Heinemeier Hansson
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-10-30 00:00:00.000000000 Z
+date: 2014-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,82 +16,82 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0.beta4
+        version: 4.2.0.rc1
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.5.4
 - !ruby/object:Gem::Dependency
   name: rails-dom-testing
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
+        version: 1.0.5
 description: Email on Rails. Compose, deliver, receive, and test emails using the
   familiar controller/view pattern. First-class support for multipart email and attachments.
 email: david@loudthinking.com
@@ -118,6 +118,7 @@ files:
 - lib/action_mailer/version.rb
 - lib/rails/generators/mailer/USAGE
 - lib/rails/generators/mailer/mailer_generator.rb
+- lib/rails/generators/mailer/templates/application_mailer.rb
 - lib/rails/generators/mailer/templates/mailer.rb
 homepage: http://www.rubyonrails.org
 licenses:
@@ -129,18 +130,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements:
 - none
 rubyforge_project:
-rubygems_version: 2.2.1
+rubygems_version: 2.2.2
 signing_key:
 specification_version: 4
 summary: Email composition, delivery, and receiving framework (part of Rails).