Class: Spec::Runner::OptionParser

Inherits:
Object
  • Object
show all
Defined in:
lib/spec/runner/option_parser.rb

Instance Method Summary collapse

Constructor Details

#initializeOptionParser

Returns a new instance of OptionParser.



12
13
14
15
# File 'lib/spec/runner/option_parser.rb', line 12

def initialize
  @spec_parser = SpecParser.new
  @file_factory = File
end

Instance Method Details

#create_context_runner(args, err, out, warn_if_no_files) ⇒ Object



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# File 'lib/spec/runner/option_parser.rb', line 17

def create_context_runner(args, err, out, warn_if_no_files)
  options = parse(args, err, out, warn_if_no_files)
  # Some exit points in parse (--generate-options, --drb) don't return the options, 
  # but hand over control. In that case we don't want to continue.
  return nil unless options.is_a?(OpenStruct)

  formatter = options.formatter_type.new(options.out, options.dry_run, options.colour)
  options.reporter = Reporter.new(formatter, options.backtrace_tweaker) 

  # this doesn't really belong here.
  # it should, but the way things are coupled, it doesn't
  if options.differ_class
    Spec::Expectations.differ = options.differ_class.new(options.diff_format, options.context_lines, options.colour)
  end

  unless options.generate
    ContextRunner.new(options)  
  end
end

#parse(args, err, out, warn_if_no_files) ⇒ Object



37
38
39
40
41
42
43
44
45
46
47
48
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
# File 'lib/spec/runner/option_parser.rb', line 37

def parse(args, err, out, warn_if_no_files)
  options_file = nil
  args_copy = args.dup
  options = OpenStruct.new
  options.out = (out == STDOUT ? Kernel : out)
  options.formatter_type = Formatter::ProgressBarFormatter
  options.backtrace_tweaker = QuietBacktraceTweaker.new
  options.spec_name = nil

  opts = ::OptionParser.new do |opts|
    opts.banner = "Usage: spec [options] (FILE|DIRECTORY|GLOB)+"
    opts.separator ""

    opts.on("-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)") do |format|

      # TODO make context_lines settable
      options.context_lines = 3

      case format
        when 'context', 'c'
          options.diff_format  = :context
        when 'unified', 'u', '', nil
          options.diff_format  = :unified
      end

      if [:context,:unified].include? options.diff_format
        require 'spec/expectations/differs/default'
        options.differ_class = Spec::Expectations::Differs::Default
      else
        begin
          options.diff_format  = :custom
          options.differ_class = eval(format)
        rescue NameError
          err.puts "Couldn't find differ class #{format}"
          err.puts "Make sure the --require option is specified *before* --diff"
          exit if out == $stdout
        end
      end

    end
    
    opts.on("-c", "--colour", "--color", "Show coloured (red/green) output") do
      options.colour = true
    end
    
    opts.on("-s", "--spec SPECIFICATION_NAME", "Execute context or specification with matching name") do |spec_name|
      options.spec_name = spec_name
    end
    
    opts.on("-l", "--line LINE_NUMBER", Integer, "Execute context or specification at given line") do |line_number|
      options.line_number = line_number.to_i
    end

    opts.on("-f", "--format FORMAT", "Builtin formats: specdoc|s|rdoc|r|html|h", 
                                     "You can also specify a custom formatter class",
                                     "(in which case you should also specify --require)") do |format|
      case format
        when 'specdoc', 's'
          options.formatter_type = Formatter::SpecdocFormatter
        when 'html', 'h'
          options.formatter_type = Formatter::HtmlFormatter
        when 'rdoc', 'r'
          options.formatter_type = Formatter::RdocFormatter
          options.dry_run = true
      else
        begin
          options.formatter_type = eval(format)
        rescue NameError
          err.puts "Couldn't find formatter class #{format}"
          err.puts "Make sure the --require option is specified *before* --format"
          exit if out == $stdout
        end
      end
    end

    opts.on("-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") do |req|
      req.split(",").each{|file| require file}
    end
    
    opts.on("-b", "--backtrace", "Output full backtrace") do
      options.backtrace_tweaker = NoisyBacktraceTweaker.new
    end

    opts.on("-H", "--heckle CODE", "If all specs pass, this will run your specs many times, mutating",
                                   "the specced code a little each time. The intent is that specs",
                                   "*should* fail, and RSpec will tell you if they don't.",
                                   "CODE should be either Some::Module, Some::Class or Some::Fabulous#method}") do |heckle|
      heckle_runner = PLATFORM == 'i386-mswin32' ? 'spec/runner/heckle_runner_win' : 'spec/runner/heckle_runner'
      require heckle_runner
      options.heckle_runner = HeckleRunner.new(heckle)
    end
    
    opts.on("-d", "--dry-run", "Don't execute specs") do
      options.dry_run = true
    end
    
    opts.on("-o", "--out OUTPUT_FILE", "Path to output file (defaults to STDOUT)") do |out_file|
      options.out = File.new(out_file, 'w')
    end
    
    opts.on("-O", "--options PATH", "Read options from a file") do |options_file|
      # Remove the --options option and the argument before writing to file
      index = args_copy.index("-O") || args_copy.index("--options")
      args_copy.delete_at(index)
      args_copy.delete_at(index)

      new_args = args_copy + IO.readlines(options_file).each {|s| s.chomp!}
      return CommandLine.run(new_args, err, out, true, warn_if_no_files)
    end

    opts.on("-G", "--generate-options PATH", "Generate an options file for --options") do |options_file|
      # Remove the --generate-options option and the argument before writing to file
      index = args_copy.index("-G") || args_copy.index("--generate-options")
      args_copy.delete_at(index)
      args_copy.delete_at(index)

      File.open(options_file, 'w') do |io|
        io.puts args_copy.join("\n")
      end
      out.puts "\nOptions written to #{options_file}. You can now use these options with:"
      out.puts "spec --options #{options_file}"
      options.generate = true
    end
    
    opts.on("-X", "--drb", "Run specs via DRb. (For example against script/rails_spec_server)") do |options_file|
      # Remove the --options option and the argument before writing to file
      index = args_copy.index("-X") || args_copy.index("--drb")
      args_copy.delete_at(index)

      return DrbCommandLine.run(args_copy, err, out, true, warn_if_no_files)
    end

    opts.on("-v", "--version", "Show version") do
      out.puts ::Spec::VERSION::DESCRIPTION
      exit if out == $stdout
    end

    opts.on_tail("-h", "--help", "You're looking at it") do
      out.puts opts
      exit if out == $stdout
    end
    
  end
  opts.parse!(args)

  if args.empty? && warn_if_no_files
    err.puts "No files specified."
    err.puts opts
    exit(6) if err == $stderr
  end

  if options.line_number
    set_spec_from_line_number(options, args, err)
  end

  options
end

#set_spec_from_line_number(options, args, err) ⇒ Object



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/spec/runner/option_parser.rb', line 200

def set_spec_from_line_number(options, args, err)
  unless options.spec_name
    if args.length == 1
      if @file_factory.file?(args[0])
        source = @file_factory.open(args[0])
        options.spec_name = @spec_parser.spec_name_for(source, options.line_number)
      elsif @file_factory.directory?(args[0])
        err.puts "You must specify one file, not a directory when using the --line option"
        exit(1) if err == $stderr
      else
        err.puts "#{args[0]} does not exist"
        exit(2) if err == $stderr
      end
    else
      err.puts "Only one file can be specified when using the --line option: #{args.inspect}"
      exit(3) if err == $stderr
    end
  else
    err.puts "You cannot use both --line and --spec"
    exit(4) if err == $stderr
  end
end