LogAsScalarAttribute can be applied to structs (#87)

destructurama · Jan 22, 2024 · 1988894 · 1988894
1 parent aae13dc
commit 1988894
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 6 deletions.
diff --git a/src/Destructurama.Attributed.Tests/Approval/Destructurama.Attributed.approved.txt b/src/Destructurama.Attributed.Tests/Approval/Destructurama.Attributed.approved.txt
@@ -17,7 +17,7 @@ namespace Destructurama.Attributed
     {
         Serilog.Events.LogEventPropertyValue CreateLogEventPropertyValue(object? value, Serilog.Core.ILogEventPropertyValueFactory propertyValueFactory);
     }
-    [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Property)]
+    [System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Struct | System.AttributeTargets.Property)]
     public class LogAsScalarAttribute : System.Attribute, Destructurama.Attributed.IPropertyDestructuringAttribute, Destructurama.Attributed.ITypeDestructuringAttribute
     {
         public LogAsScalarAttribute(bool isMutable = false) { }

diff --git a/src/Destructurama.Attributed.Tests/AttributedDestructuringTests.cs b/src/Destructurama.Attributed.Tests/AttributedDestructuringTests.cs
@@ -42,6 +42,8 @@ public void AttributesAreConsultedWhenDestructuring()
         Assert.IsInstanceOf<StructureValue>(props["NotAScalar"]);
         Assert.IsFalse(props.ContainsKey("Ignored"));
         Assert.IsInstanceOf<NotAScalar>(props["ScalarAnyway"].LiteralValue());
+        Assert.IsInstanceOf<Struct1>(props["Struct1"].LiteralValue());
+        Assert.IsInstanceOf<Struct2>(props["Struct2"].LiteralValue());
 
         var str = sv.ToString();
         Assert.That(str.Contains("This is a username"));
@@ -64,23 +66,42 @@ public class NotAScalar
 
     public class Customized
     {
-        // ReSharper disable UnusedAutoPropertyAccessor.Global
         public ImmutableScalar? ImmutableScalar { get; set; }
         public MutableScalar? MutableScalar { get; set; }
         public NotAScalar? NotAScalar { get; set; }
 
-        [NotLogged] public string? Ignored { get; set; }
+        [NotLogged]
+        public string? Ignored { get; set; }
 
-        [LogAsScalar] public NotAScalar? ScalarAnyway { get; set; }
+        [LogAsScalar]
+        public NotAScalar? ScalarAnyway { get; set; }
 
         public UserAuthData? AuthData { get; set; }
+
+        [LogAsScalar]
+        public Struct1 Struct1 { get; set; }
+
+        public Struct2 Struct2 { get; set; }
     }
 
     public class UserAuthData
     {
         public string? Username { get; set; }
 
-        [NotLogged] public string? Password { get; set; }
+        [NotLogged]
+        public string? Password { get; set; }
+    }
+
+    public struct Struct1
+    {
+        public int SomeProperty { get; set; }
+        public override string ToString() => "AAA";
     }
 
+    [LogAsScalar]
+    public struct Struct2
+    {
+        public int SomeProperty { get; set; }
+        public override string ToString() => "BBB";
+    }
 }
diff --git a/src/Destructurama.Attributed/Attributed/LogAsScalarAttribute.cs b/src/Destructurama.Attributed/Attributed/LogAsScalarAttribute.cs
@@ -21,7 +21,7 @@ namespace Destructurama.Attributed;
 /// Specified that the type or property it is applied to should never be
 /// destructured; instead it should be logged as an atomic value.
 /// </summary>
-[AttributeUsage(AttributeTargets.Class | AttributeTargets.Property)]
+[AttributeUsage(AttributeTargets.Class | AttributeTargets.Struct | AttributeTargets.Property)]
 public class LogAsScalarAttribute : Attribute, ITypeDestructuringAttribute, IPropertyDestructuringAttribute
 {
     private readonly bool _isMutable;