Merge pull request #16 from thomashilzendegen/feature/skip-equals-method

Allow skipping of IEquatable<T> and comparison operators

Author: PawelGerr

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/AdHocUnions/AdHocUnionCodeGenerator.cs

@@ -58,7 +58,7 @@ private void GenerateUnion(CancellationToken cancellationToken)
    [global::System.Diagnostics.CodeAnalysis.SuppressMessage(""ThinktectureRuntimeExtensionsAnalyzer"", ""TTRESG1000:Internal Thinktecture.Runtime.Extensions API usage"")]
    ").Append(_state.IsReferenceType ? "sealed " : "readonly ").Append("partial ").AppendTypeKind(_state).Append(" ").Append(_state.Name).Append(" :");
 
-      if (!_state.IsRefStruct)
+      if (!_state.IsRefStruct && !_state.Settings.SkipEqualityComparison)
       {
          _sb.Append(@"
       global::System.IEquatable<").AppendTypeFullyQualified(_state).Append(@">,
@@ -128,9 +128,13 @@ private void GenerateUnion(CancellationToken cancellationToken)
 
       GenerateConversionsFromValue();
       GenerateConversionsToValue();
-      GenerateEqualityOperators();
-      GenerateEquals();
-      GenerateGetHashCode();
+      
+      if (!_state.Settings.SkipEqualityComparison)
+      {
+          GenerateEqualityOperators();
+          GenerateEquals();
+          GenerateGetHashCode();
+      }
 
       if (!_state.Settings.SkipToString)
          GenerateToString();

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/AdHocUnions/AdHocUnionSettings.cs

@@ -13,6 +13,8 @@ public sealed class AdHocUnionSettings : IEquatable<AdHocUnionSettings>
    public string SwitchMapStateParameterName { get; }
    public SerializationFrameworks SerializationFrameworks { get; }
    public bool UseSingleBackingField { get; }
+   public bool SkipEqualityComparison { get; }
+   
 
    public AdHocUnionSettings(
       AttributeData attribute,
@@ -28,6 +30,7 @@ public AdHocUnionSettings(
       SwitchMapStateParameterName = attribute.FindSwitchMapStateParameterName();
       SerializationFrameworks = attribute.FindSerializationFrameworks();
       UseSingleBackingField = attribute.FindUseSingleBackingField() ?? false;
+      SkipEqualityComparison = attribute.FindSkipEqualityComparison() ?? false;
 
       var memberTypeSettings = new AdHocUnionMemberTypeSetting[numberOfMemberTypes];
       MemberTypeSettings = memberTypeSettings;
@@ -61,6 +64,7 @@ public bool Equals(AdHocUnionSettings? other)
              && SwitchMapStateParameterName == other.SwitchMapStateParameterName
              && SerializationFrameworks == other.SerializationFrameworks
              && UseSingleBackingField == other.UseSingleBackingField
+             && SkipEqualityComparison == other.SkipEqualityComparison
              && MemberTypeSettings.SequenceEqual(other.MemberTypeSettings);
    }
 
@@ -78,6 +82,7 @@ public override int GetHashCode()
          hashCode = (hashCode * 397) ^ SwitchMapStateParameterName.GetHashCode();
          hashCode = (hashCode * 397) ^ (int)SerializationFrameworks;
          hashCode = (hashCode * 397) ^ UseSingleBackingField.GetHashCode();
+         hashCode = (hashCode * 397) ^ SkipEqualityComparison.GetHashCode();
          hashCode = (hashCode * 397) ^ MemberTypeSettings.ComputeHashCode();
 
          return hashCode;

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/Constants.cs

@@ -67,6 +67,7 @@ public static class Properties
          public const string SKIP_ICOMPARABLE = "SkipIComparable";
          public const string ALLOW_DEFAULT_STRUCTS = "AllowDefaultStructs";
          public const string HAS_CORRESPONDING_CONSTRUCTOR = "HasCorrespondingConstructor";
+         public const string SKIP_EQUALITY_COMPARISON = "SkipEqualityComparison";
       }
 
       public static class ValueObject

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/Diagnostics/ThinktectureRuntimeExtensionsAnalyzer.cs

@@ -610,6 +610,8 @@ private static void ValidateKeyMemberComparers(
       ValidateComparer(context, keyType, keyMemberComparerAttr, tdsLocation);
       ValidateComparer(context, keyType, keyMemberEqualityComparerAttr, tdsLocation);
 
+      var skipEqualityComparison = attributeOperation.FindSkipEqualityComparison() ?? false;
+
       if (keyMemberComparerAttr is not null && keyMemberEqualityComparerAttr is null)
       {
          ReportDiagnostic(context,
@@ -619,7 +621,7 @@ private static void ValidateKeyMemberComparers(
       }
       else if (stringBasedRequiresEqualityComparer
                && keyType.SpecialType == SpecialType.System_String
-               && keyMemberEqualityComparerAttr is null)
+               && keyMemberEqualityComparerAttr is null && !skipEqualityComparison)
       {
          ReportDiagnostic(context,
                           DiagnosticsDescriptors.StringBasedValueObjectNeedsEqualityComparer,
@@ -733,6 +735,7 @@ private static void CheckAssignableMembers(
       Location tdsLocation)
    {
       var allowDefaultStructs = attribute.FindAllowDefaultStructs() ?? false;
+      var skipEqualityComparison = attribute.FindSkipEqualityComparison() ?? false;
 
       List<string>? membersWithDisallowDefaultValue = null;
       var hasStringMembersWithoutComparer = false;
@@ -760,7 +763,7 @@ private static void CheckAssignableMembers(
          CheckComparerTypes(context, assignableMember, tdsLocation);
       }
 
-      if (hasStringMembersWithoutComparer && !attribute.HasDefaultStringComparison())
+      if (hasStringMembersWithoutComparer && !attribute.HasDefaultStringComparison() && !skipEqualityComparison)
       {
          ReportDiagnostic(context,
                           DiagnosticsDescriptors.ComplexValueObjectWithStringMembersNeedsDefaultEqualityComparer,

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/AllValueObjectSettings.cs

@@ -15,6 +15,7 @@ public sealed class AllValueObjectSettings : IEquatable<AllValueObjectSettings>,
    public bool SkipIComparable { get; }
    public bool SkipIParsable { get; }
    public bool SkipIFormattable { get; }
+   public bool SkipEqualityComparison { get; }
    public bool SkipToString { get; }
    public OperatorsGeneration AdditionOperators { get; }
    public OperatorsGeneration SubtractionOperators { get; }
@@ -47,6 +48,7 @@ public AllValueObjectSettings(
       SkipIComparable = valueObjectAttribute.FindSkipIComparable() ?? false;
       SkipIParsable = SkipFactoryMethods || (valueObjectAttribute.FindSkipIParsable() ?? false);
       SkipIFormattable = valueObjectAttribute.FindSkipIFormattable() ?? false;
+      SkipEqualityComparison = valueObjectAttribute.FindSkipEqualityComparison() ?? false;
       SkipToString = valueObjectAttribute.FindSkipToString() ?? false;
       AdditionOperators = SkipFactoryMethods ? OperatorsGeneration.None : valueObjectAttribute.FindAdditionOperators();
       SubtractionOperators = SkipFactoryMethods ? OperatorsGeneration.None : valueObjectAttribute.FindSubtractionOperators();
@@ -65,6 +67,12 @@ public AllValueObjectSettings(
       // Comparison operators depend on the equality comparison operators
       if (ComparisonOperators > EqualityComparisonOperators)
          EqualityComparisonOperators = ComparisonOperators;
+
+      if (SkipEqualityComparison)
+      {
+          ComparisonOperators = OperatorsGeneration.None;
+          EqualityComparisonOperators = OperatorsGeneration.None;
+      }
    }
 
    public override bool Equals(object? obj)
@@ -92,6 +100,7 @@ public bool Equals(AllValueObjectSettings? other)
              && SkipIComparable == other.SkipIComparable
              && SkipIParsable == other.SkipIParsable
              && SkipIFormattable == other.SkipIFormattable
+             && SkipEqualityComparison == other.SkipEqualityComparison
              && SkipToString == other.SkipToString
              && AdditionOperators == other.AdditionOperators
              && SubtractionOperators == other.SubtractionOperators
@@ -125,6 +134,7 @@ public override int GetHashCode()
          hashCode = (hashCode * 397) ^ SkipIComparable.GetHashCode();
          hashCode = (hashCode * 397) ^ SkipIParsable.GetHashCode();
          hashCode = (hashCode * 397) ^ SkipIFormattable.GetHashCode();
+         hashCode = (hashCode * 397) ^ SkipEqualityComparison.GetHashCode();
          hashCode = (hashCode * 397) ^ SkipToString.GetHashCode();
          hashCode = (hashCode * 397) ^ (int)AdditionOperators;
          hashCode = (hashCode * 397) ^ (int)SubtractionOperators;

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/ComplexValueObjectCodeGenerator.cs

@@ -52,8 +52,16 @@ private void GenerateValueObject(CancellationToken cancellationToken)
    {
       _sb.Append(@"
    [global::System.Diagnostics.CodeAnalysis.SuppressMessage(""ThinktectureRuntimeExtensionsAnalyzer"", ""TTRESG1000:Internal Thinktecture.Runtime.Extensions API usage"")]
-   ").Append(_state.IsReferenceType ? "sealed " : "readonly ").Append("partial ").AppendTypeKind(_state).Append(" ").Append(_state.Name).AppendGenericTypeParameters(_state).Append(" : global::System.IEquatable<").AppendTypeFullyQualifiedNullAnnotated(_state).Append(@">,
-      global::System.Numerics.IEqualityOperators<").AppendTypeFullyQualified(_state).Append(", ").AppendTypeFullyQualified(_state).Append(@", bool>,
+   ").Append(_state.IsReferenceType ? "sealed " : "readonly ").Append("partial ").AppendTypeKind(_state).Append(" ").Append(_state.Name).AppendGenericTypeParameters(_state).Append(" :");
+
+      if (!_state.Settings.SkipEqualityComparison)
+      {
+          _sb.Append(@"
+      global::System.IEquatable<").AppendTypeFullyQualifiedNullAnnotated(_state).Append(@">,
+      global::System.Numerics.IEqualityOperators<").AppendTypeFullyQualified(_state).Append(", ").AppendTypeFullyQualified(_state).Append(", bool>,");
+      }
+
+      _sb.Append(@"
       global::Thinktecture.Internal.IMetadataOwner");
 
       if (_state.DisallowsDefaultValue)
@@ -105,9 +113,13 @@ private void GenerateValueObject(CancellationToken cancellationToken)
       cancellationToken.ThrowIfCancellationRequested();
 
       GenerateConstructor();
-      GenerateEqualityOperators();
-      GenerateEquals();
-      GenerateGetHashCode();
+
+      if (!_state.Settings.SkipEqualityComparison)
+      {
+          GenerateEqualityOperators();
+          GenerateEquals();
+          GenerateGetHashCode();
+      }
 
       if (!_state.Settings.SkipToString)
          GenerateToString();

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/KeyedValueObjectCodeGenerator.cs

@@ -62,7 +62,15 @@ private void GenerateValueObject(CancellationToken cancellationToken)
 
       _sb.Append(@"
    [global::System.Diagnostics.CodeAnalysis.SuppressMessage(""ThinktectureRuntimeExtensionsAnalyzer"", ""TTRESG1000:Internal Thinktecture.Runtime.Extensions API usage"")]
-   ").Append(_state.IsReferenceType ? "sealed " : "readonly ").Append("partial ").AppendTypeKind(_state).Append(" ").Append(_state.Name).Append(" : global::System.IEquatable<").AppendTypeFullyQualifiedNullAnnotated(_state).Append(@">,
+   ").Append(_state.IsReferenceType ? "sealed " : "readonly ").Append("partial ").AppendTypeKind(_state).Append(" ").Append(_state.Name).Append(" :");
+      
+      if (!_state.Settings.SkipEqualityComparison)
+      {
+          _sb.Append(@"
+      global::System.IEquatable<").AppendTypeFullyQualifiedNullAnnotated(_state).Append(">,");
+      }
+      
+      _sb.Append(@"
       global::Thinktecture.IKeyedObject<").AppendTypeFullyQualified(_state.KeyMember).Append(@">,
       global::Thinktecture.IConvertible<").AppendTypeFullyQualified(_state.KeyMember).Append(@">,
       global::Thinktecture.Internal.IMetadataOwner");
@@ -136,8 +144,12 @@ private void GenerateValueObject(CancellationToken cancellationToken)
       cancellationToken.ThrowIfCancellationRequested();
 
       GenerateConstructor();
-      GenerateEquals();
-      GenerateGetHashCode();
+
+      if (!_state.Settings.SkipEqualityComparison)
+      {
+          GenerateEquals();
+          GenerateGetHashCode();
+      }
 
       if (!_state.Settings.SkipToString)
          GenerateToString();

src/Thinktecture.Runtime.Extensions.SourceGenerator/CodeAnalysis/ValueObjects/ValueObjectSettings.cs

@@ -22,6 +22,7 @@ namespace Thinktecture.CodeAnalysis.ValueObjects;
    public bool HasStructLayoutAttribute => _attributeInfo.HasStructLayoutAttribute;
    public string? KeyMemberEqualityComparerAccessor => _attributeInfo.KeyMemberEqualityComparerAccessor;
    public SerializationFrameworks SerializationFrameworks => _allSettings.SerializationFrameworks;
+   public bool SkipEqualityComparison => _allSettings.SkipEqualityComparison;
 
    public ValueObjectSettings(
       AllValueObjectSettings allSettings,
@@ -49,7 +50,8 @@ public bool Equals(ValueObjectSettings other)
              && DefaultStringComparison == other.DefaultStringComparison
              && HasStructLayoutAttribute == other.HasStructLayoutAttribute
              && KeyMemberEqualityComparerAccessor == other.KeyMemberEqualityComparerAccessor
-             && SerializationFrameworks == other.SerializationFrameworks;
+             && SerializationFrameworks == other.SerializationFrameworks
+             && SkipEqualityComparison == other.SkipEqualityComparison;
    }
 
    public override bool Equals(object? obj)
@@ -78,6 +80,7 @@ public override int GetHashCode()
          hashCode = (hashCode * 397) ^ HasStructLayoutAttribute.GetHashCode();
          hashCode = (hashCode * 397) ^ (KeyMemberEqualityComparerAccessor?.GetHashCode() ?? 0);
          hashCode = (hashCode * 397) ^ (int)SerializationFrameworks;
+         hashCode = (hashCode * 397) ^ SkipEqualityComparison.GetHashCode();
 
          return hashCode;
       }

src/Thinktecture.Runtime.Extensions.SourceGenerator/Extensions/AttributeDataExtensions.cs

@@ -80,6 +80,11 @@ public static class AttributeDataExtensions
    {
       return GetBooleanParameterValue(attributeData, "SkipIFormattable");
    }
+   
+   public static bool? FindSkipEqualityComparison(this AttributeData attributeData)
+   {
+      return GetBooleanParameterValue(attributeData, "SkipEqualityComparison");
+   }
 
    public static OperatorsGeneration FindAdditionOperators(this AttributeData attributeData)
    {

src/Thinktecture.Runtime.Extensions.SourceGenerator/Extensions/ObjectCreationOperationExtensions.cs

@@ -20,6 +20,11 @@ public static class ObjectCreationOperationExtensions
       return GetBooleanParameterValue(operation.Initializer, Constants.Attributes.Properties.SKIP_KEY_MEMBER);
    }
 
+   public static bool? FindSkipEqualityComparison(this IObjectCreationOperation operation)
+   {
+      return GetBooleanParameterValue(operation.Initializer, Constants.Attributes.Properties.SKIP_EQUALITY_COMPARISON);
+   }
+
    public static bool? FindAllowDefaultStructs(this IObjectCreationOperation operation)
    {
       return GetBooleanParameterValue(operation.Initializer, Constants.Attributes.Properties.ALLOW_DEFAULT_STRUCTS);