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

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

@@ -68,6 +68,8 @@ $sample-project-theme: mat.define-light-theme((
 @include mat.mdc-fab-typography($sample-project-theme);
 @include mat.mdc-icon-button-theme($sample-project-theme);
 @include mat.mdc-icon-button-typography($sample-project-theme);
+@include mat.mdc-autocomplete-theme($sample-project-theme);
+@include mat.mdc-autocomplete-typography($sample-project-theme);
 
 /* You can add global styles to this file, and also import other style files */
 

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

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

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

@@ -0,0 +1,24 @@
+/**
+ * @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 AutocompleteStylesMigrator extends StyleMigrator {
+  component = 'autocomplete';
+
+  deprecatedPrefixes = ['mat-autocomplete'];
+
+  mixinChanges = [
+    {
+      old: 'autocomplete-theme',
+      new: ['mdc-autocomplete-theme', 'mdc-autocomplete-typography'],
+    },
+  ];
+
+  classChanges: ClassNameChange[] = [{old: '.mat-autocomplete', new: '.mat-mdc-autocomplete'}];
+}

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

@@ -9,6 +9,7 @@
 import {StyleMigrator} from './style-migrator';
 import {TemplateMigrator} from './template-migrator';
 
+import {AutocompleteStylesMigrator} from './components/autocomplete/autocomplete-styles';
 import {ButtonRuntimeMigrator} from './components/button/button-runtime';
 import {ButtonStylesMigrator} from './components/button/button-styles';
 import {CardStylesMigrator} from './components/card/card-styles';
@@ -38,6 +39,10 @@ export interface ComponentMigrator {
 }
 
 export const MIGRATORS: ComponentMigrator[] = [
+  {
+    component: 'autocomplete',
+    styles: new AutocompleteStylesMigrator(),
+  },
   {
     component: 'button',
     styles: new ButtonStylesMigrator(),