Skip to content

Add FileContext.GetText(IFileRange) overload #2306

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andyleejordan wants to merge 1 commit into
base: main
Choose a base branch
from
+70 −2
Open

Add FileContext.GetText(IFileRange) overload #2306

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/PowerShellEditorServices/Extensions/FileContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ internal FileContext(
/// </summary>
/// <param name="bufferRange">The buffer range for which content will be extracted.</param>
/// <returns>A string with the specified range of content.</returns>
public string GetText(FileRange bufferRange)
public string GetText(IFileRange bufferRange)
{
return
string.Join(
Expand All @@ -123,7 +123,7 @@ public string GetText(FileRange bufferRange)
/// </summary>
/// <param name="fileRange">The buffer range for which content will be extracted.</param>
/// <returns>An array of strings, each representing a line in the file within the specified range.</returns>
public string[] GetTextLines(FileRange fileRange) => scriptFile.GetLinesInRange(fileRange.ToBufferRange());
public string[] GetTextLines(IFileRange fileRange) => scriptFile.GetLinesInRange(fileRange.ToBufferRange());

#endregion

Expand Down
68 changes: 68 additions & 0 deletions test/PowerShellEditorServices.Test/Extensions/FileContextTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

using System;
using Microsoft.PowerShell.EditorServices.Extensions;
using Microsoft.PowerShell.EditorServices.Services.TextDocument;
using Microsoft.PowerShell.EditorServices.Test.Shared;
using Xunit;

namespace PowerShellEditorServices.Test.Extensions
{
[Trait("Category", "Extensions")]
public class FileContextTests
{
private static EditorContext CreateEditorContext(string content, BufferRange selectedRange)
{
string filePath = TestUtilities.NormalizePath(@"C:\Temp\Test.ps1");
ScriptFile scriptFile = ScriptFile.Create(new Uri(filePath), content, new Version("7.0"));
return new EditorContext(
editorOperations: null,
scriptFile,
new BufferPosition(line: 1, column: 1),
selectedRange);
}

// Regression test for https://github.com/PowerShell/PowerShellEditorServices/issues/1496
// where $Context.CurrentFile.GetText($Context.SelectedRange) failed because GetText only
// accepted the concrete FileRange type rather than the IFileRange that SelectedRange returns.
[Fact]
public void CanGetTextFromSelectedRange()
{
EditorContext editorContext = CreateEditorContext(
"Line One\nLine Two\nLine Three",
new BufferRange(2, 1, 2, 9));

IFileRange selectedRange = editorContext.SelectedRange;
string text = editorContext.CurrentFile.GetText(selectedRange);

Assert.Equal("Line Two", text);
}

[Fact]
public void CanGetTextLinesFromSelectedRange()
{
EditorContext editorContext = CreateEditorContext(
"Line One\nLine Two\nLine Three",
new BufferRange(1, 1, 2, 9));

string[] lines = editorContext.CurrentFile.GetTextLines(editorContext.SelectedRange);

Assert.Equal(new[] { "Line One", "Line Two" }, lines);
}

[Fact]
public void CanGetTextFromConstructedFileRange()
{
EditorContext editorContext = CreateEditorContext(
"Line One\nLine Two\nLine Three",
BufferRange.None);

IFileRange range = new FileRange(
new Microsoft.PowerShell.EditorServices.Extensions.FilePosition(3, 1),
new Microsoft.PowerShell.EditorServices.Extensions.FilePosition(3, 11));

Assert.Equal("Line Three", editorContext.CurrentFile.GetText(range));
}
}
}
Loading