refactor(core): Rename `debugMatch` to `matchDebug` for consistency (#39233)

Previous function name `debugMatch` was not consistent with other match
functions.

PR Close #39233
This commit is contained in:
Misko Hevery 2020-10-12 22:09:57 -07:00 committed by Alex Rickabaugh
parent 70f1e2e04a
commit 1b9193b3fb
3 changed files with 71 additions and 72 deletions

View File

@ -14,7 +14,7 @@ import {IcuType, TI18n} from '@angular/core/src/render3/interfaces/i18n';
import {HEADER_OFFSET} from '@angular/core/src/render3/interfaces/view';
import {expect} from '@angular/core/testing/src/testing_internal';
import {matchTI18n, matchTIcu} from '../matchers';
import {debugMatch} from '../utils';
import {matchDebug} from '../utils';
import {ViewFixture} from '../view_fixture';
describe('i18n_parse', () => {
@ -25,7 +25,7 @@ describe('i18n_parse', () => {
it('should parse simple text', () => {
const tI18n = toT18n('some text');
expect(tI18n).toEqual(matchTI18n({
create: debugMatch([
create: matchDebug([
'lView[22] = document.createText("some text");',
'parent.appendChild(lView[22]);',
]),
@ -56,7 +56,7 @@ describe('i18n_parse', () => {
other {otherCase}
}|after`);
expect(tI18n).toEqual(matchTI18n({
create: debugMatch([
create: matchDebug([
'lView[22] = document.createText("before|");',
'parent.appendChild(lView[22]);',
'lView[23] = document.createComment("ICU 0:0");',
@ -64,7 +64,7 @@ describe('i18n_parse', () => {
'lView[27] = document.createText("|after");',
'parent.appendChild(lView[27]);',
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b1) { icuSwitchCase(23, `${lView[i-1]}`); }',
])
}));
@ -74,22 +74,22 @@ describe('i18n_parse', () => {
currentCaseLViewIndex: 24,
cases: ['A', 'other'],
create: [
debugMatch([
matchDebug([
'lView[25] = document.createTextNode("caseA")',
'(lView[0] as Element).appendChild(lView[25])'
]),
debugMatch([
matchDebug([
'lView[26] = document.createTextNode("otherCase")',
'(lView[0] as Element).appendChild(lView[26])',
])
],
update: [
debugMatch([]),
debugMatch([]),
matchDebug([]),
matchDebug([]),
],
remove: [
debugMatch(['(lView[0] as Element).remove(lView[25])']),
debugMatch(['(lView[0] as Element).remove(lView[26])'])
matchDebug(['(lView[0] as Element).remove(lView[25])']),
matchDebug(['(lView[0] as Element).remove(lView[26])'])
],
}));
@ -169,11 +169,11 @@ describe('i18n_parse', () => {
other {parentOther}
}`);
expect(tI18n).toEqual(matchTI18n({
create: debugMatch([
create: matchDebug([
'lView[24] = document.createComment("ICU 0:0");',
'parent.appendChild(lView[24]);',
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b1) { icuSwitchCase(24, `${lView[i-1]}`); }',
'if (mask & 0b10) { icuSwitchCase(27, `${lView[i-2]}`); }',
'if (mask & 0b100) { icuUpdateCase(27); }',
@ -185,7 +185,7 @@ describe('i18n_parse', () => {
currentCaseLViewIndex: 25,
cases: ['A', 'other'],
create: [
debugMatch([
matchDebug([
'lView[26] = document.createTextNode("parentA ")',
'(lView[0] as Element).appendChild(lView[26])',
'lView[27] = document.createComment("nested ICU 0")',
@ -193,23 +193,23 @@ describe('i18n_parse', () => {
'lView[31] = document.createTextNode("!")',
'(lView[0] as Element).appendChild(lView[31])',
]),
debugMatch([
matchDebug([
'lView[32] = document.createTextNode("parentOther")',
'(lView[0] as Element).appendChild(lView[32])',
])
],
update: [
debugMatch([]),
debugMatch([]),
matchDebug([]),
matchDebug([]),
],
remove: [
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[26])',
'removeNestedICU(27)',
'(lView[0] as Element).remove(lView[27])',
'(lView[0] as Element).remove(lView[31])',
]),
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[32])',
])
],
@ -221,24 +221,24 @@ describe('i18n_parse', () => {
currentCaseLViewIndex: 28,
cases: ['0', 'other'],
create: [
debugMatch([
matchDebug([
'lView[29] = document.createTextNode("nested0")',
'(lView[0] as Element).appendChild(lView[29])'
]),
debugMatch([
matchDebug([
'lView[30] = document.createTextNode("")',
'(lView[0] as Element).appendChild(lView[30])',
])
],
update: [
debugMatch([]),
debugMatch([
matchDebug([]),
matchDebug([
'if (mask & 0b100) { (lView[30] as Text).textContent = `${lView[i-3]}`; }',
]),
],
remove: [
debugMatch(['(lView[0] as Element).remove(lView[29])']),
debugMatch(['(lView[0] as Element).remove(lView[30])'])
matchDebug(['(lView[0] as Element).remove(lView[29])']),
matchDebug(['(lView[0] as Element).remove(lView[30])'])
],
}));

View File

@ -18,7 +18,7 @@ import {HEADER_OFFSET, LView, TVIEW, TView} from '../../../src/render3/interface
import {getNativeByIndex} from '../../../src/render3/util/view_utils';
import {matchTNode} from '../matchers';
import {TemplateFixture} from '../render_util';
import {debugMatch} from '../utils';
import {matchDebug} from '../utils';
import {ViewFixture} from '../view_fixture';
@ -82,7 +82,7 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index) as TI18n;
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 1}] = document.createText("simple text");`,
`parent.appendChild(lView[${HEADER_OFFSET + 1}]);`,
]),
@ -103,7 +103,7 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 4}] = document.createText("Hello ");`,
`parent.appendChild(lView[${HEADER_OFFSET + 4}]);`,
`lView[${HEADER_OFFSET + 5}] = document.createText("world");`,
@ -132,11 +132,11 @@ describe('Runtime i18n', () => {
]);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 2}] = document.createText("");`,
`parent.appendChild(lView[${HEADER_OFFSET + 2}]);`,
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b1) { (lView[22] as Text).textContent = `Hello ${lView[i-1]}!`; }',
]),
});
@ -153,11 +153,11 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 2}] = document.createText("");`,
`parent.appendChild(lView[${HEADER_OFFSET + 2}]);`,
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b11) { (lView[22] as Text).textContent = `Hello ${lView[i-1]} and ${lView[i-2]}, again ${lView[i-1]}!`; }',
]),
});
@ -186,13 +186,13 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 3}] = document.createText("");`,
`parent.appendChild(lView[${HEADER_OFFSET + 3}]);`,
`lView[${HEADER_OFFSET + 4}] = document.createText("!");`,
`parent.appendChild(lView[${HEADER_OFFSET + 4}]);`,
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b1) { (lView[23] as Text).textContent = `${lView[i-1]} is rendered as: `; }',
]),
});
@ -208,7 +208,7 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 3}] = document.createText("before");`,
`lView[${HEADER_OFFSET + 4}] = document.createText("after");`,
]),
@ -226,7 +226,7 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 2}] = document.createText("middle");`,
]),
update: [],
@ -248,11 +248,11 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index) as TI18n;
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 2}] = document.createComment("ICU 1:0");`,
`parent.appendChild(lView[${HEADER_OFFSET + 2}]);`,
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b1) { icuSwitchCase(22, `${lView[i-1]}`); }',
'if (mask & 0b1) { icuUpdateCase(22); }',
]),
@ -263,7 +263,7 @@ describe('Runtime i18n', () => {
anchorIdx: 22,
cases: ['0', '1', 'other'],
create: [
debugMatch([
matchDebug([
`lView[${HEADER_OFFSET + 4}] = document.createTextNode("no ")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 4}])`,
'lView[25] = document.createElement("b")',
@ -274,7 +274,7 @@ describe('Runtime i18n', () => {
`lView[${HEADER_OFFSET + 7}] = document.createTextNode("!")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 7}])`,
]),
debugMatch([
matchDebug([
`lView[${HEADER_OFFSET + 8}] = document.createTextNode("one ")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 8}])`,
'lView[29] = document.createElement("i")',
@ -282,7 +282,7 @@ describe('Runtime i18n', () => {
'lView[30] = document.createTextNode("email")',
'(lView[29] as Element).appendChild(lView[30])',
]),
debugMatch([
matchDebug([
'lView[31] = document.createTextNode("")',
'(lView[20] as Element).appendChild(lView[31])',
'lView[32] = document.createElement("span")',
@ -292,24 +292,24 @@ describe('Runtime i18n', () => {
]),
],
remove: [
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[24])',
'(lView[0] as Element).remove(lView[25])',
'(lView[0] as Element).remove(lView[27])',
]),
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[28])',
'(lView[0] as Element).remove(lView[29])',
]),
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[31])',
'(lView[0] as Element).remove(lView[32])',
]),
],
update: [
debugMatch([]),
debugMatch([]),
debugMatch([
matchDebug([]),
matchDebug([]),
matchDebug([
'if (mask & 0b1) { (lView[31] as Text).textContent = `${lView[i-1]} `; }',
'if (mask & 0b10) { (lView[32] as Element).setAttribute(\'title\', `${lView[i-2]}`); }',
]),
@ -335,11 +335,11 @@ describe('Runtime i18n', () => {
}, undefined, nbConsts, index);
expect(opCodes).toEqual({
create: debugMatch([
create: matchDebug([
`lView[${HEADER_OFFSET + 2}] = document.createComment("ICU 1:0");`,
`parent.appendChild(lView[${HEADER_OFFSET + 2}]);`,
]),
update: debugMatch([
update: matchDebug([
'if (mask & 0b1) { icuSwitchCase(22, `${lView[i-1]}`); }',
'if (mask & 0b10) { icuSwitchCase(26, `${lView[i-2]}`); }',
'if (mask & 0b1) { icuUpdateCase(22); }',
@ -351,11 +351,11 @@ describe('Runtime i18n', () => {
currentCaseLViewIndex: 23,
cases: ['0', 'other'],
create: [
debugMatch([
matchDebug([
`lView[${HEADER_OFFSET + 4}] = document.createTextNode("zero")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 4}])`,
]),
debugMatch([
matchDebug([
`lView[${HEADER_OFFSET + 5}] = document.createTextNode("")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 5}])`,
'lView[26] = document.createComment("nested ICU 0")',
@ -365,16 +365,16 @@ describe('Runtime i18n', () => {
]),
],
update: [
debugMatch([]),
debugMatch([
matchDebug([]),
matchDebug([
'if (mask & 0b1) { (lView[25] as Text).textContent = `${lView[i-1]} `; }',
]),
],
remove: [
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[24])',
]),
debugMatch([
matchDebug([
'(lView[0] as Element).remove(lView[25])',
'removeNestedICU(26)',
'(lView[0] as Element).remove(lView[26])',
@ -388,28 +388,28 @@ describe('Runtime i18n', () => {
currentCaseLViewIndex: 27,
cases: ['cat', 'dog', 'other'],
create: [
debugMatch([
matchDebug([
`lView[${HEADER_OFFSET + 8}] = document.createTextNode("cats")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 8}])`,
]),
debugMatch([
matchDebug([
`lView[${HEADER_OFFSET + 9}] = document.createTextNode("dogs")`,
`(lView[${HEADER_OFFSET + 0}] as Element).appendChild(lView[${HEADER_OFFSET + 9}])`,
]),
debugMatch([
matchDebug([
'lView[30] = document.createTextNode("animals")',
'(lView[20] as Element).appendChild(lView[30])',
]),
],
update: [
debugMatch([]),
debugMatch([]),
debugMatch([]),
matchDebug([]),
matchDebug([]),
matchDebug([]),
],
remove: [
debugMatch(['(lView[0] as Element).remove(lView[28])']),
debugMatch(['(lView[0] as Element).remove(lView[29])']),
debugMatch(['(lView[0] as Element).remove(lView[30])'])
matchDebug(['(lView[0] as Element).remove(lView[28])']),
matchDebug(['(lView[0] as Element).remove(lView[29])']),
matchDebug(['(lView[0] as Element).remove(lView[30])'])
],
});
});
@ -451,7 +451,7 @@ describe('Runtime i18n', () => {
ɵɵelementEnd();
}, undefined, nbConsts, index);
expect(opCodes).toEqual(debugMatch([
expect(opCodes).toEqual(matchDebug([
'if (mask & 0b1) { (lView[20] as Element).setAttribute(\'title\', `Hello ${lView[i-1]}!`); }',
]));
});
@ -467,7 +467,7 @@ describe('Runtime i18n', () => {
ɵɵelementEnd();
}, undefined, nbConsts, index);
expect(opCodes).toEqual(debugMatch([
expect(opCodes).toEqual(matchDebug([
'if (mask & 0b11) { (lView[20] as Element).setAttribute(\'title\', `Hello ${lView[i-1]} and ${lView[i-2]}, again ${lView[i-1]}!`); }',
]));
});
@ -483,7 +483,7 @@ describe('Runtime i18n', () => {
ɵɵelementEnd();
}, undefined, nbConsts, index);
expect(opCodes).toEqual(debugMatch([
expect(opCodes).toEqual(matchDebug([
'if (mask & 0b1) { (lView[20] as Element).setAttribute(\'title\', `Hello ${lView[i-1]}!`); }',
'if (mask & 0b1) { (lView[20] as Element).setAttribute(\'aria-label\', `Hello ${lView[i-1]}!`); }',
]));
@ -724,7 +724,7 @@ describe('Runtime i18n', () => {
i18nRangeOffset(1), // It should append child text node "{{name}}"
],
}));
expect(ti18n.update).toEqual(debugMatch([
expect(ti18n.update).toEqual(matchDebug([
'if (mask & 0b1) { (lView[50] as Text).textContent = `${lView[i-1]} `; }',
'if (mask & 0b10) { (lView[51] as Text).textContent = `${lView[i-2]}`; }'
]));

View File

@ -52,7 +52,7 @@ function numOfWhiteSpaceLeadingChars(text: string): number {
*
* ```
* expect(obj).toEqual({
* create: debugMatch('someValue')
* create: matchDebug('someValue')
* })
* ```
*
@ -60,16 +60,15 @@ function numOfWhiteSpaceLeadingChars(text: string): number {
*
* @param expected Expected value.
*/
// FIXME(misko): rename to `matchDebug` to be consistent with other API.
export function debugMatch<T>(expected: T): any {
export function matchDebug<T>(expected: T): any {
const matcher = function() {};
let actual: any = debugMatch;
let actual: any = matchDebug;
matcher.asymmetricMatch = function(objectWithDebug: any) {
return jasmine.matchersUtil.equals(actual = objectWithDebug.debug, expected);
};
matcher.jasmineToString = function() {
if (actual === debugMatch) {
if (actual === matchDebug) {
// `asymmetricMatch` never got called hence no error to display
return '';
}