Method: CLASP::OptionSpecification#initialize

Defined in:

lib/clasp/specifications.rb

#initialize(name, aliases, help, values_range, default_value, required, required_message, constraint, extras = nil, &blk) ⇒ OptionSpecification

Creates an OptionSpecification instance from the given name, aliases, help, values_range, and default_value

Signature

• Parameters

  • name (String) The name, or long-form, of the option

  • aliases (Array) 0 or more strings specifying short-form or option-value aliases

  • help (String) The help string, which may be nil

  • values_range (Array) 0 or more strings specifying values supported by the option

  • default_value (String) The default value of the option, which will be used in the case where an option is specified without a value. May be nil

  • required (boolean) Whether the option is required. May be nil

  • required_message (::String) Message to be used when reporting that a required option is missing. May be nil in which case a message of the form “<option-name> not specified; use –help for usage”. If begins with the nul character (“0”), then is used in the place of the <option-name> and placed into the rest of the standard form message

  • constraint (Hash) Constraint to be applied to the parsed values of options matching this specification. NOTE: only integer constraints are supported in the current version

  • extras An application-defined additional parameter. If nil, it is assigned an empty Hash

• Block An optional block that is called when a matching option argument is found

NOTE: Users should prefer the CLASP::Option() method

# File 'lib/clasp/specifications.rb', line 240

def initialize(name, aliases, help, values_range, default_value, required, required_message, constraint, extras = nil, &blk)

  check_arity_(blk, 0..3, "option")

  @name             = name
  @aliases          = (aliases || []).select { |a| a and not a.empty? }
  @help             = help
  @values_range     = values_range || []
  @default_value    = default_value
  @required         = required
  @required_message = nil
  @constraint       = constraint || {}
  @extras           = extras || {}
  @action           = blk

  rm_name           = nil

  if required_message

    if "\0" == required_message[0]

        rm_name = required_message[1..-1]
    end
  else

    rm_name = "'#{name}'"
  end

  if rm_name

    required_message = "#{rm_name} not specified; use --help for usage"
  end

  @required_message = required_message
end