From 6e6c0117b30226f031771acb9715318987067f51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jos=C3=A9=20Valim?= Date: Thu, 25 Jun 2009 12:57:58 +0200 Subject: Added Mailer generaator template engine and test framework agnostic. --- railties/lib/generators/base.rb | 19 ++++++++++++++++++ railties/lib/generators/erb.rb | 8 ++++++++ .../lib/generators/erb/mailer/mailer_generator.rb | 19 ++++++++++++++++++ .../lib/generators/erb/mailer/templates/view.erb | 3 +++ railties/lib/generators/rails/mailer/USAGE | 15 ++++++++++++++ .../generators/rails/mailer/mailer_generator.rb | 18 +++++++++++++++++ .../generators/rails/mailer/templates/mailer.rb | 15 ++++++++++++++ .../test_unit/mailer/mailer_generator.rb | 23 ++++++++++++++++++++++ .../generators/test_unit/mailer/templates/fixture | 3 +++ .../test_unit/mailer/templates/unit_test.rb | 20 +++++++++++++++++++ 10 files changed, 143 insertions(+) create mode 100644 railties/lib/generators/erb.rb create mode 100644 railties/lib/generators/erb/mailer/mailer_generator.rb create mode 100644 railties/lib/generators/erb/mailer/templates/view.erb create mode 100644 railties/lib/generators/rails/mailer/USAGE create mode 100644 railties/lib/generators/rails/mailer/mailer_generator.rb create mode 100644 railties/lib/generators/rails/mailer/templates/mailer.rb create mode 100644 railties/lib/generators/test_unit/mailer/mailer_generator.rb create mode 100644 railties/lib/generators/test_unit/mailer/templates/fixture create mode 100644 railties/lib/generators/test_unit/mailer/templates/unit_test.rb (limited to 'railties/lib/generators') diff --git a/railties/lib/generators/base.rb b/railties/lib/generators/base.rb index d4bce83161..e009998bfa 100644 --- a/railties/lib/generators/base.rb +++ b/railties/lib/generators/base.rb @@ -119,6 +119,25 @@ module Rails end end end + + # Small macro to add template engine option and invoke it. + # + def self.add_and_invoke_template_engine_option! + class_option :template_engine, :type => :string, :aliases => "-e", :default => "erb", + :desc => "Template engine to be invoked by this generator", :banner => "NAME" + + define_method :invoke_template_engine do + return unless options[:template_engine] + name = "#{options[:template_engine]}:generators:#{self.class.generator_name}" + + begin + invoke name + rescue Thor::UndefinedTaskError + say "Could not find and invoke '#{name}'." + end + end + end + end end end diff --git a/railties/lib/generators/erb.rb b/railties/lib/generators/erb.rb new file mode 100644 index 0000000000..da99cec895 --- /dev/null +++ b/railties/lib/generators/erb.rb @@ -0,0 +1,8 @@ +require 'generators/named_base' + +module Erb + module Generators + class Base < Rails::Generators::NamedBase + end + end +end diff --git a/railties/lib/generators/erb/mailer/mailer_generator.rb b/railties/lib/generators/erb/mailer/mailer_generator.rb new file mode 100644 index 0000000000..2458762a9d --- /dev/null +++ b/railties/lib/generators/erb/mailer/mailer_generator.rb @@ -0,0 +1,19 @@ +module Erb + module Generators + class MailerGenerator < Base + argument :actions, :type => :array, :default => [] + + desc <#<%= @action %> + +Find me in <%= @path %> diff --git a/railties/lib/generators/rails/mailer/USAGE b/railties/lib/generators/rails/mailer/USAGE new file mode 100644 index 0000000000..638934d38d --- /dev/null +++ b/railties/lib/generators/rails/mailer/USAGE @@ -0,0 +1,15 @@ +Description: + Stubs out a new mailer and its views. Pass the mailer name, either + CamelCased or under_scored, and an optional list of emails as arguments. + + This generates a mailer class in app/models, view templates in + app/views/mailer_name and then invokes your test framework. + +Example: + `./script/generate mailer Notifications signup forgot_password invoice` + + creates a Notifications mailer class, views, test, and fixtures: + Mailer: app/models/notifications.rb + Views: app/views/notifications/signup.erb [...] + Test: test/unit/test/unit/notifications_test.rb + Fixtures: test/fixtures/notifications/signup [...] diff --git a/railties/lib/generators/rails/mailer/mailer_generator.rb b/railties/lib/generators/rails/mailer/mailer_generator.rb new file mode 100644 index 0000000000..4c77df89ab --- /dev/null +++ b/railties/lib/generators/rails/mailer/mailer_generator.rb @@ -0,0 +1,18 @@ +module Rails + module Generators + class MailerGenerator < NamedBase + argument :actions, :type => :array, :default => [] + + def check_class_collision + class_collisions class_name + end + + def create_mailer_file + template "mailer.rb", File.join('app/models', class_path, "#{file_name}.rb") + end + + add_and_invoke_template_engine_option! + add_and_invoke_test_framework_option! + end + end +end diff --git a/railties/lib/generators/rails/mailer/templates/mailer.rb b/railties/lib/generators/rails/mailer/templates/mailer.rb new file mode 100644 index 0000000000..ce15ae9de9 --- /dev/null +++ b/railties/lib/generators/rails/mailer/templates/mailer.rb @@ -0,0 +1,15 @@ +class <%= class_name %> < ActionMailer::Base + +<% for action in actions -%> + + def <%= action %>(sent_at = Time.now) + subject '<%= class_name %>#<%= action %>' + recipients '' + from '' + sent_on sent_at + + body :greeting => 'Hi,' + end +<% end -%> + +end diff --git a/railties/lib/generators/test_unit/mailer/mailer_generator.rb b/railties/lib/generators/test_unit/mailer/mailer_generator.rb new file mode 100644 index 0000000000..5fa7751076 --- /dev/null +++ b/railties/lib/generators/test_unit/mailer/mailer_generator.rb @@ -0,0 +1,23 @@ +module TestUnit + module Generators + class MailerGenerator < Base + argument :actions, :type => :array, :default => [] + + desc <#<%= @action %> + +Find me in <%= @path %> diff --git a/railties/lib/generators/test_unit/mailer/templates/unit_test.rb b/railties/lib/generators/test_unit/mailer/templates/unit_test.rb new file mode 100644 index 0000000000..4de94076e9 --- /dev/null +++ b/railties/lib/generators/test_unit/mailer/templates/unit_test.rb @@ -0,0 +1,20 @@ +require 'test_helper' + +class <%= class_name %>Test < ActionMailer::TestCase +<% for action in actions -%> + test "<%= action %>" do + @expected.subject = '<%= class_name %>#<%= action %>' + @expected.body = read_fixture('<%= action %>') + @expected.date = Time.now + + assert_equal @expected.encoded, <%= class_name %>.create_<%= action %>(@expected.date).encoded + end + +<% end -%> +<% if actions.blank? -%> + # replace this with your real tests + test "the truth" do + assert true + end +<% end -%> +end -- cgit v1.2.3