-
-
Notifications
You must be signed in to change notification settings - Fork 763
/
metadata.rb
205 lines (178 loc) · 5.78 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
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
module RSpec
module Core
class Metadata < Hash
module MetadataHash
def [](key)
return super if has_key?(key)
case key
when :location
store(:location, location)
when :file_path, :line_number
file_path, line_number = file_and_line_number
store(:file_path, file_path)
store(:line_number, line_number)
self[key]
when :execution_result
store(:execution_result, {})
when :describes
store(:describes, described_class_from(*self[:description_args]))
when :description
store(:description, description_from(*self[:description_args]))
when :full_description
store(:full_description, full_description)
else
super
end
end
def location
"#{self[:file_path]}:#{self[:line_number]}"
end
def file_and_line_number
first_caller_from_outside_rspec =~ /(.+?):(\d+)(|:\d+)/
return [$1, $2.to_i]
end
def first_caller_from_outside_rspec
self[:caller].detect {|l| l !~ /\/lib\/rspec\/core/}
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
x = self
all_args = [self[:description_args]].compact
while x.has_key?(:example_group)
x = x[:example_group]
all_args.unshift x[:description_args]
end
description_from(*all_args.flatten)
end
def described_class_from(*args)
x = self
while x.has_key?(:example_group)
x = x[:example_group]
end
y = x[:description_args].first
String === y || Symbol === y ? nil :y
end
end
attr_reader :parent_group_metadata
def initialize(parent_group_metadata=nil)
if parent_group_metadata
update(parent_group_metadata)
store(:example_group, {:example_group => parent_group_metadata[:example_group]}.extend(MetadataHash))
else
store(:example_group, {}.extend(MetadataHash))
end
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].store(:description_args, args)
self[:example_group].store(:caller, user_metadata.delete(:caller) || caller)
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, user_metadata)
dup.extend(MetadataHash).configure_for_example(description, user_metadata)
end
def configure_for_example(description, user_metadata)
store(:description_args, [description])
store(:caller, user_metadata.delete(:caller) || caller)
update(user_metadata)
end
def apply?(predicate, filters)
filters.send(predicate) do |key, value|
apply_filter(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_filter(key, value, metadata=self)
case value
when Hash
if key == :locations
file_path = (self[:example_group] || {})[:file_path]
expanded_path = file_path && File.expand_path( file_path )
if expanded_path && line_numbers = value[expanded_path]
self.apply_filter(:line_numbers, line_numbers)
else
true
end
else
value.all? { |k, v| apply_filter(k, v, metadata[key]) }
end
when Regexp
metadata[key] =~ value
when Proc
if value.arity == 2
# Pass the metadata hash to allow the proc to check if it even has the key.
# This is necessary for the implicit :if exclusion filter:
# { } # => run the example
# { :if => nil } # => exclude the example
# The value of metadata[:if] is the same in these two cases but
# they need to be treated differently.
value.call(metadata[key], metadata) rescue false
else
value.call(metadata[key]) rescue false
end
when String
metadata[key].to_s == value.to_s
when Enumerable
if key == :line_numbers
preceding_declaration_lines = value.map{|v| world.preceding_declaration_line(v)}
!(relevant_line_numbers(metadata) & preceding_declaration_lines).empty?
else
metadata[key] == value
end
else
metadata[key].to_s == value.to_s
end
end
private
def world
RSpec.world
end
end
end
end