Refactor Vue components using Composition API #230

- Migrate `StatefulVue`:
  - Introduce `UseCollectionState` that replaces its behavior and acts
    as a shared state store.
  - Add more encapsulated, granular functions based on read or write
    access to state in CollectionState.
- Some linting rules get activates due to new code-base compability to
  modern parses, fix linting errors.
  - Rename Dialog to ModalDialog as after refactoring,
    eslintvue/no-reserved-component-names does not allow name Dialog.
  - To comply with `vue/multi-word-component-names`, rename:
    - `Code`          -> `CodeInstruction`
    - `Handle`        -> `SliderHandle`
    - `Documentable`  -> `DocumentableNode`
    - `Node`          -> `NodeContent`
    - `INode`         -> `INodeContent`
    - `Responsive`    -> `SizeObserver`
- Remove `vue-property-decorator` and `vue-class-component`
  dependencies.
- Refactor `watch` with computed properties when possible for cleaner
  code.
  - Introduce `UseApplication` to reduce repeated code in new components
    that use `computed` more heavily than before.
- Change TypeScript target to `es2017` to allow top level async calls
  for getting application context/state/instance to simplify the code by
  removing async calls. However, mocha (unit and integration) tests do
  not run with top level awaits, so a workaround is used.
This commit is contained in:
undergroundwires
2023-08-07 13:16:39 +02:00
parent 3a594ac7fd
commit 1b9be8fe2d
67 changed files with 2135 additions and 1267 deletions

View File

@@ -0,0 +1,19 @@
import { IApplicationContextChangedEvent } from '@/application/Context/IApplicationContext';
import { ICategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
import { CategoryCollectionStateStub } from './CategoryCollectionStateStub';
export class ApplicationContextChangedEventStub implements IApplicationContextChangedEvent {
newState: ICategoryCollectionState = new CategoryCollectionStateStub();
oldState: ICategoryCollectionState = new CategoryCollectionStateStub();
withNewState(newState: ICategoryCollectionState) {
this.newState = newState;
return this;
}
withOldState(oldState: ICategoryCollectionState) {
this.oldState = oldState;
return this;
}
}

View File

@@ -0,0 +1,38 @@
import { IApplicationContext, IApplicationContextChangedEvent } from '@/application/Context/IApplicationContext';
import { ICategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
import { IApplication } from '@/domain/IApplication';
import { OperatingSystem } from '@/domain/OperatingSystem';
import { CategoryCollectionStateStub } from './CategoryCollectionStateStub';
import { ApplicationStub } from './ApplicationStub';
import { EventSourceStub } from './EventSourceStub';
import { ApplicationContextChangedEventStub } from './ApplicationContextChangedEventStub';
export class ApplicationContextStub implements IApplicationContext {
public state: ICategoryCollectionState = new CategoryCollectionStateStub();
public changeContext(os: OperatingSystem): void {
const oldState = this.state;
const newState = new CategoryCollectionStateStub()
.withOs(os);
this.state = newState;
const event = new ApplicationContextChangedEventStub()
.withOldState(oldState)
.withNewState(newState);
this.dispatchContextChange(event);
}
public app: IApplication = new ApplicationStub();
public contextChanged = new EventSourceStub<IApplicationContextChangedEvent>();
public withState(state: ICategoryCollectionState) {
this.state = state;
return this;
}
public dispatchContextChange(
event: IApplicationContextChangedEvent = new ApplicationContextChangedEventStub(),
) {
this.contextChanged.notify(event);
}
}

View File

@@ -4,6 +4,8 @@ import { ICategoryCollectionState } from '@/application/Context/State/ICategoryC
import { OperatingSystem } from '@/domain/OperatingSystem';
import { SelectedScript } from '@/application/Context/State/Selection/SelectedScript';
import { IScript } from '@/domain/IScript';
import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
import { ICategoryCollection } from '@/domain/ICategoryCollection';
import { CategoryCollectionStub } from './CategoryCollectionStub';
import { UserSelectionStub } from './UserSelectionStub';
import { UserFilterStub } from './UserFilterStub';
@@ -11,24 +13,35 @@ import { ApplicationCodeStub } from './ApplicationCodeStub';
import { CategoryStub } from './CategoryStub';
export class CategoryCollectionStateStub implements ICategoryCollectionState {
private collectionStub = new CategoryCollectionStub();
public readonly code: IApplicationCode = new ApplicationCodeStub();
public readonly filter: IUserFilter = new UserFilterStub();
public readonly os = OperatingSystem.Windows;
public get os(): OperatingSystem {
return this.collectionStub.os;
}
public readonly collection: CategoryCollectionStub;
public get collection(): ICategoryCollection {
return this.collectionStub;
}
public readonly selection: UserSelectionStub;
constructor(readonly allScripts: IScript[]) {
constructor(readonly allScripts: IScript[] = [new ScriptStub('script-id')]) {
this.selection = new UserSelectionStub(allScripts);
this.collection = new CategoryCollectionStub()
this.collectionStub = new CategoryCollectionStub()
.withOs(this.os)
.withTotalScripts(this.allScripts.length)
.withAction(new CategoryStub(0).withScripts(...allScripts));
}
public withOs(os: OperatingSystem) {
this.collectionStub = this.collectionStub.withOs(os);
return this;
}
public withSelectedScripts(initialScripts: readonly SelectedScript[]) {
this.selection.withSelectedScripts(initialScripts);
return this;

View File

@@ -0,0 +1,22 @@
import { EventHandler, IEventSource, IEventSubscription } from '@/infrastructure/Events/IEventSource';
import { EventSubscriptionStub } from './EventSubscriptionStub';
export class EventSourceStub<T> implements IEventSource<T> {
private readonly handlers = new Array<EventHandler<T>>();
public on(handler: EventHandler<T>): IEventSubscription {
this.handlers.push(handler);
return new EventSubscriptionStub(() => {
const index = this.handlers.indexOf(handler);
if (index !== -1) {
this.handlers.splice(index, 1);
}
});
}
public notify(data: T) {
for (const handler of this.handlers) {
handler(data);
}
}
}

View File

@@ -0,0 +1,19 @@
import { IEventSubscription } from '@/infrastructure/Events/IEventSource';
type UnsubscribeCallback = () => void;
export class EventSubscriptionStub implements IEventSubscription {
private readonly onUnsubscribe = new Array<UnsubscribeCallback>();
constructor(unsubscribeCallback?: UnsubscribeCallback) {
if (unsubscribeCallback) {
this.onUnsubscribe.push(unsubscribeCallback);
}
}
unsubscribe(): void {
for (const callback of this.onUnsubscribe) {
callback();
}
}
}