module GLI::AppSupport

Internals for make App work

Public Class Methods

included(klass) click to toggle source

# File lib/gli/app_support.rb, line 124
def self.included(klass)
  @stderr = $stderr
end

Public Instance Methods

around_blocks() click to toggle source

# File lib/gli/app_support.rb, line 157
def around_blocks
  @around_blocks || []
end

context_description() click to toggle source

# File lib/gli/app_support.rb, line 9
def context_description
  "in global context"
end

exe_name() click to toggle source

# File lib/gli/app_support.rb, line 34
def exe_name
  File.basename($0)
end

get_default_command() click to toggle source

Get the default command for the entire app

# File lib/gli/app_support.rb, line 49
def get_default_command
  @default_command
end

help_sort_type() click to toggle source

# File lib/gli/app_support.rb, line 161
def help_sort_type
  @help_sort_type || :alpha
end

help_text_wrap_type() click to toggle source

# File lib/gli/app_support.rb, line 165
def help_text_wrap_type
  @help_text_wrap_type || :to_terminal
end

override_command_defaults(command_list,config) click to toggle source

# File lib/gli/app_support.rb, line 181
def override_command_defaults(command_list,config)
  command_list.each do |command_name,command|
    next if command_name == :initconfig || command.nil?
    command_config = (config['commands'] || {})[command_name] || {}

    if @subcommand_option_handling_strategy == :legacy
      override_default(command.topmost_ancestor.flags,command_config)
      override_default(command.topmost_ancestor.switches,command_config)
    else
      override_default(command.flags,command_config)
      override_default(command.switches,command_config)
    end

    override_command_defaults(command.commands,command_config)
  end
end

override_default(tokens,config) click to toggle source

# File lib/gli/app_support.rb, line 198
def override_default(tokens,config)
  tokens.each do |name,token|
    token.default_value=config[name] if config[name]
  end
end

override_defaults_based_on_config(config) click to toggle source

Sets the default values for flags based on the configuration

# File lib/gli/app_support.rb, line 174
def override_defaults_based_on_config(config)
  override_default(flags,config)
  override_default(switches,config)

  override_command_defaults(commands,config)
end

post_block() click to toggle source

# File lib/gli/app_support.rb, line 152
def post_block
  @post_block ||= Proc.new do
  end
end

pre_block() click to toggle source

# File lib/gli/app_support.rb, line 146
def pre_block
  @pre_block ||= Proc.new do
    true
  end
end

stderr() click to toggle source

# File lib/gli/app_support.rb, line 120
def stderr
  @stderr ||= STDERR
end

subcommand_option_handling_strategy() click to toggle source

# File lib/gli/app_support.rb, line 204
def subcommand_option_handling_strategy
  @subcommand_option_handling_strategy || :legacy
end

synopsis_format_type() click to toggle source

# File lib/gli/app_support.rb, line 169
def synopsis_format_type
  @synopsis_format_type || :full
end