Class Sprout::TaskParam
In: sprout/lib/sprout/tasks/tool_task.rb
Parent: Object

The base class for all ToolTask parameters. This class is extended by a variety of concrete implementations.

At the time of this writing, only the :boolean TaskParam modifies the interface by adding the show_on_false attribute.

Some other helpful features are as follows:

:file, :files, :path and :paths will all add any items that have been added to their values as file task prerequisites. This is especially helpful when writing rake tasks for Command Line Interface (CLI) compilers.

Methods

cleaned_preprocessed_path   delimiter   hidden_name?   hidden_value?   init   prefix   prepare   prepare_preprocessor_file   prepare_preprocessor_files   prepare_preprocessor_path   prepare_preprocessor_paths   prepare_prerequisites   preprocess_content   required?   setup_preprocessing_file_tasks   shell_name   shell_value   should_preprocess?   text_file?   to_rdoc   to_shell   validate   value   visible?  

Attributes

belongs_to  [RW] 
delimiter  [W] 
description  [RW] 
file_expression  [W]  Set the file_expression (blob) to append to each path in order to build the prerequisites FileList.

Defaults to parent ToolTask.default_file_expression

hidden_name  [RW] 
hidden_value  [RW] 
name  [RW] 
prefix  [W] 
preprocessable  [RW] 
required  [RW] 
shell_name  [W] 
type  [RW] 
validator  [RW] 
value  [W] 
visible  [RW] 

Public Instance methods

delimiter()

ToolParams join their name/value pair with an equals sign by default, this can be modified To a space or whatever you wish

hidden_name?()

Should the param name be hidden from the shell? Used for params like ‘input’ on mxmlc

hidden_value?()

Should the param value be hidden from the shell? Usually used for Boolean toggles like ’-debug‘

prefix()

Leading character for each parameter Can sometimes be an empty string, other times it‘s a double dash ’—’ but usually it‘s just a single dash ’-’

shell_name()

Return the name with a single leading dash and underscores replaced with dashes

to_rdoc()

Create a string that can be turned into a file that rdoc can parse to describe the customized or generated task using param name, type and description

visible?()

By default, ToolParams only appear in the shell output when they are not nil

Protected Instance methods

[Validate]