FolderTemplate

FolderTemplate is a minimalistic template engine that generates files and folders structure from a template folder layout. It includes a simple variable expansion syntax, automatically injects variables for filename and basename, and can optionally append content to existing files.

Template definitions

• Templates are defined as files and folders on disk
• Variables are surrounded with double curly: {{variable}}
• Variables can be part of filenames, folder names, and file content
• Template filename with a >> prefix will append their content to an existing file
• New in 1.0.1
  • {{__append__}} prefix is also supported (to circumvent windows filesystem limitations). Built-in 'rubyclass' template is using it.

Usage

require 'folder_template'

template = FolderTemplate::TemplateFolder.new( template_path )
fs = FolderTemplate::FsAdapter.new( output_path, opts... )
env = Hash.new.merge( project_name:"my_project", ... )

template.generate( fs, env )

FsAdapter

All filesystem operation are abstracted through an FsAdapter object that performs final filename expansion, and execute all filesystem manipulations.

The FsAdapter interface is composed of 3 methods; any class implementing those 3 methods can be used in place of the default FsAdapter object to perform the necessary filesystem operations.

def makedirs( dirname )
def write_to_file( filename, content )
def append_to_file( filename, content )

Default implementation of FsAdapter accepts a few options:

Option	Default	Description
verbose	false	When true, log each operation that is performed
overwrite_files	false	When true, replace existing files with content generated from template

Contributing

1. Fork it ( https://github.com/[my-github-username]/__project__/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request