Skip to content
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

Refactor PocofScreen. #73

Merged
merged 12 commits into from
Nov 12, 2023
Merged

Refactor PocofScreen. #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
9b11c1d
Separate Buff type to create wrapped type for PSHostRawUserInterface.
krymtkts Nov 11, 2023
e1d9cf9
Remove the unnecessary property.
krymtkts Nov 11, 2023
dcdaa2c
A little fix.
krymtkts Nov 11, 2023
e9f2530
Move member functions to enclose Console access within RawUI type.
krymtkts Nov 11, 2023
7a272a9
Refactor Buff to access RawUI through interface.
krymtkts Nov 11, 2023
328a719
Rename interface members.
krymtkts Nov 11, 2023
b2ba86c
Add unit tests for PocofScreen module.
krymtkts Nov 12, 2023
68b6914
Refactor classes in the PocofScreen module.
krymtkts Nov 12, 2023
e4a5a8d
Add notes to the PocofScreen module.
krymtkts Nov 12, 2023
3de1579
Fix tests.
krymtkts Nov 12, 2023
9eae86d
Remove Console.TreatControlCAsInput from MockRawUI to avoid System.IO…
krymtkts Nov 12, 2023
30a7a00
Update the note.
krymtkts Nov 12, 2023
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
2 changes: 1 addition & 1 deletion psakefile.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Task Build -depends Clean {

Task UnitTest {
Remove-Item ./src/pocof.Test/TestResults/* -Recurse -ErrorAction SilentlyContinue
dotnet test --collect:"XPlat Code Coverage" --nologo
dotnet test --collect:"XPlat Code Coverage" --nologo --logger:"console;verbosity=detailed"
if (-not $?) {
throw 'dotnet test failed.'
}
Expand Down
141 changes: 76 additions & 65 deletions src/pocof.Test/PocofData.fs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ module initConfig =
Prompt = "prompt"
Layout = "TopDown"
Keymaps = Map [ ({ Modifier = 7; Key = ConsoleKey.X }, Cancel) ] }
|> shouldEqual
<| ({ Prompt = "prompt"
|> shouldEqual (
{ Prompt = "prompt"
Layout = Layout.TopDown
Keymaps = Map [ ({ Modifier = 7; Key = ConsoleKey.X }, Cancel) ]
NotInteractive = true },
Expand All @@ -170,7 +170,8 @@ module initConfig =
PropertySearch = Search "name"
Notification = ""
SuppressProperties = true },
{ X = 5; Y = 0 })
{ X = 5; Y = 0 }
)

[<Fact>]
let ``should fail due to unknown Matcher.`` () =
Expand Down Expand Up @@ -238,12 +239,13 @@ module invokeAction =
[<Fact>]
let ``should return a property search state and position.x = 1 when the char is colon.`` () =
invokeAction state { X = 0; Y = 0 } (AddChar ":")
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":"
PropertySearch = Search "" },
{ X = 1; Y = 0 },
Required)
Required
)

[<Fact>]
let ``should return a non-search state and position.X = 6 when the char is space.`` () =
Expand All @@ -253,12 +255,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 5; Y = 0 }
(AddChar " ")
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name "
PropertySearch = NonSearch },
{ X = 6; Y = 0 },
Required)
Required
)

module ``with BackwardChar`` =
[<Fact>]
Expand All @@ -271,8 +274,7 @@ module invokeAction =
let position: Position = { X = 0; Y = 0 }

invokeAction state position BackwardChar
|> shouldEqual
<| (state, position, NotRequired)
|> shouldEqual (state, position, NotRequired)

[<Fact>]
let ``should return state with position.X=4 when moving forward on ':name' with position.X=5.`` () =
Expand All @@ -282,12 +284,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 5; Y = 0 }
BackwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "nam" },
{ X = 4; Y = 0 },
Required)
Required
)

module ``with ForwardChar`` =
[<Fact>]
Expand All @@ -298,12 +301,13 @@ module invokeAction =
PropertySearch = Search "" }
{ X = 1; Y = 0 }
ForwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "n" },
{ X = 2; Y = 0 },
Required)
Required
)

[<Fact>]
let ``should return state with pos unmodified when moving forward on ':name' with position.X=5 and query.Length=3.``
Expand All @@ -315,12 +319,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 5; Y = 0 }
ForwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "name" },
{ X = 5; Y = 0 },
NotRequired)
NotRequired
)

module ``with BeginningOfLine`` =
[<Fact>]
Expand All @@ -331,12 +336,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 5; Y = 0 }
BeginningOfLine
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = NonSearch },
{ X = 0; Y = 0 },
Required)
Required
)

[<Fact>]
let ``should return state with pos unmodified`` () =
Expand All @@ -346,12 +352,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 0; Y = 0 }
BeginningOfLine
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = NonSearch },
{ X = 0; Y = 0 },
NotRequired)
NotRequired
)

[<Fact>]
let ``should return no change with pos modified when NonSearch`` () =
Expand All @@ -361,12 +368,13 @@ module invokeAction =
PropertySearch = NonSearch }
{ X = 5; Y = 0 }
BeginningOfLine
|> (shouldEqual
<| ({ state with
Query = "query"
PropertySearch = NonSearch },
{ X = 0; Y = 0 },
NotRequired))
|> (shouldEqual (
{ state with
Query = "query"
PropertySearch = NonSearch },
{ X = 0; Y = 0 },
NotRequired
))

module ``with EndOfLine`` =
[<Fact>]
Expand All @@ -377,12 +385,13 @@ module invokeAction =
PropertySearch = Search "n" }
{ X = 2; Y = 0 }
EndOfLine
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "name" },
{ X = 5; Y = 0 },
Required)
Required
)

[<Fact>]
let ``should return state with pos unmodified`` () =
Expand All @@ -392,12 +401,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 5; Y = 0 }
EndOfLine
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "name" },
{ X = 5; Y = 0 },
NotRequired)
NotRequired
)

[<Fact>]
let ``should return no change with pos modified when NonSearch`` () =
Expand All @@ -407,12 +417,13 @@ module invokeAction =
PropertySearch = NonSearch }
{ X = 0; Y = 0 }
EndOfLine
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = "query"
PropertySearch = NonSearch },
{ X = 5; Y = 0 },
NotRequired)
NotRequired
)

module ``with DeleteBackwardChar`` =
[<Fact>]
Expand All @@ -423,12 +434,13 @@ module invokeAction =
PropertySearch = NonSearch }
{ X = 6; Y = 0 }
DeleteBackwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "name" },
{ X = 5; Y = 0 },
Required)
Required
)

[<Fact>]
let ``should not change state if the cursor position is at the begin of line.`` () =
Expand All @@ -438,12 +450,13 @@ module invokeAction =
PropertySearch = NonSearch }
{ X = 0; Y = 0 }
DeleteBackwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = NonSearch },
{ X = 0; Y = 0 },
NotRequired)
NotRequired
)

module ``with DeleteForwardChar`` =
[<Fact>]
Expand All @@ -454,12 +467,13 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 0; Y = 0 }
DeleteForwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = "name "
PropertySearch = NonSearch },
{ X = 0; Y = 0 },
Required)
Required
)

[<Fact>]
let ``should not change state if the cursor position is at the end of line.`` () =
Expand All @@ -469,42 +483,39 @@ module invokeAction =
PropertySearch = Search "name" }
{ X = 5; Y = 0 }
DeleteForwardChar
|> shouldEqual
<| ({ state with
|> shouldEqual (
{ state with
Query = ":name"
PropertySearch = Search "name" },
{ X = 5; Y = 0 },
NotRequired)
NotRequired
)

module ``with KillBeginningOfLine`` =
[<Fact>]
let ``should remove all characters before the specified position.`` () =
invokeAction { state with Query = "examplequery" } { X = 7; Y = 0 } KillBeginningOfLine
|> shouldEqual
<| ({ state with Query = "query" }, { X = 0; Y = 0 }, Required)
|> shouldEqual ({ state with Query = "query" }, { X = 0; Y = 0 }, Required)

[<Fact>]
let ``should not change state if the cursor position is at the begin of line.`` () =
invokeAction { state with Query = "query" } { X = 0; Y = 0 } KillBeginningOfLine
|> shouldEqual
<| ({ state with Query = "query" }, { X = 0; Y = 0 }, NotRequired)
|> shouldEqual ({ state with Query = "query" }, { X = 0; Y = 0 }, NotRequired)

module ``with KillEndOfLine`` =
[<Fact>]
let ``should remove characters after the current cursor position.`` () =
invokeAction { state with Query = "examplequery" } { X = 7; Y = 0 } KillEndOfLine
|> shouldEqual
<| ({ state with Query = "example" }, { X = 7; Y = 0 }, Required)
|> shouldEqual ({ state with Query = "example" }, { X = 7; Y = 0 }, Required)

[<Fact>]
let ``should not change state if the cursor position is at the end of line.`` () =
invokeAction { state with Query = "example" } { X = 7; Y = 0 } KillEndOfLine
|> shouldEqual
<| ({ state with Query = "example" }, { X = 7; Y = 0 }, NotRequired)
|> shouldEqual ({ state with Query = "example" }, { X = 7; Y = 0 }, NotRequired)

let testStateOnly action state expected =
invokeAction state position action |> shouldEqual
<| (expected, position, Required)
invokeAction state position action
|> shouldEqual (expected, position, Required)

module ``with RotateMatcher`` =
let test before after =
Expand Down Expand Up @@ -578,8 +589,8 @@ module invokeAction =
let ``should return a disabled suppress property.`` () = test true false

let noop action =
invokeAction state position action |> shouldEqual
<| (state, position, NotRequired) // TODO: change to false when the action is implemented.
invokeAction state position action
|> shouldEqual (state, position, NotRequired) // TODO: change to false when the action is implemented.

module ``with SelectUp`` =
[<Fact>]
Expand Down
Loading