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.

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

Fixes #2944. TreeView unit tests fail intermittently: Ensures Attribute and Color are read only value types #3163

Merged
merged 19 commits into from
Jan 13, 2024

Conversation

tig
Copy link
Collaborator

@tig tig commented Jan 13, 2024

Fixes

Todo:

  • Make Color a readonly value type with unit test to prove it
    • Change Color.ColorName to be get only. We're lucky in that the only code in the project that does someAttribute.ColorName = colorName are in unit tests! To convince myself I'm correct on this, I commented out all those tests that set ColorName and the TreeView case no longer fails.
    • Change Color.R/G/B/A/Rgba/ to be get only.
  • Fix things that the above broke
  • Beef up unit tests

For another time:

Pull Request checklist:

  • I've named my PR in the form of "Fixes #issue. Terse description."
  • My code follows the style guidelines of Terminal.Gui - if you use Visual Studio, hit CTRL-K-D to automatically reformat your files before committing.
  • My code follows the Terminal.Gui library design guidelines
  • I ran dotnet test before commit
  • I have made corresponding changes to the API documentation (using /// style comments)
  • My changes generate no new warnings
  • I have checked my code and corrected any poor grammar or misspellings
  • I conducted basic QA to assure all features are working

@tig tig requested review from BDisp and tznind January 13, 2024 00:40
@tig
Copy link
Collaborator Author

tig commented Jan 13, 2024

On this:

  • Change Attribute.Default to be a static dynamic property with only a geter.

Now that both Color and Attribute are value types, this is no longer needed, so I took it back to the way it was before as it's slightly more performant...

[JsonConverter (typeof (AttributeJsonConverter))]
public readonly struct Attribute : IEquatable<Attribute> {
	/// <summary>
	/// Default empty attribute.
	/// </summary>
	/// </remarks>
	public static readonly Attribute Default = new (Color.White, Color.Black);

Copy link
Collaborator

@BDisp BDisp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Veryyyyy nice work. I love it.

@tig tig merged commit 6ad36b7 into gui-cs:v2_develop Jan 13, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants