This commit broadens the search functionality within privacy.sexy by including documentation text in the search scope. Users can now find scripts and categories not only by their names but also by content in their documentation. This improvement aims to make the discovery of relevant scripts and information more intuitive and comprehensive. Key changes: - Documentation text is now searchable, enhancing the ability to discover scripts and categories based on content details. Other supporting changes: - Remove interface prefixes (`I`) from related interfaces to adhere to naming conventions, enhancing code readability. - Refactor filtering to separate actual filtering logic from filter state management, improving the structure for easier maintenance. - Improve test coverage to ensure relability of existing and new search capabilities. - Test coverage expanded to ensure the reliability of the new search capabilities.
168 lines
6.1 KiB
TypeScript
168 lines
6.1 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { UserSelectionStub } from '@tests/unit/shared/Stubs/UserSelectionStub';
|
|
import { CategoryCollectionState } from '@/application/Context/State/CategoryCollectionState';
|
|
import { OperatingSystem } from '@/domain/OperatingSystem';
|
|
import { CategoryCollectionStub } from '@tests/unit/shared/Stubs/CategoryCollectionStub';
|
|
import { ScriptingDefinitionStub } from '@tests/unit/shared/Stubs/ScriptingDefinitionStub';
|
|
import { ICategoryCollection } from '@/domain/ICategoryCollection';
|
|
import { ApplicationCodeStub } from '@tests/unit/shared/Stubs/ApplicationCodeStub';
|
|
import { IScriptingDefinition } from '@/domain/IScriptingDefinition';
|
|
import { expectExists } from '@tests/shared/Assertions/ExpectExists';
|
|
import { ReadonlyScriptSelection } from '@/application/Context/State/Selection/Script/ScriptSelection';
|
|
import { ScriptSelectionStub } from '@tests/unit/shared/Stubs/ScriptSelectionStub';
|
|
import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
|
|
import type { CodeFactory, FilterFactory, SelectionFactory } from '@/application/Context/State/CategoryCollectionState';
|
|
import { FilterContextStub } from '@tests/unit/shared/Stubs/FilterContextStub';
|
|
|
|
describe('CategoryCollectionState', () => {
|
|
describe('code', () => {
|
|
it('uses the correct scripting definition', () => {
|
|
// arrange
|
|
const expectedScripting = new ScriptingDefinitionStub();
|
|
const collection = new CategoryCollectionStub()
|
|
.withScripting(expectedScripting);
|
|
let actualScripting: IScriptingDefinition | undefined;
|
|
const codeFactoryMock: CodeFactory = (_, scripting) => {
|
|
actualScripting = scripting;
|
|
return new ApplicationCodeStub();
|
|
};
|
|
// act
|
|
new CategoryCollectionStateBuilder()
|
|
.withCollection(collection)
|
|
.withCodeFactory(codeFactoryMock)
|
|
.build();
|
|
// assert
|
|
expectExists(actualScripting);
|
|
expect(actualScripting).to.equal(expectedScripting);
|
|
});
|
|
it('initializes with the expected script selection', () => {
|
|
// arrange
|
|
const expectedScriptSelection = new ScriptSelectionStub();
|
|
const selectionFactoryMock: SelectionFactory = () => {
|
|
return new UserSelectionStub().withScripts(expectedScriptSelection);
|
|
};
|
|
let actualScriptSelection: ReadonlyScriptSelection | undefined;
|
|
const codeFactoryMock: CodeFactory = (scriptSelection) => {
|
|
actualScriptSelection = scriptSelection;
|
|
return new ApplicationCodeStub();
|
|
};
|
|
// act
|
|
new CategoryCollectionStateBuilder()
|
|
.withCodeFactory(codeFactoryMock)
|
|
.withSelectionFactory(selectionFactoryMock)
|
|
.build();
|
|
// assert
|
|
expectExists(actualScriptSelection);
|
|
expect(actualScriptSelection).to.equal(expectedScriptSelection);
|
|
});
|
|
});
|
|
describe('os', () => {
|
|
it('matches the operating system of the collection', () => {
|
|
// arrange
|
|
const expected = OperatingSystem.macOS;
|
|
const collection = new CategoryCollectionStub()
|
|
.withOs(expected);
|
|
// act
|
|
const sut = new CategoryCollectionStateBuilder()
|
|
.withCollection(collection)
|
|
.build();
|
|
// assert
|
|
const actual = sut.os;
|
|
expect(expected).to.equal(actual);
|
|
});
|
|
});
|
|
describe('selection', () => {
|
|
it('initializes with empty scripts', () => {
|
|
// arrange
|
|
const expectedScripts = [];
|
|
let actualScripts: readonly SelectedScript[] | undefined;
|
|
const selectionFactoryMock: SelectionFactory = (_, scripts) => {
|
|
actualScripts = scripts;
|
|
return new UserSelectionStub();
|
|
};
|
|
// act
|
|
new CategoryCollectionStateBuilder()
|
|
.withSelectionFactory(selectionFactoryMock)
|
|
.build();
|
|
// assert
|
|
expectExists(actualScripts);
|
|
expect(actualScripts).to.deep.equal(expectedScripts);
|
|
});
|
|
it('initializes with the provided collection', () => {
|
|
// arrange
|
|
const expectedCollection = new CategoryCollectionStub();
|
|
let actualCollection: ICategoryCollection | undefined;
|
|
const selectionFactoryMock: SelectionFactory = (collection) => {
|
|
actualCollection = collection;
|
|
return new UserSelectionStub();
|
|
};
|
|
// act
|
|
new CategoryCollectionStateBuilder()
|
|
.withCollection(expectedCollection)
|
|
.withSelectionFactory(selectionFactoryMock)
|
|
.build();
|
|
// assert
|
|
expectExists(actualCollection);
|
|
expect(actualCollection).to.equal(expectedCollection);
|
|
});
|
|
});
|
|
describe('filter', () => {
|
|
it('initializes with the provided collection for filtering', () => {
|
|
// arrange
|
|
const expectedCollection = new CategoryCollectionStub();
|
|
let actualCollection: ICategoryCollection | undefined;
|
|
const filterFactoryMock: FilterFactory = (collection) => {
|
|
actualCollection = collection;
|
|
return new FilterContextStub();
|
|
};
|
|
// act
|
|
new CategoryCollectionStateBuilder()
|
|
.withCollection(expectedCollection)
|
|
.withFilterFactory(filterFactoryMock)
|
|
.build();
|
|
// assert
|
|
expectExists(expectedCollection);
|
|
expect(expectedCollection).to.equal(actualCollection);
|
|
});
|
|
});
|
|
});
|
|
|
|
class CategoryCollectionStateBuilder {
|
|
private collection: ICategoryCollection = new CategoryCollectionStub();
|
|
|
|
private codeFactory: CodeFactory = () => new ApplicationCodeStub();
|
|
|
|
private selectionFactory: SelectionFactory = () => new UserSelectionStub();
|
|
|
|
private filterFactory: FilterFactory = () => new FilterContextStub();
|
|
|
|
public withCollection(collection: ICategoryCollection): this {
|
|
this.collection = collection;
|
|
return this;
|
|
}
|
|
|
|
public withCodeFactory(codeFactory: CodeFactory): this {
|
|
this.codeFactory = codeFactory;
|
|
return this;
|
|
}
|
|
|
|
public withSelectionFactory(selectionFactory: SelectionFactory): this {
|
|
this.selectionFactory = selectionFactory;
|
|
return this;
|
|
}
|
|
|
|
public withFilterFactory(filterFactory: FilterFactory): this {
|
|
this.filterFactory = filterFactory;
|
|
return this;
|
|
}
|
|
|
|
public build() {
|
|
return new CategoryCollectionState(
|
|
this.collection,
|
|
this.selectionFactory,
|
|
this.codeFactory,
|
|
this.filterFactory,
|
|
);
|
|
}
|
|
}
|