Class: Rails::Generator::Base

Inherits:
Object
  • Object
show all
Includes:
Options
Defined in:
lib/rails_generator/base.rb

Overview

The base code generator is bare-bones. It sets up the source and destination paths and tells the logger whether to keep its trap shut.

It’s useful for copying files such as stylesheets, images, or javascripts.

For more comprehensive template-based passive code generation with arguments, you’ll want Rails::Generator::NamedBase.

Generators create a manifest of the actions they perform then hand the manifest to a command which replays the actions to do the heavy lifting (such as checking for existing files or creating directories if needed). Create, destroy, and list commands are included. Since a single manifest may be used by any command, creating new generators is as simple as writing some code templates and declaring what you’d like to do with them.

The manifest method must be implemented by subclasses, returning a Rails::Generator::Manifest. The record method is provided as a convenience for manifest creation. Example:

class StylesheetGenerator < Rails::Generator::Base
  def manifest
    record do |m|
      m.directory('public/stylesheets')
      m.file('application.css', 'public/stylesheets/application.css')
    end
  end
end

See Rails::Generator::Commands::Create for a list of methods available to the manifest.

Direct Known Subclasses

AppGenerator, Commands::Base, NamedBase

Instance Attribute Summary collapse

Attributes included from Options

#options

Instance Method Summary collapse

Methods included from Options

included

Constructor Details

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

Returns a new instance of Base.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/rails_generator/base.rb', line 101

def initialize(runtime_args, runtime_options = {})
  @args = runtime_args
  parse!(@args, runtime_options)

  # Derive source and destination paths.
  @source_root = options[:source] || File.join(spec.path, 'templates')
  if options[:destination]
    @destination_root = options[:destination]
  elsif defined? ::RAILS_ROOT
    @destination_root = ::RAILS_ROOT
  end

  # Silence the logger if requested.
  logger.quiet = options[:quiet]

  # Raise usage error if help is requested.
  usage if options[:help]
end

Instance Attribute Details

#args ⇒ Object (readonly)

Returns the value of attribute args.



99
100
101
 
# File 'lib/rails_generator/base.rb', line 99

def args
  @args
end

#destination_root ⇒ Object (readonly)

Returns the value of attribute destination_root.



99
100
101
 
# File 'lib/rails_generator/base.rb', line 99

def destination_root
  @destination_root
end

#source_root ⇒ Object (readonly)

Returns the value of attribute source_root.



99
100
101
 
# File 'lib/rails_generator/base.rb', line 99

def source_root
  @source_root
end

Instance Method Details

#after_generate ⇒ Object 



157
158
 
# File 'lib/rails_generator/base.rb', line 157

def after_generate
end

#destination_path(relative_destination) ⇒ Object

Return the full path from the destination root for the given path. Example for destination_root = ‘/dest’:

destination_path('some/path.rb') == '/dest/some/path.rb'



153
154
155
 
# File 'lib/rails_generator/base.rb', line 153

def destination_path(relative_destination)
  File.join(destination_root, relative_destination)
end

#manifest ⇒ Object

Generators must provide a manifest. Use the record method to create a new manifest and record your generator’s actions.

Raises:

  • (NotImplementedError) 


122
123
124
 
# File 'lib/rails_generator/base.rb', line 122

def manifest
  raise NotImplementedError, "No manifest for '#{spec.name}' generator."
end

#source_path(relative_source) ⇒ Object

Return the full path from the source root for the given path. Example for source_root = ‘/source’:

source_path('some/path.rb') == '/source/some/path.rb'

The given path may include a colon ‘:’ character to indicate that the file belongs to another generator. This notation allows any generator to borrow files from another. Example:

source_path('model:fixture.yml') = '/model/source/path/fixture.yml'



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/rails_generator/base.rb', line 134

def source_path(relative_source)
  # Check whether we're referring to another generator's file.
  name, path = relative_source.split(':', 2)

  # If not, return the full path to our source file.
  if path.nil?
    File.join(source_root, name)

  # Otherwise, ask our referral for the file.
  else
    # FIXME: this is broken, though almost always true.  Others'
    # source_root are not necessarily the templates dir.
    File.join(self.class.lookup(name).path, 'templates', path)
  end
end