Class: OptionParser::List

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

Overview

Simple option list providing mapping from short and/or long option string to OptionParser::Switch and mapping from acceptable argument to matching pattern and converter pair. Also provides summary feature.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ List

Just initializes all instance variables.



834
835
836
837
838
839
 
# File 'lib/optparse.rb', line 834

def initialize
  @atype = {}
  @short = OptionMap.new
  @long = OptionMap.new
  @list = []
end

Instance Attribute Details

#atype ⇒ Object (readonly)

Map from acceptable argument types to pattern and converter pairs.



820
821
822
 
# File 'lib/optparse.rb', line 820

def atype
  @atype
end

#list ⇒ Object (readonly)

List of all switches and summary string.



829
830
831
 
# File 'lib/optparse.rb', line 829

def list
  @list
end

#long ⇒ Object (readonly)

Map from long style option switches to actual switch objects.



826
827
828
 
# File 'lib/optparse.rb', line 826

def long
  @long
end

#short ⇒ Object (readonly)

Map from short style option switches to actual switch objects.



823
824
825
 
# File 'lib/optparse.rb', line 823

def short
  @short
end

Instance Method Details

#accept(t, pat = /.*/m, &block) ⇒ Object

See OptionParser.accept.



855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/optparse.rb', line 855

def accept(t, pat = /.*/m, &block)
  if pat
    pat.respond_to?(:match) or
      raise TypeError, "has no 'match'", ParseError.filter_backtrace(caller(2))
  else
    pat = t if t.respond_to?(:match)
  end
  unless block
    block = pat.method(:convert).to_proc if pat.respond_to?(:convert)
  end
  @atype[t] = [pat, block]
end

#add_banner(to) ⇒ Object

:nodoc:



978
979
980
981
982
983
984
985
 
# File 'lib/optparse.rb', line 978

def add_banner(to)  # :nodoc:
  list.each do |opt|
    if opt.respond_to?(:add_banner)
      opt.add_banner(to)
    end
  end
  to
end

#append(*args) ⇒ Object

Appends switch at the tail of the list, and associates short, long and negated long options. Arguments are:

switch

OptionParser::Switch instance to be inserted.

short_opts

List of short style options.

long_opts

List of long style options.

nolong_opts

List of long style options with “no-” prefix.

append(switch, short_opts, long_opts, nolong_opts)



918
919
920
921
 
# File 'lib/optparse.rb', line 918

def append(*args)
  update(*args)
  @list.push(args[0])
end

#complete(id, opt, icase = false, *pat, &block) ⇒ Object

Searches list id for opt and the optional patterns for completion pat. If icase is true, the search is case insensitive. The result is returned or yielded if a block is given. If it isn’t found, nil is returned.



940
941
942
 
# File 'lib/optparse.rb', line 940

def complete(id, opt, icase = false, *pat, &block)
  __send__(id).complete(opt, icase, *pat, &block)
end

#compsys(*args, &block) ⇒ Object

:nodoc:



987
988
989
990
991
992
993
 
# File 'lib/optparse.rb', line 987

def compsys(*args, &block)  # :nodoc:
  list.each do |opt|
    if opt.respond_to?(:compsys)
      opt.compsys(*args, &block)
    end
  end
end

#each_option(&block) ⇒ Object

Iterates over each option, passing the option to the block.



951
952
953
 
# File 'lib/optparse.rb', line 951

def each_option(&block)
  list.each(&block)
end

#get_candidates(id) {|__send__(id).keys| ... } ⇒ Object

Yields:

  • (__send__(id).keys) 


944
945
946
 
# File 'lib/optparse.rb', line 944

def get_candidates(id)
  yield __send__(id).keys
end

#prepend(*args) ⇒ Object

Inserts switch at the head of the list, and associates short, long and negated long options. Arguments are:

switch

OptionParser::Switch instance to be inserted.

short_opts

List of short style options.

long_opts

List of long style options.

nolong_opts

List of long style options with “no-” prefix.

prepend(switch, short_opts, long_opts, nolong_opts)



902
903
904
905
 
# File 'lib/optparse.rb', line 902

def prepend(*args)
  update(*args)
  @list.unshift(args[0])
end

#pretty_print(q) ⇒ Object

:nodoc:



841
842
843
844
845
846
847
848
849
850
 
# File 'lib/optparse.rb', line 841

def pretty_print(q)         # :nodoc:
  q.group(1, "(", ")") do
    @list.each do |sw|
      next unless Switch === sw
      q.group(1, "(" + sw.pretty_head, ")") do
        sw.pretty_print_contents(q)
      end
    end
  end
end

#reject(t) ⇒ Object

See OptionParser.reject.



871
872
873
 
# File 'lib/optparse.rb', line 871

def reject(t)
  @atype.delete(t)
end

#search(id, key) ⇒ Object

Searches key in id list. The result is returned or yielded if a block is given. If it isn’t found, nil is returned.



927
928
929
930
931
932
 
# File 'lib/optparse.rb', line 927

def search(id, key)
  if list = __send__(id)
    val = list.fetch(key) {return nil}
    block_given? ? yield(val) : val
  end
end

#summarize(*args, &block) ⇒ Object

Creates the summary table, passing each line to the block (without newline). The arguments args are passed along to the summarize method which is called on every option.



960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
 
# File 'lib/optparse.rb', line 960

def summarize(*args, &block)
  sum = []
  list.reverse_each do |opt|
    if opt.respond_to?(:summarize) # perhaps OptionParser::Switch
      s = []
      opt.summarize(*args) {|l| s << l}
      sum.concat(s.reverse)
    elsif !opt or opt.empty?
      sum << ""
    elsif opt.respond_to?(:each_line)
      sum.concat([*opt.each_line].reverse)
    else
      sum.concat([*opt.each].reverse)
    end
  end
  sum.reverse_each(&block)
end