Class: RSpec::Core::Parser

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec/core/option_parser.rb

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) parse



11
12
13
# File 'lib/rspec/core/option_parser.rb', line 11

def self.parse!(args)
  new.parse!(args)
end

+ (Object) parse!(args)



6
7
8
# File 'lib/rspec/core/option_parser.rb', line 6

def self.parse!(args)
  new.parse!(args)
end

Instance Method Details

- (Object) convert_deprecated_args(args)



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/rspec/core/option_parser.rb', line 30

def convert_deprecated_args(args)
  args.map! { |arg|
    case arg
    when "--formatter"
      RSpec.deprecate("The `--formatter` option", :replacement => "-f or --format", :call_site => nil)
      "--format"
    when "--default_path"
      RSpec.deprecate("The `--default_path` option", :replacement => "--default-path", :call_site => nil)
      "--default-path"
    when "--line_number"
      "--line-number"
    else
      arg
    end
  }
end

- (Object) parse!(args) Also known as: parse



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'lib/rspec/core/option_parser.rb', line 14

def parse!(args)
  return {} if args.empty?

  pre_parse(args)
  convert_deprecated_args(args)

  options = args.delete('--tty') ? {:tty => true} : {}
  begin
    parser(options).parse!(args)
  rescue OptionParser::InvalidOption => e
    abort "#{e.message}\n\nPlease use --help for a listing of valid options"
  end

  options
end

- (Object) parser(options)



49
50
51
52
53
54
55
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/rspec/core/option_parser.rb', line 49

def parser(options)
  OptionParser.new do |parser|
    parser.banner = "Usage: rspec [options] [files or directories]\n\n"

    parser.on('-I PATH', 'Specify PATH to add to $LOAD_PATH (may be used more than once).') do |dir|
      options[:libs] ||= []
      options[:libs] << dir
    end

    parser.on('-r', '--require PATH', 'Require a file.') do |path|
      options[:requires] ||= []
      options[:requires] << path
    end

    parser.on('-O', '--options PATH', 'Specify the path to a custom options file.') do |path|
      options[:custom_options_file] = path
    end

    parser.on('--order TYPE[:SEED]', 'Run examples by the specified order type.',
              '  [defined] groups and examples are run in the order they are defined',
              '  [default] deprecated alias for defined',
              '  [rand]    randomize the order of files, groups and examples',
              '  [random]  alias for rand',
              '  [random:SEED] e.g. --order random:123') do |o|
      options[:order] = if o == 'default'
                          RSpec.deprecate("RSpec's `--order default` CLI option", :replacement => "`--order defined`", :call_site => nil)
                          'defined'
                        else
                          o
                        end
    end

    parser.on('--seed SEED', Integer, 'Equivalent of --order rand:SEED.') do |seed|
      options[:order] = "rand:#{seed}"
    end

    parser.on('-d', '--debugger', 'Enable debugging.') do |o|
      options[:debug] = :cli
    end

    parser.on('--fail-fast', 'Abort the run on first failure.') do |o|
      options[:fail_fast] = true
    end

    parser.on('--failure-exit-code CODE', Integer, 'Override the exit code used when there are failing specs.') do |code|
      options[:failure_exit_code] = code
    end

    parser.on('-X', '--[no-]drb', 'Run examples via DRb.') do |o|
      options[:drb] = o
    end

    parser.on('--drb-port PORT', 'Port to connect to the DRb server.') do |o|
      options[:drb_port] = o.to_i
    end

    parser.on('--init', 'Initialize your project with RSpec.') do |cmd|
      ProjectInitializer.new(cmd).run
      exit
    end

    parser.on('--configure', 'Deprecated. Use --init instead.') do |cmd|
      warn "--configure is deprecated with no effect. Use --init instead."
      exit
    end

    parser.separator("\n  **** Output ****\n\n")

    parser.on('-f', '--format FORMATTER', 'Choose a formatter.',
            '  [p]rogress (default - dots)',
            '  [d]ocumentation (group and example names)',
            '  [h]tml',
            '  [t]extmate',
            '  [j]son',
            '  custom formatter class name') do |o|
      options[:formatters] ||= []
      options[:formatters] << [o]
    end

    parser.on('-o', '--out FILE',
              'Write output to a file instead of $stdout. This option applies',
              '  to the previously specified --format, or the default format',
              '  if no format is specified.'
             ) do |o|
      options[:formatters] ||= [['progress']]
      options[:formatters].last << o
    end

    parser.on('--deprecation-out FILE', 'Write deprecation warnings to a file instead of $stdout.') do |file|
      # Handled in `pre_parse` so we can set the deprecation stream as early as
      # possible in case any other options cause deprecations to be issued.
    end

    parser.on('-b', '--backtrace', 'Enable full backtrace.') do |o|
      options[:full_backtrace] = true
    end

    parser.on('-c', '--[no-]color', '--[no-]colour', 'Enable color in the output.') do |o|
      options[:color] = o
    end

    parser.on('-p', '--[no-]profile [COUNT]', 'Enable profiling of examples and list the slowest examples (default: 10).') do |argument|
      options[:profile_examples] = if argument.nil?
                                     true
                                   elsif argument == false
                                     false
                                   else
                                     begin
                                       Integer(argument)
                                     rescue ArgumentError
                                       Kernel.warn "Non integer specified as profile count, seperate " +
                                                   "your path from options with -- e.g. " +
                                                   "`rspec --profile -- #{argument}`"
                                       true
                                     end
                                   end
    end

    parser.on('-w', '--warnings', 'Enable ruby warnings') do
      options[:warnings] = true
    end

    parser.separator <<-FILTERING

  **** Filtering/tags ****

In addition to the following options for selecting specific files, groups,
or examples, you can select a single example by appending the line number to
the filename:

  rspec path/to/a_spec.rb:37

FILTERING

    parser.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: "spec/**/*_spec.rb").') do |o|
      options[:pattern] = o
    end

    parser.on('-e', '--example STRING', "Run examples whose full nested names include STRING (may be",
                                        "  used more than once)") do |o|
      (options[:full_description] ||= []) << Regexp.compile(Regexp.escape(o))
    end

    parser.on('-l', '--line-number LINE', 'Specify line number of an example or group (may be',
                                          '  used more than once).') do |o|
      Metadata.line_number_filter_deprecation_issued = true
      RSpec.deprecate("The `--line-number`/`-l` CLI option",
                      :replacement => "the `path/to/file.rb:num` form",
                      :call_site => nil)
      (options[:line_numbers] ||= []) << o
    end

    parser.on('-t', '--tag TAG[:VALUE]',
              'Run examples with the specified tag, or exclude examples',
              'by adding ~ before the tag.',
              '  - e.g. ~slow',
              '  - TAG is always converted to a symbol') do |tag|
      filter_type = tag =~ /^~/ ? :exclusion_filter : :inclusion_filter

      name,value = tag.gsub(/^(~@|~|@)/, '').split(':')
      name = name.to_sym

      options[filter_type] ||= {}
      options[filter_type][name] = value.nil? ? true : eval(value) rescue value
    end

    parser.on('--default-path PATH', 'Set the default path where RSpec looks for examples (can',
                                     '  be a path to a file or a directory).') do |path|
      options[:default_path] = path
    end

    parser.separator("\n  **** Utility ****\n\n")

    parser.on('-v', '--version', 'Display the version.') do
      puts RSpec::Core::Version::STRING
      exit
    end

    parser.on_tail('-h', '--help', "You're looking at it.") do
      puts parser
      exit
    end

  end
end

- (Object) pre_parse(args)



235
236
237
238
239
240
241
# File 'lib/rspec/core/option_parser.rb', line 235

def pre_parse(args)
  args.each_cons(2) do |arg, value|
    if arg == "--deprecation-out"
      RSpec.configuration.deprecation_stream = value
    end
  end
end