feat: add stringDefaultComparison for type-level default string comparer#948
Open
sirphilliptubell wants to merge 5 commits into
Open
feat: add stringDefaultComparison for type-level default string comparer#948sirphilliptubell wants to merge 5 commits into
sirphilliptubell wants to merge 5 commits into
Conversation
Adds a new `StringComparisonDefault` enum and `stringDefaultComparison` parameter to `ValueObjectAttribute`, `ValueObjectAttribute<T>`, and `VogenDefaultsAttribute`. When set, the specified `StringComparer` iswired into all five equality/hashing entry points on string-backed value objects: `Equals(T)`, `Equals(string)`, `operator ==` (both directions), and `GetHashCode()`. The `Comparers` nested class is generated implicitly when a default comparison is specified. Two new diagnostics: - VOG039 (warning): `stringDefaultComparison` set on a non-string type - VOG040 (error): `stringComparers: Omit` explicitly conflicts with `stringDefaultComparison` Also fixes a bug in the existing `Comparers` class where `GetHashCode` called `_comparer.GetHashCode()` (the comparer's own object hash) instead of `_comparer.GetHashCode(obj._value)`, causing all values to hash identically and degrading dictionary lookups to O(n).
… previous ones to maintain backwards compatibility
Previously, setting stringDefaultComparison (without stringComparers) caused the Comparers nested class to be generated as an unintended side-effect. The two settings are orthogonal: stringComparers controls whether the Comparers utility class is generated; stringDefaultComparison controls the VO's own Equals/GetHashCode/operator behavior. The Comparers class now only generates when stringComparers = Generate is explicitly set. VOG040 (which blocked stringComparers = Omit alongside stringDefaultComparison) has been removed as its premise no longer holds. Added a snapshot test covering both settings used together.
Author
|
Did some cleanup, the existing Comparer generation is now separate from the string equality feature |
Conversions.Unspecified = -1 fails the IsValidFlags() >= 0 check, causing VOG011 on the four string default comparison test types.
Thorough CI builds run all three frameworks; the OrdinalIgnoreCase and combined-settings tests were missing their v4.8 and v8.0 verified snapshots.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR for feature request #947
Adds a new
StringComparisonDefaultenum andstringDefaultComparisonparameter toValueObjectAttribute,ValueObjectAttribute<T>, andVogenDefaultsAttribute. When set, the specifiedStringCompareriswired into all five equality/hashing entry points on string-backed value objects:Equals(T),Equals(string),operator ==(both directions), andGetHashCode(). TheComparersnested class is generated implicitly when a default comparison is specified.Two new diagnostics:
stringDefaultComparisonset on a non-string typestringComparers: Omitexplicitly conflicts withstringDefaultComparisonAlso fixes a bug in the existing
Comparersclass whereGetHashCodecalled_comparer.GetHashCode()(the comparer's own object hash) instead of_comparer.GetHashCode(obj._value), causing all values to hash identically and degrading dictionary lookups to O(n).Fyi, this includes the Fix in #946 (but not the tests in it)