@testgorilla/tgo-coding-test 1.0.0 → 2.0.0

package/src/lib/components/common/truncated-text/truncated-text.component.ts

@@ -0,0 +1,36 @@
+import { ChangeDetectionStrategy, Component, Input, OnChanges, SimpleChanges } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { MemoizeFuncPipe } from '../../../pipes/memoize-func.pipe';
+
+const DEFAULT_MAX_CHARACTERS = 135;
+
+@Component({
+    selector: 'tgo-truncated-text',
+    templateUrl: './truncated-text.component.html',
+    styleUrls: ['./truncated-text.component.scss'],
+    changeDetection: ChangeDetectionStrategy.OnPush,
+    imports: [CommonModule, MemoizeFuncPipe]
+})
+export class TruncatedTextComponent implements OnChanges {
+  @Input() text = '';
+  @Input() maxChars = DEFAULT_MAX_CHARACTERS;
+  @Input() isWordWrap = false;
+
+  isTruncated: boolean;
+
+  ngOnChanges({ text }: SimpleChanges): void {
+    if (text?.firstChange && text?.currentValue) {
+      this.isTruncated = this.text.length > this.maxChars;
+    }
+  }
+
+  getShownText([isTruncated, fullText]: [boolean, string]): string {
+    // todo: add as an improvement:
+    // If the first line contains only a few characters, it would be good to truncate the second line to ~55 characters // Anna
+    return isTruncated ? `${this.text.slice(0, this.maxChars)}... ` : fullText;
+  }
+
+  toggleTruncation() {
+    this.isTruncated = !this.isTruncated;
+  }
+}

package/src/lib/components/configurations/configurations.component.html

@@ -0,0 +1,57 @@
+<tgo-code-panel
+  [openPanel]="configurationsPanelOpen$ | async"
+  [heading]="translations['HEADINGS']['CONFIGURATIONS']"
+  (closeEvent)="closeConfigPanel()"
+>
+  <form [formGroup]="configForm" class="configs">
+    <div id="formatting" *ngIf="formattingOptions">
+      <h3>{{ translations['HEADINGS']['FORMATTING'] }}</h3>
+      <ng-container
+        [ngTemplateOutlet]="config"
+        [ngTemplateOutletContext]="{ data: formattingOptions, inputType: 'dropdown' }"
+      ></ng-container>
+    </div>
+    <div id="codingAssistance" *ngIf="codingAssistanceOptions">
+      <h3>{{ translations['HEADINGS']['CODING_ASSISTANCE'] }}</h3>
+      <ng-container
+        [ngTemplateOutlet]="config"
+        [ngTemplateOutletContext]="{
+          data: codingAssistanceOptions,
+          inputType: 'toggle'
+        }"
+      ></ng-container>
+    </div>
+    <ng-template #config let-configData="data" let-inputType="inputType">
+      <ng-container *ngIf="language$ | async as language">
+        <ng-container *ngFor="let row of configData | keyvalue">
+          <div
+            class="config-row"
+            *ngIf="[language, row.key] | memoizeFunc: isValidRow"
+            [class.config-row-toggle]="inputType === 'toggle'"
+          >
+            <p class="config-name">{{ row.key }}</p>
+            <ui-dropdown
+              *ngIf="inputType === 'dropdown'"
+              class="config-dropdown"
+              [formControlName]="row.key"
+              [valueList]="row.value | memoizeFunc: getFormattedOptions"
+              [allowClear]="false"
+              [applicationTheme]="applicationTheme"
+              [showBottomContent]="false"
+              (change)="trackConfigChange(row.key)"
+            ></ui-dropdown>
+            <ui-toggle
+              *ngIf="inputType === 'toggle'"
+              [applicationTheme]="applicationTheme"
+              [formControlName]="row.key"
+              (toggle)="trackConfigChange(row.key)"
+              class="config-toggle"
+              [class.config-toggle-company-colored]="!!companyColor"
+              [style.--toggle-checked-color]="companyColor"
+            ></ui-toggle>
+          </div>
+        </ng-container>
+      </ng-container>
+    </ng-template>
+  </form>
+</tgo-code-panel>

package/src/lib/components/configurations/configurations.component.scss

@@ -0,0 +1,42 @@
+.configs {
+  display: flex;
+  flex-direction: column;
+  color: var(--main-text-color);
+
+  .config-row {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+
+    &.config-row-toggle {
+      margin-bottom: 32px;
+
+      .config-name {
+        margin: 0;
+        padding: 0;
+      }
+
+      .config-toggle {
+        &.config-toggle-company-colored ::ng-deep {
+          .toggle-container.active {
+            background-color: var(--toggle-checked-color);
+          }
+        }
+      }
+    }
+
+    .config-dropdown {
+      width: 100%;
+      max-width: 320px;
+
+      @media screen and (max-width: 599px) {
+        flex: 0 0 55%;
+      }
+    }
+  }
+}
+
+.config-name, .config-dropdown {
+  margin: 0.25em 0;
+  padding-bottom: 1.5em;
+}

package/src/lib/components/configurations/configurations.component.spec.ts

@@ -0,0 +1,186 @@
+import { NO_ERRORS_SCHEMA } from '@angular/core';
+import { ComponentFixture, TestBed, waitForAsync } from '@angular/core/testing';
+import { NoopAnimationsModule } from '@angular/platform-browser/animations';
+import { FormBuilder } from '@angular/forms';
+import { MockProvider } from 'ng-mocks';
+
+import { ReplaySubject } from 'rxjs';
+import { CodingAssistanceOptions, Config, FormattingOptions } from '../../models/configs';
+import { Themes } from '../../models/theme';
+import { MemoizeFuncPipe } from '../../pipes/memoize-func.pipe';
+import { ConfigurationsService } from '../../services/configurations.service';
+import { CONFIGURATIONS_SERVICE_MOCK } from '../../services/configurations.service.mocks';
+import { LibCodingTestService } from '../../services/lib-coding-test.service';
+import { StorageCodingService } from '../../services/storage.service';
+import { CodeEditorLanguages } from '../code-editor/helpers/code-editor-helper.model';
+import { ConfigurationsComponent } from './configurations.component';
+
+describe('ConfigurationsComponent', () => {
+  let component: ConfigurationsComponent;
+  let fixture: ComponentFixture<ConfigurationsComponent>;
+  let configurationsService: ConfigurationsService;
+  let storageCodingService: StorageCodingService;
+  let libCodingTestService: LibCodingTestService;
+  let changeCurrentLanguageSpy: jest.SpyInstance;
+
+  beforeEach(waitForAsync(() => {
+    TestBed.configureTestingModule({
+      imports: [ConfigurationsComponent, MemoizeFuncPipe, NoopAnimationsModule],
+      schemas: [NO_ERRORS_SCHEMA],
+      providers: [
+        FormBuilder,
+        MockProvider(ConfigurationsService, CONFIGURATIONS_SERVICE_MOCK),
+        MockProvider(StorageCodingService, {
+          getSavedConfig: () => CONFIGURATIONS_SERVICE_MOCK.defaultConfigs,
+        }),
+        MockProvider(LibCodingTestService, {
+          currentLanguage$: new ReplaySubject(1),
+          changeCurrentLanguage(value: CodeEditorLanguages): void {
+            this.currentLanguage$.next(value);
+          },
+        }),
+      ],
+    }).compileComponents();
+  }));
+
+  beforeEach(() => {
+    fixture = TestBed.createComponent(ConfigurationsComponent);
+    component = fixture.componentInstance;
+    component.translations = {
+      HEADINGS: {},
+    };
+    configurationsService = TestBed.inject(ConfigurationsService);
+    storageCodingService = TestBed.inject(StorageCodingService);
+    libCodingTestService = TestBed.inject(LibCodingTestService);
+    changeCurrentLanguageSpy = jest.spyOn(libCodingTestService, 'changeCurrentLanguage');
+    component.formattingOptions = configurationsService.getFormattingOptions();
+    component.codingAssistanceOptions = configurationsService.getCodingAssistanceOptions();
+    component.initialConfig = storageCodingService.getSavedConfig();
+  });
+
+  describe('when initialized', () => {
+    beforeEach(() => {
+      libCodingTestService.changeCurrentLanguage(CodeEditorLanguages.Typescript);
+      component.ngOnInit();
+      fixture.detectChanges();
+    });
+
+    it('should create the form with controls for each of the codingAssistanceOptions', () => {
+      expect(component.configForm.contains(CodingAssistanceOptions.AutoComplete)).toBeTruthy();
+      expect(component.configForm.contains(CodingAssistanceOptions.ErrorHighlighting)).toBeTruthy();
+      expect(component.configForm.contains(CodingAssistanceOptions.AutoBrackets)).toBeTruthy();
+    });
+
+    it('should create the form with correct default values for each of the codingAssistanceOptions', () => {
+      expect(component.configForm.controls[CodingAssistanceOptions.AutoComplete].value).toEqual(
+        component.initialConfig[CodingAssistanceOptions.AutoComplete]
+      );
+      expect(component.configForm.controls[CodingAssistanceOptions.ErrorHighlighting].value).toEqual(
+        component.initialConfig[CodingAssistanceOptions.ErrorHighlighting]
+      );
+      expect(component.configForm.controls[CodingAssistanceOptions.AutoBrackets].value).toEqual(
+        component.initialConfig[CodingAssistanceOptions.AutoBrackets]
+      );
+    });
+
+    it('should create the form with controls for each of the formattingOptions ', () => {
+      component.ngOnInit();
+      fixture.detectChanges();
+      expect(component.configForm.contains(FormattingOptions.ColorTheme)).toBeTruthy();
+      expect(component.configForm.contains(FormattingOptions.TabSize)).toBeTruthy();
+      expect(component.configForm.contains(FormattingOptions.FontSize)).toBeTruthy();
+    });
+    it('should create the form with correct default values for each of the formattingOptions', () => {
+      component.ngOnInit();
+      fixture.detectChanges();
+      expect(component.configForm.controls[FormattingOptions.ColorTheme].value).toEqual(
+        component.initialConfig[FormattingOptions.ColorTheme]
+      );
+      expect(component.configForm.controls[FormattingOptions.TabSize].value).toEqual(
+        component.initialConfig[FormattingOptions.TabSize]
+      );
+      expect(component.configForm.controls[FormattingOptions.FontSize].value).toEqual(
+        component.initialConfig[FormattingOptions.FontSize]
+      );
+    });
+    describe('when config options are changed', () => {
+      let setConfigSpy: jest.SpyInstance;
+      const currentConfig: Config = {
+        [FormattingOptions.ColorTheme]: Themes.Dark,
+        [FormattingOptions.TabSize]: 8,
+        [FormattingOptions.FontSize]: 16,
+        [CodingAssistanceOptions.AutoBrackets]: true,
+        [CodingAssistanceOptions.AutoComplete]: true,
+        [CodingAssistanceOptions.ErrorHighlighting]: true,
+      };
+
+      beforeEach(() => {
+        component.ngOnInit();
+        fixture.detectChanges();
+        setConfigSpy = jest.spyOn(configurationsService, 'setConfig');
+        component.configForm.setValue(currentConfig);
+      });
+
+      it('should call setConfig with modified value of the configuration changed', () => {
+        expect(setConfigSpy).toBeCalledWith(currentConfig);
+      });
+    });
+  });
+
+  describe('when config panel is closed', () => {
+    let closeConfigPanelSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+      closeConfigPanelSpy = jest.spyOn(configurationsService, 'closeConfigPanel');
+      component.closeConfigPanel();
+      fixture.detectChanges();
+    });
+
+    it('should call closeConfigPanel from configuration service', () => {
+      expect(closeConfigPanelSpy).toBeCalled();
+    });
+  });
+
+  describe('when any config control is changed', () => {
+    let trackConfigChangedSpy: jest.SpyInstance;
+
+    beforeEach(() => {
+      trackConfigChangedSpy = jest.spyOn(configurationsService, 'trackConfigChanged');
+
+      libCodingTestService.changeCurrentLanguage(CodeEditorLanguages.Python);
+      component.ngOnInit();
+      fixture.detectChanges();
+    });
+
+    it(`should call trackConfigChanged from configuration service with control name and it's value`, () => {
+      const controlName = FormattingOptions.FontSize;
+      const value = 12;
+
+      component.configForm.get(controlName).setValue(value);
+      component.trackConfigChange(controlName);
+
+      expect(trackConfigChangedSpy).toBeCalledWith({ [controlName]: value });
+    });
+  });
+
+  describe('when isValidRow is called', () => {
+    it('should return false if language is anything EXCEPT Javascript or Typescript and editor option is AutoComplete or Error Highlighting', () => {
+      const language = CodeEditorLanguages.Python;
+      libCodingTestService.changeCurrentLanguage(CodeEditorLanguages.Typescript);
+      const editorOption = CodingAssistanceOptions.AutoComplete;
+      expect(component.isValidRow([language, editorOption])).toBeFalsy();
+    });
+    it('should return true if language is Javascript or Typescript and editor option is AutoComplete or Error Highlighting', () => {
+      const language = CodeEditorLanguages.Javascript;
+      libCodingTestService.changeCurrentLanguage(CodeEditorLanguages.Typescript);
+      const editorOption = CodingAssistanceOptions.ErrorHighlighting;
+      expect(component.isValidRow([language, editorOption])).toBeTruthy();
+    });
+    it('should return true if language is anything and editor option is anything EXCEPT AutoComplete or Error Highlighting', () => {
+      const language = CodeEditorLanguages.Java;
+      libCodingTestService.changeCurrentLanguage(CodeEditorLanguages.Typescript);
+      const editorOption = CodingAssistanceOptions.AutoBrackets;
+      expect(component.isValidRow([language, editorOption])).toBeTruthy();
+    });
+  });
+});

package/src/lib/components/configurations/configurations.component.ts

@@ -0,0 +1,97 @@
+import { ChangeDetectionStrategy, Component, inject, Input, OnInit } from '@angular/core';
+import { CommonModule } from '@angular/common';
+import { FormBuilder, FormGroup, ReactiveFormsModule } from '@angular/forms';
+import { UntilDestroy, untilDestroyed } from '@ngneat/until-destroy';
+import { distinctUntilChanged } from 'rxjs';
+import { ApplicationTheme, OptionType, DropdownComponentModule, ToggleComponentModule } from '@testgorilla/tgo-ui';
+import { CodingAssistanceOptions, Config } from '../../models/configs';
+import { ConfigurationsService } from '../../services/configurations.service';
+import { LibCodingTestService } from '../../services/lib-coding-test.service';
+import { StorageCodingService } from '../../services/storage.service';
+import { CodeEditorLanguages } from '../code-editor/helpers/code-editor-helper.model';
+import { MemoizeFuncPipe } from '../../pipes/memoize-func.pipe';
+import { PanelComponent } from '../panel/panel.component';
+
+@UntilDestroy()
+@Component({
+    selector: 'tgo-code-configurations',
+    templateUrl: 'configurations.component.html',
+    styleUrls: ['configurations.component.scss'],
+    changeDetection: ChangeDetectionStrategy.OnPush,
+    imports: [
+        CommonModule,
+        ReactiveFormsModule,
+        DropdownComponentModule,
+        ToggleComponentModule,
+        MemoizeFuncPipe,
+        PanelComponent,
+    ]
+})
+export class ConfigurationsComponent implements OnInit {
+  private readonly fb = inject(FormBuilder);
+  private readonly configurationsService = inject(ConfigurationsService);
+  private readonly StorageCodingService = inject(StorageCodingService);
+  private readonly libCodingTestService = inject(LibCodingTestService);
+
+  @Input() translations: Record<string, unknown>;
+  @Input() companyColor: string;
+  @Input() applicationTheme: ApplicationTheme;
+
+  formattingOptions = this.configurationsService.getFormattingOptions();
+  codingAssistanceOptions = this.configurationsService.getCodingAssistanceOptions();
+  initialConfig = this.StorageCodingService.getSavedConfig();
+  language$ = this.libCodingTestService.currentLanguage$;
+
+  configForm: FormGroup;
+  formObject = {};
+  configurationsPanelOpen$ = this.configurationsService.configurationsPanelOpen$;
+
+  ngOnInit() {
+    if (!this.initialConfig) {
+      this.initialConfig = this.configurationsService.getInitialConfig();
+    }
+    this.addConfigControls(this.formattingOptions);
+    this.addConfigControls(this.codingAssistanceOptions);
+    this.configForm = this.fb.group(this.formObject);
+    this.configForm.valueChanges.pipe(distinctUntilChanged(), untilDestroyed(this)).subscribe((value: Config) => {
+      this.configurationsService.setConfig(value);
+    });
+  }
+
+  trackConfigChange(controlName: string): void {
+    const controlValue = this.configForm.value[controlName];
+    this.configurationsService.trackConfigChanged({
+      [controlName]: controlValue,
+    });
+  }
+
+  closeConfigPanel() {
+    this.configurationsService.closeConfigPanel();
+  }
+
+  private addConfigControls(configObject: object) {
+    // eslint-disable-next-line guard-for-in
+    for (const option in configObject) {
+      this.formObject[option] = this.initialConfig[option];
+    }
+  }
+
+  getFormattedOptions(configurationOptions: { label: string; value: any }[]): OptionType[] {
+    return configurationOptions.map(({ value, label }) => ({
+      value,
+      displayValue: label,
+    }));
+  }
+
+  isValidRow([language, editorOption]: [CodeEditorLanguages, CodingAssistanceOptions]) {
+    if (
+      language !== CodeEditorLanguages.Javascript &&
+      language !== CodeEditorLanguages.Typescript &&
+      (editorOption === CodingAssistanceOptions.AutoComplete ||
+        editorOption === CodingAssistanceOptions.ErrorHighlighting)
+    ) {
+      return false;
+    }
+    return true;
+  }
+}

package/src/lib/components/instructions/instructions.component.html

@@ -0,0 +1,41 @@
+<ng-container *ngIf="language$ | async as language">
+  <section *ngIf="questionText" class="question" id="question-section">
+    <header class="question-header">
+      <h2 class="question-heading">{{ translations['HEADINGS']['INSTRUCTIONS'] }}</h2>
+    </header>
+    <div class="question-content">
+      <ng-container *ngIf="mode === PreviewMode">
+        <div class="tips">
+          <ui-tooltip [message]="translations['PRACTICE_QUESTIONS_STAGE']['INFO']" class="tips-icon">
+            <ui-icon [name]="'Info'" [size]="'24'"></ui-icon>
+          </ui-tooltip>
+          <p class="tips-panel-text">
+            {{ translations['PRACTICE_QUESTIONS_STAGE']['QUESTIONS_INDEXING_AS_LAST'] }}
+          </p>
+        </div>
+        <p class="tips-text" [innerHTML]="translations['CODE_QUESTION']['PRACTICE_INTRODUCTION']"></p>
+        <ui-divider class="divider" [size]="'small'"></ui-divider>
+      </ng-container>
+
+      <quill-view
+        #quill
+        class="disable-text-selection question-text"
+        [class.question-text-dark]="isDarkTheme"
+        theme="snow"
+        [content]="questionText"
+      ></quill-view>
+      <div [ngSwitch]="language">
+        <span class="mr-4">{{ translations['CODE_QUESTION']['LANGUAGE_USING'] }}&nbsp;</span>
+        <ng-container *ngFor="let item of languages | keyvalue">
+          <span *ngSwitchCase="item.key">
+            <span class="bold mr-4">{{ item.value + ' ' + ([isLAT, item.key] | memoizeFunc: getVersion : this) }}</span>
+          </span>
+        </ng-container>
+        <span *ngIf="mode === RunningMode || mode === NonAssessmentPreview">
+          <br />
+          <span>{{ translations['CODE_QUESTION']['ADD_COMMENTS'] }}</span>
+        </span>
+      </div>
+    </div>
+  </section>
+</ng-container>

package/src/lib/components/instructions/instructions.component.scss

@@ -0,0 +1,173 @@
+.tips {
+  border-radius: 5px;
+  display: flex;
+  flex-direction: row;
+  place-content: center flex-start;
+  align-items: center;
+  margin-bottom: 16px;
+  padding: 16px;
+  background-color: var(--info-panel-color);
+
+  &-panel-text {
+    color: #000;
+  }
+
+  &-panel-text, &-text {
+    font-size: 16px;
+  }
+
+  &-icon {
+    margin-right: 8px;
+  }
+}
+
+.testgorilla-petrol-light {
+  background: #C8D7DE;
+}
+
+.question-text {
+  display: block;
+  margin-bottom: 32px;
+}
+
+.question-text-dark {
+  ::ng-deep .ql-snow .ql-editor {
+    *[style] { // to override copypasted styles in quill editor and make it usable for dark theme
+      color: var(--main-text-color) !important;
+      background-color: inherit !important;
+    }
+  }
+}
+
+.disable-text-selection { // Taken from style.scss
+  -webkit-touch-callout: none;
+  -webkit-user-select: none;
+  -khtml-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+}
+
+.question {
+  display: flex;
+  flex-direction: column;
+  height: 100%;
+
+  @media screen and (max-width: 959px) {
+    height: auto;
+  }
+
+  &.long_answer_list {
+    padding-bottom: 0;
+  }
+
+  ::ng-deep {
+    .ql-editor,
+    .ql-container {
+      max-height: 100%;
+    }
+  }
+
+  &-content {
+    padding: 16px 40px 30px;
+    height: 100%;
+    overflow-y: auto;
+
+    .divider {
+      display: block;
+      margin: 12px 0;
+    }
+  }
+}
+
+.question-header {
+  padding: 18px 0 18px 40px;
+  border-bottom: 1px solid #E0E0E0;
+
+  .question-heading {
+    margin: 0;
+  }
+}
+
+:host {
+  display: block;
+  height: 100%;
+  overflow: hidden;
+
+  @media screen and (max-width: 959px) {
+    height: auto;
+    flex: 1 0 auto;
+  }
+
+  ::ng-deep p {
+    margin: 0;
+    position: relative;
+  }
+
+  ::ng-deep img {
+    border-radius: 5px;
+  }
+
+  .bold {
+    font-weight: bold;
+  }
+
+  .medium-size {
+    font-size: medium;
+  }
+
+  .image {
+    border-radius: 6px;
+    overflow: hidden;
+    transform: translateZ(0px);
+
+    img {
+      width: 100%;
+    }
+  }
+}
+
+::ng-deep .ql-editor {
+  height: auto;
+  .table-q {
+    width: 100%;
+
+    @supports (-moz-appearance: none) {
+      // Firefox-specific override - fix table collapsed width
+      width: auto;
+    }
+
+    border-collapse: collapse;
+    border-radius: 5px;
+    table-layout: fixed;
+    overflow: hidden;
+    white-space: nowrap;
+
+    .tr-q:first-of-type {
+      background-color: var(--main-text-color) !important;
+      color: white;
+    }
+
+    .tr-q:nth-of-type(even) {
+      background-color: var(--tertiary-background-color);
+    }
+
+    .tr-q:nth-of-type(odd) {
+      background-color: var(--grey-background);
+    }
+
+    .td-q {
+      border: 4px solid var(--secondary-border-color);
+      border-radius: 10px;
+      padding: 2px 5px;
+      height: 25px;
+      vertical-align: top;
+      text-align: center;
+      white-space: normal;
+    }
+  }
+
+  &.ql-blank::before {
+    color: var(--secondary-text-color);
+  }
+}