-
-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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.
- Loading branch information
1 parent
63366a4
commit 6142f3a
Showing
36 changed files
with
917 additions
and
525 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
35 changes: 35 additions & 0 deletions
35
src/application/Context/State/Filter/AdaptiveFilterContext.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
import { EventSource } from '@/infrastructure/Events/EventSource'; | ||
import { ICategoryCollection } from '@/domain/ICategoryCollection'; | ||
import { FilterResult } from './Result/FilterResult'; | ||
import { FilterContext } from './FilterContext'; | ||
import { FilterChangeDetails } from './Event/FilterChangeDetails'; | ||
import { FilterChange } from './Event/FilterChange'; | ||
import { FilterStrategy } from './Strategy/FilterStrategy'; | ||
import { LinearFilterStrategy } from './Strategy/LinearFilterStrategy'; | ||
|
||
export class AdaptiveFilterContext implements FilterContext { | ||
public readonly filterChanged = new EventSource<FilterChangeDetails>(); | ||
|
||
public currentFilter: FilterResult | undefined; | ||
|
||
constructor( | ||
private readonly collection: ICategoryCollection, | ||
private readonly filterStrategy: FilterStrategy = new LinearFilterStrategy(), | ||
) { | ||
|
||
} | ||
|
||
public applyFilter(filter: string): void { | ||
if (!filter) { | ||
throw new Error('Filter must be defined and not empty. Use clearFilter() to remove the filter'); | ||
} | ||
const result = this.filterStrategy.applyFilter(filter, this.collection); | ||
this.currentFilter = result; | ||
this.filterChanged.notify(FilterChange.forApply(this.currentFilter)); | ||
} | ||
|
||
public clearFilter(): void { | ||
this.currentFilter = undefined; | ||
this.filterChanged.notify(FilterChange.forClear()); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
23 changes: 23 additions & 0 deletions
23
src/application/Context/State/Filter/Event/FilterChangeDetails.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
import type { FilterResult } from '@/application/Context/State/Filter/Result/FilterResult'; | ||
import type { FilterActionType } from './FilterActionType'; | ||
|
||
export interface FilterChangeDetails { | ||
readonly action: FilterAction; | ||
visit(visitor: FilterChangeDetailsVisitor): void; | ||
} | ||
|
||
export interface FilterChangeDetailsVisitor { | ||
readonly onClear?: () => void; | ||
readonly onApply?: (filter: FilterResult) => void; | ||
} | ||
|
||
export type ApplyFilterAction = { | ||
readonly type: FilterActionType.Apply, | ||
readonly filter: FilterResult; | ||
}; | ||
|
||
export type ClearFilterAction = { | ||
readonly type: FilterActionType.Clear, | ||
}; | ||
|
||
export type FilterAction = ApplyFilterAction | ClearFilterAction; |
23 changes: 0 additions & 23 deletions
23
src/application/Context/State/Filter/Event/IFilterChangeDetails.ts
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
import { IEventSource } from '@/infrastructure/Events/IEventSource'; | ||
import { FilterResult } from './Result/FilterResult'; | ||
import { FilterChangeDetails } from './Event/FilterChangeDetails'; | ||
|
||
export interface ReadonlyFilterContext { | ||
readonly currentFilter: FilterResult | undefined; | ||
readonly filterChanged: IEventSource<FilterChangeDetails>; | ||
} | ||
|
||
export interface FilterContext extends ReadonlyFilterContext { | ||
applyFilter(filter: string): void; | ||
clearFilter(): void; | ||
} |
This file was deleted.
Oops, something went wrong.
4 changes: 2 additions & 2 deletions
4
...tion/Context/State/Filter/FilterResult.ts → ...tate/Filter/Result/AppliedFilterResult.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ion/Context/State/Filter/IFilterResult.ts → ...ntext/State/Filter/Result/FilterResult.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
src/application/Context/State/Filter/Strategy/FilterStrategy.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
import type { ICategoryCollection } from '@/domain/ICategoryCollection'; | ||
import type { FilterResult } from '../Result/FilterResult'; | ||
|
||
export interface FilterStrategy { | ||
applyFilter( | ||
filter: string, | ||
collection: ICategoryCollection, | ||
): FilterResult; | ||
} |
80 changes: 80 additions & 0 deletions
80
src/application/Context/State/Filter/Strategy/LinearFilterStrategy.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
import type { ICategory, IScript } from '@/domain/ICategory'; | ||
import type { IScriptCode } from '@/domain/IScriptCode'; | ||
import type { IDocumentable } from '@/domain/IDocumentable'; | ||
import type { ICategoryCollection } from '@/domain/ICategoryCollection'; | ||
import { AppliedFilterResult } from '../Result/AppliedFilterResult'; | ||
import type { FilterStrategy } from './FilterStrategy'; | ||
import type { FilterResult } from '../Result/FilterResult'; | ||
|
||
export class LinearFilterStrategy implements FilterStrategy { | ||
applyFilter(filter: string, collection: ICategoryCollection): FilterResult { | ||
const filterLowercase = filter.toLocaleLowerCase(); | ||
const filteredScripts = collection.getAllScripts().filter( | ||
(script) => matchesScript(script, filterLowercase), | ||
); | ||
const filteredCategories = collection.getAllCategories().filter( | ||
(category) => matchesCategory(category, filterLowercase), | ||
); | ||
return new AppliedFilterResult( | ||
filteredScripts, | ||
filteredCategories, | ||
filter, | ||
); | ||
} | ||
} | ||
|
||
function matchesCategory( | ||
category: ICategory, | ||
filterLowercase: string, | ||
): boolean { | ||
return matchesAny( | ||
() => matchName(category.name, filterLowercase), | ||
() => matchDocumentation(category, filterLowercase), | ||
); | ||
} | ||
|
||
function matchesScript( | ||
script: IScript, | ||
filterLowercase: string, | ||
): boolean { | ||
return matchesAny( | ||
() => matchName(script.name, filterLowercase), | ||
() => matchCode(script.code, filterLowercase), | ||
() => matchDocumentation(script, filterLowercase), | ||
); | ||
} | ||
|
||
function matchesAny( | ||
...predicates: ReadonlyArray<() => boolean> | ||
): boolean { | ||
return predicates.some((predicate) => predicate()); | ||
} | ||
|
||
function matchName( | ||
name: string, | ||
filterLowercase: string, | ||
): boolean { | ||
return name.toLowerCase().includes(filterLowercase); | ||
} | ||
|
||
function matchCode( | ||
code: IScriptCode, | ||
filterLowercase: string, | ||
): boolean { | ||
if (code.execute.toLowerCase().includes(filterLowercase)) { | ||
return true; | ||
} | ||
if (code.revert?.toLowerCase().includes(filterLowercase)) { | ||
return true; | ||
} | ||
return false; | ||
} | ||
|
||
function matchDocumentation( | ||
documentable: IDocumentable, | ||
filterLowercase: string, | ||
): boolean { | ||
return documentable.docs.some( | ||
(doc) => doc.toLocaleLowerCase().includes(filterLowercase), | ||
); | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
import { ICategoryCollection } from '@/domain/ICategoryCollection'; | ||
import { OperatingSystem } from '@/domain/OperatingSystem'; | ||
import { IReadOnlyUserFilter, IUserFilter } from './Filter/IUserFilter'; | ||
import { ReadonlyFilterContext, FilterContext } from './Filter/FilterContext'; | ||
import { ReadonlyUserSelection, UserSelection } from './Selection/UserSelection'; | ||
import { IApplicationCode } from './Code/IApplicationCode'; | ||
|
||
export interface IReadOnlyCategoryCollectionState { | ||
readonly code: IApplicationCode; | ||
readonly os: OperatingSystem; | ||
readonly filter: IReadOnlyUserFilter; | ||
readonly filter: ReadonlyFilterContext; | ||
readonly selection: ReadonlyUserSelection; | ||
readonly collection: ICategoryCollection; | ||
} | ||
|
||
export interface ICategoryCollectionState extends IReadOnlyCategoryCollectionState { | ||
readonly filter: IUserFilter; | ||
readonly filter: FilterContext; | ||
readonly selection: UserSelection; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.