Class: Spec::Runner::OptionParser

Class | Spec::Runner::OptionParser
In: | lib/spec/runner/option_parser.rb
Parent: | ::OptionParser

### Methods

invoke_requires new order! parse parse_drb parse_generate_options parse_help parse_options_file parse_version stdout? write_generated_options

### Constants

OPTIONS | = | { :pattern => ["-p", "--pattern [PATTERN]","Limit files loaded to those matching this pattern. Defaults to '**/*_spec.rb'", "Separate multiple patterns with commas.", "Applies only to directories named on the command line (files", "named explicitly on the command line will be loaded regardless)."], :diff => ["-D", "--diff [FORMAT]", "Show diff of objects that are expected to be equal when they are not", "Builtin formats: unified|u|context|c", "You can also specify a custom differ class", "(in which case you should also specify --require)"], :colour => ["-c", "--colour", "--color", "Show coloured (red/green) output"], :example => ["-e", "--example [NAME|FILE_NAME]", "Execute example(s) with matching name(s). If the argument is", "the path to an existing file (typically generated by a previous", "run using --format failing_examples:file.txt), then the examples", "on each line of thatfile will be executed. If the file is empty,", "all examples will be run (as if --example was not specified).", " ", "If the argument is not an existing file, then it is treated as", "an example name directly, causing RSpec to run just the example", "matching that name"], :specification => ["-s", "--specification [NAME]", "DEPRECATED - use -e instead", "(This will be removed when autotest works with -e)"], :line => ["-l", "--line LINE_NUMBER", Integer, "Execute behaviout or specification at given line.", "(does not work for dynamically generated specs)"], :format => ["-f", "--format FORMAT[:WHERE]", "Specifies what format to use for output. Specify WHERE to tell", "the formatter where to write the output. All built-in formats", "expect WHERE to be a file name, and will write to STDOUT if it's", "not specified. The --format option may be specified several times", "if you want several outputs", " ", "Builtin formats for examples: ", "progress|p : Text progress", "profile|o : Text progress with profiling of 10 slowest examples", "specdoc|s : Example doc as text", "html|h : A nice HTML report", "failing_examples|e : Write all failing examples - input for --example", "failing_example_groups|g : Write all failing example groups - input for --example", " ", "Builtin formats for stories: ", "plain|p : Plain Text", "html|h : A nice HTML report", " ", "FORMAT can also be the name of a custom formatter class", "(in which case you should also specify --require to load it)"], :require => ["-r", "--require FILE", "Require FILE before running specs", "Useful for loading custom formatters or other extensions.", "If this option is used it must come before the others"], :backtrace => ["-b", "--backtrace", "Output full backtrace"], :loadby => ["-L", "--loadby STRATEGY", "Specify the strategy by which spec files should be loaded.", "STRATEGY can currently only be 'mtime' (File modification time)", "By default, spec files are loaded in alphabetical order if --loadby", "is not specified."], :reverse => ["-R", "--reverse", "Run examples in reverse order"], :timeout => ["-t", "--timeout FLOAT", "Interrupt and fail each example that doesn't complete in the", "specified time"], :heckle => ["-H", "--heckle CODE", "If all examples pass, this will mutate the classes and methods", "identified by CODE little by little and run all the examples again", "for each mutation. The intent is that for each mutation, at least", "one example *should* fail, and RSpec will tell you if this is not the", "case. CODE should be either Some::Module, Some::Class or", "Some::Fabulous#method}"], :dry_run => ["-d", "--dry-run", "Invokes formatters without executing the examples."], :options_file => ["-O", "--options PATH", "Read options from a file"], :generate_options => ["-G", "--generate-options PATH", "Generate an options file for --options"], :runner => ["-U", "--runner RUNNER", "Use a custom Runner."], :drb => ["-X", "--drb", "Run examples via DRb. (For example against script/spec_server)"], :version => ["-v", "--version", "Show version"], :help => ["-h", "--help", "You're looking at it"]

### Attributes

options | [R] |

### Public Class methods

new(err, out)

[Source]

         # File lib/spec/runner/option_parser.rb, line 85
     85:       def initialize(err, out)
     86:         super()
     87:         @error_stream = err
     88:         @out_stream = out
     89:         @options = Options.new(@error_stream, @out_stream)
     90:
     91:         @file_factory = File
     92:
     93:         self.banner = "Usage: spec (FILE|DIRECTORY|GLOB)+ [options]"
     94:         self.separator ""
     95:         on(*OPTIONS[:pattern]) {|pattern| @options.filename_pattern = pattern}
     96:         on(*OPTIONS[:diff]) {|diff| @options.parse_diff(diff)}
     97:         on(*OPTIONS[:colour]) {@options.colour = true}
     98:         on(*OPTIONS[:example]) {|example| @options.parse_example(example)}
     99:         on(*OPTIONS[:specification]) {|example| @options.parse_example(example)}
    100:         on(*OPTIONS[:line]) {|line_number| @options.line_number = line_number.to_i}
    101:         on(*OPTIONS[:format]) {|format| @options.parse_format(format)}
    102:         on(*OPTIONS[:require]) {|requires| invoke_requires(requires)}
    103:         on(*OPTIONS[:backtrace]) {@options.backtrace_tweaker = NoisyBacktraceTweaker.new}
    104:         on(*OPTIONS[:loadby]) {|loadby| @options.loadby = loadby}
    105:         on(*OPTIONS[:reverse]) {@options.reverse = true}
    106:         on(*OPTIONS[:timeout]) {|timeout| @options.timeout = timeout.to_f}
    107:         on(*OPTIONS[:heckle]) {|heckle| @options.load_heckle_runner(heckle)}
    108:         on(*OPTIONS[:dry_run]) {@options.dry_run = true}
    109:         on(*OPTIONS[:options_file]) {|options_file| parse_options_file(options_file)}
    110:         on(*OPTIONS[:generate_options]) do |options_file|
    111:         end
    112:         on(*OPTIONS[:runner]) do |runner|
    113:           @options.user_input_for_runner = runner
    114:         end
    115:         on(*OPTIONS[:drb]) {}
    116:         on(*OPTIONS[:version]) {parse_version}
    117:         on_tail(*OPTIONS[:help]) {parse_help}
    118:       end

parse(args, err, out)

[Source]

        # File lib/spec/runner/option_parser.rb, line 8
     8:         def parse(args, err, out)
     9:           parser = new(err, out)
    10:           parser.parse(args)
    11:           parser.options
    12:         end

### Public Instance methods

order!(argv, &blk)

[Source]

         # File lib/spec/runner/option_parser.rb, line 120
    120:       def order!(argv, &blk)
    121:         @argv = argv
    122:         @options.argv = @argv.dup
    123:         return if parse_generate_options
    124:         return if parse_drb
    125:
    126:         super(@argv) do |file|
    127:           @options.files << file
    128:           blk.call(file) if blk
    129:         end
    130:
    131:         @options
    132:       end

### Protected Instance methods

invoke_requires(requires)

[Source]

         # File lib/spec/runner/option_parser.rb, line 135
    135:       def invoke_requires(requires)
    136:         requires.split(",").each do |file|
    137:           require file
    138:         end
    139:       end

parse_drb()

[Source]

         # File lib/spec/runner/option_parser.rb, line 173
    173:       def parse_drb
    174:         is_drb = false
    175:         argv = @options.argv
    176:         is_drb ||= argv.delete(OPTIONS[:drb][0])
    177:         is_drb ||= argv.delete(OPTIONS[:drb][1])
    178:         return nil unless is_drb
    179:         @options.examples_should_not_be_run
    180:         DrbCommandLine.run(
    181:           self.class.parse(argv, @error_stream, @out_stream)
    182:         )
    183:         true
    184:       end

parse_generate_options()

[Source]

         # File lib/spec/runner/option_parser.rb, line 146
    146:       def parse_generate_options
    147:         # Remove the --generate-options option and the argument before writing to file
    148:         options_file = nil
    149:         ['-G', '--generate-options'].each do |option|
    150:           if index = @argv.index(option)
    151:             @argv.delete_at(index)
    152:             options_file = @argv.delete_at(index)
    153:           end
    154:         end
    155:
    156:         if options_file
    157:           write_generated_options(options_file)
    158:           return true
    159:         else
    160:           return false
    161:         end
    162:       end

parse_help()

[Source]

         # File lib/spec/runner/option_parser.rb, line 191
    191:       def parse_help
    192:         @out_stream.puts self
    193:         exit if stdout?
    194:       end

parse_options_file(options_file)

[Source]

         # File lib/spec/runner/option_parser.rb, line 141
    141:       def parse_options_file(options_file)
    142:         option_file_args = IO.readlines(options_file).map {|l| l.chomp.split " "}.flatten
    143:         @argv.push(*option_file_args)
    144:       end

parse_version()

[Source]

         # File lib/spec/runner/option_parser.rb, line 186
    186:       def parse_version
    187:         @out_stream.puts ::Spec::VERSION::DESCRIPTION
    188:         exit if stdout?
    189:       end

stdout?()

[Source]

         # File lib/spec/runner/option_parser.rb, line 196
    196:       def stdout?
    197:         @out_stream == $stdout
    198:       end

write_generated_options(options_file)

[Source]

         # File lib/spec/runner/option_parser.rb, line 164
    164:       def write_generated_options(options_file)
    165:         File.open(options_file, 'w') do |io|
    166:           io.puts @argv.join("\n")
    167:         end
    168:         @out_stream.puts "\nOptions written to #{options_file}. You can now use these options with:"
    169:         @out_stream.puts "spec --options #{options_file}"
    170:         @options.examples_should_not_be_run
    171:       end

[Validate]