Things unrelated to the true public interface of Command that are needed for bookkeeping and help support. Generally, you shouldn’t be calling these methods; they are technically public but are essentially part of GLI’s internal implementation and subject to change
The parent of this command, either the GLI app, or another command
# File lib/gli/command_support.rb, line 102 def arg_name(d,options=[]) parent.arg_name(d,options) if parent.kind_of?(Command) && send_declarations_to_parent? super(d,options) end
# File lib/gli/command_support.rb, line 28 def arguments @arguments end
Return the arguments description
# File lib/gli/command_support.rb, line 20 def arguments_description @arguments_description end
# File lib/gli/command_support.rb, line 24 def arguments_options @arguments_options end
# File lib/gli/command_support.rb, line 9 def context_description "in the command #{name}" end
# File lib/gli/command_support.rb, line 125 def default_description @default_desc end
# File lib/gli/command_support.rb, line 107 def default_value(d) parent.default_value(d) if parent.kind_of?(Command) && send_declarations_to_parent? super(d) end
# File lib/gli/command_support.rb, line 92 def desc(d) parent.desc(d) if parent.kind_of?(Command) && send_declarations_to_parent? super(d) end
Returns the array of examples
# File lib/gli/command_support.rb, line 53 def examples @examples end
Executes the command
# File lib/gli/command_support.rb, line 130 def execute(global_options,options,arguments) get_action(arguments).call(global_options,options,arguments) end
# File lib/gli/command_support.rb, line 62 def flag(*names) if send_declarations_to_parent? new_flag = if parent.kind_of? Command super(*names) parent.flag(*names) else super(*names) end new_flag.associated_command = self new_flag else super(*names) end end
Return the flags as a Hash
# File lib/gli/command_support.rb, line 113 def flags @flags ||= {} end
# File lib/gli/command_support.rb, line 148 def get_default_command @default_command end
# File lib/gli/command_support.rb, line 144 def has_action? !!@action end
# File lib/gli/command_support.rb, line 97 def long_desc(d) parent.long_desc(d) if parent.kind_of?(Command) && send_declarations_to_parent? super(d) end
Return the Array of the command’s names
# File lib/gli/command_support.rb, line 48 def names all_forms end
Return true to avoid including this command in your help strings Will honor the hide_commands_without_desc flag
# File lib/gli/command_support.rb, line 15 def nodoc @hide_commands_without_desc and description.nil? end
If true, this command doesn’t want the around block called
# File lib/gli/command_support.rb, line 43 def skips_around @skips_around end
If true, this command doesn’t want the post block run before it executes
# File lib/gli/command_support.rb, line 38 def skips_post @skips_post end
If true, this command doesn’t want the pre block run before it executes
# File lib/gli/command_support.rb, line 33 def skips_pre @skips_pre end
# File lib/gli/command_support.rb, line 77 def switch(*names) if send_declarations_to_parent? new_switch = if parent.kind_of? Command super(*names) parent.switch(*names) else super(*names) end new_switch.associated_command = self new_switch else super(*names) end end
Return the switches as a Hash
# File lib/gli/command_support.rb, line 117 def switches @switches ||= {} end
# File lib/gli/command_support.rb, line 134 def topmost_ancestor some_command = self top = some_command while some_command.kind_of? self.class top = some_command some_command = some_command.parent end top end