Extend search by including documentation content
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.
This commit is contained in:
@@ -16,7 +16,7 @@
|
||||
<script lang="ts">
|
||||
import { defineComponent, ref } from 'vue';
|
||||
import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import { IReadOnlyUserFilter } from '@/application/Context/State/Filter/IUserFilter';
|
||||
import { ReadonlyFilterContext } from '@/application/Context/State/Filter/FilterContext';
|
||||
import { IEventSubscription } from '@/infrastructure/Events/IEventSource';
|
||||
import TheOsChanger from './TheOsChanger.vue';
|
||||
import TheViewChanger from './View/TheViewChanger.vue';
|
||||
@@ -49,7 +49,7 @@ export default defineComponent({
|
||||
}, { immediate: true });
|
||||
|
||||
function subscribeToFilterChanges(
|
||||
filter: IReadOnlyUserFilter,
|
||||
filter: ReadonlyFilterContext,
|
||||
): IEventSubscription {
|
||||
return filter.filterChanged.on((event) => {
|
||||
event.visit({
|
||||
|
||||
@@ -43,8 +43,8 @@ import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import ScriptsTree from '@/presentation/components/Scripts/View/Tree/ScriptsTree.vue';
|
||||
import CardList from '@/presentation/components/Scripts/View/Cards/CardList.vue';
|
||||
import { ViewType } from '@/presentation/components/Scripts/Menu/View/ViewType';
|
||||
import { IReadOnlyUserFilter } from '@/application/Context/State/Filter/IUserFilter';
|
||||
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
||||
import { ReadonlyFilterContext } from '@/application/Context/State/Filter/FilterContext';
|
||||
import { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
|
||||
import FlatButton from '@/presentation/components/Shared/FlatButton.vue';
|
||||
|
||||
export default defineComponent({
|
||||
@@ -94,12 +94,12 @@ export default defineComponent({
|
||||
});
|
||||
}
|
||||
|
||||
function updateFromInitialFilter(filter?: IFilterResult) {
|
||||
function updateFromInitialFilter(filter?: FilterResult) {
|
||||
searchQuery.value = filter?.query;
|
||||
searchHasMatches.value = filter?.hasAnyMatches() ?? false;
|
||||
}
|
||||
|
||||
function subscribeToFilterChanges(filter: IReadOnlyUserFilter) {
|
||||
function subscribeToFilterChanges(filter: ReadonlyFilterContext) {
|
||||
return filter.filterChanged.on((event) => {
|
||||
event.visit({
|
||||
onApply: (newFilter) => {
|
||||
|
||||
@@ -4,8 +4,8 @@ import {
|
||||
import { IScript } from '@/domain/IScript';
|
||||
import { ICategory } from '@/domain/ICategory';
|
||||
import { injectKey } from '@/presentation/injectionSymbols';
|
||||
import { IReadOnlyUserFilter } from '@/application/Context/State/Filter/IUserFilter';
|
||||
import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
|
||||
import { ReadonlyFilterContext } from '@/application/Context/State/Filter/FilterContext';
|
||||
import { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
|
||||
import { TreeViewFilterEvent, createFilterRemovedEvent, createFilterTriggeredEvent } from '../TreeView/Bindings/TreeInputFilterEvent';
|
||||
import { NodeMetadata } from '../NodeContent/NodeMetadata';
|
||||
import { ReadOnlyTreeNode } from '../TreeView/Node/TreeNode';
|
||||
@@ -14,7 +14,7 @@ import { getCategoryNodeId, getScriptNodeId } from './CategoryNodeMetadataConver
|
||||
|
||||
type TreeNodeFilterResultPredicate = (
|
||||
node: ReadOnlyTreeNode,
|
||||
filterResult: IFilterResult,
|
||||
filterResult: FilterResult,
|
||||
) => boolean;
|
||||
|
||||
export function useTreeViewFilterEvent() {
|
||||
@@ -41,7 +41,7 @@ export function useTreeViewFilterEvent() {
|
||||
}
|
||||
|
||||
function subscribeToFilterChanges(
|
||||
filter: IReadOnlyUserFilter,
|
||||
filter: ReadonlyFilterContext,
|
||||
latestFilterEvent: Ref<TreeViewFilterEvent | undefined>,
|
||||
filterPredicate: TreeNodeFilterResultPredicate,
|
||||
) {
|
||||
@@ -60,7 +60,7 @@ function subscribeToFilterChanges(
|
||||
}
|
||||
|
||||
function createFilterEvent(
|
||||
filter: IFilterResult | undefined,
|
||||
filter: FilterResult | undefined,
|
||||
filterPredicate: TreeNodeFilterResultPredicate,
|
||||
): TreeViewFilterEvent {
|
||||
if (!filter) {
|
||||
@@ -71,7 +71,7 @@ function createFilterEvent(
|
||||
);
|
||||
}
|
||||
|
||||
function filterMatches(node: NodeMetadata, filter: IFilterResult): boolean {
|
||||
function filterMatches(node: NodeMetadata, filter: FilterResult): boolean {
|
||||
return containsScript(node, filter.scriptMatches)
|
||||
|| containsCategory(node, filter.categoryMatches);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user