feat(material/schematics): add card styles migrator and tests

integration/mdc-migration/golden/src/styles.scss

@@ -46,6 +46,8 @@ $sample-project-theme: mat.define-light-theme((
 @include mat.mdc-paginator-typography($sample-project-theme);
 @include mat.mdc-checkbox-theme($sample-project-theme);
 @include mat.mdc-checkbox-typography($sample-project-theme);
+@include mat.mdc-card-theme($sample-project-theme);
+@include mat.mdc-card-typography($sample-project-theme);
 @include mat.mdc-button-theme($sample-project-theme);
 @include mat.mdc-button-typography($sample-project-theme);
 @include mat.mdc-fab-theme($sample-project-theme);

src/material/schematics/ng-generate/mdc-migration/rules/components/card/card-styles.spec.ts

@@ -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('card styles', () => {
+  let runner: SchematicTestRunner;
+  let cliAppTree: UnitTestTree;
+
+  async function runMigrationTest(oldFileContent: string, newFileContent: string) {
+    cliAppTree.create(THEME_FILE, oldFileContent);
+    const tree = await migrateComponents(['card'], 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.card-theme($theme);
+      `,
+        `
+        @use '@angular/material' as mat;
+        $theme: ();
+        @include mat.mdc-card-theme($theme);
+        @include mat.mdc-card-typography($theme);
+      `,
+      );
+    });
+
+    it('should use the correct namespace', async () => {
+      await runMigrationTest(
+        `
+        @use '@angular/material' as arbitrary;
+        $theme: ();
+        @include arbitrary.card-theme($theme);
+      `,
+        `
+        @use '@angular/material' as arbitrary;
+        $theme: ();
+        @include arbitrary.mdc-card-theme($theme);
+        @include arbitrary.mdc-card-typography($theme);
+      `,
+      );
+    });
+
+    it('should handle updating multiple themes', async () => {
+      await runMigrationTest(
+        `
+        @use '@angular/material' as mat;
+        $light-theme: ();
+        $dark-theme: ();
+        @include mat.card-theme($light-theme);
+        @include mat.card-theme($dark-theme);
+      `,
+        `
+        @use '@angular/material' as mat;
+        $light-theme: ();
+        $dark-theme: ();
+        @include mat.mdc-card-theme($light-theme);
+        @include mat.mdc-card-typography($light-theme);
+        @include mat.mdc-card-theme($dark-theme);
+        @include mat.mdc-card-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-card-theme($theme);
+        @include mat.mdc-card-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-card-theme($light-theme);
+        @include mat.mdc-card-typography($light-theme);
+        @include mat.all-component-themes($dark-theme);
+        @include mat.mdc-card-theme($dark-theme);
+        @include mat.mdc-card-typography($dark-theme);
+      `,
+      );
+    });
+
+    it('should preserve whitespace', async () => {
+      await runMigrationTest(
+        `
+        @use '@angular/material' as mat;
+        $theme: ();
+
+
+        @include mat.card-theme($theme);
+
+
+      `,
+        `
+        @use '@angular/material' as mat;
+        $theme: ();
+
+
+        @include mat.mdc-card-theme($theme);
+        @include mat.mdc-card-typography($theme);
+
+
+      `,
+      );
+    });
+  });
+
+  describe('selector migrations', () => {
+    it('should update the legacy mat-card classname', async () => {
+      await runMigrationTest(
+        `
+        .mat-card {
+          padding-right: 4px;
+        }
+      `,
+        `
+        .mat-mdc-card {
+          padding-right: 4px;
+        }
+      `,
+      );
+    });
+
+    it('should update multiple legacy classnames', async () => {
+      await runMigrationTest(
+        `
+        .mat-card {
+          padding-right: 4px;
+        }
+        .mat-card-footer {
+          padding-left: 4px;
+        }
+      `,
+        `
+        .mat-mdc-card {
+          padding-right: 4px;
+        }
+        .mat-mdc-card-footer {
+          padding-left: 4px;
+        }
+      `,
+      );
+    });
+
+    it('should update a legacy classname w/ multiple selectors', async () => {
+      await runMigrationTest(
+        `
+        .some-class.mat-card-title, .another-class {
+          font-size: 16px;
+        }
+      `,
+        `
+        .some-class.mat-mdc-card-title, .another-class {
+          font-size: 16px;
+        }
+      `,
+      );
+    });
+
+    it('should preserve the whitespace of multiple selectors', async () => {
+      await runMigrationTest(
+        `
+        .some-class,
+        .mat-card-subtitle,
+        .another-class { padding: 4px; }
+      `,
+        `
+        .some-class,
+        .mat-mdc-card-subtitle,
+        .another-class { padding: 4px; }
+      `,
+      );
+    });
+
+    it('should add comment for potentially deprecated selector', async () => {
+      await runMigrationTest(
+        `
+        .mat-card-flat {
+          margin: 4px;
+        }
+      `,
+        `
+        /* TODO: The following rule targets internal classes of card that may no longer apply for the MDC version. */
+
+        .mat-card-flat {
+          margin: 4px;
+        }
+      `,
+      );
+    });
+
+    it('should add comment for potentially deprecated multi-line selector', async () => {
+      await runMigrationTest(
+        `
+        .some-class
+        .mat-card-flat {
+          margin: 4px;
+        }
+      `,
+        `
+        /* TODO: The following rule targets internal classes of card that may no longer apply for the MDC version. */
+
+        .some-class
+        .mat-card-flat {
+          margin: 4px;
+        }
+      `,
+      );
+    });
+
+    it('should update the legacy mat-card class and add comment for potentially deprecated selector', async () => {
+      await runMigrationTest(
+        `
+        .mat-card.some-class, .mat-card-flat {
+          margin: 4px;
+        }
+      `,
+        `
+        /* TODO: The following rule targets internal classes of card that may no longer apply for the MDC version. */
+
+        .mat-mdc-card.some-class, .mat-card-flat {
+          margin: 4px;
+        }
+      `,
+      );
+    });
+  });
+});

src/material/schematics/ng-generate/mdc-migration/rules/components/card/card-styles.ts

@@ -0,0 +1,39 @@
+/**
+ * @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 CardStylesMigrator extends StyleMigrator {
+  component = 'card';
+
+  deprecatedPrefix = 'mat-card';
+
+  mixinChanges = [
+    {
+      old: 'card-theme',
+      new: ['mdc-card-theme', 'mdc-card-typography'],
+    },
+  ];
+
+  classChanges: ClassNameChange[] = [
+    {old: '.mat-card', new: '.mat-mdc-card'},
+    {old: `.mat-card-title`, new: `.mat-mdc-card-title`},
+    {old: `.mat-card-title-group`, new: `.mat-mdc-card-title-group`},
+    {old: `.mat-card-content`, new: `.mat-mdc-card-content`},
+    {old: `.mat-card-subtitle`, new: `.mat-mdc-card-subtitle`},
+    {old: `.mat-card-actions`, new: `.mat-mdc-card-actions`},
+    {old: `.mat-card-header`, new: `.mat-mdc-card-header`},
+    {old: `.mat-card-footer`, new: `.mat-mdc-card-footer`},
+    {old: `.mat-card-image`, new: `.mat-mdc-card-image`},
+    {old: `.mat-card-avatar`, new: `.mat-mdc-card-avatar`},
+    {old: `.mat-card-sm-image`, new: `.mat-mdc-card-sm-image`},
+    {old: `.mat-card-md-image`, new: `.mat-mdc-card-md-image`},
+    {old: `.mat-card-lg-image`, new: `.mat-mdc-card-lg-image`},
+    {old: `.mat-card-xl-image`, new: `.mat-mdc-card-xl-image`},
+  ];
+}

src/material/schematics/ng-generate/mdc-migration/rules/index.ts

@@ -7,6 +7,7 @@
  */
 
 import {ButtonStylesMigrator} from './components/button/button-styles';
+import {CardStylesMigrator} from './components/card/card-styles';
 import {CheckboxStylesMigrator} from './components/checkbox/checkbox-styles';
 import {PaginatorStylesMigrator} from './components/paginator/paginator-styles';
 import {ProgressBarStylesMigrator} from './components/progress-bar/progress-bar-styles';
@@ -18,6 +19,7 @@ import {StyleMigrator} from './style-migrator';
 
 export const MIGRATORS: StyleMigrator[] = [
   new ButtonStylesMigrator(),
+  new CardStylesMigrator(),
   new CheckboxStylesMigrator(),
   new PaginatorStylesMigrator(),
   new ProgressBarStylesMigrator(),