Added feature find references (#8)

useblocks · Jan 19, 2023 · 52adbd8 · 52adbd8
1 parent 5d4d8cb
commit 52adbd8
Show file tree

Hide file tree

Showing 9 changed files with 309 additions and 72 deletions.
diff --git a/README.md b/README.md
@@ -35,6 +35,10 @@ hover.
 
 ![image](https://raw.githubusercontent.com/useblocks/sphinx-needs-vscode/main/docs/_images/features_goto.gif)
 
+**Find References:**
+
+![image](https://raw.githubusercontent.com/useblocks/sphinx-needs-vscode/main/docs/_images/features_find_references.gif)
+
 **ID Selection:**
 
 ![image](https://raw.githubusercontent.com/useblocks/sphinx-needs-vscode/main/docs/_images/features_id_selection.gif)

diff --git a/client/src/test/extension.test.ts b/client/src/test/extension.test.ts
@@ -77,11 +77,11 @@ suite('Sphinx-Needs Extension Tests for rst file', function () {
 
 		const testCases: [string, vscode.Position, vscode.CompletionList][] = [
 			['trigger ..', new vscode.Position(10, 2), expectedSnippets],
-			['trigger :', new vscode.Position(30, 1), expectedNeedRoleOrOption],
-			['trigger > at lev1', new vscode.Position(34, 9), expectedNeedPathLev1],
-			['trigger > at lev2', new vscode.Position(36, 13), expectedNeedPathLev2],
-			['trigger > at lev3', new vscode.Position(38, 23), expectedNeedPathLev3],
-			['trigger /', new vscode.Position(40, 25), expectedPathFolderInsider]
+			['trigger :', new vscode.Position(33, 1), expectedNeedRoleOrOption],
+			['trigger > at lev1', new vscode.Position(37, 9), expectedNeedPathLev1],
+			['trigger > at lev2', new vscode.Position(39, 13), expectedNeedPathLev2],
+			['trigger > at lev3', new vscode.Position(41, 23), expectedNeedPathLev3],
+			['trigger /', new vscode.Position(43, 25), expectedPathFolderInsider]
 		];
 
 		const promises = testCases.map(async ([name, position, expectedItems]) => {
@@ -185,25 +185,25 @@ suite('Sphinx-Needs Extension Tests for rst file', function () {
 		await activate(docUri);
 
 		const testCases: [string, vscode.Position, string, vscode.Position][] = [
-			['goto same file', new vscode.Position(19, 12), docUri.path, new vscode.Position(18, 0)],
+			['goto same file', new vscode.Position(20, 12), docUri.path, new vscode.Position(19, 0)],
 			[
 				'goto different file',
-				new vscode.Position(32, 1),
+				new vscode.Position(35, 1),
 				path.resolve(__dirname, '../../testData/mySubFolder', 'sub.rst'),
 				new vscode.Position(3, 0)
 			],
-			['goto multiple ID same line', new vscode.Position(32, 10), docUri.path, new vscode.Position(18, 0)],
+			['goto multiple ID same line', new vscode.Position(35, 10), docUri.path, new vscode.Position(19, 0)],
 			[
 				'goto option with multiple ID first',
 				new vscode.Position(13, 15),
 				docUri.path,
-				new vscode.Position(18, 0)
+				new vscode.Position(19, 0)
 			],
 			[
 				'goto option with multiple ID last',
-				new vscode.Position(13, 22),
+				new vscode.Position(13, 28),
 				path.resolve(__dirname, '../../testData/mySubFolder', 'sub.rst'),
-				new vscode.Position(9, 0)
+				new vscode.Position(3, 0)
 			],
 			['negative goto', new vscode.Position(6, 3), '', new vscode.Position(0, 0)]
 		];
@@ -229,9 +229,68 @@ suite('Sphinx-Needs Extension Tests for rst file', function () {
 		});
 		return Promise.all(promises);
 	});
+
+	// Test Find References
+	test('Test Find References', async () => {
+		// Activate extension
+		await activate(docUri);
+
+		const testCases: [string, vscode.Position, vscode.Location[]][] = [
+			[
+				'find references multiple',
+				new vscode.Position(22, 14),
+				[
+					new vscode.Location(
+						docUri,
+						new vscode.Range(new vscode.Position(13, 19), new vscode.Position(13, 24))
+					),
+					new vscode.Location(
+						docUri,
+						new vscode.Range(new vscode.Position(22, 11), new vscode.Position(22, 16))
+					)
+				]
+			],
+			[
+				'find references single',
+				new vscode.Position(20, 10),
+				[
+					new vscode.Location(
+						docUri,
+						new vscode.Range(new vscode.Position(13, 11), new vscode.Position(13, 17))
+					)
+				]
+			]
+		];
+
+		const promises = testCases.map(async ([name, position, expectedLocations]) => {
+			const allReferences = (await vscode.commands.executeCommand(
+				'vscode.executeReferenceProvider',
+				docUri,
+				position
+			)) as vscode.Location[];
+
+			if (name === 'find references multiple') {
+				assert.ok(allReferences.length === 2, `Find References over ${name} failed.`);
+			}
+
+			if (name === 'find references single') {
+				assert.ok(allReferences.length === 1, `Find References over ${name} failed.`);
+			}
+
+			expectedLocations.forEach((expLoc, i) => {
+				const actualRef = allReferences[i];
+				assert.equal(actualRef.uri.path, expLoc.uri.path);
+				assert.equal(actualRef.range.start.line, expLoc.range.start.line);
+				assert.equal(actualRef.range.start.character, expLoc.range.start.character);
+				assert.equal(actualRef.range.end.line, expLoc.range.end.line);
+				assert.equal(actualRef.range.end.character, expLoc.range.end.character);
+			});
+		});
+		return Promise.all(promises);
+	});
 });
 
-suite('Sphinx-Needs Extension Tests for plaintext file', function() {
+suite('Sphinx-Needs Extension Tests for plaintext file', function () {
 	this.timeout(30000);
 
 	// Test Document

diff --git a/client/testData/conf.py b/client/testData/conf.py
@@ -38,6 +38,17 @@
     {"directive": "need", "title": "Need", "prefix": "N_", "color": "#9856a5", "style": "node"},
 ]
 
+needs_extra_links = [
+    {
+        "option": "tests",
+        "incoming": "is tested by",
+        "outgoing": "tests",
+        "copy": True,
+        "style": "#00AA00",
+        "style_part": "dotted,#00AA00",
+    }
+]
+
 needs_build_json = True
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/client/testData/index.rst b/client/testData/index.rst
@@ -11,19 +11,22 @@ Needs
 .. req:: First requirement
    :id: REQ_1
    :status: open
-   :links: SPEC_1, REQ_3
+   :links: SPEC_1, REQ_3, REQ_2
+   :tests: REQ_2
 
    Requirement content
 
 
 .. spec:: First specification
    :id: SPEC_1
    :status: open
+   :links: REQ_3
+   :tests: REQ_2
 
    Specification content
 
 .. spec:: Dummy Title
-   :id: 3f3b1468
+   :id: SPEC_3
    :status: open
 
    Content.

diff --git a/client/testData/needs_small.json b/client/testData/needs_small.json
@@ -14,31 +14,43 @@
                     "type": "req",
                     "description": "Description for REQ_1.",
                     "docname": "index",
-                    "doctype": ".rst"
+                    "doctype": ".rst",
+                    "links": ["SPEC_1", "REQ_3", "REQ_2"],
+                    "tests": ["REQ_2"],
+                    "tests_back": []
                 },
                 "SPEC_1": {
                     "id": "SPEC_1",
                     "title": "example spec",
                     "type": "spec",
                     "description": "Description for SPEC_1.",
                     "docname": "index",
-                    "doctype": ".rst"
+                    "doctype": ".rst",
+                    "links": ["REQ_3"],
+                    "tests": ["REQ_2"],
+                    "tests_back": []
                 },
                 "REQ_2": {
                     "id": "REQ_2",
                     "title": "example second req",
                     "type": "req",
                     "description": "Description for REQ_2.",
                     "docname": "mySubFolder/sub",
-                    "doctype": ".rst"
+                    "doctype": ".rst",
+                    "links": [],
+                    "tests": [],
+                    "tests_back": ["REQ_1", "SPEC_1"]
                 },
                 "REQ_3": {
                     "id": "REQ_3",
                     "title": "example third req",
                     "type": "req",
                     "description": "Description for REQ_3.",
                     "docname": "mySubFolder/sub",
-                    "doctype": ".rst"
+                    "doctype": ".rst",
+                    "links": [],
+                    "tests": [],
+                    "tests_back": []
                 }
             }
         }

diff --git a/docs/_images/features_find_references.gif b/docs/_images/features_find_references.gif
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -9,6 +9,7 @@ Under development
 * Updated homepage for extension
 * Adapted extension activationEvents to workspace contains ``conf.py``.
 * Added setting :ref:`activateFiles` to config supported files that language features will be activated when file opened.
+* Added feature :ref:`find_references`.
 
 0.1.1
 -----

diff --git a/docs/features.rst b/docs/features.rst
@@ -33,6 +33,16 @@ The extension enables you to navigate your documentation project using the *need
 .. image:: /_images/features_goto.gif
    :align: center
 
+.. _find_references:
+
+Find References
+---------------
+
+Find all other *need* objects that link to current *need ID*.
+
+.. image:: /_images/features_find_references.gif
+   :align: center
+
 .. _id_select:
 
 Need ID Selection