Class: Rails::Generator::NamedBase

Inherits:
Base show all
Defined in:
lib/rails_generator/base.rb

Overview

The base generator for named components: models, controllers, mailers, etc. The target name is taken as the first argument and inflected to singular, plural, class, file, and table forms for your convenience. The remaining arguments are aliased to actions as an array for controller and mailer convenience.

Several useful local variables and methods are populated in the initialize method. See below for a list of Attributes and External Aliases available to both the manifest and to all templates.

If no name is provided, the generator raises a usage error with content optionally read from the USAGE file in the generator’s base path.

For example, the controller generator takes the first argument as the name of the class and subsequent arguments as the names of actions to be generated:

./script/generate controller Article index new create

See Rails::Generator::Base for a discussion of manifests, Rails::Generator::Commands::Create for methods available to the manifest, and Rails::Generator for a general discussion of generators.

Instance Attribute Summary collapse

Attributes inherited from Base

#args, #destination_root, #source_root

Attributes included from Options

#options

Instance Method Summary collapse

Methods inherited from Base

#destination_path, #manifest, #source_path

Methods included from Options

included

Constructor Details

#initialize(runtime_args, runtime_options = {}) ⇒ NamedBase

Returns a new instance of NamedBase.



203
204
205
206
207
208
209
210
211
212
 
# File 'lib/rails_generator/base.rb', line 203

def initialize(runtime_args, runtime_options = {})
  super

  # Name argument is required.
  usage if runtime_args.empty?

  @args = runtime_args.dup
  base_name = @args.shift
  assign_names!(base_name)
end

Instance Attribute Details

#class_name ⇒ Object (readonly)

Returns the value of attribute class_name.



198
199
200
 
# File 'lib/rails_generator/base.rb', line 198

def class_name
  @class_name
end

#class_nesting ⇒ Object (readonly)

Returns the value of attribute class_nesting.



199
200
201
 
# File 'lib/rails_generator/base.rb', line 199

def class_nesting
  @class_nesting
end

#class_nesting_depth ⇒ Object (readonly)

Returns the value of attribute class_nesting_depth.



199
200
201
 
# File 'lib/rails_generator/base.rb', line 199

def class_nesting_depth
  @class_nesting_depth
end

#class_path ⇒ Object (readonly)

Returns the value of attribute class_path.



199
200
201
 
# File 'lib/rails_generator/base.rb', line 199

def class_path
  @class_path
end

#file_path ⇒ Object (readonly)

Returns the value of attribute file_path.



199
200
201
 
# File 'lib/rails_generator/base.rb', line 199

def file_path
  @file_path
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



198
199
200
 
# File 'lib/rails_generator/base.rb', line 198

def name
  @name
end

#plural_name ⇒ Object (readonly)

Returns the value of attribute plural_name.



198
199
200
 
# File 'lib/rails_generator/base.rb', line 198

def plural_name
  @plural_name
end

#singular_name ⇒ Object (readonly) Also known as: file_name

Returns the value of attribute singular_name.



198
199
200
 
# File 'lib/rails_generator/base.rb', line 198

def singular_name
  @singular_name
end

#table_name ⇒ Object (readonly)

Returns the value of attribute table_name.



198
199
200
 
# File 'lib/rails_generator/base.rb', line 198

def table_name
  @table_name
end