Class: Optimist::Option

Inherits:
Object
  • Object
show all
Defined in:
lib/optimist.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Option

Returns a new instance of Option.



591
592
593
594
595
596
597
598
599
 
# File 'lib/optimist.rb', line 591

def initialize
  @long = nil
  @short = nil
  @name = nil
  @multi_given = false
  @hidden = false
  @default = nil
  @optshash = Hash.new()
end

Instance Attribute Details

#default ⇒ Object

Returns the value of attribute default.



588
589
590
 
# File 'lib/optimist.rb', line 588

def default
  @default
end

#long ⇒ Object

Returns the value of attribute long.



588
589
590
 
# File 'lib/optimist.rb', line 588

def long
  @long
end

#multi_given=(value) ⇒ Object (writeonly)

Sets the attribute multi_given

Parameters:

  • value —

    the value to set the attribute multi_given to.



589
590
591
 
# File 'lib/optimist.rb', line 589

def multi_given=(value)
  @multi_given = value
end

#name ⇒ Object

Returns the value of attribute name.



588
589
590
 
# File 'lib/optimist.rb', line 588

def name
  @name
end

#short ⇒ Object

Returns the value of attribute short.



588
589
590
 
# File 'lib/optimist.rb', line 588

def short
  @short
end

Class Method Details

.create(name, desc = "", opts = {}, settings = {}) ⇒ Object

Determines which type of object to create based on arguments passed to Optimist::opt. This is trickier in Optimist, than other cmdline parsers (e.g. Slop) because we allow the default: to be able to set the option’s type.

Raises:

  • (ArgumentError) 


672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
 
# File 'lib/optimist.rb', line 672

def self.create(name, desc="", opts={}, settings={})

  opttype = Optimist::Parser.registry_getopttype(opts[:type])
  opttype_from_default = get_klass_from_default(opts, opttype)

  raise ArgumentError, ":type specification and default type don't match (default type is #{opttype_from_default.class})" if opttype && opttype_from_default && (opttype.class != opttype_from_default.class)

  opt_inst = (opttype || opttype_from_default || Optimist::BooleanOption.new)

  ## fill in :long
  opt_inst.long = handle_long_opt(opts[:long], name)

  ## fill in :short
  opt_inst.short = handle_short_opt(opts[:short])

  ## fill in :multi
  multi_given = opts[:multi] || false
  opt_inst.multi_given = multi_given

  ## fill in :default for flags
  defvalue = opts[:default] || opt_inst.default

  ## autobox :default for :multi (multi-occurrence) arguments
  defvalue = [defvalue] if defvalue && multi_given && !defvalue.kind_of?(Array)
  opt_inst.default = defvalue
  opt_inst.name = name
  opt_inst.opts = opts
  opt_inst
end

.register_alias(*alias_keys) ⇒ Object

Provide a way to register symbol aliases to the Parser



659
660
661
662
663
664
 
# File 'lib/optimist.rb', line 659

def self.register_alias(*alias_keys)
  alias_keys.each do |alias_key|
    # pass in the alias-key and the class
    Parser.register(alias_key, self)
  end
end

Instance Method Details

#array_default? ⇒ Boolean

note: Option-Types with both multi_arg? and flag? false are single-parameter (normal) options.

Returns:

  • (Boolean) 


622
 
# File 'lib/optimist.rb', line 622

def array_default? ; self.default.kind_of?(Array) ; end

#callback ⇒ Object 



626
 
# File 'lib/optimist.rb', line 626

def callback ; opts(:callback) ; end

#desc ⇒ Object 



627
 
# File 'lib/optimist.rb', line 627

def desc ; opts(:desc) ; end

#description_with_default ⇒ Object

Format the educate-line description including the default-value(s)



643
644
645
646
647
648
649
650
651
652
653
654
655
656
 
# File 'lib/optimist.rb', line 643

def description_with_default
  return desc unless default
  default_s = case default
              when $stdout   then '<stdout>'
              when $stdin    then '<stdin>'
              when $stderr   then '<stderr>'
              when Array
                default.join(', ')
              else
                default.to_s
              end
  defword = desc.end_with?('.') ? 'Default' : 'default'
  return "#{desc} (#{defword}: #{default_s})"
end

#educate ⇒ Object 



638
639
640
 
# File 'lib/optimist.rb', line 638

def educate
  (short? ? "-#{short}, " : "") + "--#{long}" + type_format + (flag? && default ? ", --no-#{long}" : "")
end

#flag? ⇒ Boolean

Indicates a flag option, which is an option without an argument

Returns:

  • (Boolean) 


610
 
# File 'lib/optimist.rb', line 610

def flag? ; false ; end

#multi ⇒ Object Also known as: multi? 



615
 
# File 'lib/optimist.rb', line 615

def multi ; @multi_given ; end

#multi_arg? ⇒ Boolean

Indicates that this is a multivalued (Array type) argument

Returns:

  • (Boolean) 


619
 
# File 'lib/optimist.rb', line 619

def multi_arg? ; false ; end

#opts(key) ⇒ Object 



601
602
603
 
# File 'lib/optimist.rb', line 601

def opts(key)
  @optshash[key]
end

#opts=(o) ⇒ Object 



605
606
607
 
# File 'lib/optimist.rb', line 605

def opts=(o)
  @optshash = o
end

#parse(_paramlist, _neg_given) ⇒ Object

Raises:

  • (NotImplementedError) 


631
632
633
 
# File 'lib/optimist.rb', line 631

def parse(_paramlist, _neg_given)
  raise NotImplementedError, "parse must be overridden for newly registered type"
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


629
 
# File 'lib/optimist.rb', line 629

def required? ; opts(:required) ; end

#short? ⇒ Boolean

Returns:

  • (Boolean) 


624
 
# File 'lib/optimist.rb', line 624

def short? ; short && short != :none ; end

#single_arg? ⇒ Boolean

Returns:

  • (Boolean) 


611
612
613
 
# File 'lib/optimist.rb', line 611

def single_arg?
  !self.multi_arg? && !self.flag?
end

#type_format ⇒ Object

provide type-format string. default to empty, but user should probably override it



636
 
# File 'lib/optimist.rb', line 636

def type_format ; "" ; end