Assemblage::CLI::

Subcommand

module

Convenience module for subcommand registration syntax sugar.

Public Class Methods

anchor
extended( mod )

Extension callback – register the extending object as a subcommand.

# File lib/assemblage/cli.rb, line 247
def self::extended( mod )
        Assemblage::CLI.log.debug "Registering subcommands from %p" % [ mod ]
        Assemblage::CLI.register_subcommands( mod )
end

Public Instance Methods

anchor
display_table( header, rows )

Output a table with the given header (an array) and rows (an array of arrays).

# File lib/assemblage/cli.rb, line 310
def display_table( header, rows )
        table = TTY::Table.new( header, rows )
        renderer = nil

        if hl.enabled?
                renderer = TTY::Table::Renderer::Unicode.new(
                        table,
                        multiline: true,
                        padding: [0,1,0,1]
                )
                renderer.border.style = :dim

        else
                renderer = TTY::Table::Renderer::ASCII.new(
                        table,
                        multiline: true,
                        padding: [0,1,0,1]
                )
        end

        puts renderer.render
end
anchor
error_string( string )

Return the specified string in the 'error' ANSI color.

# File lib/assemblage/cli.rb, line 303
def error_string( string )
        return hl.error( string )
end
anchor
exit_now!( message, exit_code=1 )

Exit with the specified exit_code after printing the given message.

# File lib/assemblage/cli.rb, line 258
def exit_now!( message, exit_code=1 )
        raise GLI::CustomExit.new( message, exit_code )
end
anchor
headline_string( string )

Return the specified string in the 'headline' ANSI color.

# File lib/assemblage/cli.rb, line 285
def headline_string( string )
        return hl.headline( string )
end
anchor
help_now!( message=nil )

Exit with a helpful message and display the usage.

# File lib/assemblage/cli.rb, line 264
def help_now!( message=nil )
        exception = OptionParser::ParseError.new( message )
        def exception.exit_code; 64; end

        raise exception
end
anchor
highlight_string( string )

Return the specified string in the 'highlight' ANSI color.

# File lib/assemblage/cli.rb, line 291
def highlight_string( string )
        return hl.highlight( string )
end
anchor
hl()

Return the global Pastel object for convenient formatting, color, etc.

# File lib/assemblage/cli.rb, line 279
def hl
        return Assemblage::CLI.pastel
end
anchor
prompt()

Get the prompt (a TTY::Prompt object)

# File lib/assemblage/cli.rb, line 273
def prompt
        return Assemblage::CLI.prompt
end
anchor
success_string( string )

Return the specified string in the 'success' ANSI color.

# File lib/assemblage/cli.rb, line 297
def success_string( string )
        return hl.success( string )
end
anchor
unless_dry_run( description, return_value=true )
Alias for: unless_dryrun
anchor
unless_dryrun( description, return_value=true ) { || ... }

In dry-run mode, output the description instead of running the provided block and return the return_value. If dry-run mode is not enabled, yield to the block.

# File lib/assemblage/cli.rb, line 343
def unless_dryrun( description, return_value=true )
        if $DRYRUN
                self.log.warn( "DRYRUN> #{description}" )
                return return_value
        else
                return yield
        end
end
Also aliased as: unless_dry_run
anchor
visible_chars( string )

Return the count of visible (i.e., non-control) characters in the given string.

# File lib/assemblage/cli.rb, line 335
def visible_chars( string )
        return string.to_s.gsub(/\e\[.*?m/, '').scan( /\P{Cntrl}/ ).size
end