Angular: Fix Angular template error for props with a circular reference

code/frameworks/angular/src/client/angular-beta/ComputesTemplateFromComponent.test.ts

@@ -1,11 +1,285 @@
 import { Component } from '@angular/core';
 import { ArgTypes } from 'storybook/internal/types';
 import { describe, it, expect } from 'vitest';
-import { computesTemplateSourceFromComponent } from './ComputesTemplateFromComponent';
+import {
+ computesTemplateFromComponent,
+ computesTemplateSourceFromComponent,
+} from './ComputesTemplateFromComponent';
 import { ISomeInterface, ButtonAccent, InputComponent } from './__testfixtures__/input.component';
 
+describe('angular template decorator', () => {
+ it('with no props should generate simple tag', () => {
+ const component = InputComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual('<doc-button></doc-button>');
+ });
+
+ describe('with component without selector', () => {
+ @Component({
+ template: `The content`,
+ })
+ class WithoutSelectorComponent {}
+
+ it('should add component ng-container', async () => {
+ const component = WithoutSelectorComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<ng-container *ngComponentOutlet="storyComponent"></ng-container>`);
+ });
+ });
+
+ describe('with component with attribute selector', () => {
+ @Component({
+ selector: 'doc-button[foo]',
+ template: '<button></button>',
+ })
+ class WithAttributeComponent {}
+
+ it('should add attribute to template', async () => {
+ const component = WithAttributeComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button foo></doc-button>`);
+ });
+ });
+
+ describe('with component with attribute and value selector', () => {
+ @Component({
+ selector: 'doc-button[foo="bar"]',
+ template: '<button></button>',
+ })
+ class WithAttributeValueComponent {}
+
+ it('should add attribute to template', async () => {
+ const component = WithAttributeValueComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button foo="bar"></doc-button>`);
+ });
+ });
+
+ describe('with component with attribute only selector', () => {
+ @Component({
+ selector: '[foo]',
+ template: '<button></button>',
+ })
+ class WithAttributeOnlyComponent {}
+
+ it('should create a div and add attribute to template', async () => {
+ const component = WithAttributeOnlyComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<div foo></div>`);
+ });
+ });
+
+ describe('with component with void element and attribute selector', () => {
+ @Component({
+ selector: 'input[foo]',
+ template: '<button></button>',
+ })
+ class VoidElementWithAttributeComponent {}
+
+ it('should create without separate closing tag', async () => {
+ const component = VoidElementWithAttributeComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<input foo />`);
+ });
+ });
+
+ describe('with component with attribute and value only selector', () => {
+ @Component({
+ selector: '[foo="bar"]',
+ template: '<button></button>',
+ })
+ class WithAttributeOnlyComponent {}
+
+ it('should create a div and add attribute to template', async () => {
+ const component = WithAttributeOnlyComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<div foo="bar"></div>`);
+ });
+ });
+
+ describe('with component with void element, attribute and value only selector', () => {
+ @Component({
+ selector: 'input[foo="bar"]',
+ template: '<button></button>',
+ })
+ class VoidElementWithAttributeComponent {}
+
+ it('should create and add attribute to template without separate closing tag', async () => {
+ const component = VoidElementWithAttributeComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<input foo="bar" />`);
+ });
+ });
+
+ describe('with component with class selector', () => {
+ @Component({
+ selector: 'doc-button.foo',
+ template: '<button></button>',
+ })
+ class WithClassComponent {}
+
+ it('should add class to template', async () => {
+ const component = WithClassComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button class="foo"></doc-button>`);
+ });
+ });
+
+ describe('with component with class only selector', () => {
+ @Component({
+ selector: '.foo',
+ template: '<button></button>',
+ })
+ class WithClassComponent {}
+
+ it('should create a div and add attribute to template', async () => {
+ const component = WithClassComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<div class="foo"></div>`);
+ });
+ });
+
+ describe('with component with multiple selectors', () => {
+ @Component({
+ selector: 'doc-button, doc-button2',
+ template: '<button></button>',
+ })
+ class WithMultipleSelectorsComponent {}
+
+ it('should use the first selector', async () => {
+ const component = WithMultipleSelectorsComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button></doc-button>`);
+ });
+ });
+
+ describe('with component with multiple selectors starting with attribute', () => {
+ @Component({
+ selector: 'doc-button[foo], doc-button2',
+ template: '<button></button>',
+ })
+ class WithMultipleSelectorsComponent {}
+
+ it('should use the first selector', async () => {
+ const component = WithMultipleSelectorsComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button foo></doc-button>`);
+ });
+ });
+
+ describe('with component with multiple selectors starting with attribute and value', () => {
+ @Component({
+ selector: 'doc-button[foo="bar"], doc-button2',
+ template: '<button></button>',
+ })
+ class WithMultipleSelectorsComponent {}
+
+ it('should use the first selector', async () => {
+ const component = WithMultipleSelectorsComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button foo="bar"></doc-button>`);
+ });
+ });
+
+ describe('with component with multiple selectors including 2 attributes and a class', () => {
+ @Component({
+ selector: 'doc-button, button[foo], .button[foo], button[baz]',
+ template: '<button></button>',
+ })
+ class WithMultipleSelectorsComponent {}
+
+ it('should use the first selector', async () => {
+ const component = WithMultipleSelectorsComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button></doc-button>`);
+ });
+ });
+
+ describe('with component with multiple selectors with line breaks', () => {
+ @Component({
+ selector: `doc-button,
+ doc-button2`,
+ template: '<button></button>',
+ })
+ class WithMultipleSelectorsComponent {}
+
+ it('should use the first selector', async () => {
+ const component = WithMultipleSelectorsComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button></doc-button>`);
+ });
+ });
+
+ describe('with component with multiple selectors starting with attribute only with line breaks', () => {
+ @Component({
+ selector: `[foo],
+ doc-button2`,
+ template: '<button></button>',
+ })
+ class WithMultipleSelectorsComponent {}
+
+ it('should use the first selector', async () => {
+ const component = WithMultipleSelectorsComponent;
+ const props = {};
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<div foo></div>`);
+ });
+ });
+
+ it('with props should generate tag with properties', () => {
+ const component = InputComponent;
+ const props = {
+ isDisabled: true,
+ label: 'Hello world',
+ accent: ButtonAccent.High,
+ counter: 4,
+ };
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(
+ `<doc-button [counter]="counter" [accent]="accent" [isDisabled]="isDisabled" [label]="label"></doc-button>`
+ );
+ });
+
+ it('with props should generate tag with outputs', () => {
+ const component = InputComponent;
+ const props = {
+ isDisabled: true,
+ label: 'Hello world',
+ onClick: ($event: any) => {},
+ };
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(
+ `<doc-button [isDisabled]="isDisabled" [label]="label" (onClick)="onClick($event)"></doc-button>`
+ );
+ });
+
+ it('should generate correct property for overridden name for Input', () => {
+ const component = InputComponent;
+ const props = {
+ color: '#ffffff',
+ };
+ const source = computesTemplateFromComponent(component, props);
+ expect(source).toEqual(`<doc-button [color]="color"></doc-button>`);
+ });
+});
+
 describe('angular source decorator', () => {
- it('With no props should generate simple tag', () => {
+ it('with no props should generate simple tag', () => {
  const component = InputComponent;
  const props = {};
  const argTypes: ArgTypes = {};
@@ -264,7 +538,7 @@ describe('angular source decorator', () => {
  const source = computesTemplateSourceFromComponent(component, props, argTypes);
  expect(source).toEqual(`<doc-button></doc-button>`);
  });
- it('With props should generate tag with properties', () => {
+ it('with props should generate tag with properties', () => {
  const component = InputComponent;
  const props = {
  isDisabled: true,
@@ -279,7 +553,7 @@ describe('angular source decorator', () => {
  );
  });
 
- it('With props should generate tag with outputs', () => {
+ it('with props should generate tag with outputs', () => {
  const component = InputComponent;
  const props = {
  isDisabled: true,
@@ -305,7 +579,7 @@ describe('angular source decorator', () => {
  });
 
  describe('with argTypes (from compodoc)', () => {
- it('Should handle enum as strongly typed enum', () => {
+ it('should handle enum as strongly typed enum', () => {
  const component = InputComponent;
  const props = {
  isDisabled: false,
@@ -335,7 +609,7 @@ describe('angular source decorator', () => {
  );
  });
 
- it('Should handle enum without values as string', () => {
+ it('should handle enum without values as string', () => {
  const component = InputComponent;
  const props = {
  isDisabled: false,
@@ -365,7 +639,7 @@ describe('angular source decorator', () => {
  );
  });
 
- it('Should handle objects correctly', () => {
+ it('should handle simple object as stringified', () => {
  const component = InputComponent;
 
  const someDataObject: ISomeInterface = {
@@ -400,5 +674,42 @@ describe('angular source decorator', () => {
  `<doc-button [isDisabled]="false" [label]="'Hello world'" [someDataObject]="{one: 'Hello world', two: true, three: ['a string literal with \\'double quotes\\'', 'a string literal with \\'single quotes\\'', 'a single quoted string with \\'double quotes\\'', 'a double quoted string with \\'single quotes\\'', 'a single quoted string with escaped \\'single quotes\\'', 'a double quoted string with escaped \\'double quotes\\'', 'a string literal with \\'escaped single quotes\\'', 'a string literal with \\'escaped double quotes\\'']}"></doc-button>`
  );
  });
+
+ it('should handle circular object as stringified', () => {
+ const component = InputComponent;
+
+ const someDataObject: ISomeInterface = {
+ one: 'Hello world',
+ two: true,
+ three: [
+ `a string literal with "double quotes"`,
+ `a string literal with 'single quotes'`,
+ 'a single quoted string with "double quotes"',
+ "a double quoted string with 'single quotes'",
+ // eslint-disable-next-line prettier/prettier
+ 'a single quoted string with escaped \'single quotes\'',
+ // eslint-disable-next-line prettier/prettier
+ "a double quoted string with escaped \"double quotes\"",
+
+ `a string literal with \'escaped single quotes\'`,
+
+ `a string literal with \"escaped double quotes\"`,
+ ],
+ };
+ someDataObject.ref = someDataObject;
+
+ const props = {
+ isDisabled: false,
+ label: 'Hello world',
+ someDataObject,
+ };
+
+ const source = computesTemplateSourceFromComponent(component, props, null);
+ // Ideally we should stringify the object, but that could cause the story to break because of unescaped values in the JSON object.
+ // This will have to do for now
+ expect(source).toEqual(
+ `<doc-button [isDisabled]="false" [label]="'Hello world'" [someDataObject]="{one: 'Hello world', two: true, three: ['a string literal with \\'double quotes\\'', 'a string literal with \\'single quotes\\'', 'a single quoted string with \\'double quotes\\'', 'a double quoted string with \\'single quotes\\'', 'a single quoted string with escaped \\'single quotes\\'', 'a double quoted string with escaped \\'double quotes\\'', 'a string literal with \\'escaped single quotes\\'', 'a string literal with \\'escaped double quotes\\''], ref: '[Circular]'}"></doc-button>`
+ );
+ });
  });
 });