class HammerCLI::Options::OptionDefinition
Attributes
context_target[RW]
deprecated_switches[RW]
value_formatter[RW]
Public Class Methods
new(switches, type, description, options = {})
click to toggle source
Calls superclass method
# File lib/hammer_cli/options/option_definition.rb, line 29 def initialize(switches, type, description, options = {}) self.value_formatter = options[:format] || HammerCLI::Options::Normalizers::Default.new self.context_target = options[:context_target] self.deprecated_switches = options[:deprecated] super end
Public Instance Methods
complete(value)
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 36 def complete(value) value_formatter.complete(value) end
completion_type(formatter = nil)
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 141 def completion_type(formatter = nil) return { type: :flag } if @type == :flag formatter ||= value_formatter completion_type = case formatter when HammerCLI::Options::Normalizers::Bool, HammerCLI::Options::Normalizers::Enum { type: :enum, values: value_formatter.allowed_values } when HammerCLI::Options::Normalizers::EnumList { type: :multienum, values: value_formatter.allowed_values } when HammerCLI::Options::Normalizers::ListNested { type: :schema, schema: value_formatter.schema.description(richtext: false) } when HammerCLI::Options::Normalizers::List { type: :list } when HammerCLI::Options::Normalizers::KeyValueList { type: :key_value_list } when HammerCLI::Options::Normalizers::File { type: :file } end completion_type || { type: :value } end
default_conversion_block()
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 111 def default_conversion_block if flag? Clamp.method(:truthy?) else self.method(:format_value) end end
default_value()
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 133 def default_value if defined?(@default_value) value_formatter.format(@default_value) elsif multivalued? [] end end
deprecation_message(switch)
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 65 def deprecation_message(switch) if deprecated_switches.class <= String && switches.include?(switch) deprecated_switches elsif deprecated_switches.class <= Hash && deprecated_switches.keys.include?(switch) deprecated_switches[switch] end end
description()
click to toggle source
Calls superclass method
# File lib/hammer_cli/options/option_definition.rb, line 73 def description if deprecated_switches.class <= String format_deprecation_msg(super, _('Deprecated: %{deprecated_msg}') % { deprecated_msg: deprecated_switches }) elsif deprecated_switches.class <= Hash full_msg = deprecated_switches.map do |flag, msg| _('%{flag} is deprecated: %{deprecated_msg}') % { flag: flag, deprecated_msg: msg } end.join(', ') format_deprecation_msg(super, full_msg) else super end end
format_description()
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 86 def format_description value_formatter.description end
format_value(value)
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 119 def format_value(value) if value == nil_subst HammerCLI::NilValue else value_formatter.format(value) end end
handles?(switch)
click to toggle source
Calls superclass method
# File lib/hammer_cli/options/option_definition.rb, line 55 def handles?(switch) message = _("Warning: Option %{option} is deprecated. %{message}") if deprecated_switches.class <= String && switches.include?(switch) warn(message % { :option => switch, :message => deprecated_switches }) elsif deprecated_switches.class <= Hash && deprecated_switches.keys.include?(switch) warn(message % { :option => switch, :message => deprecated_switches[switch] }) end super(switch) end
help_lhs()
click to toggle source
Calls superclass method
# File lib/hammer_cli/options/option_definition.rb, line 40 def help_lhs super end
help_rhs()
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 44 def help_rhs lines = [ description.strip, format_description.strip, value_description.strip ] rhs = lines.reject(&:empty?).join("\n") rhs.empty? ? " " : rhs end
nil_subst()
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 127 def nil_subst nil_subst = ENV['HAMMER_NIL'] || HammerCLI::Options::NIL_SUBST raise _('Environment variable HAMMER_NIL can not be empty.') if nil_subst.empty? nil_subst end
value_description()
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 90 def value_description default_sources = [ ("$#{@environment_variable}" if defined?(@environment_variable)), (@default_value.inspect if defined?(@default_value)) ].compact str = "" if multivalued? str += _("Can be specified multiple times.") str += " " end unless default_sources.empty? sep = _(", or") sep += " " str += _("Default:") str += " " str += default_sources.join(sep) end str end
Private Instance Methods
format_deprecation_msg(option_desc, deprecation_msg)
click to toggle source
# File lib/hammer_cli/options/option_definition.rb, line 165 def format_deprecation_msg(option_desc, deprecation_msg) "#{option_desc} (#{deprecation_msg})" end
infer_attribute_name()
click to toggle source
Calls superclass method
# File lib/hammer_cli/options/option_definition.rb, line 169 def infer_attribute_name HammerCLI.option_accessor_name(super) end