Merge pull request #5 from chickensoft-games/fix/set-only

fix: allow set-only properties

Author: Joanna May

Chickensoft.Introspection.Generator.Tests/.generated/Chickensoft.Introspection.Generator/Chickensoft.Introspection.Generator.TypeGenerator/TestCases_SetOnlyPropertyE303C8557E.g.cs

@@ -0,0 +1,65 @@
+#pragma warning disable
+#nullable enable
+namespace Chickensoft.Introspection.Generator.Tests.TestCases;
+
+partial record class SetOnlyProperty : Chickensoft.Introspection.IIntrospective {
+  [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+  public Chickensoft.Introspection.MixinBlackboard MixinState { get; } = new();
+  
+  [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+  public Chickensoft.Introspection.IMetatype Metatype => ((Chickensoft.Introspection.IIntrospectiveTypeMetadata)Chickensoft.Introspection.Types.Graph.GetMetadata(typeof(SetOnlyProperty))).Metatype;
+  
+  public class MetatypeMetadata : Chickensoft.Introspection.IMetatype {
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public System.Type Type => typeof(SetOnlyProperty);
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public bool HasInitProperties { get; } = false;
+    
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public System.Collections.Generic.IReadOnlyList<Chickensoft.Introspection.PropertyMetadata> Properties { get; } = new System.Collections.Generic.List<Chickensoft.Introspection.PropertyMetadata>() {
+      new Chickensoft.Introspection.PropertyMetadata(
+        Name: "Value",
+        IsInit: false,
+        IsRequired: false,
+        Getter: null,
+        Setter: (object obj, object? value) => ((SetOnlyProperty)obj).Value = (string)value!,
+        GenericType: new GenericType(
+          OpenType: typeof(string),
+          ClosedType: typeof(string),
+          Arguments: System.Array.Empty<GenericType>(),
+          GenericTypeGetter: receiver => receiver.Receive<string>(),
+          GenericTypeGetter2: default
+        ),
+        Attributes: new System.Collections.Generic.Dictionary<System.Type, System.Attribute[]>() {
+        }
+      )
+    };
+    
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public System.Collections.Generic.IReadOnlyDictionary<System.Type, System.Attribute[]> Attributes { get; } = new System.Collections.Generic.Dictionary<System.Type, System.Attribute[]>() {
+      [typeof(MetaAttribute)] = new System.Attribute[] {
+        new MetaAttribute()
+      }
+    };
+    
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public System.Collections.Generic.IReadOnlyList<System.Type> Mixins { get; } = new System.Collections.Generic.List<System.Type>() {
+    };
+    
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public System.Collections.Generic.IReadOnlyDictionary<System.Type, System.Action<object>> MixinHandlers { get; } = new System.Collections.Generic.Dictionary<System.Type, System.Action<object>>() {
+    };
+    
+    
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public object Construct(System.Collections.Generic.IReadOnlyDictionary<string, object?>? args = null) {
+      throw new System.NotImplementedException("SetOnlyProperty is not instantiable.");
+    }
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public override bool Equals(object obj) => true;
+    [System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage]
+    public override int GetHashCode() => base.GetHashCode();
+  }
+}
+#nullable restore
+#pragma warning restore

Chickensoft.Introspection.Generator.Tests/.generated/Chickensoft.Introspection.Generator/Chickensoft.Introspection.Generator.TypeGenerator/TypeRegistry.g.cs

@@ -65,6 +65,7 @@ public partial class TypeRegistry : Chickensoft.Introspection.ITypeRegistry {
       [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.OuterContainer.MidContainer.ZOtherContainer)] = new Chickensoft.Introspection.ConcreteTypeMetadata("ZOtherContainer", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.OuterContainer.MidContainer.ZOtherContainer>(), () => System.Activator.CreateInstance<Chickensoft.Introspection.Generator.Tests.TestCases.OuterContainer.MidContainer.ZOtherContainer>()), 
       [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.PartialModel)] = new Chickensoft.Introspection.IdentifiableTypeMetadata("PartialModel", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.PartialModel>(), () => System.Activator.CreateInstance<Chickensoft.Introspection.Generator.Tests.TestCases.PartialModel>(), new Chickensoft.Introspection.Generator.Tests.TestCases.PartialModel.MetatypeMetadata(), "multiple_partial_definitions", 1), 
       [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.PropertyModel)] = new Chickensoft.Introspection.AbstractIntrospectiveTypeMetadata("PropertyModel", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.PropertyModel>(), new Chickensoft.Introspection.Generator.Tests.TestCases.PropertyModel.MetatypeMetadata()), 
+      [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.SetOnlyProperty)] = new Chickensoft.Introspection.AbstractIntrospectiveTypeMetadata("SetOnlyProperty", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.SetOnlyProperty>(), new Chickensoft.Introspection.Generator.Tests.TestCases.SetOnlyProperty.MetatypeMetadata()), 
       [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.SomeType)] = new Chickensoft.Introspection.IntrospectiveTypeMetadata("SomeType", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.SomeType>(), () => System.Activator.CreateInstance<Chickensoft.Introspection.Generator.Tests.TestCases.SomeType>(), new Chickensoft.Introspection.Generator.Tests.TestCases.SomeType.MetatypeMetadata(), 1), 
       [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.StaticPropertyIsSkipped)] = new Chickensoft.Introspection.IntrospectiveTypeMetadata("StaticPropertyIsSkipped", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.StaticPropertyIsSkipped>(), () => System.Activator.CreateInstance<Chickensoft.Introspection.Generator.Tests.TestCases.StaticPropertyIsSkipped>(), new Chickensoft.Introspection.Generator.Tests.TestCases.StaticPropertyIsSkipped.MetatypeMetadata(), 1), 
       [typeof(Chickensoft.Introspection.Generator.Tests.TestCases.TraditionalNamespace.A)] = new Chickensoft.Introspection.ConcreteTypeMetadata("A", (r) => r.Receive<Chickensoft.Introspection.Generator.Tests.TestCases.TraditionalNamespace.A>(), () => System.Activator.CreateInstance<Chickensoft.Introspection.Generator.Tests.TestCases.TraditionalNamespace.A>()), 

Chickensoft.Introspection.Generator.Tests/test/src/models/DeclaredPropertyTest.cs

@@ -10,6 +10,7 @@ public class DeclaredPropertyTest {
   public void Equality() {
     var prop = new DeclaredProperty(
       Name: "Name",
+      HasGetter: true,
       HasSetter: true,
       IsInit: false,
       IsRequired: false,
@@ -27,6 +28,7 @@ public void Equality() {
     prop.ShouldBe(
       new DeclaredProperty(
         Name: "Name",
+        HasGetter: true,
         HasSetter: true,
         IsInit: false,
         IsRequired: false,
@@ -40,6 +42,7 @@ public void Equality() {
 
     new DeclaredProperty(
       Name: "Name",
+      HasGetter: true,
       HasSetter: true,
       IsInit: false,
       IsRequired: false,
@@ -53,6 +56,7 @@ public void Equality() {
     ).ShouldNotBe(
       new DeclaredProperty(
         Name: "Name",
+        HasGetter: true,
         HasSetter: true,
         IsInit: false,
         IsRequired: false,

Chickensoft.Introspection.Generator.Tests/test_cases/SetOnlyProperty.cs

@@ -0,0 +1,7 @@
+namespace Chickensoft.Introspection.Generator.Tests.TestCases;
+
+[Meta]
+public abstract partial record SetOnlyProperty {
+  // No getter.
+  public string Value { set { } }
+}

Chickensoft.Introspection.Generator/src/TypeGenerator.cs

@@ -502,6 +502,11 @@ TypeDeclarationSyntax type
 
       var propertyAttributes = GetAttributes(property.AttributeLists);
 
+      var hasGetter = property.AccessorList?.Accessors
+        .Any(
+          accessor => accessor.IsKind(SyntaxKind.GetAccessorDeclaration)
+        ) ?? property.ExpressionBody is not null;
+
       // Never identified a situation in which the accessor list is null.
       var hasSetter = property.AccessorList?.Accessors
         .Any(
@@ -540,6 +545,7 @@ property.Type is GenericNameSyntax generic &&
       properties.Add(
         new DeclaredProperty(
           Name: property.Identifier.ValueText,
+          HasGetter: hasGetter,
           HasSetter: hasSetter,
           IsInit: isInit,
           IsRequired: isRequired,

Chickensoft.Introspection.Generator/src/models/DeclaredProperty.cs

@@ -9,12 +9,14 @@ namespace Chickensoft.Introspection.Generator.Models;
 /// Represents a property on a metatype. Properties are opt-in and persisted.
 /// </summary>
 /// <param name="Name">Name of the </param>
+/// <param name="HasGetter">True if the property has a getter.</param>
 /// <param name="HasSetter">True if the property has a setter.</param>
 /// <param name="IsNullable">True if the property is nullable.</param>
 /// <param name="GenericType">Type of the </param>
 /// <param name="Attributes">Attributes applied to the </param>
 public sealed record DeclaredProperty(
   string Name,
+  bool HasGetter,
   bool HasSetter,
   bool IsInit,
   bool IsRequired,
@@ -28,6 +30,10 @@ public void Write(IndentedTextWriter writer, string typeSimpleNameClosed) {
 
     var propertyValue = "value" + (IsNullable ? "" : "!");
 
+    var getter = HasGetter
+      ? $"(object obj) => (({typeSimpleNameClosed})obj).{Name}"
+      : "null";
+
     var setter = HasSetter
       ? (
         IsInit
@@ -40,9 +46,7 @@ public void Write(IndentedTextWriter writer, string typeSimpleNameClosed) {
     writer.WriteLine($"Name: \"{Name}\",");
     writer.WriteLine($"IsInit: {(IsInit ? "true" : "false")},");
     writer.WriteLine($"IsRequired: {(IsRequired ? "true" : "false")},");
-    writer.WriteLine(
-      $"Getter: (object obj) => (({typeSimpleNameClosed})obj).{Name},"
-    );
+    writer.WriteLine($"Getter: {getter},");
     writer.WriteLine($"Setter: {setter},");
     writer.Write("GenericType: ");
     GenericType.Write(writer);
@@ -64,6 +68,7 @@ public void Write(IndentedTextWriter writer, string typeSimpleNameClosed) {
   public bool Equals(DeclaredProperty? other) =>
     other is not null &&
     Name == other.Name &&
+    HasGetter == other.HasGetter &&
     HasSetter == other.HasSetter &&
     IsInit == other.IsInit &&
     IsNullable == other.IsNullable &&
@@ -72,6 +77,7 @@ other is not null &&
 
   public override int GetHashCode() => HashCode.Combine(
     Name,
+    HasGetter,
     HasSetter,
     IsInit,
     IsNullable,

Chickensoft.Introspection/src/models/PropertyMetadata.cs

@@ -21,7 +21,7 @@ public sealed record PropertyMetadata(
   string Name,
   bool IsInit,
   bool IsRequired,
-  Func<object, object?> Getter,
+  Func<object, object?>? Getter,
   Action<object, object?>? Setter,
   GenericType GenericType,
   Dictionary<Type, Attribute[]> Attributes