Module: GeneratorSpec::GeneratorExampleGroup::InstanceMethods
- Defined in:
- lib/generator_spec/generator_example_group.rb
Instance Method Summary collapse
-
#assert_class_method(method, content, &block) ⇒ Object
Asserts the given class method exists in the given content.
-
#assert_field_default_value(attribute_type, value) ⇒ Object
Asserts the given attribute type gets a proper default value:.
-
#assert_field_type(attribute_type, field_type) ⇒ Object
Asserts the given attribute type gets translated to a field type properly:.
-
#assert_file(relative, *contents) {|read| ... } ⇒ Object
(also: #assert_directory)
Asserts a given file exists.
-
#assert_instance_method(method, content) {|$2.strip| ... } ⇒ Object
(also: #assert_method)
Asserts the given method exists in the given content.
-
#assert_migration(relative, *contents, &block) ⇒ Object
Asserts a given file does not exist.
-
#assert_no_file(relative) ⇒ Object
(also: #assert_no_directory)
Asserts a given file does not exist.
-
#assert_no_migration(relative) ⇒ Object
Asserts a given migration does not exist.
-
#capture(stream) ⇒ Object
(also: #silence)
Captures the given stream and returns it:.
-
#create_generated_attribute(attribute_type, name = 'test') ⇒ Object
Create a Rails::Generators::GeneratedAttribute by supplying the attribute type and, optionally, the attribute name:.
-
#generator(args = self.default_arguments, options = {}, config = {}) ⇒ Object
Instantiate the generator.
-
#run_generator(args = self.default_arguments, config = {}) ⇒ Object
Runs the generator configured for this class.
Instance Method Details
#assert_class_method(method, content, &block) ⇒ Object
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
162 163 164 |
# File 'lib/generator_spec/generator_example_group.rb', line 162 def assert_class_method(method, content, &block) assert_instance_method "self.#{method}", content, &block end |
#assert_field_default_value(attribute_type, value) ⇒ Object
Asserts the given attribute type gets a proper default value:
assert_field_type :string, "MyString"
194 195 196 |
# File 'lib/generator_spec/generator_example_group.rb', line 194 def assert_field_default_value(attribute_type, value) assert_equal(value, create_generated_attribute(attribute_type).default) end |
#assert_field_type(attribute_type, field_type) ⇒ Object
Asserts the given attribute type gets translated to a field type properly:
assert_field_type :date, :date_select
186 187 188 |
# File 'lib/generator_spec/generator_example_group.rb', line 186 def assert_field_type(attribute_type, field_type) assert_equal(field_type, create_generated_attribute(attribute_type).field_type) end |
#assert_file(relative, *contents) {|read| ... } ⇒ Object Also known as: assert_directory
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
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 |
# File 'lib/generator_spec/generator_example_group.rb', line 95 def assert_file(relative, *contents) absolute = File.(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 |
#assert_instance_method(method, content) {|$2.strip| ... } ⇒ Object Also known as: assert_method
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
175 176 177 178 |
# File 'lib/generator_spec/generator_example_group.rb', line 175 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 |
#assert_migration(relative, *contents, &block) ⇒ Object
Asserts a given file does not exist. 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.
136 137 138 139 140 |
# File 'lib/generator_spec/generator_example_group.rb', line 136 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 |
#assert_no_file(relative) ⇒ Object Also known as: assert_no_directory
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"
118 119 120 121 |
# File 'lib/generator_spec/generator_example_group.rb', line 118 def assert_no_file(relative) absolute = File.(relative, destination_root) assert !File.exists?(absolute), "Expected file #{relative.inspect} to not exist, but does" end |
#assert_no_migration(relative) ⇒ Object
Asserts a given migration does not exist. You need to supply an absolute path or a path relative to the configured destination:
assert_no_file "config/random.rb"
147 148 149 150 |
# File 'lib/generator_spec/generator_example_group.rb', line 147 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 |
#capture(stream) ⇒ Object Also known as: silence
Captures the given stream and returns it:
stream = capture(:stdout){ puts "Cool" }
stream # => "Cool\n"
62 63 64 65 66 67 68 69 70 71 72 73 |
# File 'lib/generator_spec/generator_example_group.rb', line 62 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 |
#create_generated_attribute(attribute_type, name = 'test') ⇒ Object
Create a Rails::Generators::GeneratedAttribute by supplying the attribute type and, optionally, the attribute name:
create_generated_attribute(:string, 'name')
228 229 230 |
# File 'lib/generator_spec/generator_example_group.rb', line 228 def create_generated_attribute(attribute_type, name = 'test') Rails::Generators::GeneratedAttribute.new(name, attribute_type.to_s) end |
#generator(args = self.default_arguments, options = {}, config = {}) ⇒ Object
Instantiate the generator.
219 220 221 |
# File 'lib/generator_spec/generator_example_group.rb', line 219 def generator(args=self.default_arguments, ={}, config={}) @generator ||= self.generator_class.new(args, , config.reverse_merge(:destination_root => destination_root)) end |
#run_generator(args = self.default_arguments, config = {}) ⇒ Object
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.("../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.
214 215 216 |
# File 'lib/generator_spec/generator_example_group.rb', line 214 def run_generator(args=self.default_arguments, config={}) capture(:stdout) { self.generator_class.start(args, config.reverse_merge(:destination_root => destination_root)) } end |