From c9593afe8da1b35e81caa6397cbeb503a7f50e14 Mon Sep 17 00:00:00 2001 From: Johan Lahti Date: Mon, 11 Sep 2023 10:05:59 +0200 Subject: [PATCH] refactor: unit tests and cleaning --- .../distribute-resources-counting.spec.ts | 289 ++++++++++++++++++ .../distribute-resources-counting.ts | 10 +- .../ListboxGrid/distribute-resources.ts | 6 +- .../components/ListboxGrid/grid-constants.ts | 2 + 4 files changed, 298 insertions(+), 9 deletions(-) create mode 100644 packages/sn-filter-pane/src/components/ListboxGrid/__tests__/distribute-resources-counting.spec.ts diff --git a/packages/sn-filter-pane/src/components/ListboxGrid/__tests__/distribute-resources-counting.spec.ts b/packages/sn-filter-pane/src/components/ListboxGrid/__tests__/distribute-resources-counting.spec.ts new file mode 100644 index 00000000..239394f3 --- /dev/null +++ b/packages/sn-filter-pane/src/components/ListboxGrid/__tests__/distribute-resources-counting.spec.ts @@ -0,0 +1,289 @@ +import { IListboxResource } from '../../../hooks/types'; +import { + countListBoxes, doAllFit, estimateColumnHeight, getExpandedHeightLimit, getListBoxMaxHeight, getListBoxMinHeight, getMaxColumns, howManyListBoxesFit, +} from '../distribute-resources-counting'; +import { LIST_DENSE_ROW_HEIGHT, LIST_ROW_HEIGHT } from '../grid-constants'; +import { ExpandProps, ISize } from '../interfaces'; + +const getResource = (collapseMode = 'auto') => ({ + dense: false, + collapseMode: 'auto', + hasHeader: true, + neverExpanded: collapseMode === 'always', + alwaysExpanded: collapseMode === 'never', + layout: { layoutOptions: { collapseMode, dense: false } }, +} as unknown as IListboxResource); + +describe('distribute resources countng functions', () => { + describe('getListBoxMinHeight should return correct height for different settings', () => { + it('hasHeader: true, collapse: never, dense: false', () => { + const resource = { hasHeader: true, layout: { layoutOptions: { collapseMode: 'never', dense: false } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(77); + }); + it('hasHeader: true, collapse: never, dense: true', () => { + const resource = { hasHeader: true, layout: { layoutOptions: { collapseMode: 'never', dense: true } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(68); + }); + it('hasHeader: false, collapse: never, dense: false', () => { + const resource = { hasHeader: false, layout: { layoutOptions: { collapseMode: 'never', dense: false } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(LIST_ROW_HEIGHT); + }); + it('hasHeader: false, collapse: never, dense: true', () => { + const resource = { hasHeader: false, layout: { layoutOptions: { collapseMode: 'never', dense: true } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(LIST_DENSE_ROW_HEIGHT); + }); + + it('hasHeader: false, collapse: auto, dense: false', () => { + const resource = { hasHeader: false, layout: { layoutOptions: { collapseMode: 'auto', dense: false } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(34); + }); + it('hasHeader: true, collapse: auto, dense: false', () => { + const resource = { hasHeader: true, layout: { layoutOptions: { collapseMode: 'auto', dense: false } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(34); + }); + it('hasHeader: true, collapse: always, dense: false', () => { + const resource = { hasHeader: true, layout: { layoutOptions: { collapseMode: 'auto', dense: false } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(34); + }); + it('hasHeader: true, collapse: always, dense: true', () => { + const resource = { hasHeader: true, layout: { layoutOptions: { collapseMode: 'auto', dense: true } } } as IListboxResource; + expect(getListBoxMinHeight(resource)).toEqual(34); + }); + }); + + describe('getMaxColumns should behave', () => { + it('getMaxColumns -> 1', () => { + const size = { + width: 100, + height: 200, + dimensionCount: 4, + }; + expect(getMaxColumns(size, false)).toEqual(1); + }); + it('getMaxColumns -> 2', () => { + const size = { + width: 336, + height: 200, + dimensionCount: 4, + }; + expect(getMaxColumns(size, false)).toEqual(2); + }); + it('getMaxColumns with dense -> 1', () => { + const size = { + width: 336, + height: 200, + dimensionCount: 4, + }; + expect(getMaxColumns(size, true)).toEqual(1); + }); + it('getMaxColumns -> 2 desoute dimensionCount and height being high', () => { + const size = { + width: 336, + height: 10200, + dimensionCount: 100, + }; + expect(getMaxColumns(size, false)).toEqual(2); + }); + it('getMaxColumns -> 1 although size is 0', () => { + const size = { + width: 0, + height: 0, + dimensionCount: 100, + }; + expect(getMaxColumns(size, false)).toEqual(1); + }); + it('getMaxColumns -> 1 although size is 0', () => { + const size = { + width: 0, + height: 0, + dimensionCount: 100, + }; + expect(getMaxColumns(size, true)).toEqual(1); + }); + }); + + describe('howManyListBoxesFit should behave', () => { + it('howManyListBoxesFit - always expanded', () => { + const columnSize = { + width: 0, + height: 78, + } as ISize; + const resourcesSlice: IListboxResource[] = [getResource('never')]; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(1); + columnSize.height = 77; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(0); + }); + + it('howManyListBoxesFit - always collapsed', () => { + const columnSize = { + width: 0, + height: 35, + } as ISize; + const resourcesSlice: IListboxResource[] = [getResource('always')]; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(1); + columnSize.height = 34; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(0); + }); + it('howManyListBoxesFit - auto', () => { + const columnSize = { + width: 0, + height: 35, + } as ISize; + const resourcesSlice: IListboxResource[] = [getResource('auto')]; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(1); + columnSize.height = 34; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(0); + }); + it('howManyListBoxesFit - combination', () => { + const columnSize = { + width: 0, + height: 162, + } as ISize; + const resourcesSlice: IListboxResource[] = [getResource('never'), getResource('always'), getResource('auto')]; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(3); + columnSize.height = 161; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(2); + columnSize.height = 119; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(1); + columnSize.height = 120; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(2); + columnSize.height = 77; + expect(howManyListBoxesFit(columnSize, resourcesSlice)).toEqual(0); + }); + }); + + describe('countListBoxes should count like a pro', () => { + it('should count', () => { + expect(countListBoxes([{ itemCount: 3 }, { itemCount: 2 }, { itemCount: 3 }, { itemCount: 0 }])).toEqual(8); + }); + it('should not count', () => { + expect(countListBoxes([])).toEqual(0); + }); + it('should not throw', () => { + expect(countListBoxes([{}])).toEqual(0); + }); + }); + + describe('doAllFit', () => { + it('should count like a pro', () => { + expect(doAllFit(2, 2, 4)).toEqual(true); + expect(doAllFit(2, 2, 5)).toEqual(false); + expect(doAllFit(0, 2, 0)).toEqual(true); + }); + }); + + describe('getExpandedHeightLimit', () => { + it('should be 0 when alwaysExpanded', () => { + expect(getExpandedHeightLimit({ alwaysExpanded: true } as ExpandProps)).toEqual(0); + expect(getExpandedHeightLimit({ alwaysExpanded: true, hasHeader: true } as ExpandProps)).toEqual(0); + }); + it('should be 0 when isSingleGridLayout', () => { + expect(getExpandedHeightLimit({ isSingleGridLayout: true } as ExpandProps)).toEqual(0); + }); + it('should account for header in isSingleGridLayout', () => { + expect(getExpandedHeightLimit({ isSingleGridLayout: true, hasHeader: true } as ExpandProps)).toEqual(80); + }); + it('should return default value', () => { + expect(getExpandedHeightLimit({} as ExpandProps)).toEqual(90); + }); + }); + + describe('getListBoxMaxHeight', () => { + it('should calculate like a pro', () => { + expect(getListBoxMaxHeight({ + cardinal: 3, + dense: false, + hasHeader: true, + neverExpanded: false, + alwaysExpanded: false, + } as IListboxResource)).toEqual(135); + }); + it('should calculate like a pro with dense', () => { + expect(getListBoxMaxHeight({ + cardinal: 3, + dense: true, + hasHeader: true, + neverExpanded: false, + alwaysExpanded: false, + } as IListboxResource)).toEqual(108); + }); + it('should account for no header', () => { + expect(getListBoxMaxHeight({ + cardinal: 3, + dense: false, + hasHeader: false, + neverExpanded: false, + alwaysExpanded: false, + } as IListboxResource)).toEqual(87); + }); + it('should account for alwaysExpanded', () => { + expect(getListBoxMaxHeight({ + cardinal: 3, + dense: false, + hasHeader: true, + neverExpanded: false, + alwaysExpanded: true, + } as IListboxResource)).toEqual(135); + }); + it('should account for neverExpanded', () => { + expect(getListBoxMaxHeight({ + cardinal: 3, + dense: false, + hasHeader: true, + neverExpanded: true, + alwaysExpanded: false, + layout: { + layoutOptions: { + collapseMode: 'always', + }, + }, + } as IListboxResource)).toEqual(34); + }); + it('should return 0 when cardinal is 0 and no header', () => { + expect(getListBoxMaxHeight({ + cardinal: 0, + dense: false, + hasHeader: false, + neverExpanded: false, + alwaysExpanded: false, + layout: { + layoutOptions: { + collapseMode: 'auto', + }, + }, + } as IListboxResource)).toEqual(0); + }); + it('should account for header when cardinal is 0', () => { + expect(getListBoxMaxHeight({ + cardinal: 0, + dense: false, + hasHeader: true, + neverExpanded: false, + alwaysExpanded: false, + layout: { + layoutOptions: { + collapseMode: 'auto', + }, + }, + } as IListboxResource)).toEqual(48); + }); + }); + + describe('estimateColumnHeight', () => { + it('should estimate like a wizard', () => { + expect(estimateColumnHeight({ + items: [ + getResource('auto'), + getResource('always'), + getResource('never'), + ], + })).toEqual(171); + }); + + it('should only count the padding', () => { + expect(estimateColumnHeight({ + items: [], + })).toEqual(2); + }); + }); +}); diff --git a/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources-counting.ts b/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources-counting.ts index 40b07999..15db4c24 100644 --- a/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources-counting.ts +++ b/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources-counting.ts @@ -1,10 +1,10 @@ import { IListboxResource } from '../../hooks/types'; import { - COLLAPSED_HEIGHT, COLUMN_MIN_WIDTH, COLUMN_SPACING, EXPANDED_HEADER_HEIGHT, ITEM_SPACING, SINGLE_GRID_ROW_HEIGHT, + COLLAPSED_HEIGHT, COLUMN_MIN_WIDTH, COLUMN_SPACING, EXPANDED_HEADER_HEIGHT, ITEM_SPACING, LIST_ROW_HEIGHT, LIST_DENSE_ROW_HEIGHT, SINGLE_GRID_ROW_HEIGHT, } from './grid-constants'; import { ExpandProps, IColumn, ISize } from './interfaces'; -const getExpandedRowHeight = (dense: boolean) => (dense ? 20 : 29); +const getExpandedRowHeight = (dense: boolean) => (dense ? LIST_DENSE_ROW_HEIGHT : LIST_ROW_HEIGHT); export function getListBoxMinHeight(resource: IListboxResource, outerWidth = false) { const { dense = false, collapseMode } = resource.layout.layoutOptions || {}; @@ -81,7 +81,7 @@ export function getExpandedHeightLimit(expandProps: ExpandProps) { return heightLimit; } -const getListBoxMaxHeight = (item: IListboxResource) => { +export const getListBoxMaxHeight = (item: IListboxResource) => { const { cardinal, dense, hasHeader, neverExpanded, } = item || {}; @@ -95,8 +95,6 @@ const getListBoxMaxHeight = (item: IListboxResource) => { return maxHeight; }; -export const getExpandedHeight = (item: IListboxResource) => getListBoxMaxHeight(item); - /** * Iterate through all items in the column and summarise the height of all * individual listboxes. @@ -112,7 +110,7 @@ export function estimateColumnHeight(column: IColumn) { totHeight += getListBoxMinHeight(item); } else if (expand || item.alwaysExpanded) { if (fullyExpanded) { - totHeight += getExpandedHeight(item); + totHeight += getListBoxMaxHeight(item); } else if (height) { const h = Number.parseFloat(height); totHeight += (h || getListBoxMinHeight(item)); diff --git a/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources.ts b/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources.ts index 1193fc05..73b83572 100644 --- a/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources.ts +++ b/packages/sn-filter-pane/src/components/ListboxGrid/distribute-resources.ts @@ -4,8 +4,8 @@ import { doAllFit, estimateColumnHeight, getDimensionCardinal, - getExpandedHeight, getExpandedHeightLimit, + getListBoxMaxHeight, getListBoxMinHeight, getMaxColumns, haveRoomToExpandOne, @@ -121,7 +121,7 @@ export function assignListboxesToColumns(columns: IColumn[], resources: IListbox const setFullyExpanded = (item: IListboxResource) => { item.fullyExpanded = true; - item.height = `${getExpandedHeight(item)}px`; + item.height = `${getListBoxMaxHeight(item)}px`; }; function expandUntilFull(sortedItems: IListboxResource[] | undefined, initialLeftOverHeight: number, lastItemIndex: number, isSingleGridLayout = false) { @@ -138,7 +138,7 @@ function expandUntilFull(sortedItems: IListboxResource[] | undefined, initialLef // 1. Calculate column height without the target item, then // 2. Subtract the target's expanded height to see if it fits. leftOverHeight = initialLeftOverHeight - estimateColumnHeight({ items: [...sortedItems.slice(0, i), ...sortedItems.slice(i + 1)] }); - expandedHeight = getExpandedHeight(item) + ITEM_SPACING; + expandedHeight = getListBoxMaxHeight(item) + ITEM_SPACING; itemFits = leftOverHeight >= expandedHeight; const isLastItem = i === lastItemIndex; item.fits = itemFits; diff --git a/packages/sn-filter-pane/src/components/ListboxGrid/grid-constants.ts b/packages/sn-filter-pane/src/components/ListboxGrid/grid-constants.ts index 0206a0aa..cfca0079 100644 --- a/packages/sn-filter-pane/src/components/ListboxGrid/grid-constants.ts +++ b/packages/sn-filter-pane/src/components/ListboxGrid/grid-constants.ts @@ -6,3 +6,5 @@ export const COLUMN_SPACING = 16; export const EXPANDED_HEADER_HEIGHT = 48; export const SINGLE_GRID_ROW_HEIGHT = 32; export const DEFAULT_CSS_HEIGHT = 'calc(100% - 2px)'; +export const LIST_ROW_HEIGHT = 29; +export const LIST_DENSE_ROW_HEIGHT = 20;