-
-
Notifications
You must be signed in to change notification settings - Fork 763
/
configuration.rb
502 lines (438 loc) · 15.3 KB
/
configuration.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
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
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
require "rbconfig"
require 'fileutils'
module RSpec
module Core
class Configuration
include RSpec::Core::Hooks
def self.add_setting(name, opts={})
if opts[:alias]
alias_method name, opts[:alias]
alias_method "#{name}=", "#{opts[:alias]}="
alias_method "#{name}?", "#{opts[:alias]}?"
else
define_method("#{name}=") {|val| settings[name] = val}
define_method(name) { settings.has_key?(name) ? settings[name] : opts[:default] }
define_method("#{name}?") { send name }
end
end
add_setting :error_stream
add_setting :output_stream
add_setting :output, :alias => :output_stream
add_setting :out, :alias => :output_stream
add_setting :drb
add_setting :drb_port
add_setting :profile_examples
add_setting :fail_fast
add_setting :run_all_when_everything_filtered
add_setting :exclusion_filter
add_setting :inclusion_filter
add_setting :filter, :alias => :inclusion_filter
add_setting :pattern, :default => '**/*_spec.rb'
add_setting :filename_pattern, :alias => :pattern
add_setting :files_to_run
add_setting :include_or_extend_modules
add_setting :backtrace_clean_patterns
add_setting :tty
add_setting :treat_symbols_as_metadata_keys_with_true_values, :default => false
add_setting :expecting_with_rspec
CONDITIONAL_FILTERS = {
:if => lambda { |value, metadata| metadata.has_key?(:if) && !value },
:unless => lambda { |value| value }
}
DEFAULT_BACKTRACE_PATTERNS = [
/\/lib\d*\/ruby\//,
/bin\//,
/gems/,
/spec\/spec_helper\.rb/,
/lib\/rspec\/(core|expectations|matchers|mocks)/
]
def initialize
@color_enabled = false
self.include_or_extend_modules = []
self.files_to_run = []
self.backtrace_clean_patterns = DEFAULT_BACKTRACE_PATTERNS.dup
self.exclusion_filter = CONDITIONAL_FILTERS.dup
end
def reset
@reporter = nil
end
# :call-seq:
# add_setting(:name)
# add_setting(:name, :default => "default_value")
# add_setting(:name, :alias => :other_setting)
#
# Use this to add custom settings to the RSpec.configuration object.
#
# RSpec.configuration.add_setting :foo
#
# Creates three methods on the configuration object, a setter, a getter,
# and a predicate:
#
# RSpec.configuration.foo=(value)
# RSpec.configuration.foo()
# RSpec.configuration.foo?() # returns true if foo returns anything but nil or false
#
# Intended for extension frameworks like rspec-rails, so they can add config
# settings that are domain specific. For example:
#
# RSpec.configure do |c|
# c.add_setting :use_transactional_fixtures, :default => true
# c.add_setting :use_transactional_examples, :alias => :use_transactional_fixtures
# end
#
# == Options
#
# +add_setting+ takes an optional hash that supports the following
# keys:
#
# :default => "default value"
#
# This sets the default value for the getter and the predicate (which
# will return +true+ as long as the value is not +false+ or +nil+).
#
# :alias => :other_setting
#
# Aliases its setter, getter, and predicate, to those for the
# +other_setting+.
def add_setting(name, opts={})
self.class.add_setting(name, opts)
end
def puts(message)
output_stream.puts(message)
end
def settings
@settings ||= {}
end
def clear_inclusion_filter # :nodoc:
self.inclusion_filter = nil
end
def cleaned_from_backtrace?(line)
backtrace_clean_patterns.any? { |regex| line =~ regex }
end
# Returns the configured mock framework adapter module
def mock_framework
settings[:mock_framework] ||= begin
require 'rspec/core/mocking/with_rspec'
RSpec::Core::MockFrameworkAdapter
end
end
# Delegates to mock_framework=(framework)
def mock_with(framework)
self.mock_framework = framework
end
# Sets the mock framework adapter module.
#
# +framework+ can be a Symbol or a Module.
#
# Given any of :rspec, :mocha, :flexmock, or :rr, configures the named
# framework.
#
# Given :nothing, configures no framework. Use this if you don't use any
# mocking framework to save a little bit of overhead.
#
# Given a Module, includes that module in every example group. The module
# should adhere to RSpec's mock framework adapter API:
#
# setup_mocks_for_rspec
# - called before each example
#
# verify_mocks_for_rspec
# - called after each example. Framework should raise an exception
# when expectations fail
#
# teardown_mocks_for_rspec
# - called after verify_mocks_for_rspec (even if there are errors)
def mock_framework=(framework)
case framework
when Module
settings[:mock_framework] = framework
when String, Symbol
require case framework.to_s
when /rspec/i
'rspec/core/mocking/with_rspec'
when /mocha/i
'rspec/core/mocking/with_mocha'
when /rr/i
'rspec/core/mocking/with_rr'
when /flexmock/i
'rspec/core/mocking/with_flexmock'
else
'rspec/core/mocking/with_absolutely_nothing'
end
settings[:mock_framework] = RSpec::Core::MockFrameworkAdapter
else
end
end
# Returns the configured expectation framework adapter module(s)
def expectation_frameworks
expect_with :rspec unless settings[:expectation_frameworks]
settings[:expectation_frameworks]
end
# Delegates to expect_with([framework])
def expectation_framework=(framework)
expect_with([framework])
end
# Sets the expectation framework module(s).
#
# +frameworks+ can be :rspec, :stdlib, or both
#
# Given :rspec, configures rspec/expectations.
# Given :stdlib, configures test/unit/assertions
# Given both, configures both
def expect_with(*frameworks)
settings[:expectation_frameworks] = []
frameworks.each do |framework|
case framework
when Symbol
case framework
when :rspec
require 'rspec/core/expecting/with_rspec'
self.expecting_with_rspec = true
when :stdlib
require 'rspec/core/expecting/with_stdlib'
else
raise ArgumentError, "#{framework.inspect} is not supported"
end
settings[:expectation_frameworks] << RSpec::Core::ExpectationFrameworkAdapter
end
end
end
def full_backtrace=(true_or_false)
settings[:backtrace_clean_patterns] = true_or_false ? [] : DEFAULT_BACKTRACE_PATTERNS
end
def color_enabled
@color_enabled && output_to_tty?
end
def color_enabled?
color_enabled
end
def color_enabled=(bool)
return unless bool
@color_enabled = true
if bool && ::RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
unless ENV['ANSICON']
warn "You must use ANSICON 1.31 or later (http://adoxa.110mb.com/ansicon/) to use colour on Windows"
@color_enabled = false
end
end
end
def libs=(libs)
libs.map {|lib| $LOAD_PATH.unshift lib}
end
def requires=(paths)
paths.map {|path| require path}
end
def debug=(bool)
return unless bool
begin
require 'ruby-debug'
Debugger.start
rescue LoadError
raise <<-EOM
#{'*'*50}
You must install ruby-debug to run rspec with the --debug option.
If you have ruby-debug installed as a ruby gem, then you need to either
require 'rubygems' or configure the RUBYOPT environment variable with
the value 'rubygems'.
#{'*'*50}
EOM
end
end
def line_number=(line_number)
filter_run({ :line_number => line_number.to_i }, true)
end
def full_description=(description)
filter_run({ :full_description => /#{description}/ }, true)
end
def add_formatter(formatter_to_use, path=nil)
formatter_class =
built_in_formatter(formatter_to_use) ||
custom_formatter(formatter_to_use) ||
(raise ArgumentError, "Formatter '#{formatter_to_use}' unknown - maybe you meant 'documentation' or 'progress'?.")
formatters << formatter_class.new(path ? file_at(path) : output)
end
alias_method :formatter=, :add_formatter
def formatters
@formatters ||= []
end
def reporter
@reporter ||= begin
add_formatter('progress') if formatters.empty?
Reporter.new(*formatters)
end
end
def files_or_directories_to_run=(*files)
self.files_to_run = files.flatten.collect do |file|
if File.directory?(file)
pattern.split(",").collect do |pattern|
Dir["#{file}/#{pattern.strip}"]
end
else
if file =~ /(\:(\d+))$/
self.line_number = $2
file.sub($1,'')
else
file
end
end
end.flatten
end
# E.g. alias_example_to :crazy_slow, :speed => 'crazy_slow' defines
# crazy_slow as an example variant that has the crazy_slow speed option
def alias_example_to(new_name, *args)
extra_options = build_metadata_hash_from(args)
RSpec::Core::ExampleGroup.alias_example_to(new_name, extra_options)
end
# Define an alias for it_should_behave_like that allows different
# language (like "it_has_behavior" or "it_behaves_like") to be
# employed when including shared examples.
#
# Example:
#
# alias_it_should_behave_like_to(:it_has_behavior, 'has behavior:')
#
# allows the user to include a shared example group like:
#
# describe Entity do
# it_has_behavior 'sortability' do
# let(:sortable) { Entity.new }
# end
# end
#
# which is reported in the output as:
#
# Entity
# has behavior: sortability
# # sortability examples here
def alias_it_should_behave_like_to(new_name, report_label = '')
RSpec::Core::ExampleGroup.alias_it_should_behave_like_to(new_name, report_label)
end
def exclusion_filter=(filter)
settings[:exclusion_filter] = filter
end
def inclusion_filter=(filter)
settings[:inclusion_filter] = filter
end
def filter_run_including(*args)
force_overwrite = if args.last.is_a?(Hash) || args.last.is_a?(Symbol)
false
else
args.pop
end
options = build_metadata_hash_from(args)
if inclusion_filter and inclusion_filter[:line_number] || inclusion_filter[:full_description]
warn "Filtering by #{options.inspect} is not possible since " \
"you are already filtering by #{inclusion_filter.inspect}"
else
if force_overwrite
self.inclusion_filter = options
else
self.inclusion_filter = (inclusion_filter || {}).merge(options)
end
end
end
alias_method :filter_run, :filter_run_including
def filter_run_excluding(*args)
options = build_metadata_hash_from(args)
self.exclusion_filter = (exclusion_filter || {}).merge(options)
end
def include(mod, *args)
filters = build_metadata_hash_from(args)
include_or_extend_modules << [:include, mod, filters]
end
def extend(mod, *args)
filters = build_metadata_hash_from(args)
include_or_extend_modules << [:extend, mod, filters]
end
def configure_group(group)
include_or_extend_modules.each do |include_or_extend, mod, filters|
next unless filters.empty? || group.apply?(:any?, filters)
group.send(include_or_extend, mod)
end
end
def configure_mock_framework
RSpec::Core::ExampleGroup.send(:include, mock_framework)
end
def configure_expectation_framework
expectation_frameworks.each do |framework|
RSpec::Core::ExampleGroup.send(:include, framework)
end
end
def load_spec_files
files_to_run.map {|f| load File.expand_path(f) }
raise_if_rspec_1_is_loaded
end
private
def raise_if_rspec_1_is_loaded
if defined?(Spec) && defined?(Spec::VERSION::MAJOR) && Spec::VERSION::MAJOR == 1
raise <<-MESSAGE
#{'*'*80}
You are running rspec-2, but it seems as though rspec-1 has been loaded as
well. This is likely due to a statement like this somewhere in the specs:
require 'spec'
Please locate that statement, remove it, and try again.
#{'*'*80}
MESSAGE
end
end
def output_to_tty?
begin
output_stream.tty? || tty?
rescue NoMethodError
false
end
end
def built_in_formatter(key)
case key.to_s
when 'd', 'doc', 'documentation', 's', 'n', 'spec', 'nested'
require 'rspec/core/formatters/documentation_formatter'
RSpec::Core::Formatters::DocumentationFormatter
when 'h', 'html'
require 'rspec/core/formatters/html_formatter'
RSpec::Core::Formatters::HtmlFormatter
when 't', 'textmate'
require 'rspec/core/formatters/text_mate_formatter'
RSpec::Core::Formatters::TextMateFormatter
when 'p', 'progress'
require 'rspec/core/formatters/progress_formatter'
RSpec::Core::Formatters::ProgressFormatter
end
end
def custom_formatter(formatter_ref)
if Class === formatter_ref
formatter_ref
elsif string_const?(formatter_ref)
begin
eval(formatter_ref)
rescue NameError
require path_for(formatter_ref)
eval(formatter_ref)
end
end
end
def string_const?(str)
str.is_a?(String) && /\A[A-Z][a-zA-Z0-9_:]*\z/ =~ str
end
def path_for(const_ref)
underscore_with_fix_for_non_standard_rspec_naming(const_ref)
end
def underscore_with_fix_for_non_standard_rspec_naming(string)
underscore(string).sub(%r{(^|/)r_spec($|/)}, '\\1rspec\\2')
end
# activesupport/lib/active_support/inflector/methods.rb, line 48
def underscore(camel_cased_word)
word = camel_cased_word.to_s.dup
word.gsub!(/::/, '/')
word.gsub!(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
word.tr!("-", "_")
word.downcase!
word
end
def file_at(path)
FileUtils.mkdir_p(File.dirname(path))
File.new(path, 'w')
end
end
end
end