Skip to content

Commit

Permalink
feat(material/schematics): add menu styles migrator and tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@amysorto @mmalerba
amysorto authored and mmalerba committed Jul 15, 2022
1 parent 1a99002 commit 6b24f96
Show file tree
Hide file tree
Showing 4 changed files with 299 additions and 0 deletions.
2 changes: 2 additions & 0 deletions integration/mdc-migration/golden/src/styles.scss
View file
Expand Up @@ -46,6 +46,8 @@ $sample-project-theme: mat.define-light-theme((
@include mat.mdc-progress-bar-typography($sample-project-theme);
@include mat.mdc-paginator-theme($sample-project-theme);
@include mat.mdc-paginator-typography($sample-project-theme);
@include mat.mdc-menu-theme($sample-project-theme);
@include mat.mdc-menu-typography($sample-project-theme);
@include mat.mdc-list-theme($sample-project-theme);
@include mat.mdc-list-typography($sample-project-theme);
@include mat.mdc-dialog-theme($sample-project-theme);
Expand Down
259 changes: 259 additions & 0 deletions src/material/schematics/ng-generate/mdc-migration/rules/components/menu/menu-styles.spec.ts
View file
@@ -0,0 +1,259 @@
import {createTestApp, patchDevkitTreeToExposeTypeScript} from '@angular/cdk/schematics/testing';
import {SchematicTestRunner, UnitTestTree} from '@angular-devkit/schematics/testing';
import {createNewTestRunner, migrateComponents, THEME_FILE} from '../test-setup-helper';

describe('menu styles', () => {
let runner: SchematicTestRunner;
let cliAppTree: UnitTestTree;

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

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

describe('mixin migrations', () => {
it('should replace the old theme with the new ones', async () => {
await runMigrationTest(
`
@use '@angular/material' as mat;
$theme: ();
@include mat.menu-theme($theme);
`,
`
@use '@angular/material' as mat;
$theme: ();
@include mat.mdc-menu-theme($theme);
@include mat.mdc-menu-typography($theme);
`,
);
});

it('should use the correct namespace', async () => {
await runMigrationTest(
`
@use '@angular/material' as arbitrary;
$theme: ();
@include arbitrary.menu-theme($theme);
`,
`
@use '@angular/material' as arbitrary;
$theme: ();
@include arbitrary.mdc-menu-theme($theme);
@include arbitrary.mdc-menu-typography($theme);
`,
);
});

it('should handle updating multiple themes', async () => {
await runMigrationTest(
`
@use '@angular/material' as mat;
$light-theme: ();
$dark-theme: ();
@include mat.menu-theme($light-theme);
@include mat.menu-theme($dark-theme);
`,
`
@use '@angular/material' as mat;
$light-theme: ();
$dark-theme: ();
@include mat.mdc-menu-theme($light-theme);
@include mat.mdc-menu-typography($light-theme);
@include mat.mdc-menu-theme($dark-theme);
@include mat.mdc-menu-typography($dark-theme);
`,
);
});

it('should add correct theme if all-component-themes mixin included', async () => {
await runMigrationTest(
`
@use '@angular/material' as mat;
$theme: ();
@include mat.all-component-themes($theme);
`,
`
@use '@angular/material' as mat;
$theme: ();
@include mat.all-component-themes($theme);
@include mat.mdc-menu-theme($theme);
@include mat.mdc-menu-typography($theme);
`,
);
});

it('should add multiple themes for multiple all-component-themes mixins', async () => {
await runMigrationTest(
`
@use '@angular/material' as mat;
$light-theme: ();
$dark-theme: ();
@include mat.all-component-themes($light-theme);
@include mat.all-component-themes($dark-theme);
`,
`
@use '@angular/material' as mat;
$light-theme: ();
$dark-theme: ();
@include mat.all-component-themes($light-theme);
@include mat.mdc-menu-theme($light-theme);
@include mat.mdc-menu-typography($light-theme);
@include mat.all-component-themes($dark-theme);
@include mat.mdc-menu-theme($dark-theme);
@include mat.mdc-menu-typography($dark-theme);
`,
);
});

it('should preserve whitespace', async () => {
await runMigrationTest(
`
@use '@angular/material' as mat;
$theme: ();
@include mat.menu-theme($theme);
`,
`
@use '@angular/material' as mat;
$theme: ();
@include mat.mdc-menu-theme($theme);
@include mat.mdc-menu-typography($theme);
`,
);
});
});

describe('selector migrations', () => {
it('should update the legacy mat-menu-panel classname', async () => {
await runMigrationTest(
`
.mat-menu-panel {
padding: 12px;
}
`,
`
.mat-mdc-menu-panel {
padding: 12px;
}
`,
);
});

it('should update multiple legacy classnames', async () => {
await runMigrationTest(
`
.mat-menu-panel {
padding: 12px;
}
.mat-menu-item {
border: solid;
}
`,
`
.mat-mdc-menu-panel {
padding: 12px;
}
.mat-mdc-menu-item {
border: solid;
}
`,
);
});

it('should update a legacy classname w/ multiple selectors', async () => {
await runMigrationTest(
`
.some-class.mat-menu-panel, .another-class {
padding: 12px;
}
`,
`
.some-class.mat-mdc-menu-panel, .another-class {
padding: 12px;
}
`,
);
});

it('should preserve the whitespace of multiple selectors', async () => {
await runMigrationTest(
`
.some-class,
.mat-menu-panel,
.another-class { padding: 12px; }
`,
`
.some-class,
.mat-mdc-menu-panel,
.another-class { padding: 12px; }
`,
);
});

it('should add comment for potentially deprecated selector', async () => {
await runMigrationTest(
`
.mat-menu-submenu-icon {
padding: 12px;
}
`,
`
/* TODO: The following rule targets internal classes of menu that may no longer apply for the MDC version. */
.mat-menu-submenu-icon {
padding: 12px;
}
`,
);
});

it('should add comment for potentially deprecated multi-line selector', async () => {
await runMigrationTest(
`
.some-class
.mat-menu-submenu-icon {
padding: 12px;
}
`,
`
/* TODO: The following rule targets internal classes of menu that may no longer apply for the MDC version. */
.some-class
.mat-menu-submenu-icon {
padding: 12px;
}
`,
);
});

it('should update the legacy mat-menu-panel class and add comment for potentially deprecated selector', async () => {
await runMigrationTest(
`
.mat-menu-panel.some-class, .mat-menu-submenu-icon {
padding: 12px;
}
`,
`
/* TODO: The following rule targets internal classes of menu that may no longer apply for the MDC version. */
.mat-mdc-menu-panel.some-class, .mat-menu-submenu-icon {
padding: 12px;
}
`,
);
});
});
});
33 changes: 33 additions & 0 deletions src/material/schematics/ng-generate/mdc-migration/rules/components/menu/menu-styles.ts
View file
@@ -0,0 +1,33 @@
/**
* @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 {ClassNameChange, StyleMigrator} from '../../style-migrator';

export class MenuStylesMigrator extends StyleMigrator {
component = 'menu';

deprecatedPrefix = 'mat-menu';

mixinChanges = [
{
old: 'menu-theme',
new: ['mdc-menu-theme', 'mdc-menu-typography'],
},
];

classChanges: ClassNameChange[] = [
{old: '.mat-menu-item', new: '.mat-mdc-menu-item'},
{old: '.mat-menu-trigger', new: '.mat-mdc-menu-trigger'},
{old: '.mat-menu-panel', new: '.mat-mdc-menu-panel'},
{old: '.mat-menu-content', new: '.mat-mdc-menu-content'},
{
old: '.mat-menu-item-submenu-trigger',
new: '.mat-mdc-menu-item-submenu-trigger',
},
];
}
5 changes: 5 additions & 0 deletions src/material/schematics/ng-generate/mdc-migration/rules/index.ts
View file
Expand Up @@ -14,6 +14,7 @@ import {CheckboxStylesMigrator} from './components/checkbox/checkbox-styles';
import {ChipsStylesMigrator} from './components/chips/chips-styles';
import {DialogStylesMigrator} from './components/dialog/dialog-styles';
import {ListStylesMigrator} from './components/list/list-styles';
import {MenuStylesMigrator} from './components/menu/menu-styles';
import {PaginatorStylesMigrator} from './components/paginator/paginator-styles';
import {ProgressBarStylesMigrator} from './components/progress-bar/progress-bar-styles';
import {ProgressSpinnerStylesMigrator} from './components/progress-spinner/progress-spinner-styles';
Expand Down Expand Up @@ -60,6 +61,10 @@ export const MIGRATORS: ComponentMigrator[] = [
component: 'list',
styles: new ListStylesMigrator(),
},
{
component: 'menu',
styles: new MenuStylesMigrator(),
},
{
component: 'paginator',
styles: new PaginatorStylesMigrator(),
Expand Down

0 comments on commit 6b24f96

Please sign in to comment.