RSCG – Vogen
RSCG – Vogen
| name | Vogen |
| nuget | https://www.nuget.org/packages/Vogen/ |
| link | https://dunnhq.com/posts/2021/primitive-obsession/ |
| author | Steve Dunn |
Transform values( e.g. int) into classes
If you know what are ValueObject,that is one solution
This is how you can use Vogen .
The code that you start with is
01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 | <Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <OutputType>Exe</OutputType> <TargetFramework>net7.0</TargetFramework> <ImplicitUsings>enable</ImplicitUsings> <Nullable>enable</Nullable> </PropertyGroup> <ItemGroup> <PackageReference Include="Vogen" Version="3.0.16" /> </ItemGroup><PropertyGroup> <EmitCompilerGeneratedFiles>true</EmitCompilerGeneratedFiles> <CompilerGeneratedFilesOutputPath>$(BaseIntermediateOutputPath)\GX</CompilerGeneratedFilesOutputPath> </PropertyGroup></Project> |
The code that you will use is
01 02 03 04 05 06 07 08 09 10 11 12 | // See https://aka.ms/new-console-template for more informationusing DemoVogen;Console.WriteLine("Hello, World!");var p = PersonId.From(123);var p1 = PersonId.From(123);var p2 =(PersonId) 123;Console.WriteLine(p == 123);Console.WriteLine(p == p1);Console.WriteLine(p == p2); |
1 2 3 4 5 6 7 | // See https://aka.ms/new-console-template for more informationusing Vogen;namespace DemoVogen;[ValueObject<int>]public partial struct PersonId{} |
The code that is generated is
001 002 003 004 005 006 007 008 009 010 011 012 013 014 015 016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051 052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087 088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 | // ------------------------------------------------------------------------------// <auto-generated>// This code was generated by a source generator named Vogen (https://github.com/SteveDunn/Vogen)//// Changes to this file may cause incorrect behavior and will be lost if// the code is regenerated.// </auto-generated>// ------------------------------------------------------------------------------// Suppress warnings about [Obsolete] member usage in generated code.#pragma warning disable CS0618// Suppress warnings for 'Override methods on comparable types'.#pragma warning disable CA1036// Suppress Error MA0097 : A class that implements IComparable<T> or IComparable should override comparison operators#pragma warning disable MA0097// Suppress warning for 'The annotation for nullable reference types should only be used in code within a '#nullable' annotations context. Auto-generated code requires an explicit '#nullable' directive in source.'// The generator copies signatures from the BCL, e.g. for `TryParse`, and some of those have nullable annotations.#pragma warning disable CS8669// Suppress warnings about CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'#pragma warning disable CS1591using Vogen;namespace DemoVogen{ [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverage] [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Vogen", "3.0.0.0")] [global::System.Text.Json.Serialization.JsonConverter(typeof(PersonIdSystemTextJsonConverter))][global::System.ComponentModel.TypeConverter(typeof(PersonIdTypeConverter))] [global::System.Diagnostics.DebuggerTypeProxyAttribute(typeof(PersonIdDebugView))] [global::System.Diagnostics.DebuggerDisplayAttribute("Underlying type: System.Int32, Value = { _value }")] public partial struct PersonId : global::System.IEquatable<PersonId>, global::System.IEquatable<System.Int32> , global::System.IComparable<PersonId>, global::System.IComparable {#if DEBUG private readonly global::System.Diagnostics.StackTrace _stackTrace = null;#endif private readonly global::System.Boolean _isInitialized; private readonly System.Int32 _value; /// <summary> /// Gets the underlying <see cref="System.Int32" /> value if set, otherwise a <see cref="ValueObjectValidationException" /> is thrown. /// </summary> public readonly System.Int32 Value { [global::System.Diagnostics.DebuggerStepThroughAttribute] get { EnsureInitialized(); return _value; } } [global::System.Diagnostics.DebuggerStepThroughAttribute] [global::System.ComponentModel.EditorBrowsable(global::System.ComponentModel.EditorBrowsableState.Never)] public PersonId() {#if DEBUG _stackTrace = new global::System.Diagnostics.StackTrace();#endif _isInitialized = false; _value = default; } [global::System.Diagnostics.DebuggerStepThroughAttribute] private PersonId(System.Int32 value) { _value = value; _isInitialized = true; } /// <summary> /// Builds an instance from the provided underlying type. /// </summary> /// <param name="value">The underlying type.</param> /// <returns>An instance of this type.</returns> public static PersonId From(System.Int32 value) { PersonId instance = new PersonId(value); return instance; } public static explicit operator PersonId(System.Int32 value) => From(value); public static explicit operator System.Int32(PersonId value) => value.Value; // only called internally when something has been deserialized into // its primitive type. private static PersonId Deserialize(System.Int32 value) { return new PersonId(value); } public readonly global::System.Boolean Equals(PersonId other) { // It's possible to create uninitialized instances via converters such as EfCore (HasDefaultValue), which call Equals. // We treat anything uninitialized as not equal to anything, even other uninitialized instances of this type. if(!_isInitialized || !other._isInitialized) return false; return global::System.Collections.Generic.EqualityComparer<System.Int32>.Default.Equals(Value, other.Value); } public readonly global::System.Boolean Equals(System.Int32 primitive) => Value.Equals(primitive); public readonly override global::System.Boolean Equals(global::System.Object obj) { return obj is PersonId && Equals((PersonId) obj); } public static global::System.Boolean operator ==(PersonId left, PersonId right) => Equals(left, right); public static global::System.Boolean operator !=(PersonId left, PersonId right) => !(left == right); public static global::System.Boolean operator ==(PersonId left, System.Int32 right) => Equals(left.Value, right); public static global::System.Boolean operator !=(PersonId left, System.Int32 right) => !Equals(left.Value, right); public static global::System.Boolean operator ==(System.Int32 left, PersonId right) => Equals(left, right.Value); public static global::System.Boolean operator !=(System.Int32 left, PersonId right) => !Equals(left, right.Value); public int CompareTo(PersonId other) => Value.CompareTo(other.Value); public int CompareTo(object other) { if(other == null) return 1; if(other is PersonId x) return CompareTo(x); throw new global::System.ArgumentException("Cannot compare to object as it is not of type PersonId", nameof(other)); } /// <inheritdoc cref="int.TryParse(System.ReadOnlySpan{char}, System.Globalization.NumberStyles, System.IFormatProvider?, out int)"/> /// <summary> /// </summary> /// <returns> /// The value created via the <see cref="From"/> method. /// </returns> /// <exception cref="ValueObjectValidationException">Thrown when the value can be parsed, but is not valid.</exception> public static global::System.Boolean TryParse(global::System.ReadOnlySpan<char> s, global::System.Globalization.NumberStyles style, global::System.IFormatProvider provider, #if NETCOREAPP3_0_OR_GREATER[global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif out PersonId result) { if(System.Int32.TryParse(s, style, provider, out var r)) { result = From(r); return true; } result = default; return false; } /// <inheritdoc cref="int.TryParse(System.ReadOnlySpan{char}, System.IFormatProvider?, out int)"/> /// <summary> /// </summary> /// <returns> /// The value created via the <see cref="From"/> method. /// </returns> /// <exception cref="ValueObjectValidationException">Thrown when the value can be parsed, but is not valid.</exception> public static global::System.Boolean TryParse(global::System.ReadOnlySpan<char> s, global::System.IFormatProvider provider, #if NETCOREAPP3_0_OR_GREATER[global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif out PersonId result) { if(System.Int32.TryParse(s, provider, out var r)) { result = From(r); return true; } result = default; return false; } /// <inheritdoc cref="int.TryParse(System.ReadOnlySpan{char}, out int)"/> /// <summary> /// </summary> /// <returns> /// The value created via the <see cref="From"/> method. /// </returns> /// <exception cref="ValueObjectValidationException">Thrown when the value can be parsed, but is not valid.</exception> public static global::System.Boolean TryParse(global::System.ReadOnlySpan<char> s, #if NETCOREAPP3_0_OR_GREATER[global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif out PersonId result) { if(System.Int32.TryParse(s, out var r)) { result = From(r); return true; } result = default; return false; } /// <inheritdoc cref="int.TryParse(string?, System.Globalization.NumberStyles, System.IFormatProvider?, out int)"/> /// <summary> /// </summary> /// <returns> /// The value created via the <see cref="From"/> method. /// </returns> /// <exception cref="ValueObjectValidationException">Thrown when the value can be parsed, but is not valid.</exception> public static global::System.Boolean TryParse(string s, global::System.Globalization.NumberStyles style, global::System.IFormatProvider provider, #if NETCOREAPP3_0_OR_GREATER[global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif out PersonId result) { if(System.Int32.TryParse(s, style, provider, out var r)) { result = From(r); return true; } result = default; return false; } /// <inheritdoc cref="int.TryParse(string?, System.IFormatProvider?, out int)"/> /// <summary> /// </summary> /// <returns> /// The value created via the <see cref="From"/> method. /// </returns> /// <exception cref="ValueObjectValidationException">Thrown when the value can be parsed, but is not valid.</exception> public static global::System.Boolean TryParse(string s, global::System.IFormatProvider provider, #if NETCOREAPP3_0_OR_GREATER[global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif out PersonId result) { if(System.Int32.TryParse(s, provider, out var r)) { result = From(r); return true; } result = default; return false; } /// <inheritdoc cref="int.TryParse(string?, out int)"/> /// <summary> /// </summary> /// <returns> /// The value created via the <see cref="From"/> method. /// </returns> /// <exception cref="ValueObjectValidationException">Thrown when the value can be parsed, but is not valid.</exception> public static global::System.Boolean TryParse(string s, #if NETCOREAPP3_0_OR_GREATER[global::System.Diagnostics.CodeAnalysis.NotNullWhen(true)]#endif out PersonId result) { if(System.Int32.TryParse(s, out var r)) { result = From(r); return true; } result = default; return false; } public readonly override global::System.Int32 GetHashCode() => global::System.Collections.Generic.EqualityComparer<System.Int32>.Default.GetHashCode(_value); /// <summary>Returns the string representation of the underlying type</summary> /// <inheritdoc cref="System.Int32.ToString()" /> public readonly override global::System.String ToString() =>_isInitialized ? Value.ToString() : "[UNINITIALIZED]"; private readonly void EnsureInitialized() { if (!_isInitialized) {#if DEBUG global::System.String message = "Use of uninitialized Value Object at: " + _stackTrace ?? "";#else global::System.String message = "Use of uninitialized Value Object.";#endif throw new global::Vogen.ValueObjectValidationException(message); } } class PersonIdSystemTextJsonConverter : global::System.Text.Json.Serialization.JsonConverter<PersonId> { public override PersonId Read(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options) { return PersonId.Deserialize(reader.GetInt32()); } public override void Write(System.Text.Json.Utf8JsonWriter writer, PersonId value, global::System.Text.Json.JsonSerializerOptions options) { writer.WriteNumberValue(value.Value); }#if NET6_0_OR_GREATER public override PersonId ReadAsPropertyName(ref global::System.Text.Json.Utf8JsonReader reader, global::System.Type typeToConvert, global::System.Text.Json.JsonSerializerOptions options) { return PersonId.Deserialize(global::System.Int32.Parse(reader.GetString(), global::System.Globalization.NumberStyles.Any, global::System.Globalization.CultureInfo.InvariantCulture)); } public override void WriteAsPropertyName(System.Text.Json.Utf8JsonWriter writer, PersonId value, global::System.Text.Json.JsonSerializerOptions options) { writer.WritePropertyName(value.Value.ToString(global::System.Globalization.CultureInfo.InvariantCulture)); }#endif } class PersonIdTypeConverter : global::System.ComponentModel.TypeConverter { public override global::System.Boolean CanConvertFrom(global::System.ComponentModel.ITypeDescriptorContext context, global::System.Type sourceType) { return sourceType == typeof(global::System.Int32) || sourceType == typeof(global::System.String) || base.CanConvertFrom(context, sourceType); } public override global::System.Object ConvertFrom(global::System.ComponentModel.ITypeDescriptorContext context, global::System.Globalization.CultureInfo culture, global::System.Object value) { return value switch { global::System.Int32 intValue => PersonId.Deserialize(intValue), global::System.String stringValue when !global::System.String.IsNullOrEmpty(stringValue) && global::System.Int32.TryParse(stringValue, out var result) => PersonId.Deserialize(result), _ => base.ConvertFrom(context, culture, value), }; } public override bool CanConvertTo(global::System.ComponentModel.ITypeDescriptorContext context, global::System.Type sourceType) { return sourceType == typeof(global::System.Int32) || sourceType == typeof(global::System.String) || base.CanConvertTo(context, sourceType); } public override object ConvertTo(global::System.ComponentModel.ITypeDescriptorContext context, global::System.Globalization.CultureInfo culture, global::System.Object value, global::System.Type destinationType) { if (value is PersonId idValue) { if (destinationType == typeof(global::System.Int32)) { return idValue.Value; } if (destinationType == typeof(global::System.String)) { return idValue.Value.ToString(); } } return base.ConvertTo(context, culture, value, destinationType); } } internal sealed class PersonIdDebugView { private readonly PersonId _t; PersonIdDebugView(PersonId t) { _t = t; } public global::System.Boolean IsInitialized => _t._isInitialized; public global::System.String UnderlyingType => "System.Int32"; public global::System.String Value => _t._isInitialized ? _t._value.ToString() : "[not initialized]" ; #if DEBUG public global::System.String CreatedWith => _t._stackTrace?.ToString() ?? "the From method"; #endif public global::System.String Conversions => @"Default"; }}} |
Code and pdf at
https://ignatandrei.github.io/RSCG_Examples/v2/docs/Vogen
Leave a Reply