Key highlights: - Written from scratch to cater specifically to privacy.sexy's needs and requirements. - The visual look mimics the previous component with minimal changes, but its internal code is completely rewritten. - Lays groundwork for future functionalities like the "expand all" button a flat view mode as discussed in #158. - Facilitates the transition to Vue 3 by omitting the Vue 2.0 dependent `liquour-tree` as part of #230. Improvements and features: - Caching for quicker node queries. - Gradual rendering of nodes that introduces a noticable boost in performance, particularly during search/filtering. - `TreeView` solely governs the check states of branch nodes. Changes: - Keyboard interactions now alter the background color to highlight the focused item. Previously, it was changing the color of the text. - Better state management with clear separation of concerns: - `TreeView` exclusively manages indeterminate states. - `TreeView` solely governs the check states of branch nodes. - Introduce transaction pattern to update state in batches to minimize amount of events handled. - Improve keyboard focus, style background instead of foreground. Use hover/touch color on keyboard focus. - `SelectableTree` has been removed. Instead, `TreeView` is now directly integrated with `ScriptsTree`. - `ScriptsTree` has been refactored to incorporate hooks for clearer code and separation of duties. - Adopt Vue-idiomatic bindings instead of keeping a reference of the tree component. - Simplify and change filter event management. - Abandon global styles in favor of class-scoped styles. - Use global mixins with descriptive names to clarify indended functionality.
195 lines
8.4 KiB
TypeScript
195 lines
8.4 KiB
TypeScript
import { shallowMount } from '@vue/test-utils';
|
|
import { describe, it, expect } from 'vitest';
|
|
import { TreeNodeStateChangedEmittedEvent } from '@/presentation/components/Scripts/View/Tree/TreeView/Bindings/TreeNodeStateChangedEmittedEvent';
|
|
import { useCollectionSelectionStateUpdater } from '@/presentation/components/Scripts/View/Tree/TreeViewAdapter/UseCollectionSelectionStateUpdater';
|
|
import { InjectionKeys } from '@/presentation/injectionSymbols';
|
|
import { HierarchyAccessStub } from '@tests/unit/shared/Stubs/HierarchyAccessStub';
|
|
import { TreeNodeStateAccessStub } from '@tests/unit/shared/Stubs/TreeNodeStateAccessStub';
|
|
import { TreeNodeStub } from '@tests/unit/shared/Stubs/TreeNodeStub';
|
|
import { UseCollectionStateStub } from '@tests/unit/shared/Stubs/UseCollectionStateStub';
|
|
import { TreeNodeStateDescriptorStub } from '@tests/unit/shared/Stubs/TreeNodeStateDescriptorStub';
|
|
import { TreeNodeCheckState } from '@/presentation/components/Scripts/View/Tree/TreeView/Node/State/CheckState';
|
|
import { NodeStateChangedEventStub } from '@tests/unit/shared/Stubs/NodeStateChangedEventStub';
|
|
import { CategoryCollectionStateStub } from '@tests/unit/shared/Stubs/CategoryCollectionStateStub';
|
|
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
|
|
|
describe('useCollectionSelectionStateUpdater', () => {
|
|
describe('updateNodeSelection', () => {
|
|
describe('when node is a branch node', () => {
|
|
it('does nothing', () => {
|
|
// arrange
|
|
const { returnObject, useStateStub } = mountWrapperComponent();
|
|
const mockEvent: TreeNodeStateChangedEmittedEvent = {
|
|
node: createTreeNodeStub({
|
|
isBranch: true,
|
|
currentState: TreeNodeCheckState.Checked,
|
|
}),
|
|
change: new NodeStateChangedEventStub().withCheckStateChange({
|
|
oldState: TreeNodeCheckState.Checked,
|
|
newState: TreeNodeCheckState.Unchecked,
|
|
}),
|
|
};
|
|
// act
|
|
returnObject.updateNodeSelection(mockEvent);
|
|
// assert
|
|
const modifyCall = useStateStub.callHistory.find((call) => call.methodName === 'modifyCurrentState');
|
|
expect(modifyCall).toBeUndefined();
|
|
});
|
|
});
|
|
describe('when old and new check states are the same', () => {
|
|
it('does nothing', () => {
|
|
// arrange
|
|
const { returnObject, useStateStub } = mountWrapperComponent();
|
|
const mockEvent: TreeNodeStateChangedEmittedEvent = {
|
|
node: createTreeNodeStub({
|
|
isBranch: false,
|
|
currentState: TreeNodeCheckState.Checked,
|
|
}),
|
|
change: new NodeStateChangedEventStub().withCheckStateChange({
|
|
oldState: TreeNodeCheckState.Checked,
|
|
newState: TreeNodeCheckState.Checked,
|
|
}),
|
|
};
|
|
// act
|
|
returnObject.updateNodeSelection(mockEvent);
|
|
// assert
|
|
const modifyCall = useStateStub.callHistory.find((call) => call.methodName === 'modifyCurrentState');
|
|
expect(modifyCall).toBeUndefined();
|
|
});
|
|
});
|
|
describe('when checkState is checked', () => {
|
|
it('adds to selection if not already selected', () => {
|
|
// arrange
|
|
const { returnObject, useStateStub } = mountWrapperComponent();
|
|
const selectionStub = new UserSelectionStub([]);
|
|
selectionStub.isSelected = () => false;
|
|
useStateStub.withState(new CategoryCollectionStateStub().withSelection(selectionStub));
|
|
const mockEvent: TreeNodeStateChangedEmittedEvent = {
|
|
node: new TreeNodeStub()
|
|
.withHierarchy(new HierarchyAccessStub().withIsBranchNode(false))
|
|
.withState(new TreeNodeStateAccessStub().withCurrent(
|
|
new TreeNodeStateDescriptorStub().withCheckState(
|
|
TreeNodeCheckState.Checked,
|
|
),
|
|
)),
|
|
change: new NodeStateChangedEventStub().withCheckStateChange({
|
|
oldState: TreeNodeCheckState.Unchecked,
|
|
newState: TreeNodeCheckState.Checked,
|
|
}),
|
|
};
|
|
// act
|
|
returnObject.updateNodeSelection(mockEvent);
|
|
// assert
|
|
const modifyCall = useStateStub.callHistory.find((call) => call.methodName === 'modifyCurrentState');
|
|
expect(modifyCall).toBeDefined();
|
|
const addSelectedScriptCall = selectionStub.callHistory.find((call) => call.methodName === 'addSelectedScript');
|
|
expect(addSelectedScriptCall).toBeDefined();
|
|
});
|
|
it('does nothing if already selected', () => {
|
|
// arrange
|
|
const { returnObject, useStateStub } = mountWrapperComponent();
|
|
const selectionStub = new UserSelectionStub([]);
|
|
selectionStub.isSelected = () => true;
|
|
useStateStub.withState(new CategoryCollectionStateStub().withSelection(selectionStub));
|
|
const mockEvent: TreeNodeStateChangedEmittedEvent = {
|
|
node: createTreeNodeStub({
|
|
isBranch: false,
|
|
currentState: TreeNodeCheckState.Checked,
|
|
}),
|
|
change: new NodeStateChangedEventStub().withCheckStateChange({
|
|
oldState: TreeNodeCheckState.Unchecked,
|
|
newState: TreeNodeCheckState.Checked,
|
|
}),
|
|
};
|
|
// act
|
|
returnObject.updateNodeSelection(mockEvent);
|
|
// assert
|
|
const modifyCall = useStateStub.callHistory.find((call) => call.methodName === 'modifyCurrentState');
|
|
expect(modifyCall).toBeUndefined();
|
|
});
|
|
});
|
|
describe('when checkState is unchecked', () => {
|
|
it('removes from selection if already selected', () => {
|
|
// arrange
|
|
const { returnObject, useStateStub } = mountWrapperComponent();
|
|
const selectionStub = new UserSelectionStub([]);
|
|
selectionStub.isSelected = () => true;
|
|
useStateStub.withState(new CategoryCollectionStateStub().withSelection(selectionStub));
|
|
const mockEvent: TreeNodeStateChangedEmittedEvent = {
|
|
node: createTreeNodeStub({
|
|
isBranch: false,
|
|
currentState: TreeNodeCheckState.Unchecked,
|
|
}),
|
|
change: new NodeStateChangedEventStub().withCheckStateChange({
|
|
oldState: TreeNodeCheckState.Checked,
|
|
newState: TreeNodeCheckState.Unchecked,
|
|
}),
|
|
};
|
|
// act
|
|
returnObject.updateNodeSelection(mockEvent);
|
|
// assert
|
|
const modifyCall = useStateStub.callHistory.find((call) => call.methodName === 'modifyCurrentState');
|
|
expect(modifyCall).toBeDefined();
|
|
const removeSelectedScriptCall = selectionStub.callHistory.find((call) => call.methodName === 'removeSelectedScript');
|
|
expect(removeSelectedScriptCall).toBeDefined();
|
|
});
|
|
it('does nothing if not already selected', () => {
|
|
// arrange
|
|
const { returnObject, useStateStub } = mountWrapperComponent();
|
|
const selectionStub = new UserSelectionStub([]);
|
|
selectionStub.isSelected = () => false;
|
|
useStateStub.withState(new CategoryCollectionStateStub().withSelection(selectionStub));
|
|
const mockEvent: TreeNodeStateChangedEmittedEvent = {
|
|
node: createTreeNodeStub({
|
|
isBranch: false,
|
|
currentState: TreeNodeCheckState.Unchecked,
|
|
}),
|
|
change: new NodeStateChangedEventStub().withCheckStateChange({
|
|
oldState: TreeNodeCheckState.Checked,
|
|
newState: TreeNodeCheckState.Unchecked,
|
|
}),
|
|
};
|
|
// act
|
|
returnObject.updateNodeSelection(mockEvent);
|
|
// assert
|
|
const modifyCall = useStateStub.callHistory.find((call) => call.methodName === 'modifyCurrentState');
|
|
expect(modifyCall).toBeUndefined();
|
|
});
|
|
});
|
|
});
|
|
});
|
|
|
|
function mountWrapperComponent() {
|
|
const useStateStub = new UseCollectionStateStub();
|
|
let returnObject: ReturnType<typeof useCollectionSelectionStateUpdater>;
|
|
|
|
shallowMount({
|
|
setup() {
|
|
returnObject = useCollectionSelectionStateUpdater();
|
|
},
|
|
template: '<div></div>',
|
|
}, {
|
|
provide: {
|
|
[InjectionKeys.useCollectionState as symbol]: () => useStateStub.get(),
|
|
},
|
|
});
|
|
|
|
return {
|
|
returnObject,
|
|
useStateStub,
|
|
};
|
|
}
|
|
|
|
function createTreeNodeStub(scenario: {
|
|
readonly isBranch: boolean,
|
|
readonly currentState: TreeNodeCheckState,
|
|
}) {
|
|
return new TreeNodeStub()
|
|
.withHierarchy(new HierarchyAccessStub().withIsBranchNode(scenario.isBranch))
|
|
.withState(new TreeNodeStateAccessStub().withCurrent(
|
|
new TreeNodeStateDescriptorStub().withCheckState(
|
|
scenario.currentState,
|
|
),
|
|
));
|
|
}
|