Turple

Quick project templating, with optional cli wizard support

Turple can take a custom template and use it to bootstrap projects structures you commonly use instead of copy/pasting an old project and find/replacing to make it a new project.

Usage

I always make projects the same way. There are a bunch of tools for making this faster, but i didnt like any of them. This is what i like.

Turple takes any kind of template format you want, a bunch of data, and in*turple*ates it.

Turple is best used from a command line, but it can be used directly in ruby as well. CLI FIRST...

CLI

Turple requires a path to a template, and an optional destination. If no destination is passed, it will put everything in a turple folder from your current working directory.

turple --template /path/to/template --destination my_new_project_name

Turple will scan the template, determine what data is needed to process it, and prompt you for any missing data. If you wanted to run turple without the wizard, just throw a Turplefile into your destination directory with the nececssary data (even the template if you want)

Turplefile

Turplefile files are yaml formatted files that provided various information to turple. Assuming our template requires a single peice of information called foo, our destination Turplefile would look something like this.

template: /path/to/template
data:
  foo: bar

Turple templates also have a Turplefile

Turple Templates

A turple template is simply a directory containing a Turplefile, and any amount of custom folders and files your project template needs. The Turplefile inside a template has different data than a destination file. It has instructions on how to prompt a user for data, and the configuration details on how the template is built. This example uses the default turple configuration.

Configuration

name: Foo Project Template
configuration:
  file_ext: turple
  path_regex: '\[([A-Z_\.]+)\]'
  path_separator: .
  content_regex: '<>([a-z_\.]+)<>'
  content_separator: .
data_map:
  foo: What is the foo called?

• name is just a friendly name for the template. its optional. we can use the template directory name for that.
• configuration has some very important details. (again, these are the defaults, so if your template does not have a custom configuration, it uses these values)
  • file_ext is the file extension turple looks for to tell it there is content inside the file that needs processed
  • path_regex this is a string representing a regex match to variable names
  • path_separator this is a string representing a character(s) to seperate variables strung togehter
  • content_regex & content_separator are the same as with a path, but to match file contents rather than a path.
• data_map is a hash that matches the same structure as the data required for a template, but instead provides the details to prompt a user in case a peice of required data is missing.

Example Template

Say you design a template using teh turple default configuration, and you create a file structure like so...

foo_template
  |__ my_[FOO.BAR]_dir
  |   |
  |   |__ my_[FOO.BAZ]_file.txt.turple
  |
  |__ Turplefile

and say your my_[FOO.BAZ]_file.txt.turple file contains the following

This <>foo.baz<> file is in the <>foo.bar<> folder.

With a simple Turplefile containing...

name: Foo Template
data_map:
  foo:
    bar: What is the foo bar?
    baz: What is the foo baz?

• Notice how the path variables match the path_regex
• Notice how the separator of the path variables match the path_separator
• Notice how the content variables match the content_regex
• Notice how the separator of the content variables match the content_separator

Let's run Turple!

Saving to: /your/current/directory/turple
There is some missing data. You will be prompted to enter each value.
What is the foo bar?
>>> # enter your value here
What is the foo baz?
>>> # enter your value here
================================================================================
                              !TURPLE SUCCESS!
================================================================================
Turpleated `Foo Template` to a new project `turple`
Paths Turpleated: 2
   Turpleated in: 1.1ms
================================================================================

Ruby

You can run turple directly in ruby if needed as well. This example matches the template from the above example.

require 'turple'

Turple.ate '~/Code/templates/mini_ruby_project', {
  :foo => {
    :bar => 'foobar',
    :baz => 'foobaz'
  }
}, {
  :destination => '/path/to/your/new/project',
}

most notably the passing of the destination in the 3rd argument (the configuration hash)

Development & Testing

gem install yuyi
yuyi -m https://raw.githubusercontent.com/brewster1134/turple/master/yuyi_menu
bundle install
bundle exec guard