Module Gitlab::CLI::Helpers
In: lib/gitlab/cli_helpers.rb

Defines methods related to CLI output and formatting.

Methods

actions   client   confirm_command   excluded_fields   get_keys   gitlab_helper   help   method_owners   output_json   output_table   record_hash   record_table   required_fields   symbolize_keys   valid_command?   yaml_load  

Public Instance methods

actions()

Returns actions available to CLI & Shell

@return [Array]

client()

Returns Gitlab::Client instance

@return [Gitlab::Client]

confirm_command(cmd)

Confirms command with a desctructive action.

@return [String]

excluded_fields(args)

Returns filtered excluded fields.

@return [Array]

get_keys(args, data)

Helper function to get rows and keys from data returned from API call

gitlab_helper(cmd, args=[]) {|if block_given?| ...}

Helper function to call Gitlab commands with args.

help(cmd=nil, &block)

Gets defined help for a specific command/action.

@return [String]

method_owners()

Returns method names and their owners

@return [Array<Hash>]

output_table(cmd, args, data)

Outputs a nicely formatted table or error msg.

record_hash(data, cmd, args, single_value=false)

Renders the result of given commands and arguments into a Hash

@param [Array] data Resultset from the API call @param [String] cmd The command passed to the API @param [Array] args Options passed to the API call @param [bool] single_value If set to true, a single result should be returned @return [Hash] Result hash

record_table(data, cmd, args)

Table to display records.

@return [Terminal::Table]

required_fields(args)

Returns filtered required fields.

@return [Array]

symbolize_keys(hash)

Convert a hash (recursively) to use symbol hash keys @return [Hash]

valid_command?(cmd)

Confirms command is valid.

@return [Boolean]

yaml_load(arg)

YAML::load on a single argument

[Validate]