feat(gui): filter is:done (#685)

* feat(gui): filter `is:done`

* style: apply automatic fixes of linters

* feat(gui): increase min width of filter help button

Co-authored-by: lars-reimann <[email protected]>

Author: lars-reimann

.gitignore

@@ -18,6 +18,7 @@ yarn.lock
 report/
 
 # Compilation/build outputs
+bin/
 build/
 coverage/
 dist/

api-editor/gui/src/common/FilterHelpButton.tsx

@@ -22,7 +22,7 @@ export const FilterHelpButton = function () {
                 <PopoverTrigger>
                     <IconButton variant="ghost" icon={<Icon name="help" />} aria-label="help" />
                 </PopoverTrigger>
-                <PopoverContent minWidth={462} fontSize="sm" marginRight={2}>
+                <PopoverContent minWidth={600} fontSize="sm" marginRight={2}>
                     <PopoverArrow />
                     <PopoverCloseButton />
                     <PopoverHeader>Filter Options</PopoverHeader>
@@ -46,6 +46,15 @@ export const FilterHelpButton = function () {
                                     of <em>public, internal</em>.
                                 </ChakraText>
                             </ListItem>
+                            <ListItem>
+                                <ChakraText>
+                                    <strong>is:done</strong>
+                                </ChakraText>
+                                <ChakraText>
+                                    Displays only elements that are marked as complete and where all annotations are
+                                    marked as correct.
+                                </ChakraText>
+                            </ListItem>
                             <ListItem>
                                 <ChakraText>
                                     <strong>is:complete</strong>

api-editor/gui/src/features/annotations/annotationSlice.ts

@@ -969,8 +969,10 @@ export const selectTodo =
 export const selectNumberOfAnnotations =
     (target: string) =>
     (state: RootState): number => {
-        return Object.values(selectAnnotationStore(state)).reduce((acc, annotations) => {
-            if (target in annotations) {
+        return Object.entries(selectAnnotationStore(state)).reduce((acc, [annotationType, annotations]) => {
+            if (annotationType === 'completes') {
+                return acc;
+            } else if (target in annotations) {
                 return acc + 1;
             } else {
                 return acc;

api-editor/gui/src/features/packageData/model/filters/DoneFilter.ts

@@ -0,0 +1,62 @@
+import { PythonClass } from '../PythonClass';
+import { PythonFunction } from '../PythonFunction';
+import { PythonModule } from '../PythonModule';
+import { PythonParameter } from '../PythonParameter';
+import { AbstractPythonFilter } from './AbstractPythonFilter';
+import { PythonDeclaration } from '../PythonDeclaration';
+import { Annotation, AnnotationStore } from '../../../annotations/annotationSlice';
+import { UsageCountStore } from '../../../usages/model/UsageCountStore';
+
+/**
+ * Keeps only declarations that are marked as complete and all annotations as correct.
+ */
+export class DoneFilter extends AbstractPythonFilter {
+    shouldKeepModule(pythonModule: PythonModule, annotations: AnnotationStore, usages: UsageCountStore): boolean {
+        return this.shouldKeepDeclaration(pythonModule, annotations, usages);
+    }
+
+    shouldKeepClass(pythonClass: PythonClass, annotations: AnnotationStore, usages: UsageCountStore): boolean {
+        return this.shouldKeepDeclaration(pythonClass, annotations, usages);
+    }
+
+    shouldKeepFunction(pythonFunction: PythonFunction, annotations: AnnotationStore, usages: UsageCountStore): boolean {
+        return this.shouldKeepDeclaration(pythonFunction, annotations, usages);
+    }
+
+    shouldKeepParameter(
+        pythonParameter: PythonParameter,
+        annotations: AnnotationStore,
+        usages: UsageCountStore,
+    ): boolean {
+        return this.shouldKeepDeclaration(pythonParameter, annotations, usages);
+    }
+
+    shouldKeepDeclaration(
+        pythonDeclaration: PythonDeclaration,
+        annotations: AnnotationStore,
+        _usages: UsageCountStore,
+    ): boolean {
+        return (
+            pythonDeclaration.id in annotations.completes &&
+            this.getAnnotationsForTarget(pythonDeclaration.id, annotations).every(
+                (annotation) => (annotation.reviewers?.length ?? 0) > 0,
+            )
+        );
+    }
+
+    private getAnnotationsForTarget(target: string, annotationStore: AnnotationStore): Annotation[] {
+        return Object.entries(annotationStore).flatMap(([key, value]) => {
+            if (!(target in value)) {
+                return [];
+            }
+
+            if (key === 'calledAfters' || key === 'groups') {
+                return Object.values(value[target]);
+            } else if (key === 'completes') {
+                return [];
+            } else {
+                return [value[target]];
+            }
+        });
+    }
+}

api-editor/gui/src/features/packageData/model/filters/filterFactory.ts

@@ -13,6 +13,7 @@ import { ParameterAssignmentFilter } from './ParameterAssignmentFilter';
 import { PythonParameterAssignment } from '../PythonParameter';
 import { RequiredOrOptional, RequiredOrOptionalFilter } from './RequiredOrOptionalFilter';
 import { NameRegexFilter } from './NameRegexFilter';
+import { DoneFilter } from './DoneFilter';
 
 /**
  * Creates a filter from the given string. This method handles conjunctions, negations, and non-negated tokens.
@@ -89,6 +90,10 @@ const parsePositiveToken = function (token: string): Optional<AbstractPythonFilt
         case 'is:nameonly':
             return new ParameterAssignmentFilter(PythonParameterAssignment.NAME_ONLY);
 
+        // Done
+        case 'is:done':
+            return new DoneFilter();
+
         // Annotations
         case 'annotation:any':
             return new AnnotationFilter(AnnotationType.Any);