Implement custom lightweight modal #230

Introduce a brand new lightweight and efficient modal component. It is
designed to be visually similar to the previous one to not introduce a
change in feel of the application in a patch release, but behind the
scenes it features:

- Enhanced application speed and reduced bundle size.
- New flexbox-driven layout, eliminating JS calculations.
- Composition API ready for Vue 3.0 #230.

Other changes:

- Adopt idiomatic Vue via `v-modal` binding.
- Add unit tests for both the modal and dialog.
- Remove `vue-js-modal` dependency in favor of the new implementation.
- Adjust modal shadow color to better match theme.
- Add `@vue/test-utils` for unit testing.
This commit is contained in:
undergroundwires
2023-08-11 19:35:26 +02:00
parent 986ba078a6
commit 9e5491fdbf
28 changed files with 2126 additions and 171 deletions

View File

@@ -0,0 +1,164 @@
import 'mocha';
import { ref, nextTick } from 'vue';
import { expect } from 'chai';
import { useAllTrueWatcher } from '@/presentation/components/Shared/Modal/Hooks/UseAllTrueWatcher';
describe('useAllTrueWatcher', () => {
describe('onAllConditionsMet', () => {
it('triggers the callback when all conditions turn true', async () => {
// arrange
const condition1 = ref(false);
const condition2 = ref(false);
const { onAllConditionsMet } = useAllTrueWatcher(condition1, condition2);
let callbackCalled = false;
// act
onAllConditionsMet(() => {
callbackCalled = true;
});
condition1.value = true;
condition2.value = true;
await nextTick();
// assert
expect(callbackCalled).to.equal(true);
});
it('instantly triggers the callback if conditions are true on callback registration', async () => {
// arrange
const condition1 = ref(true);
const condition2 = ref(true);
const { onAllConditionsMet } = useAllTrueWatcher(condition1, condition2);
let callbackCalled = false;
// act
onAllConditionsMet(() => {
callbackCalled = true;
});
await nextTick();
// assert
expect(callbackCalled).to.equal(true);
});
it('does not trigger the callback unless all conditions are met', async () => {
// arrange
const condition1 = ref(true);
const condition2 = ref(false);
const { onAllConditionsMet } = useAllTrueWatcher(condition1, condition2);
let callbackCalled = false;
// act
onAllConditionsMet(() => {
callbackCalled = true;
});
await nextTick();
// assert
expect(callbackCalled).to.be.equal(false);
});
it('triggers all registered callbacks once all conditions are satisfied', async () => {
// arrange
const condition1 = ref(false);
const condition2 = ref(false);
const { onAllConditionsMet } = useAllTrueWatcher(condition1, condition2);
let callbackCount = 0;
// act
onAllConditionsMet(() => callbackCount++);
onAllConditionsMet(() => callbackCount++);
condition1.value = true;
condition2.value = true;
await nextTick();
// assert
expect(callbackCount).to.equal(2);
});
it('ensures each callback is invoked only once for a single condition set', async () => {
// arrange
const condition1 = ref(false);
const condition2 = ref(false);
const { onAllConditionsMet } = useAllTrueWatcher(condition1, condition2);
let callbackCount = 0;
// act
onAllConditionsMet(() => callbackCount++);
condition1.value = true;
condition2.value = true;
condition1.value = false;
condition1.value = true;
await nextTick();
// assert
expect(callbackCount).to.equal(1);
});
it('triggers the callback after conditions are sequentially met post-reset', async () => {
// arrange
const condition1 = ref(false);
const condition2 = ref(false);
const { onAllConditionsMet, resetAllConditions } = useAllTrueWatcher(condition1, condition2);
let callbackCalled = false;
// act
onAllConditionsMet(() => {
callbackCalled = true;
});
condition1.value = true;
resetAllConditions();
condition1.value = true;
condition2.value = true;
await nextTick();
// assert
expect(callbackCalled).to.equal(true);
});
it('avoids triggering the callback for single condition post-reset', async () => {
// arrange
const condition1 = ref(false);
const condition2 = ref(false);
const { onAllConditionsMet, resetAllConditions } = useAllTrueWatcher(condition1, condition2);
let callbackCalled = false;
// act
condition1.value = true;
condition2.value = true;
resetAllConditions();
onAllConditionsMet(() => {
callbackCalled = true;
});
condition1.value = true;
await nextTick();
// assert
expect(callbackCalled).to.equal(false);
});
});
describe('resetAllConditions', () => {
it('returns all conditions to their default false state', async () => {
// arrange
const condition1 = ref(true);
const condition2 = ref(true);
const { resetAllConditions } = useAllTrueWatcher(condition1, condition2);
// act
resetAllConditions();
await nextTick();
// assert
expect(condition1.value).to.be.equal(false);
expect(condition2.value).to.be.equal(false);
});
});
});