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.

Sign up for GitHub

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

Jump to bottom

fix: bugs in format painter #677

Merged
merged 7 commits into from
Dec 9, 2023
Merged

fix: bugs in format painter #677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
8819955
fix: copy range style
yuhongz Dec 7, 2023
19acbe5
fix: delete useless merge mutation
yuhongz Dec 7, 2023
25e3aba
fix: range mark conflicts between format-painter and clipboard
yuhongz Dec 7, 2023
95252b9
fix: set cursor when format painter is enabled
yuhongz Dec 7, 2023
3b0de81
feat: format painter set merges
yuhongz Dec 7, 2023
277dbd5
test: add set format painter test
yuhongz Dec 8, 2023
c22a2a4
refactor: remove functions
yuhongz Dec 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
279 changes: 279 additions & 0 deletions packages/sheets-ui/src/commands/commands/__tests__/set-format-painter.command.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,279 @@
/* eslint-disable no-magic-numbers */

import type { Univer } from '@univerjs/core';
import {
Disposable,
ICommandService,
IUniverInstanceService,
LocaleType,
RedoCommand,
ThemeService,
UndoCommand,
} from '@univerjs/core';
import { IRenderManagerService } from '@univerjs/engine-render';
import {
AddWorksheetMergeMutation,
NORMAL_SELECTION_PLUGIN_NAME,
RemoveWorksheetMergeMutation,
SelectionManagerService,
SetRangeValuesCommand,
SetRangeValuesMutation,
SetSelectionsOperation,
} from '@univerjs/sheets';
import { createCommandTestBed } from '@univerjs/sheets/commands/commands/__tests__/create-command-test-bed.js';
import type { Injector } from '@wendellhu/redi';
import { beforeEach, describe, expect, it } from 'vitest';

import { IMarkSelectionService } from '../../..';
import { FormatPainterController } from '../../../controllers/format-painter/format-painter.controller';
import { FormatPainterService, IFormatPainterService } from '../../../services/format-painter/format-painter.service';
import { SetFormatPainterOperation } from '../../operations/set-format-painter.operation';
import {
ApplyFormatPainterCommand,
SetInfiniteFormatPainterCommand,
SetOnceFormatPainterCommand,
} from '../set-format-painter.command';

const theme = {
colorBlack: '#35322b',
};

const TEST_WORKBOOK_DATA = {
id: 'workbook-01',
sheetOrder: ['sheet-0011'],
name: 'UniverSheet Demo',
appVersion: '3.0.0-alpha',
styles: {
yifA1t: {
bl: 1,
it: 1,
ul: {
s: 1,
},
st: {
s: 1,
},
},
M5JbP2: {
bg: {
rgb: '#409f11',
},
cl: {
rgb: '#E30909',
},
ff: 'Microsoft YaHei',
},
},
sheets: {
'sheet-0011': {
type: 0,
id: 'sheet-0011',
name: 'sheet11',
columnData: {
'1': {
hd: 0,
},
},
mergeData: [
{
startRow: 1,
endRow: 1,
startColumn: 0,
endColumn: 1,
},
],
status: 1,
cellData: {
'0': {
'0': {
v: 1,
t: 2,
s: 'yifA1t',
},
'1': {
v: 2,
t: 2,
s: 'M5JbP2',
},
'2': {
v: 3,
},
'3': {
v: 1,
f: '=SUM(A1)',
si: '3e4r5t',
t: 2,
},
},
'1': {
'0': {
v: 4,
},
'2': {
v: 1,
t: 2,
},
'3': {
v: 1,
t: 2,
},
},
'2': {
'0': {
v: 44,
},
'2': {
v: 1,
t: 2,
},
'3': {
v: 1,
t: 2,
},
},
'3': {
'0': {
v: 444,
},
'2': {
v: 1,
t: 2,
},
'3': {
v: 1,
t: 2,
},
},
'4': {
'2': {
v: 1,
t: 2,
},
},
},
},
},
createdTime: '',
creator: '',
lastModifiedBy: '',
locale: LocaleType.EN_US,
modifiedTime: '',
timeZone: '',
};

class MarkSelectionService extends Disposable implements IMarkSelectionService {
addShape(): string | null {
return null;
}

refreshShapes() {}

removeShape(id: string): void {}

removeAllShapes(): void {}
}

class RenderManagerService {
getRenderById(id: string) {
return null;
}
}

describe('Test format painter rules in controller', () => {
let univer: Univer;
let get: Injector['get'];
let commandService: ICommandService;
let themeService: ThemeService;
let formatPainterController: FormatPainterController;
beforeEach(() => {
const testBed = createCommandTestBed(TEST_WORKBOOK_DATA, [
[IMarkSelectionService, { useClass: MarkSelectionService }],
[IFormatPainterService, { useClass: FormatPainterService }],
[IRenderManagerService, { useClass: RenderManagerService }],
[FormatPainterController],
]);
univer = testBed.univer;
get = testBed.get;

commandService = get(ICommandService);
themeService = get(ThemeService);
themeService.setTheme(theme);

formatPainterController = get(FormatPainterController);
commandService.registerCommand(SetFormatPainterOperation);
commandService.registerCommand(SetInfiniteFormatPainterCommand);
commandService.registerCommand(SetOnceFormatPainterCommand);
commandService.registerCommand(ApplyFormatPainterCommand);
commandService.registerCommand(SetSelectionsOperation);
commandService.registerCommand(SetRangeValuesCommand);
commandService.registerCommand(SetRangeValuesMutation);
commandService.registerCommand(RemoveWorksheetMergeMutation);
commandService.registerCommand(AddWorksheetMergeMutation);

const selectionManagerService = get(SelectionManagerService);
selectionManagerService.setCurrentSelection({
pluginName: NORMAL_SELECTION_PLUGIN_NAME,
unitId: 'workbook-01',
sheetId: 'sheet-0011',
});
});

describe('format painter', () => {
describe('format painter the numbers', async () => {
it('correct situation', async () => {
const workbook = get(IUniverInstanceService).getCurrentUniverSheetInstance();
if (!workbook) throw new Error('This is an error');
await commandService.executeCommand(SetSelectionsOperation.id, {
workbookId: 'workbook-01',
worksheetId: 'sheet-0011',
pluginName: NORMAL_SELECTION_PLUGIN_NAME,
selections: [
{
range: {
startRow: 0,
endRow: 1,
startColumn: 0,
endColumn: 1,
},
},
],
});
await commandService.executeCommand(SetOnceFormatPainterCommand.id);
await (formatPainterController as any)._applyFormatPainter({
startRow: 0,
endRow: 4,
startColumn: 2,
endColumn: 3,
});
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(0, 2)?.s).toBe('yifA1t');
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(0, 3)?.s).toBe('M5JbP2');
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(2, 3)?.s).toBe('M5JbP2');
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(2, 3)?.s).toBe('M5JbP2');
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData().length).toBe(3);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[0].startRow).toBe(1);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[1].startRow).toBe(1);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[2].startRow).toBe(3);

get(IUniverInstanceService).focusUniverInstance('workbook-01');
// undo
await commandService.executeCommand(UndoCommand.id);
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(0, 2)?.s).toBe(undefined);
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(0, 3)?.s).toBe(undefined);
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(2, 3)?.s).toBe(undefined);
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(2, 3)?.s).toBe(undefined);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData().length).toBe(1);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[0].startRow).toBe(1);
//redo
await commandService.executeCommand(RedoCommand.id);

expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(0, 3)?.s).toBe('M5JbP2');
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(2, 3)?.s).toBe('M5JbP2');
expect(workbook.getSheetBySheetId('sheet-0011')?.getCell(2, 3)?.s).toBe('M5JbP2');
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData().length).toBe(3);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[0].startRow).toBe(1);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[1].startRow).toBe(1);
expect(workbook.getSheetBySheetId('sheet-0011')?.getMergeData()[2].startRow).toBe(3);
});
});
});
});
83 changes: 4 additions & 79 deletions packages/sheets-ui/src/commands/commands/add-worksheet-merge.command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,109 +1,34 @@
import type { ICellData, ICommand, IMutationInfo, IRange, Worksheet } from '@univerjs/core';
import type { ICommand, IMutationInfo, IRange } from '@univerjs/core';
import {
CommandType,
Dimension,
ICommandService,
IUndoRedoService,
IUniverInstanceService,
LocaleService,
ObjectMatrix,
sequenceExecute,
} from '@univerjs/core';
import type {
IAddWorksheetMergeMutationParams,
IRemoveWorksheetMergeMutationParams,
ISetRangeValuesMutationParams,
} from '@univerjs/sheets';
import type { IAddWorksheetMergeMutationParams, IRemoveWorksheetMergeMutationParams } from '@univerjs/sheets';
import {
AddMergeUndoMutationFactory,
AddWorksheetMergeMutation,
getAddMergeMutationRangeByType,
RemoveMergeUndoMutationFactory,
RemoveWorksheetMergeMutation,
SelectionManagerService,
SetRangeValuesMutation,
SetRangeValuesUndoMutationFactory,
} from '@univerjs/sheets';
import { IConfirmService } from '@univerjs/ui';
import type { IAccessor } from '@wendellhu/redi';

import { checkCellContentInRanges, getClearContentMutationParamsForRanges } from '../../common/utils';

export interface IAddMergeCommandParams {
value?: Dimension.ROWS | Dimension.COLUMNS;
selections: IRange[];
workbookId: string;
worksheetId: string;
}

function checkCellContentInRanges(worksheet: Worksheet, ranges: IRange[]): boolean {
return ranges.some((range) => checkCellContentInRange(worksheet, range));
}

function checkCellContentInRange(worksheet: Worksheet, range: IRange): boolean {
const { startRow, startColumn, endColumn, endRow } = range;
const cellMatrix = worksheet.getMatrixWithMergedCells(startRow, startColumn, endRow, endColumn);

let someCellGoingToBeRemoved = false;
cellMatrix.forValue((row, col, cellData) => {
if (cellData && (row !== startRow || col !== startColumn) && worksheet.cellHasValue(cellData)) {
someCellGoingToBeRemoved = true;
return false;
}
});
return someCellGoingToBeRemoved;
}

function getClearContentMutationParamsForRanges(
accessor: IAccessor,
workbookId: string,
worksheet: Worksheet,
ranges: IRange[]
): {
undos: IMutationInfo[];
redos: IMutationInfo[];
} {
const undos: IMutationInfo[] = [];
const redos: IMutationInfo[] = [];

const worksheetId = worksheet.getSheetId();

// Use the following file as a reference.
// packages/sheets/src/commands/commands/clear-selection-all.command.ts
// packages/sheets/src/commands/mutations/set-range-values.mutation.ts
ranges.forEach((range) => {
const redoMatrix = getClearContentMutationParamForRange(worksheet, range);
const redoMutationParams: ISetRangeValuesMutationParams = {
workbookId,
worksheetId,
cellValue: redoMatrix.getData(),
};
const undoMutationParams: ISetRangeValuesMutationParams = SetRangeValuesUndoMutationFactory(
accessor,
redoMutationParams
);

undos.push({ id: SetRangeValuesMutation.id, params: undoMutationParams });
redos.push({ id: SetRangeValuesMutation.id, params: redoMutationParams });
});

return {
undos,
redos,
};
}

function getClearContentMutationParamForRange(worksheet: Worksheet, range: IRange): ObjectMatrix<ICellData> {
const { startRow, startColumn, endColumn, endRow } = range;
const cellMatrix = worksheet.getMatrixWithMergedCells(startRow, startColumn, endRow, endColumn);
const redoMatrix = new ObjectMatrix<ICellData>();
cellMatrix.forValue((row, col, cellData) => {
if (cellData && (row !== startRow || col !== startColumn)) {
redoMatrix.setValue(row, col, null);
}
});

return redoMatrix;
}

export const AddWorksheetMergeCommand: ICommand = {
type: CommandType.COMMAND,
id: 'sheet.command.add-worksheet-merge',
Expand Down