Fix 'Add subprogram box' command

We were not using the right SymbolKind enumeration.

A test for this command has also been added.

Author: AnthonyLeonardoGracio

integration/vscode/ada/src/extension.ts

@@ -24,8 +24,8 @@ import {
     LanguageClientOptions,
     Middleware,
     ServerOptions,
-    SymbolKind,
 } from 'vscode-languageclient/node';
+import { SymbolKind } from 'vscode';
 import { ALSClientFeatures } from './alsClientFeatures';
 import { alsCommandExecutor } from './alsExecuteCommand';
 import GnatTaskProvider, { getEnclosingSymbol } from './gnatTaskProvider';
@@ -274,44 +274,45 @@ function createClient(
 async function addSupbrogramBox() {
     const activeEditor = vscode.window.activeTextEditor;
 
-    await getEnclosingSymbol(activeEditor, [SymbolKind.Function, SymbolKind.Module]).then(
-        async (symbol) => {
-            if (symbol !== null) {
-                const name: string = symbol.name ?? '';
-                const insertPos = new vscode.Position(symbol.range.start.line, 0);
-                const indentationRange = new vscode.Range(insertPos, symbol.range.start);
-                const indentation: string = activeEditor?.document.getText(indentationRange) ?? '';
-                const eol: string =
-                    activeEditor?.document.eol == vscode.EndOfLine.CRLF ? '\r\n' : '\n';
-
-                // Generate the subprogram box after retrieving the indentation of the line of
-                // the subprogram's body declaration.
-                const text: string =
-                    indentation +
-                    '---' +
-                    '-'.repeat(name.length) +
-                    '---' +
-                    eol +
-                    indentation +
-                    '-- ' +
-                    name +
-                    ' --' +
-                    eol +
-                    indentation +
-                    '---' +
-                    '-'.repeat(name.length) +
-                    '---' +
-                    eol +
-                    eol;
-
-                if (activeEditor) {
-                    await activeEditor.edit((editBuilder) => {
-                        editBuilder.insert(insertPos, text);
-                    });
-                }
+    await getEnclosingSymbol(activeEditor, [
+        SymbolKind.Function,
+        SymbolKind.Package,
+        SymbolKind.Module,
+    ]).then(async (symbol) => {
+        if (symbol !== null) {
+            const name: string = symbol.name ?? '';
+            const insertPos = new vscode.Position(symbol.range.start.line, 0);
+            const indentationRange = new vscode.Range(insertPos, symbol.range.start);
+            const indentation: string = activeEditor?.document.getText(indentationRange) ?? '';
+            const eol: string = activeEditor?.document.eol == vscode.EndOfLine.CRLF ? '\r\n' : '\n';
+
+            // Generate the subprogram box after retrieving the indentation of the line of
+            // the subprogram's body declaration.
+            const text: string =
+                indentation +
+                '---' +
+                '-'.repeat(name.length) +
+                '---' +
+                eol +
+                indentation +
+                '-- ' +
+                name +
+                ' --' +
+                eol +
+                indentation +
+                '---' +
+                '-'.repeat(name.length) +
+                '---' +
+                eol +
+                eol;
+
+            if (activeEditor) {
+                await activeEditor.edit((editBuilder) => {
+                    editBuilder.insert(insertPos, text);
+                });
             }
         }
-    );
+    });
 }
 
 type ALSSourceDirDescription = {

integration/vscode/ada/src/gnatTaskProvider.ts

@@ -309,7 +309,7 @@ export async function getEnclosingSymbol(
         const getAllSymbols = (symbols: vscode.DocumentSymbol[]) => {
             let sym;
             for (sym of symbols) {
-                if (sym.kind in kinds) {
+                if (kinds.includes(sym.kind)) {
                     filtered_symbols.push(sym);
                 }
                 if (sym.kind == SymbolKind.Function || sym.kind == SymbolKind.Module) {
@@ -324,11 +324,13 @@ export async function getEnclosingSymbol(
         const scopeSymbols = filtered_symbols.filter(
             (sym) => line >= sym.range.start.line && line <= sym.range.end.line
         );
+
         if (scopeSymbols.length > 0) {
             scopeSymbols.sort(
                 (a, b) =>
                     a.range.end.line - a.range.start.line - (b.range.end.line - b.range.start.line)
             );
+
             return scopeSymbols[0];
         }
     }

integration/vscode/ada/test/TestWorkspace/src/test_subprogram_box.adb

@@ -0,0 +1,14 @@
+procedure Test_Subprogram_Box is
+
+    procedure Do_Nothing is
+    begin
+        null;
+    end Do_Nothing;
+
+    task body T is
+    begin
+        null;
+    end T;
+begin
+    null;
+end Test_Subprogram_Box;

integration/vscode/ada/test/TestWorkspace/src/test_subprogram_box.expected

@@ -0,0 +1,26 @@
+-------------------------
+-- Test_Subprogram_Box --
+-------------------------
+
+procedure Test_Subprogram_Box is
+
+    ----------------
+    -- Do_Nothing --
+    ----------------
+
+    procedure Do_Nothing is
+    begin
+        null;
+    end Do_Nothing;
+
+    -------
+    -- T --
+    -------
+
+    task body T is
+    begin
+        null;
+    end T;
+begin
+    null;
+end Test_Subprogram_Box;

integration/vscode/ada/test/suite/extension.test.ts

@@ -2,7 +2,7 @@ import * as assert from 'assert';
 import { before } from 'mocha';
 import { contextClients } from '../../src/extension';
 import { GlsMainResult, GlsExecutableResult } from '../../src/gprTaskProvider';
-
+import { assertEqualToFileContent } from './utils';
 import * as vscode from 'vscode';
 
 suite('Extension Tasks Test Suite', () => {
@@ -45,4 +45,27 @@ suite('Extension Tasks Test Suite', () => {
             throw new Error('No workspace folder found for the specified URI');
         }
     });
+    test('Test Add Subprogram Box', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            await contextClients.adaClient.onReady();
+            const cursorPositions : vscode.Position[] =
+                [new vscode.Position (9, 1), new vscode.Position (4, 1), new vscode.Position (1, 1)];
+            const folder = vscode.workspace.workspaceFolders[0].uri;
+            const fileUri = vscode.Uri.joinPath(folder, 'src', 'test_subprogram_box.adb');
+            const expectedUri = vscode.Uri.joinPath(
+                folder, 'src', 'test_subprogram_box.expected');
+
+            for (let cursorPos of cursorPositions) {
+                await vscode.window.showTextDocument(fileUri,
+                    {selection: new vscode.Range(cursorPos, cursorPos)});
+                await vscode.commands.executeCommand('ada.subprogramBox');
+            }
+
+            const editorText = vscode.window.activeTextEditor?.document.getText()?? "";
+
+            assertEqualToFileContent(editorText, expectedUri);
+        } else {
+            throw new Error('No workspace folder found for the specified URI');
+        }
+    });
 });