Class: Thor::Options

Inherits:
Arguments show all
Defined in:
lib/thor/parser/options.rb

Overview

This is a modified version of Daniel Berger’s Getopt::Long class, licensed under Ruby’s license.

Constant Summary collapse

LONG_RE =

:nodoc:

/^(--\w+(?:-\w+)*)$/
SHORT_RE = 
/^(-[a-z])$/i
EQ_RE = 
/^(--\w+(?:-\w+)*|-[a-z])=(.*)$/i
SHORT_SQ_RE =

Allow either -x -v or -xv style for single char args

/^-([a-z]{2,})$/i
SHORT_NUM = 
/^(-[a-z])#{NUMERIC}$/i

Constants inherited from Arguments

Arguments::NUMERIC

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Arguments

parse, split

Constructor Details

#initialize(hash_options = {}, defaults = {}) ⇒ Options

Takes a hash of Thor::Option and a hash with defaults.



31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/thor/parser/options.rb', line 31

def initialize(hash_options={}, defaults={})
  options = hash_options.values
  super(options)

  # Add defaults
  defaults.each do |key, value|
    @assigns[key.to_s] = value
    @non_assigned_required.delete(hash_options[key])
  end

  @shorts, @switches, @extra = {}, {}, []

  options.each do |option|
    @switches[option.switch_name] = option

    option.aliases.each do |short|
      @shorts[short.to_s] ||= option.switch_name
    end
  end
end

Class Method Details

.to_switches(options) ⇒ Object

Receives a hash and makes it switches.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/thor/parser/options.rb', line 13

def self.to_switches(options)
  options.map do |key, value|
    case value
      when true
        "--#{key}"
      when Array
        "--#{key} #{value.map{ |v| v.inspect }.join(' ')}"
      when Hash
        "--#{key} #{value.map{ |k,v| "#{k}:#{v}" }.join(' ')}"
      when nil, false
        ""
      else
        "--#{key} #{value.inspect}"
    end
  end.join(" ")
end

Instance Method Details

#check_unknown! ⇒ Object

Raises:



93
94
95
96
97
 
# File 'lib/thor/parser/options.rb', line 93

def check_unknown!
  # an unknown option starts with - or -- and has no more -'s afterward.
  unknown = @extra.select { |str| str =~ /^--?[^-]*$/ }
  raise UnknownArgumentError, "Unknown switches '#{unknown.join(', ')}'" unless unknown.empty?
end

#parse(args) ⇒ Object 



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/thor/parser/options.rb', line 56

def parse(args)
  @pile = args.dup

  while peek
    match, is_switch = current_is_switch?
    shifted = shift

    if is_switch
      case shifted
        when SHORT_SQ_RE
          unshift($1.split('').map { |f| "-#{f}" })
          next
        when EQ_RE, SHORT_NUM
          unshift($2)
          switch = $1
        when LONG_RE, SHORT_RE
          switch = $1
      end

      switch = normalize_switch(switch)
      option = switch_option(switch)
      @assigns[option.human_name] = parse_peek(switch, option)
    elsif match
      @extra << shifted
      @extra << shift while peek && peek !~ /^-/
    else
      @extra << shifted
    end
  end

  check_requirement!

  assigns = Thor::CoreExt::HashWithIndifferentAccess.new(@assigns)
  assigns.freeze
  assigns
end

#remaining ⇒ Object 



52
53
54
 
# File 'lib/thor/parser/options.rb', line 52

def remaining
  @extra
end