forked from rspec/rspec-core
/
metadata.rb
165 lines (139 loc) · 4.53 KB
/
metadata.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
module RSpec
module Core
class Metadata < Hash
def initialize(superclass_metadata=nil)
@superclass_metadata = superclass_metadata
if @superclass_metadata
update(@superclass_metadata)
example_group = {:example_group => @superclass_metadata[:example_group]}
end
store(:example_group, example_group || {})
yield self if block_given?
end
RESERVED_KEYS = [
:description,
:example_group,
:execution_result,
:file_path,
:full_description,
:line_number,
:location
]
def process(*args)
user_metadata = args.last.is_a?(Hash) ? args.pop : {}
ensure_valid_keys(user_metadata)
self[:example_group][:describes] = described_class_from(*args)
self[:example_group][:description] = description_from(*args)
self[:example_group][:full_description] = full_description_from(*args)
self[:example_group][:block] = user_metadata.delete(:example_group_block)
self[:example_group][:file_path], self[:example_group][:line_number] = file_and_line_number_from(user_metadata.delete(:caller) || caller)
self[:example_group][:location] = location_from(self[:example_group])
update(user_metadata)
end
def ensure_valid_keys(user_metadata)
RESERVED_KEYS.each do |key|
if user_metadata.keys.include?(key)
raise <<-EOM
#{"*"*50}
:#{key} is not allowed
RSpec reserves some hash keys for its own internal use,
including :#{key}, which is used on:
#{caller(0)[4]}.
Here are all of RSpec's reserved hash keys:
#{RESERVED_KEYS.join("\n ")}
#{"*"*50}
EOM
raise ":#{key} is not allowed"
end
end
end
def for_example(description, options)
dup.configure_for_example(description,options)
end
def configure_for_example(description, options)
store(:description, description.to_s)
store(:full_description, "#{self[:example_group][:full_description]} #{self[:description]}")
store(:execution_result, {})
self[:file_path], self[:line_number] = file_and_line_number_from(options.delete(:caller) || caller)
self[:location] = location_from(self)
update(options)
end
def all_apply?(filters)
filters.all? do |key, value|
apply_condition(key, value)
end
end
def relevant_line_numbers(metadata)
line_numbers = [metadata[:line_number]]
if metadata[:example_group]
line_numbers + relevant_line_numbers(metadata[:example_group])
else
line_numbers
end
end
def apply_condition(key, value, metadata=nil)
metadata ||= self
case value
when Hash
value.all? { |k, v| apply_condition(k, v, metadata[key]) }
when Regexp
metadata[key] =~ value
when Proc
value.call(metadata[key]) rescue false
when Fixnum
if key == :line_number
relevant_line_numbers(metadata).include?(world.preceding_declaration_line(value))
else
metadata[key] == value
end
else
metadata[key] == value
end
end
private
def world
RSpec.world
end
def superclass_metadata
@superclass_metadata ||= { :example_group => {} }
end
def description_from(*args)
args.inject("") do |result, a|
a = a.to_s.strip
if result == ""
a
elsif a =~ /^(#|::|\.)/
"#{result}#{a}"
else
"#{result} #{a}"
end
end
end
def full_description_from(*args)
if superclass_metadata[:example_group][:full_description]
description_from(superclass_metadata[:example_group][:full_description], *args)
else
description_from(*args)
end
end
def described_class_from(*args)
if args.first.is_a?(String) || args.first.is_a?(Symbol)
superclass_metadata[:example_group][:describes]
else
args.first
end
end
def file_and_line_number_from(list)
entry = first_caller_from_outside_rspec_from_caller(list)
entry =~ /(.+?):(\d+)(|:\d+)/
return [$1, $2.to_i]
end
def first_caller_from_outside_rspec_from_caller(list)
list.detect {|l| l !~ /\/lib\/rspec\/core/}
end
def location_from(metadata)
"#{metadata[:file_path]}:#{metadata[:line_number]}"
end
end
end
end