Class | Spec::Runner::OptionParser |
In: |
lib/spec/runner/option_parser.rb
|
Parent: | ::OptionParser |
OPTIONS | = | { :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"] |
options | [R] |
# File lib/spec/runner/option_parser.rb, line 81 81: def initialize(err, out) 82: super() 83: @error_stream = err 84: @out_stream = out 85: @options = Options.new(@error_stream, @out_stream) 86: 87: @spec_parser = SpecParser.new 88: @file_factory = File 89: 90: self.banner = "Usage: spec (FILE|DIRECTORY|GLOB)+ [options]" 91: self.separator "" 92: on(*OPTIONS[:diff]) {|diff| @options.parse_diff(diff)} 93: on(*OPTIONS[:colour]) {@options.colour = true} 94: on(*OPTIONS[:example]) {|example| @options.parse_example(example)} 95: on(*OPTIONS[:specification]) {|example| @options.parse_example(example)} 96: on(*OPTIONS[:line]) {|line_number| @options.line_number = line_number.to_i} 97: on(*OPTIONS[:format]) {|format| @options.parse_format(format)} 98: on(*OPTIONS[:require]) {|requires| invoke_requires(requires)} 99: on(*OPTIONS[:backtrace]) {@options.backtrace_tweaker = NoisyBacktraceTweaker.new} 100: on(*OPTIONS[:loadby]) {|loadby| @options.loadby = loadby} 101: on(*OPTIONS[:reverse]) {@options.reverse = true} 102: on(*OPTIONS[:timeout]) {|timeout| @options.timeout = timeout.to_f} 103: on(*OPTIONS[:heckle]) {|heckle| @options.load_heckle_runner(heckle)} 104: on(*OPTIONS[:dry_run]) {@options.dry_run = true} 105: on(*OPTIONS[:options_file]) {|options_file| parse_options_file(options_file)} 106: on(*OPTIONS[:generate_options]) do |options_file| 107: end 108: on(*OPTIONS[:runner]) do |runner| 109: @options.user_input_for_runner = runner 110: end 111: on(*OPTIONS[:drb]) {} 112: on(*OPTIONS[:version]) {parse_version} 113: on_tail(*OPTIONS[:help]) {parse_help} 114: end
# 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
# File lib/spec/runner/option_parser.rb, line 116 116: def order!(argv, &blk) 117: @argv = argv 118: @options.argv = @argv.dup 119: return if parse_generate_options 120: return if parse_drb 121: 122: super(@argv) do |file| 123: @options.files << file 124: blk.call(file) if blk 125: end 126: 127: if @options.line_number 128: set_spec_from_line_number 129: end 130: 131: @options 132: end
# 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
# 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
# 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
# File lib/spec/runner/option_parser.rb, line 191 191: def parse_help 192: @out_stream.puts self 193: exit if stdout? 194: end
# 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
# 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
# File lib/spec/runner/option_parser.rb, line 196 196: def set_spec_from_line_number 197: if @options.examples.empty? 198: if @options.files.length == 1 199: if @file_factory.file?(@options.files[0]) 200: source = @file_factory.open(@options.files[0]) 201: example = @spec_parser.spec_name_for(source, @options.line_number) 202: @options.parse_example(example) 203: elsif @file_factory.directory?(@options.files[0]) 204: @error_stream.puts "You must specify one file, not a directory when using the --line option" 205: exit(1) if stderr? 206: else 207: @error_stream.puts "#{@options.files[0]} does not exist" 208: exit(2) if stderr? 209: end 210: else 211: @error_stream.puts "Only one file can be specified when using the --line option: #{@options.files.inspect}" 212: exit(3) if stderr? 213: end 214: else 215: @error_stream.puts "You cannot use both --line and --example" 216: exit(4) if stderr? 217: end 218: end
# File lib/spec/runner/option_parser.rb, line 224 224: def stderr? 225: @error_stream == $stderr 226: end
# File lib/spec/runner/option_parser.rb, line 220 220: def stdout? 221: @out_stream == $stdout 222: end
# 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