Merge pull request #19 from bmazzarol/feat/implicit-option

feat: support for implicit conversion from raw to refined
bmazzarol · Jan 8, 2025 · 9d44c1f · 9d44c1f
2 parents fb373d2 + fcf8530
commit 9d44c1f
Show file tree

Hide file tree

Showing 25 changed files with 592 additions and 55 deletions.
diff --git a/Tuxedo.SourceGenerator/Analysers/MissingFailureMessageAnalyzer.cs b/Tuxedo.SourceGenerator/Analysers/MissingFailureMessageAnalyzer.cs
@@ -64,7 +64,10 @@ private static void Analyze(SyntaxNodeAnalysisContext ctx)
         var hasStringConstructor = ctx
             .Node.DescendantNodes()
             .OfType<AttributeArgumentSyntax>()
-            .Any(arg => arg.Expression is LiteralExpressionSyntax);
+            .Any(arg =>
+                arg.Expression is LiteralExpressionSyntax literal
+                && literal.IsKind(SyntaxKind.StringLiteralExpression)
+            );
 
         var hasStringReturn = ctx
             .Node.Ancestors()

diff --git a/Tuxedo.SourceGenerator/Extensions/StringExtensions.cs b/Tuxedo.SourceGenerator/Extensions/StringExtensions.cs
@@ -43,6 +43,11 @@ public static string StripExpressionParts(this string value)
         return value == null ? null : render(value);
     }
 
+    public static string? RenderIfTrue(this bool value, Func<string> render)
+    {
+        return !value ? null : render();
+    }
+
     public static string? LowercaseFirst(this string? value)
     {
         return value == null ? null : char.ToLowerInvariant(value[0]) + value.Substring(1);

diff --git a/Tuxedo.SourceGenerator/Extensions/SymbolExtensions.cs b/Tuxedo.SourceGenerator/Extensions/SymbolExtensions.cs
@@ -14,4 +14,11 @@ public static bool IsRefinedType(this INamedTypeSymbol symbol)
                 is true
         );
     }
+
+    public static bool HasInterface(this ITypeSymbol? symbol, string interfaceName)
+    {
+        return symbol?.AllInterfaces.Any(i =>
+                i.ToDisplayString().Equals(interfaceName, StringComparison.Ordinal)
+            ) ?? false;
+    }
 }
diff --git a/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.AttributeSources.cs b/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.AttributeSources.cs
@@ -33,6 +33,12 @@ internal sealed class RefinementAttribute : Attribute
             /// </summary>
             public string? Name { get; set; }
             
+            /// <summary>
+            /// Indicates whether the raw type has an implicit conversion to the refined type.
+            /// The default is false, which generates an explicit conversion.
+            /// </summary>
+            public bool HasImplicitConversionFromRaw { get; set; }
+            
             /// <summary>
             /// Initializes a new instance of the <see cref="RefinementAttribute"/> class
             /// </summary>

diff --git a/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.MultiRefinedTypeSource.cs b/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.MultiRefinedTypeSource.cs
@@ -37,11 +37,13 @@ private static string RenderMultiRefinedType(RefinedTypeDetails model)
                      
                      {{RenderEqualityMembers(model)}}
                      
+                     {{RenderFormattingMembers(model)}}
+                     
                      /// <summary>
                      /// Standard deconstruction to the underlying values
                      /// </summary>
                      /// <param name="value">raw {{model.RawType.EscapeXml()}}</param>
-                     /// <param name="altValue">alternative {{model.AlternativeType.EscapeXml()}}</param>
+                     /// <param name="altValue">The alternative {{model.AlternativeType.EscapeXml()}} produced when the refinement predicate is satisfied</param>
                      public void Deconstruct(out {{model.RawType}} value, out {{model.AlternativeType}} altValue)
                      {
                           value = Value;

diff --git a/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.RefinedTypeDetails.cs b/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.RefinedTypeDetails.cs
@@ -6,18 +6,19 @@ namespace Tuxedo.SourceGenerator;
 
 public sealed partial class RefinementSourceGenerator
 {
-    private readonly record struct RefinedTypeDetails(
+    private sealed record RefinedTypeDetails(
         string? Namespace,
         SyntaxList<UsingDirectiveSyntax> Usings,
         string? Predicate,
         bool PredicateReturnsFailureMessage,
-        string? FailureMessage,
-        string? AccessModifier,
+        RefinementAttributeParts AttributeDetails,
         string? Generics,
         string? GenericConstraints,
         string? RawType,
+        ITypeSymbol? RawTypeSymbol,
         string? RefinedType,
-        string? AlternativeType
+        string? AlternativeType,
+        ITypeSymbol? AlternativeTypeSymbol
     )
     {
         public string? RefinedTypeXmlSafeName => (RefinedType + Generics).EscapeXml();

diff --git a/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.RefinementAttributeParts.cs b/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.RefinementAttributeParts.cs
@@ -5,12 +5,13 @@ namespace Tuxedo.SourceGenerator;
 
 public sealed partial class RefinementSourceGenerator
 {
-    private readonly ref struct RefinementAttributeParts
+    private sealed record RefinementAttributeParts
     {
         public string? FailureMessage { get; }
         private bool IsInternal { get; }
         public string AccessModifier => IsInternal ? "internal" : "public";
         public string? Name { get; }
+        public bool HasImplicitConversionFromRaw { get; }
 
         public RefinementAttributeParts(MethodDeclarationSyntax methodDeclaration)
         {
@@ -39,12 +40,18 @@ public RefinementAttributeParts(MethodDeclarationSyntax methodDeclaration)
                     .Where(x => x.NameEquals is null)
                     .Select(x => x.Expression.ToString())
                     .FirstOrDefault();
-            IsInternal =
-                nameToArgs.TryGetValue(nameof(IsInternal), out var value)
-                && string.Equals(value, "true", StringComparison.Ordinal);
             Name = nameToArgs.TryGetValue(nameof(Name), out var nameToName)
                 ? nameToName.StripExpressionParts()
                 : null;
+            IsInternal = IsEnabled(nameof(IsInternal), nameToArgs);
+            HasImplicitConversionFromRaw = IsEnabled(
+                nameof(HasImplicitConversionFromRaw),
+                nameToArgs
+            );
         }
+
+        private static bool IsEnabled(string value, Dictionary<string?, string> nameToArgs) =>
+            nameToArgs.TryGetValue(value, out var v)
+            && string.Equals(v, "true", StringComparison.Ordinal);
     }
 }
diff --git a/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.SingleRefinedTypeSource.cs b/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.SingleRefinedTypeSource.cs
@@ -27,6 +27,8 @@ private static string RenderSingleRefinedType(RefinedTypeDetails model)
                      {{RenderTryParseMethod(model)}}
                      
                      {{RenderEqualityMembers(model)}}
+                     
+                     {{RenderFormattingMembers(model)}}
                  }
                  """;
     }
@@ -50,14 +52,15 @@ namespace {model.Namespace};
 
     private static string RenderTypeNameParts(RefinedTypeDetails model)
     {
+        var isFormattable = model.RawTypeSymbol.HasInterface("System.IFormattable");
         return $"""
             /// <summary>
             /// A refined {model.RawType.EscapeXml()} based on the {model.Predicate.EscapeXml()} refinement predicate{model.AlternativeType.RenderIfNotNull(
                 x => $" which produces an alternative {x.EscapeXml()} value"
             )}
             /// </summary>
             [RefinedType]
-            {model.AccessModifier} readonly partial struct {model.RefinedType}{model.Generics} : IEquatable<{model.RefinedType}{model.Generics}>{model.GenericConstraints.PrependIfNotNull(
+            {model.AttributeDetails.AccessModifier} readonly partial struct {model.RefinedType}{model.Generics} : IEquatable<{model.RefinedType}{model.Generics}>{isFormattable.RenderIfTrue(() => ", IFormattable")}{model.GenericConstraints.PrependIfNotNull(
                 "\n\t"
             )}
             """;
@@ -103,12 +106,16 @@ private static string RenderParseMethod(RefinedTypeDetails model)
     {
         return $$"""
             /// <summary>
-                /// Explicit conversion from a {{model.RawType.EscapeXml()}} to a {{model.RefinedTypeXmlSafeName}}
+                /// {{(
+                model.AttributeDetails.HasImplicitConversionFromRaw ? "Implicit" : "Explicit"
+            )}} conversion from a {{model.RawType.EscapeXml()}} to a {{model.RefinedTypeXmlSafeName}}
                 /// </summary>
                 /// <param name="value">raw {{model.RawType.EscapeXml()}}</param>
                 /// <returns>refined {{model.RefinedTypeXmlSafeName}}</returns>
                 /// <exception cref="ArgumentOutOfRangeException">if the {{model.Predicate.EscapeXml()}} refinement fails</exception>
-                public static explicit operator {{model.RefinedType}}{{model.Generics}}({{model.RawType}} value)
+                public static {{(
+                    model.AttributeDetails.HasImplicitConversionFromRaw ? "implicit" : "explicit"
+                )}} operator {{model.RefinedType}}{{model.Generics}}({{model.RawType}} value)
                 {
                     return Parse(value);
                 }
@@ -144,15 +151,15 @@ public static bool TryParse(
                 {
                     if ({{model.Predicate}}{{model.Generics}}(value{{model.AlternativeType.RenderIfNotNull(
                 _ => ", out var altValue"
-            )}}){{(model.PredicateReturnsFailureMessage ? " is not {} fm": "")}})
+            )}}){{model.PredicateReturnsFailureMessage.RenderIfTrue(() =>" is not {} fm")}})
                     {
                         refined = new {{model.RefinedType}}{{model.Generics}}(value{{model.AlternativeType.RenderIfNotNull(_ => ", altValue")}});
                         failureMessage = null;
                         return true;
                     }
                     
-                    refined = default!;
-                    failureMessage = {{(model.PredicateReturnsFailureMessage ? "fm" : $"${model.FailureMessage}")}};
+                    refined = default;
+                    failureMessage = {{(model.PredicateReturnsFailureMessage ? "fm" : $"${model.AttributeDetails.FailureMessage}")}};
                     return false;
                 }
             """;
@@ -199,4 +206,51 @@ public override int GetHashCode()
                 }
             """;
     }
+
+    private static string RenderFormattingMembers(RefinedTypeDetails details)
+    {
+        var isConvertible = details.RawTypeSymbol?.HasInterface("System.IConvertible") ?? false;
+        var isFormattable = details.RawTypeSymbol?.HasInterface("System.IFormattable") ?? false;
+        return $$"""
+            /// <summary>
+                /// Returns the string representation of the underlying {{details.RawType.EscapeXml()}}
+                /// </summary>
+                public override string ToString()
+                {
+                    return Value.ToString() ?? string.Empty;
+                }{{isConvertible.RenderIfTrue(RenderConvertableImpl)}}{{isFormattable.RenderIfTrue(
+                RenderFormattableImpl
+            )}}
+            """;
+
+        string RenderConvertableImpl()
+        {
+            return $$"""
+
+                    
+                    /// <summary>
+                    /// Returns the string representation of the underlying {{details.RawType.EscapeXml()}}
+                    /// </summary>
+                    public string ToString(IFormatProvider? provider)
+                    {
+                        return ((IConvertible)Value).ToString(provider) ?? string.Empty;
+                    }
+                """;
+        }
+
+        string RenderFormattableImpl()
+        {
+            return $$"""
+
+                    
+                    /// <summary>
+                    /// Returns the string representation of the underlying {{details.RawType.EscapeXml()}}
+                    /// </summary>
+                    public string ToString(string? format, IFormatProvider? formatProvider)
+                    {
+                        return ((IFormattable)Value).ToString(format, formatProvider) ?? string.Empty;
+                    }
+                """;
+        }
+    }
 }
diff --git a/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.cs b/Tuxedo.SourceGenerator/Generators/RefinementSourceGenerator.cs
@@ -91,8 +91,6 @@ CancellationToken token
 
         // get the attribute details
         var attributeParts = new RefinementAttributeParts(methodDeclarationSyntax);
-        var failureMessage = attributeParts.FailureMessage;
-        var accessModifier = attributeParts.AccessModifier;
 
         // extract the generic parts
         ExtractGenericPartDetails(
@@ -119,27 +117,30 @@ attributeParts.Name is not null
 
         // try and see if there is a second out parameter
         string? altType = null;
+        ITypeSymbol? altTypeSymbol = null;
         if (methodDeclarationSyntax.ParameterList.Parameters.Count > 1)
         {
             var secondParam = methodDeclarationSyntax.ParameterList.Parameters[1].Type!;
             var secondParameterTypeInfo = ctx
                 .SemanticModel.GetTypeInfo(secondParam, cancellationToken: token)
                 .Type;
             altType = secondParameterTypeInfo!.ToDisplayString();
+            altTypeSymbol = secondParameterTypeInfo;
         }
 
         return new RefinedTypeDetails(
             Namespace: ns,
             Usings: usings,
             Predicate: predicate,
             PredicateReturnsFailureMessage: returningFailureMessage,
-            FailureMessage: failureMessage,
-            AccessModifier: accessModifier,
+            AttributeDetails: attributeParts,
             Generics: generics,
             GenericConstraints: genericTypeConstraints,
             RawType: rawType,
+            RawTypeSymbol: firstParameterTypeInfo,
             RefinedType: refinedType,
-            AlternativeType: altType
+            AlternativeType: altType,
+            AlternativeTypeSymbol: altTypeSymbol
         );
     }
 

diff --git a/Tuxedo.Tests/BoolRefinementsTests.Case4#FalseBool.g.verified.cs b/Tuxedo.Tests/BoolRefinementsTests.Case4#FalseBool.g.verified.cs
@@ -78,7 +78,7 @@ public static bool TryParse(
             return true;
         }
 
-        refined = default!;
+        refined = default;
         failureMessage = $"The boolean value must be 'False', instead found '{value}'";
         return false;
     }
@@ -112,4 +112,20 @@ public override int GetHashCode()
     {
         return HashCode.Combine(_value);
     }
+
+    /// <summary>
+    /// Returns the string representation of the underlying bool
+    /// </summary>
+    public override string ToString()
+    {
+        return Value.ToString() ?? string.Empty;
+    }
+
+    /// <summary>
+    /// Returns the string representation of the underlying bool
+    /// </summary>
+    public string ToString(IFormatProvider? provider)
+    {
+        return ((IConvertible)Value).ToString(provider) ?? string.Empty;
+    }
 }
diff --git a/Tuxedo.Tests/BoolRefinementsTests.Case5#TrueBool.g.verified.cs b/Tuxedo.Tests/BoolRefinementsTests.Case5#TrueBool.g.verified.cs
@@ -78,7 +78,7 @@ public static bool TryParse(
             return true;
         }
 
-        refined = default!;
+        refined = default;
         failureMessage = $"The boolean value must be 'True', instead found '{value}'";
         return false;
     }
@@ -112,4 +112,20 @@ public override int GetHashCode()
     {
         return HashCode.Combine(_value);
     }
+
+    /// <summary>
+    /// Returns the string representation of the underlying bool
+    /// </summary>
+    public override string ToString()
+    {
+        return Value.ToString() ?? string.Empty;
+    }
+
+    /// <summary>
+    /// Returns the string representation of the underlying bool
+    /// </summary>
+    public string ToString(IFormatProvider? provider)
+    {
+        return ((IConvertible)Value).ToString(provider) ?? string.Empty;
+    }
 }
diff --git a/Tuxedo.Tests/ConfigureRefinementTypesExample.Case1#Case3.g.verified.cs b/Tuxedo.Tests/ConfigureRefinementTypesExample.Case1#Case3.g.verified.cs
@@ -78,7 +78,7 @@ public static bool TryParse(
             return true;
         }
 
-        refined = default!;
+        refined = default;
         failureMessage = fm;
         return false;
     }
@@ -112,4 +112,20 @@ public override int GetHashCode()
     {
         return HashCode.Combine(_value);
     }
+
+    /// <summary>
+    /// Returns the string representation of the underlying bool
+    /// </summary>
+    public override string ToString()
+    {
+        return Value.ToString() ?? string.Empty;
+    }
+
+    /// <summary>
+    /// Returns the string representation of the underlying bool
+    /// </summary>
+    public string ToString(IFormatProvider? provider)
+    {
+        return ((IConvertible)Value).ToString(provider) ?? string.Empty;
+    }
 }