refactor: convert classes to records and simplify constructors for IntOrString, ResourceQuantity, and V1Patch

Author: tg123

examples/resize/Program.cs

@@ -23,7 +23,7 @@
                 {
                     Requests = new Dictionary<string, ResourceQuantity>()
                     {
-                        ["cpu"] = new ResourceQuantity("100m"),
+                        ["cpu"] = "100m",
                     },
                 },
             },

src/KubernetesClient/Models/IntOrString.cs

@@ -1,16 +1,19 @@
 namespace k8s.Models
 {
     [JsonConverter(typeof(IntOrStringJsonConverter))]
-    public partial class IntOrString
+    public record IntOrString
     {
+        [JsonPropertyName("value")]
+        public string Value { get; init; }
+
         public static implicit operator IntOrString(int v)
         {
-            return new IntOrString { Value = Convert.ToString(v) };
+            return new IntOrString(Convert.ToString(v));
         }
 
         public static implicit operator IntOrString(long v)
         {
-            return new IntOrString { Value = Convert.ToString(v) };
+            return new IntOrString(Convert.ToString(v));
         }
 
         public static implicit operator string(IntOrString v)
@@ -20,37 +23,12 @@ public static implicit operator string(IntOrString v)
 
         public static implicit operator IntOrString(string v)
         {
-            return new IntOrString { Value = v };
-        }
-
-        protected bool Equals(IntOrString other)
-        {
-            return string.Equals(Value, other?.Value);
-        }
-
-        public override bool Equals(object obj)
-        {
-            if (ReferenceEquals(null, obj))
-            {
-                return false;
-            }
-
-            if (ReferenceEquals(this, obj))
-            {
-                return true;
-            }
-
-            if (obj.GetType() != GetType())
-            {
-                return false;
-            }
-
-            return Equals((IntOrString)obj);
+            return new IntOrString(v);
         }
 
-        public override int GetHashCode()
+        public override string ToString()
         {
-            return Value != null ? Value.GetHashCode() : 0;
+            return Value;
         }
     }
 }

src/KubernetesClient/Models/IntOrStringYamlConverter.cs

@@ -21,7 +21,7 @@ public object ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeseria
                         return null;
                     }
 
-                    return new IntOrString { Value = scalar?.Value };
+                    return scalar?.Value;
                 }
                 finally
                 {

src/KubernetesClient/Models/ResourceQuantity.cs

@@ -54,7 +54,7 @@ namespace k8s.Models
     ///     cause implementors to also use a fixed point implementation.
     /// </summary>
     [JsonConverter(typeof(ResourceQuantityJsonConverter))]
-    public partial class ResourceQuantity
+    public record ResourceQuantity
     {
         public enum SuffixFormat
         {
@@ -85,12 +85,6 @@ public ResourceQuantity(decimal n, int exp, SuffixFormat format)
             Format = format;
         }
 
-        public ResourceQuantity(string s)
-        {
-            Value = s;
-            CustomInit();
-        }
-
         public SuffixFormat Format { get; private set; }
 
         public string CanonicalizeString()
@@ -103,39 +97,6 @@ public override string ToString()
             return CanonicalizeString();
         }
 
-        protected bool Equals(ResourceQuantity other)
-        {
-            return _unitlessValue.Equals(other?._unitlessValue);
-        }
-
-        public override bool Equals(object obj)
-        {
-            if (ReferenceEquals(null, obj))
-            {
-                return false;
-            }
-
-            if (ReferenceEquals(this, obj))
-            {
-                return true;
-            }
-
-            if (obj.GetType() != GetType())
-            {
-                return false;
-            }
-
-            return Equals((ResourceQuantity)obj);
-        }
-
-        public override int GetHashCode()
-        {
-            unchecked
-            {
-                return ((int)Format * 397) ^ _unitlessValue.GetHashCode();
-            }
-        }
-
         //
         // CanonicalizeString = go version CanonicalizeBytes
         // CanonicalizeBytes returns the canonical form of q and its suffix (see comment on Quantity).
@@ -163,18 +124,17 @@ public string CanonicalizeString(SuffixFormat suffixFormat)
             return Suffixer.AppendMaxSuffix(_unitlessValue, suffixFormat);
         }
 
-        // ctor
-        partial void CustomInit()
+        public ResourceQuantity(string v)
         {
-            if (Value == null)
+            if (v == null)
             {
                 // No value has been defined, initialize to 0.
                 _unitlessValue = new Fraction(0);
                 Format = SuffixFormat.BinarySI;
                 return;
             }
 
-            var value = Value.Trim();
+            var value = v.Trim();
 
             var si = value.IndexOfAny(SuffixChars);
             if (si == -1)
@@ -194,6 +154,11 @@ partial void CustomInit()
             }
         }
 
+        public static implicit operator ResourceQuantity(string v)
+        {
+            return new ResourceQuantity(v);
+        }
+
         private static bool HasMantissa(Fraction value)
         {
             if (value.IsZero)

src/KubernetesClient/Models/ResourceQuantityJsonConverter.cs

@@ -8,16 +8,16 @@ public override ResourceQuantity Read(ref Utf8JsonReader reader, Type typeToConv
             switch (reader.TokenType)
             {
                 case JsonTokenType.Null:
-                    return new ResourceQuantity { Value = null };
+                    return null;
                 case JsonTokenType.Number:
                     if (reader.TryGetDouble(out var val))
                     {
-                        return new ResourceQuantity { Value = Convert.ToString(val) };
+                        return Convert.ToString(val);
                     }
 
                     return reader.GetDecimal();
                 default:
-                    return new ResourceQuantity { Value = reader.GetString() };
+                    return reader.GetString();
             }
         }
 

src/KubernetesClient/Models/ResourceQuantityYamlConverter.cs

@@ -21,7 +21,7 @@ public object ReadYaml(IParser parser, Type type, ObjectDeserializer rootDeseria
                         return null;
                     }
 
-                    return new ResourceQuantity { Value = scalar?.Value };
+                    return scalar?.Value;
                 }
                 finally
                 {

src/KubernetesClient/Models/V1Patch.cs

@@ -1,7 +1,7 @@
 namespace k8s.Models
 {
     [JsonConverter(typeof(V1PatchJsonConverter))]
-    public partial record class V1Patch
+    public record V1Patch
     {
         public enum PatchType
         {
@@ -31,17 +31,17 @@ public enum PatchType
             ApplyPatch,
         }
 
+        [JsonPropertyName("content")]
+        [JsonInclude]
+        public object Content { get; private set; }
+
         public PatchType Type { get; private set; }
 
         public V1Patch(object body, PatchType type)
         {
             Content = body;
             Type = type;
-            CustomInit();
-        }
 
-        partial void CustomInit()
-        {
             if (Content == null)
             {
                 throw new ArgumentNullException(nameof(Content), "object must be set");

src/LibKubernetesGenerator/ModelGenerator.cs

@@ -19,24 +19,36 @@ public void Generate(OpenApiDocument swagger, IncrementalGeneratorPostInitializa
         {
             var sc = scriptObjectFactory.CreateScriptObject();
 
+            var genSkippedTypes = new HashSet<string>
+            {
+                "IntOrString",
+                "ResourceQuantity",
+                "V1Patch",
+            };
+
             var extSkippedTypes = new HashSet<string>
             {
                 "V1WatchEvent",
             };
 
             var typeOverrides = new Dictionary<string, string>
             {
-                { "IntOrString", "class" },
-                { "ResourceQuantity", "class" },
+                // not used at the moment
             };
 
             foreach (var kv in swagger.Definitions)
             {
                 var def = kv.Value;
                 var clz = classNameHelper.GetClassNameForSchemaDefinition(def);
+
+                if (genSkippedTypes.Contains(clz))
+                {
+                    continue;
+                }
+
                 var hasExt = def.ExtensionData != null
                      && def.ExtensionData.ContainsKey("x-kubernetes-group-version-kind")
-                     && !extSkippedTypes.Contains(classNameHelper.GetClassName(def));
+                     && !extSkippedTypes.Contains(clz);
 
 
                 var typ = "record";
@@ -51,7 +63,6 @@ public void Generate(OpenApiDocument swagger, IncrementalGeneratorPostInitializa
                 sc.SetValue("typ", typ, true);
                 sc.SetValue("hasExt", hasExt, true);
 
-
                 context.RenderToContext("Model.cs.template", sc, $"Models_{clz}.g.cs");
             }
         }

src/LibKubernetesGenerator/templates/Model.cs.template

@@ -21,25 +21,12 @@ public partial {{typ}} {{clz}} {{ if hasExt }} : {{ GetInterfaceName def }} {{ e
     public const string KubePluralName = "{{ GetPlural def }}";
     {{ end }}
 
-    /// <summary>
-    /// Initializes a new instance of the {{GetClassName def}} class.
-    /// </summary>
-    public {{clz}}()
-    {
-        CustomInit();
-    }
-
-    /// <summary>
-    /// An initialization method that performs custom operations like setting defaults
-    /// </summary>
-    partial void CustomInit();
-
     {{ for property in properties }}
     /// <summary>
     /// {{ToXmlDoc property.description}}
     /// </summary>
     [JsonPropertyName("{{property.name}}")]
-    public {{ if property.IsRequired }} required  {{ end }} {{GetDotNetType property}} {{GetDotNetName property.name "field"}} { get; set; }
+    public {{ if property.IsRequired }} required {{ end }} {{GetDotNetType property}} {{GetDotNetName property.name "field"}} { get; set; }
     {{ end }}
 }