build: prevents duplicate builds running

Author: geometricpanda

.github/workflows/build.yml

@@ -1,5 +1,5 @@
 name: Build
-on: [push, pull_request]
+on: [push]
 
 env:
   CYPRESS_INSTALL_BINARY: 0

apps/www/src/app/components/masthead/masthead.component.ts

@@ -2,7 +2,7 @@ import {Component, HostBinding, OnDestroy, OnInit} from "@angular/core";
 import {FormControl, ReactiveFormsModule} from "@angular/forms";
 import {Subscription} from "rxjs";
 import {SegmentedControlButtonComponent, SegmentedControlComponent} from "../segmented-control";
-import {RadioValueAccessorDirective} from "../../library-components/directives";
+import {RadioValueAccessorDirective} from "../../library-components/directives/radio-control-accessor";
 import {ColorModeService, ColourMode} from "../../library-components/services";
 import {ContainerComponent} from "../container";
 import {IconComponent} from "../icon";

apps/www/src/app/components/segmented-control/segmented-control-button.component.ts

@@ -1,5 +1,5 @@
 import {Component, ElementRef, HostBinding, HostListener, Input} from "@angular/core";
-import {RadioValueAccessorDirective} from "../../library-components/directives";
+import {RadioValueAccessorDirective} from "../../library-components/directives/radio-control-accessor";
 import {FocusableOption, FocusOrigin} from "@angular/cdk/a11y";
 
 @Component({

apps/www/src/app/library-components/directives/index.ts

@@ -1,2 +1 @@
-export * from './radio-value-accessor.directive';
-export * from './radio-control-registry.service';
+export * from './radio-control-accessor';

apps/www/src/app/library-components/directives/radio-control-accessor/index.ts

@@ -0,0 +1,2 @@
+export * from './radio-value-accessor.directive';
+export * from './radio-control-registry.service';

apps/www/src/app/library-components/directives/radio-control-registry.service.ts renamed to apps/www/src/app/library-components/directives/radio-control-accessor/radio-control-registry.service.ts

@@ -1,7 +1,7 @@
 import {Directive, Input, OnDestroy, OnInit} from "@angular/core";
 import {ControlValueAccessor, NG_VALUE_ACCESSOR} from "@angular/forms";
 import {noop} from "rxjs";
-import {RadioControlRegistry} from ".";
+import {RadioControlRegistry} from "./index";
 
 
 @Directive({

apps/www/src/app/library-components/directives/radio-value-accessor.directive.ts renamed to apps/www/src/app/library-components/directives/radio-control-accessor/radio-value-accessor.directive.ts

@@ -35,7 +35,7 @@ export class ColorModeService {
 
   private setAuto() {
     this._mode.next(ColourMode.AUTO);
-    this.storage.clear();
+    this.storage.removeItem();
     this.document.body.classList?.remove(ColourMode.LIGHT);
     this.document.body.classList?.remove(ColourMode.DARK);
   }

apps/www/src/app/library-components/services/color-mode/color-mode.service.ts

@@ -0,0 +1 @@
+export * from './key-storage';

apps/www/src/app/library-components/utilities/index.ts

@@ -0,0 +1,42 @@
+import {TestBed} from "@angular/core/testing";
+import {createKeyStorage} from "./create-key-storage";
+import {KeyStorage} from "./key-storage";
+import {InMemoryStore, LocalStorageStore} from "./stores";
+
+describe('Create Key Storage', () => {
+
+  const key = 'key';
+  const defaultValue = 'default-value';
+
+  it('should return an Angular injection token', () => {
+    const token = createKeyStorage(key, defaultValue);
+    const store = TestBed.inject(token);
+    expect(store).toBeInstanceOf(KeyStorage);
+  });
+
+  it('should configure the key storage correctly', () => {
+    const token = createKeyStorage(key, defaultValue);
+    const store = TestBed.inject(token);
+    expect(store['_key']).toBe(key)
+    expect(store['_defaultValue']).toBe(defaultValue)
+  });
+
+  it('should configure the key storage to use the localStorageStore by default', () => {
+    const token = createKeyStorage(key, defaultValue);
+    const store = TestBed.inject(token);
+    expect(store['_store']).toBeInstanceOf(LocalStorageStore)
+  });
+
+  it('should configure the key storage to use the localStorage Store', () => {
+    const token = createKeyStorage(key, defaultValue, );
+    const store = TestBed.inject(token);
+    expect(store['_store']).toBeInstanceOf(LocalStorageStore)
+  });
+
+  it('should configure the key storage to use the InMemory Store', () => {
+    const token = createKeyStorage(key, defaultValue, new InMemoryStore());
+    const store = TestBed.inject(token);
+    expect(store['_store']).toBeInstanceOf(InMemoryStore)
+  });
+
+})

apps/www/src/app/library-components/utilities/key-storage/create-key-storage.spec.ts

@@ -0,0 +1,52 @@
+import {KeyStorage} from "./key-storage";
+import {InMemoryStore} from "./stores";
+
+describe('Key Storage', () => {
+
+  const key = 'key';
+  const defaultValue = 'default';
+
+  let store: KeyStorage;
+
+  beforeEach(() => {
+    store = new KeyStorage(
+      key,
+      defaultValue,
+      new InMemoryStore(),
+    );
+  });
+
+  it('should return a stored record', () => {
+    const record = 'value';
+    store.setItem(record);
+
+    const returnedRecord = store.getItem();
+    expect(returnedRecord).toEqual(record);
+  });
+
+  it('should overwrite the value', () => {
+    const record1 = 'value';
+    const record2 = 'value-2';
+
+    store.setItem(record1);
+    store.setItem(record2);
+
+    const returnedRecord = store.getItem();
+    expect(returnedRecord).toEqual(record2);
+  });
+
+  it('should return the default value if the record doesnt exist', () => {
+    const returnedRecord = store.getItem();
+    expect(returnedRecord).toBe(defaultValue);
+  });
+
+  it('should return the default value for removed records', () => {
+    const record = 'value';
+    store.setItem(record);
+    store.removeItem();
+
+    const returnedRecord = store.getItem();
+    expect(returnedRecord).toEqual(defaultValue);
+  });
+
+})

apps/www/src/app/library-components/utilities/key-storage/key-storage.spec.ts

@@ -19,7 +19,7 @@ export class KeyStorage<T = unknown> {
     this._store.setItem(this._key, data);
   }
 
-  clear(): void {
+  removeItem(): void {
     this._store.removeItem(this._key);
   }
 

apps/www/src/app/library-components/utilities/key-storage/key-storage.ts

@@ -0,0 +1,119 @@
+import {InMemoryStore} from "./in-memory.store";
+
+describe('In Memory Store', () => {
+
+  let store: InMemoryStore;
+
+  beforeEach(() => {
+    store = new InMemoryStore();
+  });
+
+  it('should return the size of the store', () => {
+    const key0 = 'key-0';
+    const record0 = 'value';
+
+    const key1 = 'key-1';
+    const record1 = 'value-1';
+
+    store.setItem(key0, record0);
+    store.setItem(key1, record1);
+
+    const size = store.length;
+
+    expect(size).toEqual(2);
+  });
+
+  it('should store a record', () => {
+    const key = 'key';
+    const record = 'value';
+    store.setItem(key, record);
+    expect(store.length).toBe(1);
+  });
+
+  it('should return a stored record', () => {
+    const key = 'key';
+    const record = 'value';
+    store.setItem(key, record);
+
+    const returnedRecord = store.getItem(key);
+    expect(returnedRecord).toEqual(record);
+  });
+
+  it('should respect the integrity of individual records', () => {
+    const key1 = 'key';
+    const record1 = 'value';
+
+    const key2 = 'key-2';
+    const record2 = 'value-2';
+
+    store.setItem(key1, record1);
+    store.setItem(key2, record2);
+
+    const returnedRecord1 = store.getItem(key1);
+    const returnedRecord2 = store.getItem(key2);
+
+    expect(returnedRecord1).toEqual(record1);
+    expect(returnedRecord2).toEqual(record2);
+  });
+
+  it('should return null if a record doesnt exist', () => {
+    const key = 'key';
+    const returnedRecord = store.getItem(key);
+    expect(returnedRecord).toBeNull();
+  });
+
+  it('should remove records', () => {
+    const key = 'key';
+    const record = 'value';
+    store.setItem(key, record);
+
+    expect(store.length).toBe(1);
+
+    store.removeItem(key);
+    expect(store.length).toBe(0);
+  });
+
+  it('should return null for removed records', () => {
+    const key = 'key';
+    const record = 'value';
+    store.setItem(key, record);
+
+    expect(store.length).toBe(1);
+
+    store.removeItem(key);
+    const returnedRecord = store.getItem(key);
+    expect(returnedRecord).toBeNull();
+  });
+
+  it('should return the zero indexed key for index 1', () => {
+    const key0 = 'key-0';
+    const record0 = 'value';
+
+    const key1 = 'key-1';
+    const record1 = 'value-1';
+
+    store.setItem(key0, record0);
+    store.setItem(key1, record1);
+
+    const returnedKey = store.key(1);
+    expect(returnedKey).toEqual(key1);
+
+  });
+
+  it('should remove all keys', () => {
+    const key0 = 'key-0';
+    const record0 = 'value';
+
+    const key1 = 'key-1';
+    const record1 = 'value-1';
+
+    store.setItem(key0, record0);
+    store.setItem(key1, record1);
+
+    store.clear();
+    const size = store.length;
+
+    expect(size).toEqual(0);
+  });
+
+})