Skip to content
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

chore: add migration for active zone parent #8873

Merged
merged 2 commits into from
Sep 10, 2024
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
Expand Up @@ -31,6 +31,7 @@ import {
TAGS_TO_REPLACE,
} from './constants';
import {
migrateActiveZoneParent,
migrateAvatar,
migrateAxes,
migrateBadge,
Expand Down Expand Up @@ -121,6 +122,7 @@ export function migrateTemplates(fileSystem: DevkitFileSystem, options: TuiSchem
migrateNumberPrecision,
migrateNotification,
migrateFilterPipe,
migrateActiveZoneParent,
] as const;

const progressLog = setupProgressLogger({
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from './migrate-active-zone';
export * from './migrate-avatar';
export * from './migrate-axes';
export * from './migrate-badge';
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
import type {UpdateRecorder} from '@angular-devkit/schematics';
import type {DevkitFileSystem} from 'ng-morph';

import {
findElementsByFn,
findElementsByTagName,
hasElementAttribute,
} from '../../../../utils/templates/elements';
import {findAttr} from '../../../../utils/templates/inputs';
import {
getTemplateFromTemplateResource,
getTemplateOffset,
} from '../../../../utils/templates/template-resource';
import type {TemplateResource} from '../../../interfaces';
import {removeAttrs} from '../utils/remove-attrs';

export function migrateActiveZoneParent({
resource,
recorder,
fileSystem,
}: {
fileSystem: DevkitFileSystem;
recorder: UpdateRecorder;
resource: TemplateResource;
}): void {
const template = getTemplateFromTemplateResource(resource, fileSystem);
const templateOffset = getTemplateOffset(resource);

const elements = findElementsByTagName(template, 'ng-template');

elements.forEach(({attrs, sourceCodeLocation, childNodes}) => {
const zoneAttr = findAttr(attrs, 'let-activeZone');

if (!sourceCodeLocation) {
return;
}

if (zoneAttr) {
removeAttrs([zoneAttr], sourceCodeLocation, recorder, templateOffset);
}

const children = findElementsByFn(childNodes, (el) =>
hasElementAttribute(el, 'tuiActiveZoneParent'),
);

children.forEach(({attrs, sourceCodeLocation}) => {
const parentAttr = findAttr(attrs, 'tuiActiveZoneParent');

if (!parentAttr || !sourceCodeLocation) {
return;
}

if (parentAttr) {
removeAttrs([parentAttr], sourceCodeLocation, recorder, templateOffset);
}
});
});
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
import {join} from 'node:path';

import {HostTree} from '@angular-devkit/schematics';
import {SchematicTestRunner, UnitTestTree} from '@angular-devkit/schematics/testing';
import type {TuiSchema} from '@taiga-ui/cdk/schematics/ng-add/schema';
import {
createProject,
createSourceFile,
resetActiveProject,
saveActiveProject,
setActiveProject,
} from 'ng-morph';

import {createAngularJson} from '../../../utils/create-angular-json';

const collectionPath = join(__dirname, '../../../migration.json');

const COMPONENT_BEFORE = `
@Component({
standalone: true,
templateUrl: './test.template.html',
})
export class Test {
}`;

const TEMPLATE_BEFORE = `
<tui-hosted-dropdown
tuiDropdownLimitWidth="fixed"
[content]="dropdown"
[(open)]="open"
>
<button
size="l"
title="Menu"
tuiIconButton
type="button"
class="tui-group__auto-width-item"
[iconRight]="icon"
></button>
</tui-hosted-dropdown>
<ng-template
#dropdown
let-activeZone
>
<tui-select
class="margin"
[tuiActiveZoneParent]="activeZone"
[(ngModel)]="selected"
>
Nested Select
<tui-data-list-wrapper
*tuiDataList
[items]="selectItems"
></tui-data-list-wrapper>
</tui-select>
</ng-template>
`;

const TEMPLATE_AFTER = `
<div ${''}
tuiDropdownLimitWidth="fixed"
[tuiDropdown]="dropdown"
[(tuiDropdownOpen)]="open"
>
<button
size="l"
title="Menu"
tuiIconButton
type="button"
class="tui-group__auto-width-item"
[iconEnd]="icon"
></button>
</div>
<ng-template
#dropdown
${''}
>
<tui-select
class="margin"
${''}
[(ngModel)]="selected"
>
Nested Select
<tui-data-list-wrapper
*tuiDataList
[items]="selectItems"
></tui-data-list-wrapper>
</tui-select>
</ng-template>
`;

describe('ng-update', () => {
let host: UnitTestTree;
let runner: SchematicTestRunner;

beforeEach(() => {
host = new UnitTestTree(new HostTree());
runner = new SchematicTestRunner('schematics', collectionPath);

setActiveProject(createProject(host));

createMainFiles();

saveActiveProject();
});

it('should migrate active zone parent in template', async () => {
const tree = await runner.runSchematic(
'updateToV4',
{'skip-logs': process.env['TUI_CI'] === 'true'} as Partial<TuiSchema>,
host,
);

expect(tree.readContent('test/app/test.template.html')).toEqual(TEMPLATE_AFTER);
});

afterEach(() => {
resetActiveProject();
});
});

function createMainFiles(): void {
createSourceFile('test/app/test.component.ts', COMPONENT_BEFORE);

createSourceFile('test/app/test.template.html', TEMPLATE_BEFORE);

createAngularJson();
createSourceFile(
'package.json',
'{"dependencies": {"@angular/core": "~13.0.0", "@taiga-ui/addon-commerce": "~3.42.0"}}',
);
}
Loading