improve mailer generator and add tests
Reported by Mislav | April 18th, 2008 @ 10:55 PM
This is what mailer generator used to generate:
class Notifier < ActionMailer::Base
def reset_password()
@subject = "..."
@from = "..."
# ...
end
end
You see that it used instance variables, while the documentation clearly advocates usage of methods. This patch changes output to:
def reset_password()
subject "..."
from "..."
# ...
end
It also cleans up the generator test suite, removing quite a lot duplication, and adds mailer test for the first time.
Comments and changes to this ticket
-
Mislav April 18th, 2008 @ 10:55 PM
- no changes were found...
-
Mislav April 18th, 2008 @ 11:11 PM
Added third commit. This is how the generated mailer now looks like:
script/generate mailer notifier reset_passwordIn @app/models/notifier.rb@:
class Notifier < ActionMailer::Base # change to your domain name default_url_options[:host] = 'example.com' def reset_password(sent_at = Time.now) subject 'Notifier#reset_password' recipients '' from '' sent_on sent_at body :greeting => 'Hi,' end end -
Joshua Peek April 18th, 2008 @ 11:17 PM
- → State changed from “new” to “resolved”
- → Assigned user changed from “” to “Joshua Peek”
-
-
Joshua Peek April 18th, 2008 @ 11:22 PM
Question, how did you diff those patches? It included your name and email at the top which is really nice.
Can you doc the process under Ticket Guidelines Authorship.
-
Mislav April 18th, 2008 @ 11:53 PM
git format-patch HEAD~3I can't edit Ticket Guidelines, only core team can.
-
Cody Fauser April 21st, 2008 @ 01:09 PM
Great changes overall. However, I did notice one small potential issue. I don't think the default_url_options[:host] call should be placed in the mailer. This seems to promote setting the host in each mailer, but the host is likely to be the same in most cases. Also, default_url_options is a mattr_accessor so the settings in each mailer will overwrite each other, which is likely to be confusing for the developer.
It seems more useful to use something like the following in the application's configuration:
config.action_mailer.default_url_options = { :host => 'myhost.com' } -
Mislav April 21st, 2008 @ 01:15 PM
Well, I generally agree. We only have to update docs for ActionMailer and we can remove `default_url_options` from generator.
-
Cody Fauser April 21st, 2008 @ 03:16 PM
Please take a look at #32. I created a patch which updates the documentation and removes the default_url_options call from the generator.
Please Login or create a free account to add a new comment.
You can update this ticket by sending an email to from your email client. (help)
Create your profile
Help contribute to this project by taking a few moments to create your personal profile. Create your profile »
Source available from github
The Git repository resides at http://github.com/rails
Check out the current development trunk (Edge Rails) with:
git clone git://github.com/rails/rails.git
Creating or reviewing a patch
See the contributor guide.
Creating a feature request
Please don't. If you want a new feature in Rails, you'll have to pull up your sleeves and get busy yourself. Or convince someone else to do it. See the contributor guide on how to get going. But posting them here is just going to lead to ticket root.
Creating a bug report
When creating a bug report, be sure to include as much relevant information as possible. Post the code sample that causes the problem. Preferably, alter the unit tests and show through either changed or added tests how the expected behavior is not occuring.
Security vulnerabilities should be reported via an email to security@rubyonrails.org, do not use trac for reporting security vulnerabilities. All content in trac is publicly available as soon as it is posted.
Then don't get your hopes up. Unless you have a "Code Red, Mission Critical, The World is Coming to an End" kinda bug, you're creating this ticket in the hope that others with the same problem will be able to collaborate with you on solving it. Do not expect that the ticket automatically will see any activity or that others will jump to fix it. Creating a ticket like this is mostly to help yourself start on the path of fixing the problem and for others to sign on to with a "I'm having this problem too".
