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.

tests/unit/shared/Stubs/CategoryCollectionStateStub.ts

@@ -1,5 +1,4 @@
 import { IApplicationCode } from '@/application/Context/State/Code/IApplicationCode';
-import { IUserFilter } from '@/application/Context/State/Filter/IUserFilter';
 import { ICategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
 import { OperatingSystem } from '@/domain/OperatingSystem';
 import { IScript } from '@/domain/IScript';
@@ -7,9 +6,10 @@ import { ScriptStub } from '@tests/unit/shared/Stubs/ScriptStub';
 import { ICategoryCollection } from '@/domain/ICategoryCollection';
 import { UserSelection } from '@/application/Context/State/Selection/UserSelection';
 import { SelectedScript } from '@/application/Context/State/Selection/Script/SelectedScript';
+import { FilterContext } from '@/application/Context/State/Filter/FilterContext';
 import { CategoryCollectionStub } from './CategoryCollectionStub';
 import { UserSelectionStub } from './UserSelectionStub';
-import { UserFilterStub } from './UserFilterStub';
+import { FilterContextStub } from './FilterContextStub';
 import { ApplicationCodeStub } from './ApplicationCodeStub';
 import { CategoryStub } from './CategoryStub';
 import { ScriptSelectionStub } from './ScriptSelectionStub';
@@ -17,7 +17,7 @@ import { ScriptSelectionStub } from './ScriptSelectionStub';
 export class CategoryCollectionStateStub implements ICategoryCollectionState {
   public code: IApplicationCode = new ApplicationCodeStub();
 
-  public filter: IUserFilter = new UserFilterStub();
+  public filter: FilterContext = new FilterContextStub();
 
   public get os(): OperatingSystem {
     return this.collection.os;
@@ -55,7 +55,7 @@ export class CategoryCollectionStateStub implements ICategoryCollectionState {
     return this;
   }
 
-  public withFilter(filter: IUserFilter): this {
+  public withFilter(filter: FilterContext): this {
     this.filter = filter;
     return this;
   }
@@ -69,7 +69,7 @@ export class CategoryCollectionStateStub implements ICategoryCollectionState {
     );
   }
 
-  public withSelection(selection: UserSelection) {
+  public withSelection(selection: UserSelection): this {
     this.selection = selection;
     return this;
   }

tests/unit/shared/Stubs/CategoryStub.ts

@@ -10,7 +10,7 @@ export class CategoryStub extends BaseEntity<number> implements ICategory {
 
   public readonly scripts = new Array<IScript>();
 
-  public readonly docs = new Array<string>();
+  public docs: readonly string[] = new Array<string>();
 
   private allScriptsRecursively: (readonly IScript[]) | undefined;
 
@@ -82,4 +82,9 @@ export class CategoryStub extends BaseEntity<number> implements ICategory {
     this.name = categoryName;
     return this;
   }
+
+  public withDocs(docs: readonly string[]): this {
+    this.docs = docs;
+    return this;
+  }
 }

tests/unit/shared/Stubs/FilterChangeDetailsStub.ts

@@ -1,9 +1,9 @@
 import { FilterActionType } from '@/application/Context/State/Filter/Event/FilterActionType';
-import { FilterAction, IFilterChangeDetails, IFilterChangeDetailsVisitor } from '@/application/Context/State/Filter/Event/IFilterChangeDetails';
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
+import type { FilterAction, FilterChangeDetails, FilterChangeDetailsVisitor } from '@/application/Context/State/Filter/Event/FilterChangeDetails';
+import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
 
-export class FilterChangeDetailsStub implements IFilterChangeDetails {
-  public static forApply(filter: IFilterResult) {
+export class FilterChangeDetailsStub implements FilterChangeDetails {
+  public static forApply(filter: FilterResult) {
     return new FilterChangeDetailsStub({
       type: FilterActionType.Apply,
       filter,
@@ -20,7 +20,7 @@ export class FilterChangeDetailsStub implements IFilterChangeDetails {
     public readonly action: FilterAction,
   ) { /* Private constructor to enforce factory methods */ }
 
-  visit(visitor: IFilterChangeDetailsVisitor): void {
+  visit(visitor: FilterChangeDetailsVisitor): void {
     if (this.action.type === FilterActionType.Apply) {
       if (visitor.onApply) {
         visitor.onApply(this.action.filter);

tests/unit/shared/Stubs/FilterChangeDetailsVisitorStub.ts

@@ -1,18 +1,21 @@
-import { FilterActionType } from '@/application/Context/State/Filter/Event/FilterActionType';
-import { IFilterChangeDetailsVisitor } from '@/application/Context/State/Filter/Event/IFilterChangeDetails';
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
+import type { FilterChangeDetailsVisitor } from '@/application/Context/State/Filter/Event/FilterChangeDetails';
+import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
+import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
 
-export class FilterChangeDetailsVisitorStub implements IFilterChangeDetailsVisitor {
-  public readonly visitedEvents = new Array<FilterActionType>();
-
-  public readonly visitedResults = new Array<IFilterResult>();
-
-  onClear(): void {
-    this.visitedEvents.push(FilterActionType.Clear);
+export class FilterChangeDetailsVisitorStub
+  extends StubWithObservableMethodCalls<Required<FilterChangeDetailsVisitor>>
+  implements FilterChangeDetailsVisitor {
+  public onClear(): void {
+    this.registerMethodCall({
+      methodName: 'onClear',
+      args: [],
+    });
   }
 
-  onApply(filter: IFilterResult): void {
-    this.visitedEvents.push(FilterActionType.Apply);
-    this.visitedResults.push(filter);
+  public onApply(filter: FilterResult): void {
+    this.registerMethodCall({
+      methodName: 'onApply',
+      args: [filter],
+    });
   }
 }

tests/unit/shared/Stubs/FilterContextStub.ts

@@ -0,0 +1,55 @@
+import { FilterContext } from '@/application/Context/State/Filter/FilterContext';
+import { IEventSource } from '@/infrastructure/Events/IEventSource';
+import { FilterChangeDetails } from '@/application/Context/State/Filter/Event/FilterChangeDetails';
+import { FilterActionType } from '@/application/Context/State/Filter/Event/FilterActionType';
+import { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
+import { FilterResultStub } from './FilterResultStub';
+import { EventSourceStub } from './EventSourceStub';
+import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
+
+export enum FilterMethod {
+  ApplyFilter,
+  ClearFilter,
+}
+
+export class FilterContextStub
+  extends StubWithObservableMethodCalls<FilterContext>
+  implements FilterContext {
+  private readonly filterChangedSource = new EventSourceStub<FilterChangeDetails>();
+
+  public currentFilter: FilterResult | undefined = new FilterResultStub();
+
+  public filterChanged: IEventSource<FilterChangeDetails> = this.filterChangedSource;
+
+  public notifyFilterChange(change: FilterChangeDetails): void {
+    this.filterChangedSource.notify(change);
+    if (change.action.type === FilterActionType.Apply) {
+      this.currentFilter = change.action.filter;
+    } else {
+      this.currentFilter = undefined;
+    }
+  }
+
+  public withNoCurrentFilter(): this {
+    return this.withCurrentFilter(undefined);
+  }
+
+  public withCurrentFilter(filter: FilterResult | undefined): this {
+    this.currentFilter = filter;
+    return this;
+  }
+
+  public applyFilter(...args: Parameters<FilterContext['applyFilter']>): void {
+    this.registerMethodCall({
+      methodName: 'applyFilter',
+      args: [...args],
+    });
+  }
+
+  public clearFilter(): void {
+    this.registerMethodCall({
+      methodName: 'clearFilter',
+      args: [],
+    });
+  }
+}

tests/unit/shared/Stubs/FilterResultStub.ts

@@ -1,10 +1,10 @@
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
-import { ICategory } from '@/domain/ICategory';
-import { IScript } from '@/domain/IScript';
+import type { ICategory } from '@/domain/ICategory';
+import type { IScript } from '@/domain/IScript';
+import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
 import { CategoryStub } from './CategoryStub';
 import { ScriptStub } from './ScriptStub';
 
-export class FilterResultStub implements IFilterResult {
+export class FilterResultStub implements FilterResult {
   public categoryMatches: readonly ICategory[] = [];
 
   public scriptMatches: readonly IScript[] = [];

tests/unit/shared/Stubs/FilterStrategyStub.ts

@@ -0,0 +1,24 @@
+import { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
+import { FilterStrategy } from '@/application/Context/State/Filter/Strategy/FilterStrategy';
+import { ICategoryCollection } from '@/domain/ICategoryCollection';
+import { FilterResultStub } from './FilterResultStub';
+import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
+
+export class FilterStrategyStub
+  extends StubWithObservableMethodCalls<FilterStrategy>
+  implements FilterStrategy {
+  private predeterminedResult: FilterResult = new FilterResultStub();
+
+  public applyFilter(filter: string, collection: ICategoryCollection): FilterResult {
+    this.registerMethodCall({
+      methodName: 'applyFilter',
+      args: [filter, collection],
+    });
+    return this.predeterminedResult;
+  }
+
+  public withApplyFilterResult(predeterminedResult: FilterResult): this {
+    this.predeterminedResult = predeterminedResult;
+    return this;
+  }
+}

tests/unit/shared/Stubs/ScriptStub.ts

@@ -12,7 +12,7 @@ export class ScriptStub extends BaseEntity<string> implements IScript {
     revert: `REM revert-code (${this.id})`,
   };
 
-  public readonly docs = new Array<string>();
+  public docs: readonly string[] = new Array<string>();
 
   public level? = RecommendationLevel.Standard;
 
@@ -60,6 +60,11 @@ export class ScriptStub extends BaseEntity<string> implements IScript {
     return this;
   }
 
+  public withDocs(docs: readonly string[]): this {
+    this.docs = docs;
+    return this;
+  }
+
   public toSelectedScript(): SelectedScriptStub {
     return new SelectedScriptStub(this);
   }

tests/unit/shared/Stubs/UseCollectionStateStub.ts

@@ -4,12 +4,12 @@ import {
   StateModifier, useCollectionState,
 } from '@/presentation/components/Shared/Hooks/UseCollectionState';
 import { ICategoryCollectionState } from '@/application/Context/State/ICategoryCollectionState';
-import { IUserFilter } from '@/application/Context/State/Filter/IUserFilter';
+import { FilterContext } from '@/application/Context/State/Filter/FilterContext';
 import { IApplicationContext } from '@/application/Context/IApplicationContext';
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
+import { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult';
 import { CategoryCollectionStateStub } from './CategoryCollectionStateStub';
 import { ApplicationContextStub } from './ApplicationContextStub';
-import { UserFilterStub } from './UserFilterStub';
+import { FilterContextStub } from './FilterContextStub';
 import { StubWithObservableMethodCalls } from './StubWithObservableMethodCalls';
 
 export class UseCollectionStateStub
@@ -20,7 +20,7 @@ export class UseCollectionStateStub
     new CategoryCollectionStateStub(),
   );
 
-  public withFilter(filter: IUserFilter) {
+  public withFilter(filter: FilterContext) {
     const state = new CategoryCollectionStateStub()
       .withFilter(filter);
     const context = new ApplicationContextStub()
@@ -30,9 +30,9 @@ export class UseCollectionStateStub
       .withContext(context);
   }
 
-  public withFilterResult(filterResult: IFilterResult | undefined) {
-    const filter = new UserFilterStub()
-      .withCurrentFilterResult(filterResult);
+  public withFilterResult(filterResult: FilterResult | undefined) {
+    const filter = new FilterContextStub()
+      .withCurrentFilter(filterResult);
     return this.withFilter(filter);
   }
 

tests/unit/shared/Stubs/UserFilterStub.ts

@@ -1,48 +0,0 @@
-import { IFilterResult } from '@/application/Context/State/Filter/IFilterResult';
-import { IUserFilter } from '@/application/Context/State/Filter/IUserFilter';
-import { IEventSource } from '@/infrastructure/Events/IEventSource';
-import { IFilterChangeDetails } from '@/application/Context/State/Filter/Event/IFilterChangeDetails';
-import { FilterActionType } from '@/application/Context/State/Filter/Event/FilterActionType';
-import { FilterResultStub } from './FilterResultStub';
-import { EventSourceStub } from './EventSourceStub';
-
-export enum UserFilterMethod {
-  ApplyFilter,
-  ClearFilter,
-}
-
-export class UserFilterStub implements IUserFilter {
-  private readonly filterChangedSource = new EventSourceStub<IFilterChangeDetails>();
-
-  public readonly callHistory = new Array<UserFilterMethod>();
-
-  public currentFilter: IFilterResult | undefined = new FilterResultStub();
-
-  public filterChanged: IEventSource<IFilterChangeDetails> = this.filterChangedSource;
-
-  public notifyFilterChange(change: IFilterChangeDetails) {
-    this.filterChangedSource.notify(change);
-    if (change.action.type === FilterActionType.Apply) {
-      this.currentFilter = change.action.filter;
-    } else {
-      this.currentFilter = undefined;
-    }
-  }
-
-  public withNoCurrentFilter() {
-    return this.withCurrentFilterResult(undefined);
-  }
-
-  public withCurrentFilterResult(filter: IFilterResult | undefined) {
-    this.currentFilter = filter;
-    return this;
-  }
-
-  public applyFilter(): void {
-    this.callHistory.push(UserFilterMethod.ApplyFilter);
-  }
-
-  public clearFilter(): void {
-    this.callHistory.push(UserFilterMethod.ClearFilter);
-  }
-}