module GeneratorSpec::GeneratorExampleGroup::InstanceMethods
def assert_class_method(method, content, &block)
end
end
assert_match /create_table/, up
assert_class_method :up, migration do |up|
assert_migration "db/migrate/create_products.rb" do |migration|
When a block is given, it yields the content of the method.
class methods inside (class << self), only class methods which starts with "self.".
Asserts the given class method exists in the given content. This method does not detect
def assert_class_method(method, content, &block) assert_instance_method "self.#{method}", content, &block end
def assert_field_default_value(attribute_type, value)
assert_field_type :string, "MyString"
Asserts the given attribute type gets a proper default value:
def assert_field_default_value(attribute_type, value) assert_equal(value, create_generated_attribute(attribute_type).default) end
def assert_field_type(attribute_type, field_type)
assert_field_type :date, :date_select
properly:
Asserts the given attribute type gets translated to a field type
def assert_field_type(attribute_type, field_type) assert_equal(field_type, create_generated_attribute(attribute_type).field_type) end
def assert_file(relative, *contents)
end
end
assert_match /Product\.all/, index
assert_instance_method :index, content do |index|
assert_file "app/controller/products_controller.rb" do |controller|
Finally, when a block is given, it yields the file content:
assert_file "config/environment.rb", /initialize/
file with the given string:
regular expression matches the given file content. If it's a string, it compares the
You can also give extra arguments. If the argument is a regexp, it will check if the
assert_file "config/environment.rb"
to the configured destination:
Asserts a given file exists. You need to supply an absolute path or a path relative
def assert_file(relative, *contents) absolute = File.expand_path(relative, destination_root) assert File.exists?(absolute), "Expected file #{relative.inspect} to exist, but does not" read = File.read(absolute) if block_given? || !contents.empty? yield read if block_given? contents.each do |content| case content when String assert_equal content, read when Regexp assert_match content, read end end end
def assert_instance_method(method, content)
end
end
assert_match /Product\.all/, index
assert_instance_method :index, content do |index|
assert_file "app/controller/products_controller.rb" do |controller|
it yields the content of the method.
Asserts the given method exists in the given content. When a block is given,
def assert_instance_method(method, content) assert content =~ /def #{method}(\(.+\))?(.*?)\n end/m, "Expected to have method #{method}" yield $2.strip if block_given? end
def assert_migration(relative, *contents, &block)
Consequently, assert_migration accepts the same arguments has assert_file.
assert_file "db/migrate/003_create_products.rb"
matches the migration name. For example, the call above is converted to:
This method manipulates the given path and tries to find any migration which
assert_migration "db/migrate/create_products.rb"
path relative to the configured destination:
Asserts a given file does not exist. You need to supply an absolute path or a
def assert_migration(relative, *contents, &block) file_name = migration_file_name(relative) assert file_name, "Expected migration #{relative} to exist, but was not found" assert_file file_name, *contents, &block end
def assert_no_file(relative)
assert_no_file "config/random.rb"
path relative to the configured destination:
Asserts a given file does not exist. You need to supply an absolute path or a
def assert_no_file(relative) absolute = File.expand_path(relative, destination_root) assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does" end
def assert_no_migration(relative)
assert_no_file "config/random.rb"
path relative to the configured destination:
Asserts a given migration does not exist. You need to supply an absolute path or a
def assert_no_migration(relative) file_name = migration_file_name(relative) assert_nil file_name, "Expected migration #{relative} to not exist, but found #{file_name}" end
def capture(stream)
stream # => "Cool\n"
stream = capture(:stdout){ puts "Cool" }
Captures the given stream and returns it:
def capture(stream) begin stream = stream.to_s eval "$#{stream} = StringIO.new" yield result = eval("$#{stream}").string ensure eval("$#{stream} = #{stream.upcase}") end result end
def create_generated_attribute(attribute_type, name = 'test')
create_generated_attribute(:string, 'name')
attribute type and, optionally, the attribute name:
Create a Rails::Generators::GeneratedAttribute by supplying the
def create_generated_attribute(attribute_type, name = 'test') Rails::Generators::GeneratedAttribute.new(name, attribute_type.to_s) end
def destination_root_is_set? #:nodoc:
def destination_root_is_set? #:nodoc: raise "You need to configure your Rails::Generators::TestCase destination root." unless destination_root end
def ensure_current_path #:nodoc:
def ensure_current_path #:nodoc: cd current_path end
def generator(args=self.default_arguments, options={}, config={})
def generator(args=self.default_arguments, options={}, config={}) @generator ||= self.generator_class.new(args, options, config.reverse_merge(:destination_root => destination_root)) end
def migration_file_name(relative) #:nodoc:
def migration_file_name(relative) #:nodoc: absolute = File.expand_path(relative, destination_root) dirname, file_name = File.dirname(absolute), File.basename(absolute).sub(/\.rb$/, '') Dir.glob("#{dirname}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first end
def prepare_destination
def prepare_destination rm_rf(destination_root) mkdir_p(destination_root) end
def run_generator(args=self.default_arguments, config={})
You can provide a configuration hash as second argument. This method returns the output
end
end
assert_no_file "config/database.yml"
run_generator %w(myapp --skip-active-record)
test "database.yml is not created when skipping Active Record" do
teardown :cleanup_destination_root
destination File.expand_path("../tmp", File.dirname(__FILE__))
tests AppGenerator
class AppGeneratorTest < Rails::Generators::TestCase
command line arguments:
Runs the generator configured for this class. The first argument is an array like
def run_generator(args=self.default_arguments, config={}) capture(:stdout) { self.generator_class.start(args, config.reverse_merge(:destination_root => destination_root)) } end