Skip to content

feat(material/schematics): impl card template migration #24566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import {createTestApp, patchDevkitTreeToExposeTypeScript} from '@angular/cdk/schematics/testing';
import {SchematicTestRunner, UnitTestTree} from '@angular-devkit/schematics/testing';
import {createNewTestRunner, migrateComponents, TEMPLATE_FILE} from '../test-setup-helper';

describe('card template migrator', () => {
let runner: SchematicTestRunner;
let cliAppTree: UnitTestTree;

async function runMigrationTest(oldFileContent: string, newFileContent: string) {
cliAppTree.overwrite(TEMPLATE_FILE, oldFileContent);
const tree = await migrateComponents(['card'], runner, cliAppTree);
expect(tree.readContent(TEMPLATE_FILE)).toBe(newFileContent);
}

beforeEach(async () => {
runner = createNewTestRunner();
cliAppTree = patchDevkitTreeToExposeTypeScript(await createTestApp(runner));
});

it('should not update other elements', async () => {
await runMigrationTest('<mat-button></mat-button>', '<mat-button></mat-button>');
});

it('should update single', async () => {
await runMigrationTest('<mat-card></mat-card>', '<mat-card appearance="outlined"></mat-card>');
});

it('should update multiple same-line unnested', async () => {
await runMigrationTest(
'<mat-card></mat-card><mat-card></mat-card>',
'<mat-card appearance="outlined"></mat-card><mat-card appearance="outlined"></mat-card>',
);
});

it('should update multiple same-line nested', async () => {
await runMigrationTest(
'<mat-card><mat-card></mat-card></mat-card>',
'<mat-card appearance="outlined"><mat-card appearance="outlined"></mat-card></mat-card>',
);
});

it('should update multiple same-line nested and unnested', async () => {
await runMigrationTest(
'<mat-card><mat-card></mat-card><mat-card></mat-card></mat-card>',
'<mat-card appearance="outlined"><mat-card appearance="outlined"></mat-card><mat-card appearance="outlined"></mat-card></mat-card>',
);
});

it('should update multiple multi-line unnested', async () => {
await runMigrationTest(
`
<mat-card></mat-card>
<mat-card></mat-card>
`,
`
<mat-card appearance="outlined"></mat-card>
<mat-card appearance="outlined"></mat-card>
`,
);
});

it('should update multiple multi-line nested', async () => {
await runMigrationTest(
`
<mat-card>
<mat-card></mat-card>
</mat-card>
`,
`
<mat-card appearance="outlined">
<mat-card appearance="outlined"></mat-card>
</mat-card>
`,
);
});

it('should update multiple multi-line nested and unnested', async () => {
await runMigrationTest(
`
<mat-card>
<mat-card></mat-card>
<mat-card></mat-card>
</mat-card>
`,
`
<mat-card appearance="outlined">
<mat-card appearance="outlined"></mat-card>
<mat-card appearance="outlined"></mat-card>
</mat-card>
`,
);
});
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/**
* @license
* Copyright Google LLC All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/

import {TmplAstElement} from '@angular/compiler';
import {TemplateMigrator} from '../../template-migrator';
import {addAttribute} from '../../tree-traversal';

export class CardTemplateMigrator extends TemplateMigrator {
component = 'card';
tagName = 'mat-card';

override updateStartTag(template: string, node: TmplAstElement): string {
if (node.name !== this.tagName) {
return template;
}
return addAttribute(template, node, 'appearance', 'outlined');
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

import {ButtonStylesMigrator} from './components/button/button-styles';
import {CardStylesMigrator} from './components/card/card-styles';
import {CardTemplateMigrator} from './components/card/card-template';
import {CheckboxStylesMigrator} from './components/checkbox/checkbox-styles';
import {ChipsStylesMigrator} from './components/chips/chips-styles';
import {DialogStylesMigrator} from './components/dialog/dialog-styles';
Expand Down Expand Up @@ -36,6 +37,7 @@ export const MIGRATORS: ComponentMigrator[] = [
{
component: 'card',
styles: new CardStylesMigrator(),
template: new CardTemplateMigrator(),
},
{
component: 'checkbox',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,21 @@ export class TemplateMigration extends Migration<ComponentMigrator[], SchematicC

override visitTemplate(template: ResolvedResource) {
const ast = parseTemplate(template.content, template.filePath);
const migrators = this.upgradeData.filter(m => m.template).map(m => m.template!);

visitElements(ast.nodes, node => {
// TODO(wagnermaciel): implement the migration updates.
});
visitElements(
ast.nodes,
node => {
migrators.forEach(m => {
template.content = m.updateEndTag(template.content, node);
});
},
node => {
migrators.forEach(m => {
template.content = m.updateStartTag(template.content, node);
});
},
);

this.fileSystem.overwrite(template.filePath, template.content);
}
Expand Down