feat: hide private declarations by default and prevent annotating them (#423)

lars-reimann · paul0314 · web-flow · commit 903f5846da63 · 2022-02-18T13:37:14.000+01:00
* feat: hide private declarations by default and prevent annotating them

* style: apply automatic fixes of linters

Co-authored-by: lars-reimann &lt;lars-reimann@users.noreply.github.com&gt;
Co-authored-by: paul0314 &lt;45012526+paul0314@users.noreply.github.com&gt;
diff --git a/api-editor/client/src/common/MenuBar.tsx b/api-editor/client/src/common/MenuBar.tsx
@@ -46,7 +46,11 @@ import {
 import AnnotatedPythonPackageBuilder from '../features/annotatedPackageData/model/AnnotatedPythonPackageBuilder';
 import { PythonFilter } from '../features/packageData/model/PythonFilter';
 import PythonPackage from '../features/packageData/model/PythonPackage';
-import { togglePackageDataImportDialog } from '../features/packageData/packageDataSlice';
+import {
+    selectShowPrivateDeclarations,
+    togglePackageDataImportDialog,
+    toggleShowPrivateDeclarations,
+} from '../features/packageData/packageDataSlice';
 import { Setter } from './util/types';
 
 interface MenuBarProps {
@@ -251,6 +255,13 @@ const MenuBar: React.FC<MenuBarProps> = function ({
                 </Box>
                 <Button onClick={exportAnnotations}>Export</Button>
                 <DeleteAllAnnotations />
+                <Button
+                    onClick={() => dispatch(toggleShowPrivateDeclarations())}
+                >
+                    {useAppSelector(selectShowPrivateDeclarations)
+                        ? 'Hide private declarations'
+                        : 'Show private declarations'}
+                </Button>
                 <Button onClick={toggleColorMode}>
                     Toggle {colorMode === 'light' ? 'dark' : 'light'}
                 </Button>
diff --git a/api-editor/client/src/features/packageData/model/PythonClass.ts b/api-editor/client/src/features/packageData/model/PythonClass.ts
@@ -51,6 +51,10 @@ export default class PythonClass extends PythonDeclaration {
         return this.methods;
     }
 
+    isPublicDeclaration(): boolean {
+        return this.isPublic;
+    }
+
     toString(): string {
         let result = '';
 
diff --git a/api-editor/client/src/features/packageData/model/PythonDeclaration.ts b/api-editor/client/src/features/packageData/model/PythonDeclaration.ts
@@ -12,6 +12,10 @@ export default abstract class PythonDeclaration {
         return this.name;
     }
 
+    isPublicDeclaration(): boolean {
+        return true;
+    }
+
     path(): string[] {
         let current: Optional<PythonDeclaration> = this;
         const result: string[] = [];
diff --git a/api-editor/client/src/features/packageData/model/PythonFunction.ts b/api-editor/client/src/features/packageData/model/PythonFunction.ts
@@ -62,6 +62,10 @@ export default class PythonFunction extends PythonDeclaration {
         return this.parameters;
     }
 
+    isPublicDeclaration(): boolean {
+        return this.isPublic;
+    }
+
     getUniqueName(): string {
         return this.uniqueName;
     }
diff --git a/api-editor/client/src/features/packageData/model/PythonParameter.ts b/api-editor/client/src/features/packageData/model/PythonParameter.ts
@@ -49,6 +49,10 @@ export default class PythonParameter extends PythonDeclaration {
         return [];
     }
 
+    isPublicDeclaration(): boolean {
+        return this.isPublic;
+    }
+
     isExplicitParameter(): boolean {
         const containingFunction = this.parent();
         if (!containingFunction) {
diff --git a/api-editor/client/src/features/packageData/packageDataSlice.ts b/api-editor/client/src/features/packageData/packageDataSlice.ts
@@ -7,6 +7,7 @@ export interface PackageDataState {
     };
     treeViewScrollOffset: number;
     showImportDialog: boolean;
+    showPrivateDeclarations: boolean;
 }
 
 // Initial state -------------------------------------------------------------------------------------------------------
@@ -15,6 +16,7 @@ const initialState: PackageDataState = {
     expandedInTreeView: {},
     treeViewScrollOffset: 0,
     showImportDialog: false,
+    showPrivateDeclarations: false,
 };
 
 // Slice ---------------------------------------------------------------------------------------------------------------
@@ -36,6 +38,9 @@ const packageDataSlice = createSlice({
         toggleImportDialog(state) {
             state.showImportDialog = !state.showImportDialog;
         },
+        toggleShowPrivateDeclarations(state) {
+            state.showPrivateDeclarations = !state.showPrivateDeclarations;
+        },
     },
 });
 
@@ -44,6 +49,7 @@ export const {
     toggleIsExpanded: toggleIsExpandedInTreeView,
     setScrollOffset: setTreeViewScrollOffset,
     toggleImportDialog: togglePackageDataImportDialog,
+    toggleShowPrivateDeclarations,
 } = actions;
 export default reducer;
 
@@ -59,3 +65,5 @@ export const selectTreeViewScrollOffset = (state: RootState): number =>
     selectPackageData(state).treeViewScrollOffset;
 export const selectShowPackageDataImportDialog = (state: RootState): boolean =>
     selectPackageData(state).showImportDialog;
+export const selectShowPrivateDeclarations = (state: RootState): boolean =>
+    selectPackageData(state).showPrivateDeclarations;
diff --git a/api-editor/client/src/features/packageData/selectionView/ClassView.tsx b/api-editor/client/src/features/packageData/selectionView/ClassView.tsx
@@ -24,14 +24,17 @@ const ClassView: React.FC<ClassViewProps> = function ({ pythonClass }) {
             <Stack spacing={4}>
                 <HStack>
                     <Heading as="h3" size="lg">
-                        {pythonClass.name}
+                        {pythonClass.name}{' '}
+                        {!pythonClass.isPublic && '(private)'}
                     </Heading>
-                    <AnnotationDropdown
-                        target={id}
-                        showMove
-                        showRename
-                        showUnused
-                    />
+                    {pythonClass.isPublic && (
+                        <AnnotationDropdown
+                            target={id}
+                            showMove
+                            showRename
+                            showUnused
+                        />
+                    )}
                 </HStack>
 
                 <AnnotationView target={id} />
diff --git a/api-editor/client/src/features/packageData/selectionView/FunctionView.tsx b/api-editor/client/src/features/packageData/selectionView/FunctionView.tsx
@@ -38,22 +38,25 @@ const FunctionView: React.FC<FunctionViewProps> = function ({
             <Stack spacing={4}>
                 <HStack>
                     <Heading as="h3" size="lg">
-                        {pythonFunction.name}
+                        {pythonFunction.name}{' '}
+                        {!pythonFunction.isPublic && '(private)'}
                     </Heading>
-                    <AnnotationDropdown
-                        target={id}
-                        showCalledAfter={hasRemainingCalledAfters}
-                        showGroup={
-                            pythonFunction.explicitParameters().length >= 2
-                        }
-                        showMove={
-                            pythonFunction.containingModuleOrClass instanceof
-                            PythonModule
-                        }
-                        showPure
-                        showRename
-                        showUnused
-                    />
+                    {pythonFunction.isPublic && (
+                        <AnnotationDropdown
+                            target={id}
+                            showCalledAfter={hasRemainingCalledAfters}
+                            showGroup={
+                                pythonFunction.explicitParameters().length >= 2
+                            }
+                            showMove={
+                                pythonFunction.containingModuleOrClass instanceof
+                                PythonModule
+                            }
+                            showPure
+                            showRename
+                            showUnused
+                        />
+                    )}
                 </HStack>
 
                 <AnnotationView target={id} />
diff --git a/api-editor/client/src/features/packageData/selectionView/ParameterNode.tsx b/api-editor/client/src/features/packageData/selectionView/ParameterNode.tsx
@@ -31,14 +31,16 @@ const ParameterNode: React.FC<ParameterNodeProps> = function ({
             <HStack>
                 {isTitle ? (
                     <Heading as="h3" size="lg">
-                        {pythonParameter.name}
+                        {pythonParameter.name}{' '}
+                        {!pythonParameter.isPublic && '(private)'}
                     </Heading>
                 ) : (
                     <Heading as="h4" size="sm">
-                        {pythonParameter.name}
+                        {pythonParameter.name}{' '}
+                        {!pythonParameter.isPublic && '(private)'}
                     </Heading>
                 )}
-                {isExplicitParameter && (
+                {pythonParameter.isPublic && isExplicitParameter && (
                     <AnnotationDropdown
                         target={id}
                         showAttribute={isConstructorParameter}
diff --git a/api-editor/client/src/features/packageData/treeView/ClassNode.tsx b/api-editor/client/src/features/packageData/treeView/ClassNode.tsx
@@ -3,13 +3,19 @@ import { FaChalkboard } from 'react-icons/fa';
 import { isEmptyList } from '../../../common/util/listOperations';
 import PythonClass from '../model/PythonClass';
 import TreeNode from './TreeNode';
+import { useAppSelector } from '../../../app/hooks';
+import { selectShowPrivateDeclarations } from '../packageDataSlice';
 
 interface ClassNodeProps {
     pythonClass: PythonClass;
 }
 
 const ClassNode: React.FC<ClassNodeProps> = function ({ pythonClass }) {
-    const hasMethods = !isEmptyList(pythonClass.methods);
+    let methods = pythonClass.methods;
+    if (!useAppSelector(selectShowPrivateDeclarations)) {
+        methods = methods.filter((it) => it.isPublic);
+    }
+    const hasMethods = !isEmptyList(methods);
 
     return (
         <TreeNode
diff --git a/api-editor/client/src/features/packageData/treeView/FunctionNode.tsx b/api-editor/client/src/features/packageData/treeView/FunctionNode.tsx
@@ -3,6 +3,8 @@ import { FaCogs } from 'react-icons/fa';
 import { isEmptyList } from '../../../common/util/listOperations';
 import PythonFunction from '../model/PythonFunction';
 import TreeNode from './TreeNode';
+import { useAppSelector } from '../../../app/hooks';
+import { selectShowPrivateDeclarations } from '../packageDataSlice';
 
 interface FunctionNodeProps {
     pythonFunction: PythonFunction;
@@ -11,7 +13,11 @@ interface FunctionNodeProps {
 const FunctionNode: React.FC<FunctionNodeProps> = function ({
     pythonFunction,
 }) {
-    const hasParameters = !isEmptyList(pythonFunction.parameters);
+    let parameters = pythonFunction.parameters;
+    if (!useAppSelector(selectShowPrivateDeclarations)) {
+        parameters = parameters.filter((it) => it.isPublic);
+    }
+    const hasParameters = !isEmptyList(parameters);
 
     return (
         <TreeNode
diff --git a/api-editor/client/src/features/packageData/treeView/ModuleNode.tsx b/api-editor/client/src/features/packageData/treeView/ModuleNode.tsx
@@ -3,14 +3,24 @@ import { FaArchive } from 'react-icons/fa';
 import { isEmptyList } from '../../../common/util/listOperations';
 import PythonModule from '../model/PythonModule';
 import TreeNode from './TreeNode';
+import { useAppSelector } from '../../../app/hooks';
+import { selectShowPrivateDeclarations } from '../packageDataSlice';
 
 interface ModuleNodeProps {
     pythonModule: PythonModule;
 }
 
 const ModuleNode: React.FC<ModuleNodeProps> = function ({ pythonModule }) {
-    const hasClasses = !isEmptyList(pythonModule.classes);
-    const hasFunctions = !isEmptyList(pythonModule.functions);
+    let classes = pythonModule.classes;
+    if (!useAppSelector(selectShowPrivateDeclarations)) {
+        classes = classes.filter((it) => it.isPublic);
+    }
+    const hasClasses = !isEmptyList(classes);
+    let functions = pythonModule.functions;
+    if (!useAppSelector(selectShowPrivateDeclarations)) {
+        functions = functions.filter((it) => it.isPublic);
+    }
+    const hasFunctions = !isEmptyList(functions);
     const hasChildren = hasClasses || hasFunctions;
 
     return (
diff --git a/api-editor/client/src/features/packageData/treeView/TreeView.tsx b/api-editor/client/src/features/packageData/treeView/TreeView.tsx
@@ -11,6 +11,7 @@ import PythonPackage from '../model/PythonPackage';
 import PythonParameter from '../model/PythonParameter';
 import {
     selectAllExpandedInTreeView,
+    selectShowPrivateDeclarations,
     selectTreeViewScrollOffset,
     setTreeViewScrollOffset,
 } from '../packageDataSlice';
@@ -31,7 +32,10 @@ const TreeView: React.FC<TreeViewProps> = memo(({ pythonPackage }) => {
     const dispatch = useAppDispatch();
     const allExpanded = useAppSelector(selectAllExpandedInTreeView);
 
-    const children = walkChildrenInPreorder(allExpanded, pythonPackage);
+    let children = walkChildrenInPreorder(allExpanded, pythonPackage);
+    if (!useAppSelector(selectShowPrivateDeclarations)) {
+        children = children.filter((it) => it.isPublicDeclaration());
+    }
     const previousScrollOffset = useAppSelector(selectTreeViewScrollOffset);
 
     // Keep a reference to the last FixedSizeList before everything is dismounted

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,10 @@ export default class PythonClass extends PythonDeclaration {`
`51`	`51`	`return this.methods;`
`52`	`52`	`}`
`53`	`53`
	`54`	`+ isPublicDeclaration(): boolean {`
	`55`	`+ return this.isPublic;`
	`56`	`+ }`
	`57`	`+`
`54`	`58`	`toString(): string {`
`55`	`59`	`let result = '';`
`56`	`60`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,10 @@ export default class PythonFunction extends PythonDeclaration {`
`62`	`62`	`return this.parameters;`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ isPublicDeclaration(): boolean {`
	`66`	`+ return this.isPublic;`
	`67`	`+ }`
	`68`	`+`
`65`	`69`	`getUniqueName(): string {`
`66`	`70`	`return this.uniqueName;`
`67`	`71`	`}`