Rails::Generators::TestCase

This class provides a TestCase for testing generators. To setup, you need just to configure the destination and set which generator is being tested:

  class AppGeneratorTest < Rails::Generators::TestCase
    tests AppGenerator
    destination File.expand_path("../tmp", File.dirname(__FILE__))
  end

If you want to ensure your destination root is clean before running each test, you can set a setup callback:

  class AppGeneratorTest < Rails::Generators::TestCase
    tests AppGenerator
    destination File.expand_path("../tmp", File.dirname(__FILE__))
    setup :prepare_destination
  end

Methods

A

arguments,
assert_class_method,
assert_directory,
assert_field_default_value,
assert_field_type,
assert_file,
assert_instance_method,
assert_method,
assert_migration,
assert_no_directory,
assert_no_file,
assert_no_migration

C

create_generated_attribute

D

destination

G

generator

P

prepare_destination

R

run_generator

T

tests

Included Modules

FileUtils START:includes

Class Public methods

arguments(array)

Sets default arguments on generator invocation. This can be overwritten when invoking it.

  arguments %w(app_name --skip-active-record)

Source: show | on GitHub

    # File railties/lib/rails/generators/test_case.rb, line 57
57:       def self.arguments(array)
58:         self.default_arguments = array
59:       end

destination(path)

Sets the destination of generator files:

  destination File.expand_path("../tmp", File.dirname(__FILE__))

Source: show | on GitHub

    # File railties/lib/rails/generators/test_case.rb, line 65
65:       def self.destination(path)
66:         self.destination_root = path
67:       end

tests(klass)

Sets which generator should be tested:

  tests AppGenerator

Source: show | on GitHub

    # File railties/lib/rails/generators/test_case.rb, line 48
48:       def self.tests(klass)
49:         self.generator_class = klass
50:       end

Instance Public methods

assert_class_method(method, content, &block)

Asserts the given class method exists in the given content. This method does not detect class methods inside (class << self), only class methods which starts with “self.”. When a block is given, it yields the content of the method.

  assert_migration "db/migrate/create_products.rb" do |migration|
    assert_class_method :up, migration do |up|
      assert_match(/create_table/, up)
    end
  end

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 155
155:       def assert_class_method(method, content, &block)
156:         assert_instance_method "self.#{method}", content, &block
157:       end

assert_directory(relative, *contents)

Alias for assert_file

assert_field_default_value(attribute_type, value)

Asserts the given attribute type gets a proper default value:

  assert_field_default_value :string, "MyString"

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 187
187:       def assert_field_default_value(attribute_type, value)
188:         assert_equal(value, create_generated_attribute(attribute_type).default)
189:       end

assert_field_type(attribute_type, field_type)

Asserts the given attribute type gets translated to a field type properly:

  assert_field_type :date, :date_select

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 179
179:       def assert_field_type(attribute_type, field_type)
180:         assert_equal(field_type, create_generated_attribute(attribute_type).field_type)
181:       end

assert_file(relative, *contents)

Asserts a given file exists. You need to supply an absolute path or a path relative to the configured destination:

  assert_file "config/environment.rb"

You can also give extra arguments. If the argument is a regexp, it will check if the regular expression matches the given file content. If it’s a string, it compares the file with the given string:

  assert_file "config/environment.rb", /initialize/

Finally, when a block is given, it yields the file content:

  assert_file "app/controller/products_controller.rb" do |controller|
    assert_instance_method :index, content do |index|
      assert_match(/Product\.all/, index)
    end
  end

This method is also aliased as assert_directory

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 88
 88:       def assert_file(relative, *contents)
 89:         absolute = File.expand_path(relative, destination_root)
 90:         assert File.exists?(absolute), "Expected file #{relative.inspect} to exist, but does not"
 91: 
 92:         read = File.read(absolute) if block_given? || !contents.empty?
 93:         yield read if block_given?
 94: 
 95:         contents.each do |content|
 96:           case content
 97:             when String
 98:               assert_equal content, read
 99:             when Regexp
100:               assert_match content, read
101:           end
102:         end
103:       end

assert_instance_method(method, content)

Asserts the given method exists in the given content. When a block is given, it yields the content of the method.

  assert_file "app/controller/products_controller.rb" do |controller|
    assert_instance_method :index, content do |index|
      assert_match(/Product\.all/, index)
    end
  end

This method is also aliased as assert_method

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 168
168:       def assert_instance_method(method, content)
169:         assert content =~ /def #{method}(\(.+\))?(.*?)\n  end/m, "Expected to have method #{method}"
170:         yield $2.strip if block_given?
171:       end

assert_method(method, content)

Alias for assert_instance_method

assert_migration(relative, *contents, &block)

Asserts a given migration exists. You need to supply an absolute path or a path relative to the configured destination:

  assert_migration "db/migrate/create_products.rb"

This method manipulates the given path and tries to find any migration which matches the migration name. For example, the call above is converted to:

  assert_file "db/migrate/003_create_products.rb"

Consequently, assert_migration accepts the same arguments has assert_file.

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 129
129:       def assert_migration(relative, *contents, &block)
130:         file_name = migration_file_name(relative)
131:         assert file_name, "Expected migration #{relative} to exist, but was not found"
132:         assert_file file_name, *contents, &block
133:       end

assert_no_directory(relative)

Alias for assert_no_file

assert_no_file(relative)

Asserts a given file does not exist. You need to supply an absolute path or a path relative to the configured destination:

  assert_no_file "config/random.rb"

This method is also aliased as assert_no_directory

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 111
111:       def assert_no_file(relative)
112:         absolute = File.expand_path(relative, destination_root)
113:         assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does"
114:       end

assert_no_migration(relative)

Asserts a given migration does not exist. You need to supply an absolute path or a path relative to the configured destination:

  assert_no_migration "db/migrate/create_products.rb"

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 140
140:       def assert_no_migration(relative)
141:         file_name = migration_file_name(relative)
142:         assert_nil file_name, "Expected migration #{relative} to not exist, but found #{file_name}"
143:       end

create_generated_attribute(attribute_type, name = 'test', index = nil)

Create a Rails::Generators::GeneratedAttribute by supplying the attribute type and, optionally, the attribute name:

  create_generated_attribute(:string, 'name')

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 221
221:       def create_generated_attribute(attribute_type, name = 'test', index = nil)
222:         Rails::Generators::GeneratedAttribute.parse([name, attribute_type, index].compact.join(':'))
223:       end

generator(args=self.default_arguments, options={}, config={})

Instantiate the generator.

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 212
212:       def generator(args=self.default_arguments, options={}, config={})
213:         @generator ||= self.generator_class.new(args, options, config.reverse_merge(:destination_root => destination_root))
214:       end

run_generator(args=self.default_arguments, config={})

Runs the generator configured for this class. The first argument is an array like command line arguments:

  class AppGeneratorTest < Rails::Generators::TestCase
    tests AppGenerator
    destination File.expand_path("../tmp", File.dirname(__FILE__))
    teardown :cleanup_destination_root

    test "database.yml is not created when skipping Active Record" do
      run_generator %w(myapp --skip-active-record)
      assert_no_file "config/database.yml"
    end
  end

You can provide a configuration hash as second argument. This method returns the output printed by the generator.

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 207
207:       def run_generator(args=self.default_arguments, config={})
208:         capture(:stdout) { self.generator_class.start(args, config.reverse_merge(:destination_root => destination_root)) }
209:       end

Instance Protected methods

prepare_destination()

Source: show | on GitHub

     # File railties/lib/rails/generators/test_case.rb, line 235
235:         def prepare_destination
236:           rm_rf(destination_root)
237:           mkdir_p(destination_root)
238:         end

Class Rails::Generators::TestCase < ActiveSupport::TestCase