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
|
// Copyright 2009 The Closure Library Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS-IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
/**
* @fileoverview A utility class for making layout assertions. This is a port
* of http://go/layoutbot.java
* See {@link http://go/layouttesting}.
*/
goog.provide('goog.testing.style.layoutasserts');
goog.require('goog.style');
goog.require('goog.testing.asserts');
goog.require('goog.testing.style');
/**
* Asserts that an element has:
* 1 - a CSS rendering the makes the element visible.
* 2 - a non-zero width and height.
* @param {Element|string} a The element or optionally the comment string.
* @param {Element=} opt_b The element when a comment string is present.
*/
var assertIsVisible = function(a, opt_b) {
_validateArguments(1, arguments);
var element = nonCommentArg(1, 1, arguments);
_assert(commentArg(1, arguments),
goog.testing.style.isVisible(element) &&
goog.testing.style.hasVisibleDimensions(element),
'Specified element should be visible.');
};
/**
* The counter assertion of assertIsVisible().
* @param {Element|string} a The element or optionally the comment string.
* @param {Element=} opt_b The element when a comment string is present.
*/
var assertNotVisible = function(a, opt_b) {
_validateArguments(1, arguments);
var element = nonCommentArg(1, 1, arguments);
if (!element) {
return;
}
_assert(commentArg(1, arguments),
!goog.testing.style.isVisible(element) ||
!goog.testing.style.hasVisibleDimensions(element),
'Specified element should not be visible.');
};
/**
* Asserts that the two specified elements intersect.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertIntersect = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
_assert(commentArg(1, arguments),
goog.testing.style.intersects(element, otherElement),
'Elements should intersect.');
};
/**
* Asserts that the two specified elements do not intersect.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertNoIntersect = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
_assert(commentArg(1, arguments),
!goog.testing.style.intersects(element, otherElement),
'Elements should not intersect.');
};
/**
* Asserts that the element must have the specified width.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertWidth = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var width = nonCommentArg(2, 2, arguments);
var size = goog.style.getSize(element);
var elementWidth = size.width;
_assert(commentArg(1, arguments),
goog.testing.style.layoutasserts.isWithinThreshold_(
width, elementWidth, 0 /* tolerance */),
'Element should have width ' + width + ' but was ' + elementWidth + '.');
};
/**
* Asserts that the element must have the specified width within the specified
* tolerance.
* @param {Element|string} a The element or optionally the comment string.
* @param {number|Element} b The height or the element if comment string is
* present.
* @param {number} c The tolerance or the height if comment string is
* present.
* @param {number=} opt_d The tolerance if comment string is present.
*/
var assertWidthWithinTolerance = function(a, b, c, opt_d) {
_validateArguments(3, arguments);
var element = nonCommentArg(1, 3, arguments);
var width = nonCommentArg(2, 3, arguments);
var tolerance = nonCommentArg(3, 3, arguments);
var size = goog.style.getSize(element);
var elementWidth = size.width;
_assert(commentArg(1, arguments),
goog.testing.style.layoutasserts.isWithinThreshold_(
width, elementWidth, tolerance),
'Element width(' + elementWidth + ') should be within given width(' +
width + ') with tolerance value of ' + tolerance + '.');
};
/**
* Asserts that the element must have the specified height.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertHeight = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var height = nonCommentArg(2, 2, arguments);
var size = goog.style.getSize(element);
var elementHeight = size.height;
_assert(commentArg(1, arguments),
goog.testing.style.layoutasserts.isWithinThreshold_(
height, elementHeight, 0 /* tolerance */),
'Element should have height ' + height + '.');
};
/**
* Asserts that the element must have the specified height within the specified
* tolerance.
* @param {Element|string} a The element or optionally the comment string.
* @param {number|Element} b The height or the element if comment string is
* present.
* @param {number} c The tolerance or the height if comment string is
* present.
* @param {number=} opt_d The tolerance if comment string is present.
*/
var assertHeightWithinTolerance = function(a, b, c, opt_d) {
_validateArguments(3, arguments);
var element = nonCommentArg(1, 3, arguments);
var height = nonCommentArg(2, 3, arguments);
var tolerance = nonCommentArg(3, 3, arguments);
var size = goog.style.getSize(element);
var elementHeight = size.height;
_assert(commentArg(1, arguments),
goog.testing.style.layoutasserts.isWithinThreshold_(
height, elementHeight, tolerance),
'Element width(' + elementHeight + ') should be within given width(' +
height + ') with tolerance value of ' + tolerance + '.');
};
/**
* Asserts that the first element is to the left of the second element.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertIsLeftOf = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
var elementRect = goog.style.getBounds(element);
var otherElementRect = goog.style.getBounds(otherElement);
_assert(commentArg(1, arguments),
elementRect.left < otherElementRect.left,
'Elements should be left to right.');
};
/**
* Asserts that the first element is strictly left of the second element.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertIsStrictlyLeftOf = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
var elementRect = goog.style.getBounds(element);
var otherElementRect = goog.style.getBounds(otherElement);
_assert(commentArg(1, arguments),
elementRect.left + elementRect.width < otherElementRect.left,
'Elements should be strictly left to right.');
};
/**
* Asserts that the first element is higher than the second element.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertIsAbove = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
var elementRect = goog.style.getBounds(element);
var otherElementRect = goog.style.getBounds(otherElement);
_assert(commentArg(1, arguments),
elementRect.top < otherElementRect.top,
'Elements should be top to bottom.');
};
/**
* Asserts that the first element is strictly higher than the second element.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertIsStrictlyAbove = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
var elementRect = goog.style.getBounds(element);
var otherElementRect = goog.style.getBounds(otherElement);
_assert(commentArg(1, arguments),
elementRect.top + elementRect.height < otherElementRect.top,
'Elements should be strictly top to bottom.');
};
/**
* Asserts that the first element's bounds contain the bounds of the second
* element.
* @param {Element|string} a The first element or optionally the comment string.
* @param {Element} b The second element or the first element if comment string
* is present.
* @param {Element=} opt_c The second element if comment string is present.
*/
var assertContained = function(a, b, opt_c) {
_validateArguments(2, arguments);
var element = nonCommentArg(1, 2, arguments);
var otherElement = nonCommentArg(2, 2, arguments);
var elementRect = goog.style.getBounds(element);
var otherElementRect = goog.style.getBounds(otherElement);
_assert(commentArg(1, arguments),
elementRect.contains(otherElementRect),
'Element should be contained within the other element.');
};
/**
* Returns true if the difference between val1 and val2 is less than or equal to
* the threashold.
* @param {number} val1 The first value.
* @param {number} val2 The second value.
* @param {number} threshold The threshold value.
* @return {boolean} Whether or not the the values are within the threshold.
* @private
*/
goog.testing.style.layoutasserts.isWithinThreshold_ = function(
val1, val2, threshold) {
return Math.abs(val1 - val2) <= threshold;
};
|
