@veltra/sheet 2.0.1 → 2.2.0

package/src/components/sheet/__test__/sheet-context-menu.test.ts

@@ -0,0 +1,206 @@
+import { createRange } from '@veltra/sheet-core/core/address'
+import { Sheet } from '@veltra/sheet-core/core/sheet'
+import { describe, expect, it } from 'vitest'
+
+import { createSheetContext } from '../../../tools/context'
+import {
+  buildBodyMenus,
+  buildColHeaderMenus,
+  buildRowHeaderMenus,
+  defaultInsertCount,
+  ensureContextMenuSelection,
+  isColInSelection,
+  isRowInSelection,
+  resolveRenderSize,
+  wholeColRange,
+  wholeRowRange
+} from '../sheet-context-menu'
+
+describe('sheet-context-menu helpers', () => {
+  it('defaultInsertCount = 选区覆盖行/列数（钳制 1..1000）', () => {
+    expect(defaultInsertCount(null, 'row')).toBe(1)
+    expect(defaultInsertCount(createRange({ row: 2, col: 0 }, { row: 4, col: 2 }), 'row')).toBe(3)
+    expect(defaultInsertCount(createRange({ row: 0, col: 1 }, { row: 0, col: 5 }), 'col')).toBe(5)
+    expect(defaultInsertCount(createRange({ row: 0, col: 0 }, { row: 2000, col: 0 }), 'row')).toBe(
+      1000
+    )
+  })
+
+  it('整行/整列选区与选区覆盖判定', () => {
+    expect(wholeRowRange(2, 6)).toEqual({ start: { row: 2, col: 0 }, end: { row: 2, col: 5 } })
+    expect(wholeColRange(3, 10)).toEqual({ start: { row: 0, col: 3 }, end: { row: 9, col: 3 } })
+    const ranges = [createRange({ row: 1, col: 0 }, { row: 3, col: 5 })]
+    expect(isRowInSelection(ranges, 2)).toBe(true)
+    expect(isRowInSelection(ranges, 5)).toBe(false)
+    expect(isColInSelection(ranges, 4)).toBe(true)
+    expect(isColInSelection(ranges, 6)).toBe(false)
+  })
+
+  it('resolveRenderSize = max(props, sheet)', () => {
+    expect(resolveRenderSize(100, 26, 120, 10)).toEqual({ rows: 120, cols: 26 })
+    expect(resolveRenderSize(undefined, undefined, 0, 0)).toEqual({ rows: 100, cols: 26 })
+  })
+})
+
+describe('ensureContextMenuSelection', () => {
+  it('body 落点在选区外 → 选中该格', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectRange(createRange({ row: 0, col: 0 }, { row: 1, col: 1 }))
+    ensureContextMenuSelection(
+      ctx,
+      { kind: 'body', addr: { row: 5, col: 2 } },
+      { rows: 100, cols: 26 }
+    )
+    expect(ctx.getSelection().activeCell).toEqual({ row: 5, col: 2 })
+  })
+
+  it('行号落点在选区外 → 选中整行', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectCell({ row: 0, col: 0 })
+    ensureContextMenuSelection(
+      ctx,
+      { kind: 'row-header', addr: null, row: 4 },
+      { rows: 100, cols: 6 }
+    )
+    expect(ctx.getSelection().ranges[0]).toEqual({
+      start: { row: 4, col: 0 },
+      end: { row: 4, col: 5 }
+    })
+  })
+
+  it('行号落点在选区内 → 保留选区', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    const range = createRange({ row: 2, col: 0 }, { row: 4, col: 5 })
+    sheet.selectRange(range)
+    ensureContextMenuSelection(
+      ctx,
+      { kind: 'row-header', addr: null, row: 3 },
+      { rows: 100, cols: 6 }
+    )
+    expect(ctx.getSelection().ranges[0]).toEqual(range)
+  })
+
+  it('列头落点在选区外 → 选中整列', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectCell({ row: 0, col: 0 })
+    ensureContextMenuSelection(
+      ctx,
+      { kind: 'col-header', addr: null, col: 2 },
+      { rows: 10, cols: 26 }
+    )
+    expect(ctx.getSelection().ranges[0]).toEqual({
+      start: { row: 0, col: 2 },
+      end: { row: 9, col: 2 }
+    })
+  })
+})
+
+describe('build*Menus', () => {
+  it('行号菜单：插入×2 / 删除 / divider / 冻结项；无合并/插入列', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectRange(createRange({ row: 1, col: 0 }, { row: 3, col: 5 }))
+    const menus = buildRowHeaderMenus(ctx)
+    const labels = menus.map((m) => m.label ?? (m.divider ? '---' : ''))
+    expect(labels).toEqual([
+      '在上方插入行',
+      '在下方插入行',
+      '删除行',
+      '---',
+      '冻结到当前行',
+      '取消冻结'
+    ])
+    expect(menus.filter((m) => m.keepOpen)).toHaveLength(2)
+    expect(menus.some((m) => m.divider)).toBe(true)
+    expect(menus.at(-1)?.disabled).toBe(true)
+    expect(labels.join()).not.toContain('合并')
+    expect(labels.join()).not.toContain('插入列')
+  })
+
+  it('冻结到当前行 active 标记 + 取消冻结可用', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectRange(createRange({ row: 0, col: 0 }, { row: 2, col: 5 }))
+    sheet.setFrozen(3, 0) // endRow(2)+1
+    const menus = buildRowHeaderMenus(ctx)
+    expect(menus.find((m) => m.label?.includes('冻结到当前行'))?.label).toBe('✓ 冻结到当前行')
+    expect(menus.find((m) => m.label === '取消冻结')?.disabled).toBe(false)
+  })
+
+  it('列头菜单对称', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectRange(createRange({ row: 0, col: 1 }, { row: 9, col: 3 }))
+    const labels = buildColHeaderMenus(ctx).map((m) => m.label ?? (m.divider ? '---' : ''))
+    expect(labels).toEqual([
+      '在左侧插入列',
+      '在右侧插入列',
+      '删除列',
+      '---',
+      '冻结到当前列',
+      '取消冻结'
+    ])
+  })
+
+  it('body 菜单三项：合并/取消合并/插入图片，不含行列插入删除', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectCell({ row: 0, col: 0 })
+    const menus = buildBodyMenus(ctx)
+    expect(menus).toHaveLength(3)
+    expect(menus.map((m) => m.label)).toEqual(['合并单元格', '取消合并单元格', '插入图片'])
+    const insertImage = menus.find((m) => m.label === '插入图片')!
+    expect(insertImage.disabled).toBeFalsy()
+    expect(insertImage.callback).toBeTruthy()
+    const labels = menus.map((m) => m.label).join()
+    expect(labels).not.toContain('插入行')
+    expect(labels).not.toContain('插入列')
+    expect(labels).not.toContain('删除行')
+    expect(labels).not.toContain('删除列')
+  })
+
+  it('body 插入图片：无活动格时禁用', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selection.clear()
+    const menus = buildBodyMenus(ctx)
+    expect(menus.find((m) => m.label === '插入图片')?.disabled).toBe(true)
+  })
+
+  it('行号/列头菜单仍含插入删除行列', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.selectCell({ row: 0, col: 0 })
+    const rowLabels = buildRowHeaderMenus(ctx)
+      .map((m) => m.label)
+      .join()
+    const colLabels = buildColHeaderMenus(ctx)
+      .map((m) => m.label)
+      .join()
+    expect(rowLabels).toContain('在上方插入行')
+    expect(rowLabels).toContain('在下方插入行')
+    expect(rowLabels).toContain('删除行')
+    expect(colLabels).toContain('在左侧插入列')
+    expect(colLabels).toContain('在右侧插入列')
+    expect(colLabels).toContain('删除列')
+  })
+
+  it('行号菜单：上方插入落在选区首行、下方插入落在末行+1', () => {
+    const sheet = new Sheet()
+    const ctx = createSheetContext(sheet)
+    sheet.setCellValue({ row: 5, col: 0 }, 'keep')
+    sheet.selectRange(createRange({ row: 1, col: 0 }, { row: 2, col: 5 }))
+    const menus = buildRowHeaderMenus(ctx)
+    // 模拟 confirm：直接调 insert（与 render onConfirm 同路径）
+    ctx.insertRows(1, 2) // 上方
+    expect(sheet.getDisplayValue({ row: 7, col: 0 })).toBe('keep')
+    sheet.undo()
+    ctx.insertRows(3, 2) // 下方 endRow+1
+    expect(sheet.getDisplayValue({ row: 7, col: 0 })).toBe('keep')
+    expect(menus[0]?.keepOpen).toBe(true)
+  })
+})

package/src/components/sheet/__test__/use-formula-ref-select.test.ts

@@ -0,0 +1,35 @@
+import { describe, expect, it } from 'vitest'
+
+import { insertRefText, isRefSelectContext } from '../use-formula-ref-select'
+
+describe('isRefSelectContext', () => {
+  it('运算符 / ( / , / = 之后可插入引用', () => {
+    expect(isRefSelectContext('=', 1)).toBe(true)
+    expect(isRefSelectContext('=SUM(', 5)).toBe(true)
+    expect(isRefSelectContext('=SUM(A1,', 8)).toBe(true)
+    expect(isRefSelectContext('=A1+', 4)).toBe(true)
+    expect(isRefSelectContext('=A1-', 4)).toBe(true)
+  })
+
+  it('引用中途 / 非公式 / 闭合括号后不可插入', () => {
+    expect(isRefSelectContext('=A1', 3)).toBe(false)
+    expect(isRefSelectContext('=SUM(A1)', 8)).toBe(false)
+    expect(isRefSelectContext('hello', 5)).toBe(false)
+    expect(isRefSelectContext('SUM(', 4)).toBe(false)
+  })
+
+  it('忽略光标前空白', () => {
+    expect(isRefSelectContext('=SUM(  ', 7)).toBe(true)
+  })
+})
+
+describe('insertRefText', () => {
+  it('在光标处插入并移动光标到引用后', () => {
+    expect(insertRefText('=SUM(', 5, 'A1:B2')).toEqual({ text: '=SUM(A1:B2', cursor: 10 })
+    expect(insertRefText('=A1+', 4, 'B1')).toEqual({ text: '=A1+B1', cursor: 6 })
+  })
+
+  it('有选区时覆盖选区', () => {
+    expect(insertRefText('=SUM(XX)', 5, 'A1', 7)).toEqual({ text: '=SUM(A1)', cursor: 7 })
+  })
+})

package/src/components/sheet/__test__/use-formula-suggest.test.ts

@@ -0,0 +1,83 @@
+import { registerFormulaFunction } from '@veltra/sheet-core/core/formula/functions'
+import { describe, expect, it } from 'vitest'
+
+import {
+  applySuggest,
+  filterFormulaSuggestions,
+  FORMULA_SUGGEST_LIMIT,
+  formatFunctionSignature,
+  getSuggestContext,
+  moveSuggestIndex
+} from '../use-formula-suggest'
+
+describe('getSuggestContext', () => {
+  it('输入 = 后（空前缀）进入补全上下文', () => {
+    expect(getSuggestContext('=', 1)).toEqual({ prefix: '', start: 1, end: 1 })
+  })
+
+  it('=SU 前缀过滤上下文', () => {
+    expect(getSuggestContext('=SU', 3)).toEqual({ prefix: 'SU', start: 1, end: 3 })
+  })
+
+  it('运算符 / ( / , 后的 token 可补全', () => {
+    expect(getSuggestContext('=1+AB', 5)).toMatchObject({ prefix: 'AB', start: 3 })
+    expect(getSuggestContext('=SUM(AV', 7)).toMatchObject({ prefix: 'AV', start: 5 })
+    expect(getSuggestContext('=SUM(1,MA', 9)).toMatchObject({ prefix: 'MA', start: 7 })
+  })
+
+  it('非触发位置不补全；引用 token 可判定但过滤为空', () => {
+    // =A1：token 合法但无匹配函数 → 候选列表不展示（filter 空）
+    expect(getSuggestContext('=A1', 3)).toMatchObject({ prefix: 'A1' })
+    expect(filterFormulaSuggestions('A1')).toEqual([])
+    expect(getSuggestContext('hello', 5)).toBeNull()
+    expect(getSuggestContext('=SUM(A1)', 8)).toBeNull()
+  })
+
+  it('空前缀仅紧跟 = 时出现（( 后空前缀不弹）', () => {
+    expect(getSuggestContext('=SUM(', 5)).toBeNull()
+  })
+
+  it('<= / >= 尾随 = 不弹空前缀候选（比较运算符）', () => {
+    expect(getSuggestContext('=A1<=', 5)).toBeNull()
+    expect(getSuggestContext('=A1>=', 5)).toBeNull()
+    // 二元比较 = 后仍可空前缀（=A1=ABS(...)）
+    expect(getSuggestContext('=A1=', 4)).toEqual({ prefix: '', start: 4, end: 4 })
+  })
+})
+
+describe('filterFormulaSuggestions / applySuggest / moveSuggestIndex', () => {
+  it('空前缀优先常用函数（含 SUM），至多 10 条；SU 过滤到 SUM', () => {
+    const all = filterFormulaSuggestions('')
+    expect(all.length).toBeGreaterThan(0)
+    expect(all.length).toBeLessThanOrEqual(FORMULA_SUGGEST_LIMIT)
+    expect(all[0]!.name).toBe('SUM')
+    expect(all.map((s) => s.name)).toContain('SUM')
+    const su = filterFormulaSuggestions('SU')
+    expect(su.map((s) => s.name)).toEqual(['SUM'])
+    expect(su[0]!.signature).toBe(formatFunctionSignature('SUM', su[0]!.params))
+  })
+
+  it('无 meta 函数签名仅为名称', () => {
+    registerFormulaFunction('__SUGGEST_TMP__', { impl: () => 1 })
+    try {
+      const hit = filterFormulaSuggestions('__SUGGEST_TMP__')
+      expect(hit[0]?.signature).toBe('__SUGGEST_TMP__')
+    } finally {
+      // 注册表无 unregister：覆盖为无 meta 占位，避免污染后续用例
+      registerFormulaFunction('__SUGGEST_TMP__', { impl: () => null })
+    }
+  })
+
+  it('applySuggest：token → NAME() 且光标入括号', () => {
+    const r = applySuggest('=SU', 1, 3, 'SUM')
+    expect(r).toEqual({ text: '=SUM()', cursor: 5 })
+    const r2 = applySuggest('=1+av', 3, 5, 'AVERAGE')
+    expect(r2).toEqual({ text: '=1+AVERAGE()', cursor: 11 })
+  })
+
+  it('moveSuggestIndex 循环', () => {
+    expect(moveSuggestIndex(0, 3, 1)).toBe(1)
+    expect(moveSuggestIndex(2, 3, 1)).toBe(0)
+    expect(moveSuggestIndex(0, 3, -1)).toBe(2)
+  })
+})