Module: RubiGen

### Home Classes Methods

### In Files

- lib/rubigen.rb
- lib/rubigen/base.rb
- lib/rubigen/commands.rb
- lib/rubigen/generated_attribute.rb
- lib/rubigen/helpers/generator_test_helper.rb
- lib/rubigen/lookup.rb
- lib/rubigen/manifest.rb
- lib/rubigen/options.rb
- lib/rubigen/scripts.rb
- lib/rubigen/simple_logger.rb
- lib/rubigen/spec.rb

### Namespace

- MODULE RubiGen::Commands
- MODULE RubiGen::GeneratorTestHelper
- MODULE RubiGen::Lookup
- MODULE RubiGen::Options
- MODULE RubiGen::Scripts
- CLASS RubiGen::AbstractGemSource
- CLASS RubiGen::Base
- CLASS RubiGen::GemPathSource
- CLASS RubiGen::GeneratedAttribute
- CLASS RubiGen::GeneratorError
- CLASS RubiGen::Manifest
- CLASS RubiGen::PathFilteredSource
- CLASS RubiGen::PathSource
- CLASS RubiGen::Source
- CLASS RubiGen::Spec
- CLASS RubiGen::UsageError

### Files

- History.txt
- License.txt
- Manifest.txt
- Todo.txt
- README.txt
- index.txt
- version-raw.txt
- version.txt

### Class/Module Index

Quicksearch

- RubiGen
- RubiGen::AbstractGemSource
- RubiGen::Base
- RubiGen::Commands
- RubiGen::Commands::Base
- RubiGen::Commands::Create
- RubiGen::Commands::Destroy
- RubiGen::Commands::List
- RubiGen::Commands::RewindBase
- RubiGen::Commands::Update
- RubiGen::GemPathSource
- RubiGen::GeneratedAttribute
- RubiGen::GeneratorError
- RubiGen::GeneratorTestHelper
- RubiGen::Lookup
- RubiGen::Lookup::ClassMethods
- RubiGen::Manifest
- RubiGen::Options
- RubiGen::Options::ClassMethods
- RubiGen::PathFilteredSource
- RubiGen::PathSource
- RubiGen::Scripts
- RubiGen::Scripts::Base
- RubiGen::Scripts::Destroy
- RubiGen::Scripts::Generate
- RubiGen::Scripts::Update
- RubiGen::Source
- RubiGen::Spec
- RubiGen::UsageError
- Rubigen
- Rubigen::CLI
- Dir
- Object

No matching classes.

# RubiGen

RubiGen is a code generation platform Ruby frameworks. Generators are easily invoked within Ruby framework instances to add and remove components such as library and test files.

New generators are easy to create and may be distributed within RubyGems, user home directory, or within each Ruby framework that uses RubiGen.

For example, newgem uses RubiGen to generate new RubyGems. Those generated RubyGems can then use RubiGen (via a generated script/generate application) to generate tests and executable apps, etc, for the RubyGem.

Generators may subclass other generators to provide variations that require little or no new logic but replace the template files.

For a RubyGem, put your generator classes and templates within subfolders of the `generators` directory.

The layout of generator files can be seen in the built-in `test_unit` generator:

    test_unit_generators/
      test_unit/
        test_unit_generator.rb
        templates/
          test_unit.rb

The directory name (`test_unit`) matches the name of the generator file (test_unit_generator.rb) and class (`TestUnitGenerator`). The files that will be copied or used as templates are stored in the `templates` directory.

The filenames of the templates don't matter, but choose something that will be self-explanatory since you will be referencing these in the `manifest` method inside your generator subclass.

### Constants

VERSION

[Validate]

Generated with the Darkfish Rdoc Generator 2.