Skip to content

Commit 828d150

Browse files
lukesandberglukesandberg
authored
Merge pull request #137 from dibenede/swap-asserts
Replace goog.asserts and goog.testing.asserts
2 parents f9b1939 + 864e80f commit 828d150

32 files changed

+5188
-5027
lines changed

‎BUILD.bazel

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ pkg_files(
2727
"package.json",
2828
"README.md",
2929
"LICENSE.md",
30+
"LICENSE-asserts.md",
3031
],
3132
strip_prefix = strip_prefix.from_root(""),
3233
)

‎LICENSE-asserts.md

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎asserts.js

+159
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,159 @@
1+
/**
2+
* @license
3+
* Copyright The Closure Library Authors.
4+
* SPDX-License-Identifier: Apache-2.0
5+
*/
6+
7+
/**
8+
* @fileoverview Utilities to check the preconditions, postconditions and
9+
* invariants runtime.
10+
*/
11+
12+
goog.provide('jspb.asserts');
13+
14+
/**
15+
* Throws an exception with the given message and "Assertion failed" prefixed
16+
* onto it.
17+
* @param {string} defaultMessage The message to use if givenMessage is empty.
18+
* @param {?Array<*>} defaultArgs The substitution arguments for defaultMessage.
19+
* @param {string|undefined} givenMessage Message supplied by the caller.
20+
* @param {!Array<*>} givenArgs The substitution arguments for givenMessage.
21+
* @throws {Error} When the value is not a number.
22+
*/
23+
jspb.asserts.doAssertFailure = function(defaultMessage, defaultArgs, givenMessage, givenArgs) {
24+
let message = 'Assertion failed';
25+
let args;
26+
if (givenMessage) {
27+
message += ': ' + givenMessage;
28+
args = givenArgs;
29+
} else if (defaultMessage) {
30+
message += ': ' + defaultMessage;
31+
args = defaultArgs;
32+
}
33+
// The '' + works around an Opera 10 bug in the unit tests. Without it,
34+
// a stack trace is added to var message above. With this, a stack trace is
35+
// not added until this line (it causes the extra garbage to be added after
36+
// the assertion message instead of in the middle of it).
37+
throw new Error('' + message, args || []);
38+
}
39+
40+
/**
41+
* Checks if the condition evaluates to true.
42+
* @template T
43+
* @param {T} condition The condition to check.
44+
* @param {string=} opt_message Error message in case of failure.
45+
* @param {...*} args The items to substitute into the failure message.
46+
* @return {T} The value of the condition.
47+
* @throws {Error} When the condition evaluates to false.
48+
*/
49+
50+
jspb.asserts.assert = function(condition, opt_message, ...args) {
51+
if (!condition) {
52+
jspb.asserts.doAssertFailure('', null, opt_message, args);
53+
}
54+
return condition;
55+
};
56+
57+
58+
/**
59+
* Checks if the value is a string.
60+
* @param {*} value The value to check.
61+
* @param {string=} opt_message Error message in case of failure.
62+
* @param {...*} args The items to substitute into the failure message.
63+
* @return {string} The value, guaranteed to be a string when asserts enabled.
64+
* @throws {Error} When the value is not a string.
65+
*/
66+
jspb.asserts.assertString = function(value, opt_message, ...args) {
67+
if (typeof value !== 'string') {
68+
jspb.asserts.doAssertFailure(
69+
'Expected string but got %s: %s.', [goog.typeOf(value), value],
70+
opt_message, args);
71+
}
72+
return /** @type {string} */ (value);
73+
};
74+
75+
76+
/**
77+
* Checks if the value is an Array.
78+
* @param {*} value The value to check.
79+
* @param {string=} opt_message Error message in case of failure.
80+
* @param {...*} args The items to substitute into the failure message.
81+
* @return {!Array<?>} The value, guaranteed to be a non-null array.
82+
* @throws {Error} When the value is not an array.
83+
*/
84+
jspb.asserts.assertArray = function(value, opt_message, ...args) {
85+
if (!Array.isArray(value)) {
86+
jspb.asserts.doAssertFailure(
87+
'Expected array but got %s: %s.', [goog.typeOf(value), value],
88+
opt_message, args);
89+
}
90+
return /** @type {!Array<?>} */ (value);
91+
};
92+
93+
/**
94+
* Triggers a failure. This function is useful in case when we want to add a
95+
* check in the unreachable area like switch-case statement:
96+
*
97+
* <pre>
98+
* switch(type) {
99+
* case FOO: doSomething(); break;
100+
* case BAR: doSomethingElse(); break;
101+
* default: jspb.asserts.JspbFail('Unrecognized type: ' + type);
102+
* // We have only 2 types - "default:" section is unreachable code.
103+
* }
104+
* </pre>
105+
*
106+
* @param {string=} opt_message Error message in case of failure.
107+
* @param {...*} args The items to substitute into the failure message.
108+
* @return {void}
109+
* @throws {Error} Failure.
110+
*/
111+
jspb.asserts.fail = function(opt_message, ...args) {
112+
throw new Error(
113+
'Failure' + (opt_message ? ': ' + opt_message : ''),
114+
args);
115+
};
116+
117+
/**
118+
* Checks if the value is an instance of the user-defined type.
119+
*
120+
* Do not use this to ensure a value is an HTMLElement or a subclass! Cross-
121+
* document DOM inherits from separate - though identical - browser classes, and
122+
* such a check will unexpectedly fail.
123+
*
124+
* @param {?} value The value to check.
125+
* @param {function(new: T, ...)} type A user-defined constructor.
126+
* @param {string=} opt_message Error message in case of failure.
127+
* @param {...*} args The items to substitute into the failure message.
128+
* @throws {Error} When the value is not an instance of
129+
* type.
130+
* @return {T}
131+
* @template T
132+
*/
133+
jspb.asserts.assertInstanceof = function(value, type, opt_message, ...args) {
134+
if (!(value instanceof type)) {
135+
jspb.assert.doAssertFailure(
136+
'Expected instanceof %s but got %s.',
137+
[jspb.asserts.getType(type), jspb.asseerts.getType(value)],
138+
opt_message, args);
139+
}
140+
return value;
141+
};
142+
143+
/**
144+
* Returns the type of a value. If a constructor is passed, and a suitable
145+
* string cannot be found, 'unknown type name' will be returned.
146+
* @param {*} value A constructor, object, or primitive.
147+
* @return {string} The best display name for the value, or 'unknown type name'.
148+
* @private
149+
*/
150+
jspb.asserts.getType = function(value) {
151+
if (value instanceof Function) {
152+
return value.displayName || value.name || 'unknown type name';
153+
} else if (value instanceof Object) {
154+
return /** @type {string} */ (value.constructor.displayName) ||
155+
value.constructor.name || Object.prototype.toString.call(value);
156+
} else {
157+
return value === null ? 'null' : typeof value;
158+
}
159+
}

0 commit comments

Comments
 (0)