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

refactor: refactor core package to DI pattern and remove Context #45

Merged
merged 6 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Next Next commit
WIP
  • Loading branch information
Wenzhao Hu committed Aug 10, 2023
commit 4d4bde6f4deb1605b38b459742de1acf2714b725
7 changes: 7 additions & 0 deletions packages/core/src/Basics/ContextBase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ export abstract class ContextBase {
this._initialize();
}

/**
* This is a temporary hack before we completely remove Context.
*/
UNSAFE_setObserverManager(observerManager: ObserverManager): void {
this._observerManager = observerManager;
}

onUniver(univer: Univer): void {
const globalContext = univer.getGlobalContext();
this._univer = univer;
Expand Down
25 changes: 15 additions & 10 deletions packages/core/src/Basics/SheetContext.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import { Inject, Injector } from '@wendellhu/redi';

import { Workbook } from '../Sheets/Domain';
import { WorkBookObserverImpl } from './WorkBookObserverImpl';
import { ContextBase } from './ContextBase';
Expand All @@ -15,11 +17,13 @@ export class SheetContext extends ContextBase {

protected _genname: GenName;

constructor(univerSheetData: Partial<IWorkbookConfig> = {}) {
constructor(univerSheetData: Partial<IWorkbookConfig> = {}, @Inject(Injector) private readonly _sheetInjector: Injector) {
super();
this._setObserver();
this._genname = new GenName();
this._workbook = new Workbook(univerSheetData, this);
this._workbook = this._sheetInjector.createInstance(Workbook, univerSheetData);
}

UNSAFE_setGenName(genName: GenName): void {
this._genname = genName;
}

getWorkBook(): Workbook {
Expand All @@ -30,25 +34,26 @@ export class SheetContext extends ContextBase {
return this._genname;
}

onUniver(univer: Univer) {
override onUniver(univer: Univer) {
super.onUniver(univer);
this._workbook.onUniver(univer);

this._workbook.onUniver();
}

getContextObserver<Key extends keyof WorkBookObserver>(value: Key): Observable<PropsFrom<WorkBookObserver[Key]>> {
return this.getObserverManager().requiredObserver(value, 'core');
}

refreshWorkbook(univerSheetData: Partial<IWorkbookConfig> = {}) {
this._workbook = new Workbook(univerSheetData, this);
TEMP_setObserver(): void {
this._setObserver();
}

protected _setObserver(): void {
const manager = this.getObserverManager();
new WorkBookObserverImpl().install(manager);
}

protected _initialize(): void {
protected override _initialize(): void {
// EMPTY Context Initialize
}
}
}
17 changes: 6 additions & 11 deletions packages/core/src/Basics/UniverSheet.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,12 @@ export class UniverSheet implements Disposable {
constructor(univerSheetData: Partial<IWorkbookConfig> = {}, @Optional(Injector) parentInjector?: Injector) {
this.univerSheetConfig = univerSheetData;

this._context = new SheetContext(univerSheetData);

// Initialize injector after constructoring context
this._sheetInjector = this.initializeInjector(parentInjector);
this._context = new SheetContext(univerSheetData, this._sheetInjector);
this._context.UNSAFE_setObserverManager(this._sheetInjector.get(ObserverManager));
this._context.UNSAFE_setGenName(this._sheetInjector.get(GenName));
this._context.TEMP_setObserver();
}

/**
Expand Down Expand Up @@ -171,15 +173,8 @@ export class UniverSheet implements Disposable {
return this._context.getWorkBook();
}

refreshWorkbook(univerSheetData: Partial<IWorkbookConfig> = {}) {
this._context.refreshWorkbook(univerSheetData);
}

private initializeInjector(parentInjector?: Injector): Injector {
const dependencies: Dependency[] = [
[ObserverManager, { useValue: this.context.getObserverManager() }],
[GenName, { useValue: this.context.getGenName() }],
];
const dependencies: Dependency[] = [[ObserverManager], [GenName]];
return parentInjector ? parentInjector.createChild(dependencies) : new Injector(dependencies);
}
}
}
160 changes: 42 additions & 118 deletions packages/core/src/Basics/WorkBookObserverImpl.ts
Original file line number Diff line number Diff line change
@@ -1,118 +1,42 @@
import { Observable, ObserverManager } from '../Observer';

export class WorkBookObserverImpl {
install(manager: ObserverManager) {
// const manager = this.getObserverManager();

manager.addObserver(
'onAfterSetSelectionObservable',
'core',
new Observable()
);

manager.addObserver(
'onBeforeChangeNameObservable',
'core',
new Observable()
);
manager.addObserver('onAfterChangeNameObservable', 'core', new Observable());

manager.addObserver(
'onBeforeChangeActiveSheetObservable',
'core',
new Observable()
);
manager.addObserver(
'onAfterChangeActiveSheetObservable',
'core',
new Observable()
);

manager.addObserver(
'onBeforeChangeSheetNameObservable',
'core',
new Observable()
);
manager.addObserver(
'onAfterChangeSheetNameObservable',
'core',
new Observable()
);

manager.addObserver(
'onBeforeInsertSheetObservable',
'core',
new Observable()
);
manager.addObserver(
'onAfterInsertSheetObservable',
'core',
new Observable()
);

manager.addObserver(
'onBeforeRemoveSheetObservable',
'core',
new Observable()
);
manager.addObserver(
'onAfterRemoveSheetObservable',
'core',
new Observable()
);

manager.addObserver(
'onBeforeChangeSheetColorObservable',
'core',
new Observable()
);
manager.addObserver(
'onAfterChangeSheetColorObservable',
'core',
new Observable()
);

manager.addObserver(
'onBeforeChangeSheetDataObservable',
'core',
new Observable()
);
manager.addObserver(
'onAfterChangeSheetDataObservable',
'core',
new Observable()
);

manager.addObserver(
'onSheetBarDidMountObservable',
'core',
new Observable()
);
manager.addObserver('onInfoBarDidMountObservable', 'core', new Observable());
manager.addObserver(
'onRightMenuDidMountObservable',
'core',
new Observable()
);

manager.addObserver(
'onAfterChangeSheetScrollObservable',
'core',
new Observable()
);
manager.addObserver(
'onSheetRenderDidMountObservable',
'core',
new Observable()
);
manager.addObserver('onHideSheetObservable', 'core', new Observable());
manager.addObserver('onShowSheetObservable', 'core', new Observable());
manager.addObserver(
'onSheetTabColorChangeObservable',
'core',
new Observable()
);
manager.addObserver('onSheetOrderObservable', 'core', new Observable());
manager.addObserver('onZoomRatioSheetObservable', 'core', new Observable());
}
}
import { Observable, ObserverManager } from '../Observer';

export class WorkBookObserverImpl {
install(manager: ObserverManager) {
// const manager = this.getObserverManager();

manager.addObserver('onAfterSetSelectionObservable', 'core', new Observable());

manager.addObserver('onBeforeChangeNameObservable', 'core', new Observable());
manager.addObserver('onAfterChangeNameObservable', 'core', new Observable());

manager.addObserver('onBeforeChangeActiveSheetObservable', 'core', new Observable());
manager.addObserver('onAfterChangeActiveSheetObservable', 'core', new Observable());

manager.addObserver('onBeforeChangeSheetNameObservable', 'core', new Observable());
manager.addObserver('onAfterChangeSheetNameObservable', 'core', new Observable());

manager.addObserver('onBeforeInsertSheetObservable', 'core', new Observable());
manager.addObserver('onAfterInsertSheetObservable', 'core', new Observable());

manager.addObserver('onBeforeRemoveSheetObservable', 'core', new Observable());
manager.addObserver('onAfterRemoveSheetObservable', 'core', new Observable());

manager.addObserver('onBeforeChangeSheetColorObservable', 'core', new Observable());
manager.addObserver('onAfterChangeSheetColorObservable', 'core', new Observable());

manager.addObserver('onBeforeChangeSheetDataObservable', 'core', new Observable());
manager.addObserver('onAfterChangeSheetDataObservable', 'core', new Observable());

manager.addObserver('onSheetBarDidMountObservable', 'core', new Observable());
manager.addObserver('onInfoBarDidMountObservable', 'core', new Observable());
manager.addObserver('onRightMenuDidMountObservable', 'core', new Observable());

manager.addObserver('onAfterChangeSheetScrollObservable', 'core', new Observable());
manager.addObserver('onSheetRenderDidMountObservable', 'core', new Observable());
manager.addObserver('onHideSheetObservable', 'core', new Observable());
manager.addObserver('onShowSheetObservable', 'core', new Observable());
manager.addObserver('onSheetTabColorChangeObservable', 'core', new Observable());
manager.addObserver('onSheetOrderObservable', 'core', new Observable());
manager.addObserver('onZoomRatioSheetObservable', 'core', new Observable());
}
}
29 changes: 8 additions & 21 deletions packages/core/src/Sheets/Domain/NamedRange.ts
Original file line number Diff line number Diff line change
@@ -1,35 +1,22 @@
import { SheetContext } from '../../Basics';
import { CommandManager, Command } from '../../Command';
import {
IAddNamedRangeActionData,
IDeleteNamedRangeActionData,
ISetNamedRangeActionData,
AddNamedRangeAction,
} from '../Action';
import { Command } from '../../Command';
import { IAddNamedRangeActionData, IDeleteNamedRangeActionData, ISetNamedRangeActionData, AddNamedRangeAction } from '../Action';
import { ACTION_NAMES } from '../../Types/Const';
import { Workbook } from './index';
import { INamedRange } from '../../Types/Interfaces';

// TODO: @Dushudir: the purpose of this class is prettry suspicious...

/**
* Create, access and modify named ranges in a spreadsheet. Named ranges are ranges that have associated string aliases.
*
* Reference: https://developers.google.com/apps-script/reference/spreadsheet/named-range
*/
export class NamedRange {
private _workbook: Workbook;

private _commandManager: CommandManager;

private _context: SheetContext;

// private _name: string;
// private _range: Range;
// private _namedRangeId: string;

constructor(workbook: Workbook) {
this._workbook = workbook;
constructor() {
this._commandManager = this._workbook.getCommandManager();
this._context = this._workbook.getContext();

// this._name = name;
// this._range = range;
Expand All @@ -38,7 +25,7 @@ export class NamedRange {
}

addNamedRange(namedRange: INamedRange) {
const { _workbook, _context, _commandManager } = this;
const { _workbook, _commandManager } = this;

// const namedRange: INamedRange = {
// namedRangeId: this._namedRangeId,
Expand Down Expand Up @@ -69,7 +56,7 @@ export class NamedRange {
}

setNamedRange(namedRange: INamedRange) {
const { _workbook, _commandManager } = this;
const { _commandManager } = this;

// const namedRange: INamedRange = {
// namedRangeId: this._namedRangeId,
Expand Down Expand Up @@ -182,4 +169,4 @@ export class NamedRange {
// }
// })!;
}
}
}
Loading