Module: Clamp::Messages

Included in:
Clamp
Defined in:
lib/clamp/messages.rb

Overview

Message lookup, to allow localization.

Constant Summary collapse

DEFAULTS = 
{
  too_many_arguments: "too many arguments",
  option_required: "option '%<option>s' is required",
  option_or_env_required: "option '%<option>s' (or env %<env>s) is required",
  option_argument_error: "option '%<switch>s': %<message>s",
  parameter_argument_error: "parameter '%<param>s': %<message>s",
  env_argument_error: "$%<env>s: %<message>s",
  unrecognised_option: "Unrecognised option '%<switch>s'",
  no_such_subcommand: "No such sub-command '%<name>s'",
  no_value_provided: "no value provided",
  default: "default",
  or: "or",
  required: "required",
  usage_heading: "Usage",
  parameters_heading: "Parameters",
  subcommands_heading: "Subcommands",
  options_heading: "Options"
}.freeze

Instance Method Summary collapse

Instance Method Details

#clear_messages! ⇒ Object 



20
21
22
 
# File 'lib/clamp/messages.rb', line 20

def clear_messages!
  init_default_messages
end

#message(key, options = {}) ⇒ Object 



13
14
15
16
17
18
 
# File 'lib/clamp/messages.rb', line 13

def message(key, options = {})
  string = messages.fetch(key)
  return string if options.empty?

  format string, options
end

#messages=(new_messages) ⇒ Object 



9
10
11
 
# File 'lib/clamp/messages.rb', line 9

def messages=(new_messages)
  messages.merge!(new_messages)
end