Class RubiGen::Base
In: lib/rubigen/base.rb
Parent: Object

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 RubiGen::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 RubiGen::Manifest. The record method is provided as a convenience for manifest creation. Example:

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

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

Methods

Included Modules

Options

Attributes

args  [R] 
destination_root  [R] 
source_root  [R] 
stdout  [R] 

Public Class methods

Public Instance methods

Return the basename of the destination_root, BUT, if it is trunk, tags, or branches, it continues to the parent path for the name

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'

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

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'

Protected Instance methods

Override with your own usage banner.

Convenience method for generator subclasses to record a manifest.

Read USAGE from file in generator base path.

[Validate]