Class: Spec::Runner::Options

Class | Spec::Runner::Options
In: | lib/spec/runner/options.rb
Parent: | Object

### Methods

add_example_group colour= custom_runner custom_runner? default_differ differ_class= examples_run? examples_should_be_run? examples_should_not_be_run files_to_load formatters heckle load_class load_formatters load_heckle_runner new number_of_examples parse_diff parse_example parse_format remove_example_group run_examples set_spec_from_line_number sorted_files sorter stderr? story_formatters

### Constants

FILE_SORTERS | = | { 'mtime' => lambda {|file_a, file_b| File.mtime(file_b) <=> File.mtime(file_a)}
EXAMPLE_FORMATTERS | = | { # Load these lazily for better speed 'specdoc' => ['spec/runner/formatter/specdoc_formatter', 'Formatter::SpecdocFormatter'], 's' => ['spec/runner/formatter/specdoc_formatter', 'Formatter::SpecdocFormatter'], 'html' => ['spec/runner/formatter/html_formatter', 'Formatter::HtmlFormatter'], 'h' => ['spec/runner/formatter/html_formatter', 'Formatter::HtmlFormatter'], 'progress' => ['spec/runner/formatter/progress_bar_formatter', 'Formatter::ProgressBarFormatter'], 'p' => ['spec/runner/formatter/progress_bar_formatter', 'Formatter::ProgressBarFormatter'], 'failing_examples' => ['spec/runner/formatter/failing_examples_formatter', 'Formatter::FailingExamplesFormatter'], 'e' => ['spec/runner/formatter/failing_examples_formatter', 'Formatter::FailingExamplesFormatter'], 'failing_example_groups' => ['spec/runner/formatter/failing_example_groups_formatter', 'Formatter::FailingExampleGroupsFormatter'], 'g' => ['spec/runner/formatter/failing_example_groups_formatter', 'Formatter::FailingExampleGroupsFormatter'], 'profile' => ['spec/runner/formatter/profile_formatter', 'Formatter::ProfileFormatter'], 'o' => ['spec/runner/formatter/profile_formatter', 'Formatter::ProfileFormatter'], 'textmate' => ['spec/runner/formatter/text_mate_formatter', 'Formatter::TextMateFormatter']
STORY_FORMATTERS | = | { 'plain' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'], 'p' => ['spec/runner/formatter/story/plain_text_formatter', 'Formatter::Story::PlainTextFormatter'], 'html' => ['spec/runner/formatter/story/html_formatter', 'Formatter::Story::HtmlFormatter'], 'h' => ['spec/runner/formatter/story/html_formatter', 'Formatter::Story::HtmlFormatter']

### Attributes

argv | [RW] |
backtrace_tweaker | [RW] |
colour | [R] |
context_lines | [RW] |
diff_format | [RW] |
differ_class | [R] |
dry_run | [RW] |
error_stream | [RW] |
example_groups | [R] |
examples | [RW] |
filename_pattern | [RW] |
files | [R] |
heckle_runner | [RW] |
line_number | [RW] |
loadby | [RW] |
output_stream | [RW] |
profile | [RW] |
reporter | [RW] |
reverse | [RW] |
timeout | [RW] |
user_input_for_runner | [RW] |
verbose | [RW] |

### Public Class methods

new(error_stream, output_stream)

[Source]

        # File lib/spec/runner/options.rb, line 54
    54:       def initialize(error_stream, output_stream)
    55:         @error_stream = error_stream
    56:         @output_stream = output_stream
    57:         @filename_pattern = "**/*_spec.rb"
    58:         @backtrace_tweaker = QuietBacktraceTweaker.new
    59:         @examples = []
    60:         @colour = false
    61:         @profile = false
    62:         @dry_run = false
    63:         @reporter = Reporter.new(self)
    64:         @context_lines = 3
    65:         @diff_format  = :unified
    66:         @files = []
    67:         @example_groups = []
    68:         @examples_run = false
    69:         @examples_should_be_run = nil
    70:         @user_input_for_runner = nil
    71:       end

### Public Instance methods

add_example_group(example_group)

[Source]

        # File lib/spec/runner/options.rb, line 73
    73:       def add_example_group(example_group)
    74:         @example_groups << example_group
    75:       end

colour=(colour)

[Source]

         # File lib/spec/runner/options.rb, line 105
    105:       def colour=(colour)
    106:         @colour = colour
    107:         if @colour && RUBY_PLATFORM =~ /win32/ ;\
    108:           begin ;\
    109:             require 'rubygems' ;\
    110:             require 'Win32/Console/ANSI' ;\
    111:           rescue LoadError ;\
    112:             warn "You must 'gem install win32console' to use colour on Windows" ;\
    113:             @colour = false ;\
    114:           end
    115:         end
    116:       end

examples_run?()

[Source]

        # File lib/spec/runner/options.rb, line 97
    97:       def examples_run?
    98:         @examples_run
    99:       end

examples_should_not_be_run()

[Source]

         # File lib/spec/runner/options.rb, line 101
    101:       def examples_should_not_be_run
    102:         @examples_should_be_run = false
    103:       end

files_to_load()

[Source]

         # File lib/spec/runner/options.rb, line 185
    185:       def files_to_load
    186:         result = []
    187:         sorted_files.each do |file|
    188:           if File.directory?(file)
    189:             filename_pattern.split(",").each do |pattern|
    190:               result += Dir[File.expand_path("#{file}/#{pattern.strip}")]
    191:             end
    192:           elsif File.file?(file)
    193:             result << file
    194:           else
    195:             raise "File or directory not found: #{file}"
    196:           end
    197:         end
    198:         result
    199:       end

formatters()

[Source]

         # File lib/spec/runner/options.rb, line 151
    151:       def formatters
    152:         @format_options ||= [['progress', @output_stream]]
    153:         @formatters ||= load_formatters(@format_options, EXAMPLE_FORMATTERS)
    154:       end

load_formatters(format_options, formatters)

[Source]

         # File lib/spec/runner/options.rb, line 161
    161:       def load_formatters(format_options, formatters)
    162:         format_options.map do |format, where|
    163:           formatter_type = if formatters[format]
    164:             require formatters[format][0]
    165:             eval(formatters[format][1], binding, __FILE__, __LINE__)
    166:           else
    167:             load_class(format, 'formatter', '--format')
    168:           end
    169:           formatter_type.new(self, where)
    170:         end
    171:       end

load_heckle_runner(heckle)

[Source]

         # File lib/spec/runner/options.rb, line 173
    173:       def load_heckle_runner(heckle)
    174:         suffix = [/mswin/, /java/].detect{|p| p =~ RUBY_PLATFORM} ? '_unsupported' : ''
    175:         require "spec/runner/heckle_runner#{suffix}"
    176:         @heckle_runner = HeckleRunner.new(heckle)
    177:       end

number_of_examples()

[Source]

         # File lib/spec/runner/options.rb, line 179
    179:       def number_of_examples
    180:         @example_groups.inject(0) do |sum, example_group|
    181:           sum + example_group.number_of_examples
    182:         end
    183:       end

parse_diff(format)

[Source]

         # File lib/spec/runner/options.rb, line 118
    118:       def parse_diff(format)
    119:         case format
    120:         when :context, 'context', 'c'
    121:           @diff_format  = :context
    122:           default_differ
    123:         when :unified, 'unified', 'u', '', nil
    124:           @diff_format  = :unified
    125:           default_differ
    126:         else
    127:           @diff_format  = :custom
    128:           self.differ_class = load_class(format, 'differ', '--diff')
    129:         end
    130:       end

parse_example(example)

[Source]

         # File lib/spec/runner/options.rb, line 132
    132:       def parse_example(example)
    133:         if(File.file?(example))
    134:           @examples = File.open(example).read.split("\n")
    135:         else
    136:           @examples = [example]
    137:         end
    138:       end

parse_format(format_arg)

[Source]

         # File lib/spec/runner/options.rb, line 140
    140:       def parse_format(format_arg)
    141:         format, where = ClassAndArgumentsParser.parse(format_arg)
    142:         unless where
    143:           raise "When using several --format options only one of them can be without a file" if @out_used
    144:           where = @output_stream
    145:           @out_used = true
    146:         end
    147:         @format_options ||= []
    148:         @format_options << [format, where]
    149:       end

remove_example_group(example_group)

[Source]

        # File lib/spec/runner/options.rb, line 77
    77:       def remove_example_group(example_group)
    78:         @example_groups.delete(example_group)
    79:       end

run_examples()

[Source]

        # File lib/spec/runner/options.rb, line 81
    81:       def run_examples
    82:         return true unless examples_should_be_run?
    83:         runner = custom_runner || ExampleGroupRunner.new(self)
    84:
    85:         runner.load_files(files_to_load)
    86:         if example_groups.empty?
    87:           true
    88:         else
    89:           set_spec_from_line_number if line_number
    90:           success = runner.run
    91:           @examples_run = true
    92:           heckle if heckle_runner
    93:           success
    94:         end
    95:       end

story_formatters()

[Source]

         # File lib/spec/runner/options.rb, line 156
    156:       def story_formatters
    157:         @format_options ||= [['plain', @output_stream]]
    158:         @formatters ||= load_formatters(@format_options, STORY_FORMATTERS)
    159:       end

### Protected Instance methods

custom_runner()

[Source]

         # File lib/spec/runner/options.rb, line 231
    231:       def custom_runner
    232:         return nil unless custom_runner?
    233:         klass_name, arg = ClassAndArgumentsParser.parse(user_input_for_runner)
    234:         runner_type = load_class(klass_name, 'behaviour runner', '--runner')
    235:         return runner_type.new(self, arg)
    236:       end

custom_runner?()

[Source]

         # File lib/spec/runner/options.rb, line 238
    238:       def custom_runner?
    239:         return user_input_for_runner ? true : false
    240:       end

default_differ()

[Source]

         # File lib/spec/runner/options.rb, line 256
    256:       def default_differ
    257:         require 'spec/expectations/differs/default'
    258:         self.differ_class = Spec::Expectations::Differs::Default
    259:       end

differ_class=(klass)

[Source]

         # File lib/spec/runner/options.rb, line 207
    207:       def differ_class=(klass)
    208:         return unless klass
    209:         @differ_class = klass
    210:         Spec::Expectations.differ = self.differ_class.new(self)
    211:       end

examples_should_be_run?()

[Source]

         # File lib/spec/runner/options.rb, line 202
    202:       def examples_should_be_run?
    203:         return @examples_should_be_run unless @examples_should_be_run.nil?
    204:         @examples_should_be_run = true
    205:       end

heckle()

[Source]

         # File lib/spec/runner/options.rb, line 242
    242:       def heckle
    243:         returns = self.heckle_runner.heckle_with
    244:         self.heckle_runner = nil
    245:         returns
    246:       end

load_class(name, kind, option)

[Source]

         # File lib/spec/runner/options.rb, line 213
    213:       def load_class(name, kind, option)
    214:         if name =~ /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/
    215:           arg = $2 == "" ? nil : $2
    216:           [$1, arg]
    217:         else
    218:           m = "#{name.inspect} is not a valid class name"
    219:           @error_stream.puts m
    220:           raise m
    221:         end
    222:         begin
    223:           eval(name, binding, __FILE__, __LINE__)
    224:         rescue NameError => e
    225:           @error_stream.puts "Couldn't find #{kind} class #{name}"
    226:           @error_stream.puts "Make sure the --require option is specified *before* #{option}"
    227:           if $_spec_spec ; raise e ; else exit(1) ; end
    228:         end
    229:       end

set_spec_from_line_number()

[Source]

         # File lib/spec/runner/options.rb, line 261
    261:       def set_spec_from_line_number
    262:         if examples.empty?
    263:           if files.length == 1
    264:             if File.directory?(files[0])
    265:               error_stream.puts "You must specify one file, not a directory when using the --line option"
    266:               exit(1) if stderr?
    267:             else
    268:               example = SpecParser.new.spec_name_for(files[0], line_number)
    269:               @examples = [example]
    270:             end
    271:           else
    272:             error_stream.puts "Only one file can be specified when using the --line option: #{files.inspect}"
    273:             exit(3) if stderr?
    274:           end
    275:         else
    276:           error_stream.puts "You cannot use both --line and --example"
    277:           exit(4) if stderr?
    278:         end
    279:       end

sorted_files()

[Source]

         # File lib/spec/runner/options.rb, line 248
    248:       def sorted_files
    249:         return sorter ? files.sort(&sorter) : files
    250:       end

sorter()

[Source]

         # File lib/spec/runner/options.rb, line 252
    252:       def sorter
    253:         FILE_SORTERS[loadby]
    254:       end

stderr?()

[Source]

         # File lib/spec/runner/options.rb, line 281
    281:       def stderr?
    282:         @error_stream == $stderr
    283:       end

[Validate]