Cleanup generator tests by extracting repeated code into generator_te…

…st_helper. Add test for mailer generator.

Signed-off-by: Joshua Peek <josh@joshpeek.com>

railties/lib/rails_generator/generators/components/mailer/mailer_generator.rb

@@ -11,12 +11,8 @@ def manifest
       m.directory File.join('test/fixtures', file_path)
 
       # Mailer class and unit test.
-      m.template "mailer.rb",    File.join('app/models',
-                                           class_path,
-                                           "#{file_name}.rb")
-      m.template "unit_test.rb", File.join('test/unit',
-                                           class_path,
-                                           "#{file_name}_test.rb")
+      m.template "mailer.rb",    File.join('app/models', class_path, "#{file_name}.rb")
+      m.template "unit_test.rb", File.join('test/unit', class_path, "#{file_name}_test.rb")
 
       # View template and fixture for each action.
       actions.each do |action|

railties/test/generators/generator_test_helper.rb

@@ -1,3 +1,51 @@
+require 'test/unit'
+require 'fileutils'
+
+# Mock out what we need from AR::Base
+module ActiveRecord
+  class Base
+    class << self
+      attr_accessor :pluralize_table_names
+    end
+    self.pluralize_table_names = true
+  end
+
+  module ConnectionAdapters
+    class Column
+      attr_reader :name, :default, :type, :limit, :null, :sql_type, :precision, :scale
+
+      def initialize(name, default, sql_type = nil)
+        @name = name
+        @default = default
+        @type = @sql_type = sql_type
+      end
+
+      def human_name
+        @name.humanize
+      end
+    end
+  end
+end
+
+# Mock up necessities from ActionView
+module ActionView
+  module Helpers
+    module ActionRecordHelper; end
+    class InstanceTag; end
+  end
+end
+
+# Set RAILS_ROOT appropriately fixture generation
+tmp_dir = "#{File.dirname(__FILE__)}/../fixtures/tmp"
+
+if defined? RAILS_ROOT
+  RAILS_ROOT.replace tmp_dir
+else
+  RAILS_ROOT = tmp_dir
+end
+FileUtils.mkdir_p RAILS_ROOT
+
+$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
 require 'initializer'
 
 # Mocks out the configuration
@@ -9,44 +57,71 @@ def self.configuration
 
 require 'rails_generator'
 
+class GeneratorTestCase < Test::Unit::TestCase
+  include FileUtils
+
+  def setup
+    ActiveRecord::Base.pluralize_table_names = true
+
+    mkdir_p "#{RAILS_ROOT}/app/views/layouts"
+    mkdir_p "#{RAILS_ROOT}/config"
+    mkdir_p "#{RAILS_ROOT}/db"
+    mkdir_p "#{RAILS_ROOT}/test/fixtures"
+    mkdir_p "#{RAILS_ROOT}/public/stylesheets"
+
+    File.open("#{RAILS_ROOT}/config/routes.rb", 'w') do |f|
+      f << "ActionController::Routing::Routes.draw do |map|\n\nend"
+    end
+  end
 
-module GeneratorTestHelper
+  def teardown
+    rm_rf "#{RAILS_ROOT}/app"
+    rm_rf "#{RAILS_ROOT}/test"
+    rm_rf "#{RAILS_ROOT}/config"
+    rm_rf "#{RAILS_ROOT}/db"
+    rm_rf "#{RAILS_ROOT}/public"
+  end
+
+  def test_truth
+    # don't complain, test/unit
+  end
+
   # Instantiates the Generator
-  def build_generator(name,params)
-    Rails::Generator::Base.instance(name,params)
+  def build_generator(name, params)
+    Rails::Generator::Base.instance(name, params)
   end
 
   # Runs the create command (like the command line does)
-  def run_generator(name,params)
+  def run_generator(name, params)
     silence_generator do
-      build_generator(name,params).command(:create).invoke!
+      build_generator(name, params).command(:create).invoke!
     end
   end
 
   # Silences the logger temporarily and returns the output as a String
   def silence_generator
-    logger_original=Rails::Generator::Base.logger
-    myout=StringIO.new
-    Rails::Generator::Base.logger=Rails::Generator::SimpleLogger.new(myout)
+    logger_original = Rails::Generator::Base.logger
+    myout = StringIO.new
+    Rails::Generator::Base.logger = Rails::Generator::SimpleLogger.new(myout)
     yield if block_given?
-    Rails::Generator::Base.logger=logger_original
+    Rails::Generator::Base.logger = logger_original
     myout.string
   end
 
   # asserts that the given controller was generated.
   # It takes a name or symbol without the <tt>_controller</tt> part and an optional super class.
   # The contents of the class source file is passed to a block.
-  def assert_generated_controller_for(name,parent="ApplicationController")
-    assert_generated_class "app/controllers/#{name.to_s.underscore}_controller",parent do |body|
+  def assert_generated_controller_for(name, parent = "ApplicationController")
+    assert_generated_class "app/controllers/#{name.to_s.underscore}_controller", parent do |body|
       yield body if block_given?
     end
   end
 
   # asserts that the given model was generated.
   # It takes a name or symbol and an optional super class.
   # the contents of the class source file is passed to a block.
-  def assert_generated_model_for(name,parent="ActiveRecord::Base")
-    assert_generated_class "app/models/#{name.to_s.underscore}",parent do |body|
+  def assert_generated_model_for(name, parent = "ActiveRecord::Base")
+    assert_generated_class "app/models/#{name.to_s.underscore}", parent do |body|
       yield body if block_given?
     end
   end
@@ -63,7 +138,7 @@ def assert_generated_helper_for(name)
   # asserts that the given functional test was generated.
   # It takes a name or symbol without the <tt>_controller_test</tt> part and an optional super class.
   # the contents of the class source file is passed to a block.
-  def assert_generated_functional_test_for(name,parent="ActionController::TestCase")
+  def assert_generated_functional_test_for(name, parent = "ActionController::TestCase")
     assert_generated_class "test/functional/#{name.to_s.underscore}_controller_test",parent do |body|
       yield body if block_given?
     end
@@ -72,8 +147,8 @@ def assert_generated_functional_test_for(name,parent="ActionController::TestCase
   # asserts that the given unit test was generated.
   # It takes a name or symbol without the <tt>_test</tt> part and an optional super class.
   # the contents of the class source file is passed to a block.
-  def assert_generated_unit_test_for(name,parent="ActiveSupport::TestCase")
-    assert_generated_class "test/unit/#{name.to_s.underscore}_test",parent do |body|
+  def assert_generated_unit_test_for(name, parent = "ActiveSupport::TestCase")
+    assert_generated_class "test/unit/#{name.to_s.underscore}_test", parent do |body|
       yield body if block_given?
     end
   end
@@ -89,17 +164,18 @@ def assert_generated_file(path)
 
   # asserts that the given file exists
   def assert_file_exists(path)
-    assert File.exist?("#{RAILS_ROOT}/#{path}"),"The file '#{RAILS_ROOT}/#{path}' should exist"
+    assert File.exist?("#{RAILS_ROOT}/#{path}"),
+      "The file '#{RAILS_ROOT}/#{path}' should exist"
   end
 
   # asserts that the given class source file was generated.
   # It takes a path without the <tt>.rb</tt> part and an optional super class.
   # the contents of the class source file is passed to a block.
-  def assert_generated_class(path,parent=nil)
-    path=~/\/?(\d+_)?(\w+)$/
-    class_name=$2.camelize
+  def assert_generated_class(path, parent=nil)
+    path =~ /\/?(\d+_)?(\w+)$/
+    class_name = $2.camelize
     assert_generated_file("#{path}.rb") do |body|
-      assert body=~/class #{class_name}#{parent.nil? ? '':" < #{parent}"}/,"the file '#{path}.rb' should be a class"
+      assert_match /class #{class_name}#{parent.nil? ? '':" < #{parent}"}/, body, "the file '#{path}.rb' should be a class"
       yield body if block_given?
     end
   end
@@ -108,10 +184,10 @@ def assert_generated_class(path,parent=nil)
   # It takes a path without the <tt>.rb</tt> part.
   # the contents of the class source file is passed to a block.
   def assert_generated_module(path)
-    path=~/\/?(\w+)$/
-    module_name=$1.camelize
+    path =~ /\/?(\w+)$/
+    module_name = $1.camelize
     assert_generated_file("#{path}.rb") do |body|
-      assert body=~/module #{module_name}/,"the file '#{path}.rb' should be a module"
+      assert_match /module #{module_name}/, body, "the file '#{path}.rb' should be a module"
       yield body if block_given?
     end
   end
@@ -130,7 +206,8 @@ def assert_generated_stylesheet(path)
   # the parsed yaml tree is passed to a block.
   def assert_generated_yaml(path)
     assert_generated_file("#{path}.yml") do |body|
-      assert yaml=YAML.load(body)
+      yaml = YAML.load(body)
+      assert yaml, 'YAML data missing'
       yield yaml if block_given?
     end
   end
@@ -147,23 +224,22 @@ def assert_generated_fixtures_for(name)
   # asserts that the given views were generated.
   # It takes a controller name and a list of views (including extensions).
   # The body of each view is passed to a block
-  def assert_generated_views_for(name,*actions)
+  def assert_generated_views_for(name, *actions)
     actions.each do |action|
-      assert_generated_file("app/views/#{name.to_s.underscore}/#{action.to_s}") do |body|
+      assert_generated_file("app/views/#{name.to_s.underscore}/#{action}") do |body|
         yield body if block_given?
       end
     end
   end
 
-  def assert_generated_migration(name,parent="ActiveRecord::Migration")
-      file =
-   Dir.glob("#{RAILS_ROOT}/db/migrate/*_#{name.to_s.underscore}.rb").first
-      file = file.match(/db\/migrate\/[0-9]+_#{name.to_s.underscore}/).to_s
-      assert_generated_class file,parent do |body|
-        assert body=~/timestamps/, "should have timestamps defined"
-        yield body if block_given?
-      end
+  def assert_generated_migration(name, parent = "ActiveRecord::Migration")
+    file = Dir.glob("#{RAILS_ROOT}/db/migrate/*_#{name.to_s.underscore}.rb").first
+    file = file.match(/db\/migrate\/[0-9]+_\w+/).to_s
+    assert_generated_class file, parent do |body|
+      assert_match /timestamps/, body, "should have timestamps defined"
+      yield body if block_given?
     end
+  end
 
   # Asserts that the given migration file was not generated.
   # It takes the name of the migration as a parameter.
@@ -175,22 +251,23 @@ def assert_skipped_migration(name)
   # asserts that the given resource was added to the routes.
   def assert_added_route_for(name)
     assert_generated_file("config/routes.rb") do |body|
-      assert body=~/map.resources :#{name.to_s.underscore}/,"should add route for :#{name.to_s.underscore}"
+      assert_match /map.resources :#{name.to_s.underscore}/, body,
+        "should add route for :#{name.to_s.underscore}"
     end
   end
 
   # asserts that the given methods are defined in the body.
   # This does assume standard rails code conventions with regards to the source code.
   # The body of each individual method is passed to a block.
-  def assert_has_method(body,*methods)
+  def assert_has_method(body, *methods)
     methods.each do |name|
-      assert body=~/^  def #{name.to_s}\n((\n|   .*\n)*)  end/,"should have method #{name.to_s}"
-      yield( name, $1 ) if block_given?
+      assert body =~ /^  def #{name}(\(.+\))?\n((\n|   .*\n)*)  end/, "should have method #{name}"
+      yield(name, $2) if block_given?
     end
   end
 
   # asserts that the given column is defined in the migration
-  def assert_generated_column(body,name,type)
-      assert body=~/t\.#{type.to_s} :#{name.to_s}/, "should have column #{name.to_s} defined"
+  def assert_generated_column(body, name, type)
+    assert_match /t\.#{type.to_s} :#{name.to_s}/, body, "should have column #{name.to_s} defined"
   end
 end

railties/test/generators/rails_mailer_generator_test.rb

@@ -0,0 +1,26 @@
+require 'generators/generator_test_helper'
+
+class RailsMailerGeneratorTest < GeneratorTestCase
+
+  def test_generates_mailer
+    run_generator('mailer', %w(Notifier reset_password))
+
+    assert_generated_model_for :notifier, 'ActionMailer::Base' do |model|
+      assert_has_method model, :reset_password do |name, body|
+        assert_equal [
+            "@subject    = 'Notifier#reset_password'",
+            "@body       = {}",
+            "@recipients = ''",
+            "@from       = ''",
+            "@sent_on    = sent_at",
+            "@headers    = {}"
+          ],
+          body.split("\n").map{|line| line.sub(' '*4, '') }
+      end
+    end
+
+    assert_generated_views_for :notifier, 'reset_password.erb'
+    assert_generated_unit_test_for :notifier, 'ActionMailer::TestCase'
+    assert_generated_file "test/fixtures/notifier/reset_password"
+  end
+end

railties/test/generators/rails_model_generator_test.rb

@@ -1,84 +1,6 @@
-require 'test/unit'
-
-# Optionally load RubyGems
-begin
-  require 'rubygems'
-rescue LoadError
-end
-
-# Mock out what we need from AR::Base
-module ActiveRecord
-  class Base
-    class << self
-      attr_accessor :pluralize_table_names
-    end
-    self.pluralize_table_names = true
-  end
-
-  module ConnectionAdapters
-    class Column
-      attr_reader :name, :default, :type, :limit, :null, :sql_type, :precision, :scale
-      def initialize(name, default, sql_type=nil)
-        @namename
-        @default=default
-        @type=@sql_type=sql_type
-      end
-
-      def human_name
-        @name.humanize
-      end
-    end
-  end
-end
-
-# Mock up necessities from ActionView
-module ActionView
-  module Helpers
-    module ActionRecordHelper; end
-    class InstanceTag; end
-  end
-end
-
-# Set RAILS_ROOT appropriately fixture generation
-tmp_dir="#{File.dirname(__FILE__)}/../fixtures/tmp"
-if defined?(RAILS_ROOT)
-  RAILS_ROOT.replace(tmp_dir)
-else
-  RAILS_ROOT=tmp_dir
-end
-Dir.mkdir(RAILS_ROOT) unless File.exist?(RAILS_ROOT)
-
-
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../../lib"
-
 require 'generators/generator_test_helper'
 
-class RailsModelGeneratorTest < Test::Unit::TestCase
-  include GeneratorTestHelper
-
-  def setup
-    ActiveRecord::Base.pluralize_table_names = true
-    Dir.mkdir("#{RAILS_ROOT}/app") unless File.exist?("#{RAILS_ROOT}/app")
-    Dir.mkdir("#{RAILS_ROOT}/app/views") unless File.exist?("#{RAILS_ROOT}/app/views")
-    Dir.mkdir("#{RAILS_ROOT}/app/views/layouts") unless File.exist?("#{RAILS_ROOT}/app/views/layouts")
-    Dir.mkdir("#{RAILS_ROOT}/config") unless File.exist?("#{RAILS_ROOT}/config")
-    Dir.mkdir("#{RAILS_ROOT}/db") unless File.exist?("#{RAILS_ROOT}/db")
-    Dir.mkdir("#{RAILS_ROOT}/test") unless File.exist?("#{RAILS_ROOT}/test")
-    Dir.mkdir("#{RAILS_ROOT}/test/fixtures") unless File.exist?("#{RAILS_ROOT}/test/fixtures")
-    Dir.mkdir("#{RAILS_ROOT}/public") unless File.exist?("#{RAILS_ROOT}/public")
-    Dir.mkdir("#{RAILS_ROOT}/public/stylesheets") unless File.exist?("#{RAILS_ROOT}/public/stylesheets")
-    File.open("#{RAILS_ROOT}/config/routes.rb", 'w') do |f|
-      f<<"ActionController::Routing::Routes.draw do |map|\n\nend\n"
-    end
-  end
-
-    def teardown
-    FileUtils.rm_rf "#{RAILS_ROOT}/app"
-    FileUtils.rm_rf "#{RAILS_ROOT}/test"
-    FileUtils.rm_rf "#{RAILS_ROOT}/config"
-    FileUtils.rm_rf "#{RAILS_ROOT}/db"
-    FileUtils.rm_rf "#{RAILS_ROOT}/public"
-  end
+class RailsModelGeneratorTest < GeneratorTestCase
 
   def test_model_generates_resources
     run_generator('model', %w(Product name:string))