class GLI::Commands::HelpModules::ArgNameFormatter

Handles wrapping text

Public Instance Methods

format(arguments_description,arguments_options,arguments) click to toggle source
# File lib/gli/commands/help_modules/arg_name_formatter.rb, line 6
def format(arguments_description,arguments_options,arguments)
  # Select which format to use: argname or arguments
  # Priority to old way: argname
  desc = format_argname(arguments_description, arguments_options)
  desc = format_arguments(arguments) if desc.strip == ''
  desc
end
format_argname(arguments_description,arguments_options) click to toggle source
# File lib/gli/commands/help_modules/arg_name_formatter.rb, line 33
def format_argname(arguments_description,arguments_options)
  return '' if String(arguments_description).strip == ''
  desc = arguments_description
  if arguments_options.include? :optional
    desc = "[#{desc}]"
  end
  if arguments_options.include? :multiple
    desc = "#{desc}[, #{desc}]*"
  end
  " " + desc
end
format_arguments(arguments) click to toggle source
# File lib/gli/commands/help_modules/arg_name_formatter.rb, line 14
def format_arguments(arguments)
  return '' if arguments.empty?
  desc = ""

  # Go through the arguments, building the description string
  arguments.each do |arg|
    arg_desc = "#{arg.name}"
    if arg.optional?
      arg_desc = "[#{arg_desc}]"
    end
    if arg.multiple?
      arg_desc = "#{arg_desc}[, #{arg_desc}]*"
    end
    desc = desc + " " + arg_desc
  end

  desc
end