Better Collection and ReadOnlyCollection support

New generators, additional tests
soenneker · Apr 19, 2024 · 852f891 · 852f891
1 parent 6f659df
commit 852f891
Show file tree

Hide file tree

Showing 16 changed files with 280 additions and 80 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,11 @@
 
 This project is an automatic creator and populator for the fake data generator [Bogus](https://github.com/bchavez/Bogus). It's a replacement for the abandoned [AutoBogus](https://github.com/nickdodd79/AutoBogus) library.
 
-The goals are to be *fast*, and support the latest types in .NET. It uses the fastest .NET Reflection cache: [soenneker.reflection.cache](https://github.com/soenneker/soenneker.reflection.cache).
+The goals:
+- Be *fast*
+- Support the latest types in .NET
+
+It uses the fastest .NET Reflection cache: [soenneker.reflection.cache](https://github.com/soenneker/soenneker.reflection.cache). Bogus updates are automatically integrated.
 
 .NET 6+ is supported.
 
@@ -95,14 +99,21 @@ var order = autoFaker.Generate();
 
 ## Benchmarks
 
-### Soenneker.Utils.AutoBogus
+### Soenneker.Utils.AutoBogus - `AutoFaker`
 
 | Method           | Mean        | Error     | StdDev    |
 |----------------- |------------:|----------:|----------:|
 | Generate_int     |    79.40 ns |  0.635 ns |  0.563 ns |
 | Generate_string  |   241.35 ns |  3.553 ns |  3.324 ns |
 | Generate_complex | 6,782.34 ns | 43.811 ns | 38.837 ns |
 
+### Soenneker.Utils.AutoBogus - `AutoFaker<T>`
+
+| Method           | Mean       | Error    | StdDev   |
+|----------------- |-----------:|---------:|---------:|
+| Generate_string  |   283.6 ns |  3.28 ns |  3.07 ns |
+| Generate_complex | 8,504.0 ns | 76.58 ns | 67.89 ns |
+
 ### AutoBogus
 
 | Method           | Mean      | Error    | StdDev   |
@@ -112,8 +123,9 @@ var order = autoFaker.Generate();
 
 ### Bogus
 
-| Method       | Mean          | Error         | StdDev       |
-|------------- |--------------:|--------------:|-------------:|
-| Bogus_int    |      19.58 ns |      0.150 ns |     0.133 ns |
-| Bogus_string |     172.25 ns |      2.510 ns |     2.347 ns |
-| Bogus_ctor   | 717,799.56 ns | 10,086.875 ns | 9,435.269 ns |
+| Method       | Mean          | Error        | StdDev       |
+|------------- |--------------:|-------------:|-------------:|
+| Bogus_int    |      19.70 ns |     0.176 ns |     0.165 ns |
+| Bogus_string |     171.75 ns |     2.763 ns |     2.585 ns |
+| Bogus_ctor   | 730,669.06 ns | 8,246.622 ns | 7,310.416 ns |
+
diff --git a/src/Enums/GenericCollectionType.cs b/src/Enums/GenericCollectionType.cs
@@ -1,6 +1,4 @@
-#pragma warning disable CA2211
-
-namespace Soenneker.Utils.AutoBogus.Enums;
+namespace Soenneker.Utils.AutoBogus.Enums;
 
 public enum GenericCollectionType
 {
@@ -9,7 +7,7 @@ public enum GenericCollectionType
     Collection = 2,
     ReadOnlyCollection = 3,
     Set = 4,
-    ListType = 5,
+    List = 5,
     ReadOnlyList = 6,
     SortedList = 7,
     ReadOnlyDictionary = 8,

diff --git a/src/Extensions/TypeArrayExtension.cs b/src/Extensions/TypeArrayExtension.cs
@@ -32,6 +32,10 @@ internal static (CachedType?, GenericCollectionType?) GetTypeOfGenericCollection
                     }
 
                     break;
+                case "ReadOnlyCollection`1":
+                    return (cachedType, GenericCollectionType.ReadOnlyCollection);
+                case "Collection`1":
+                    return (cachedType, GenericCollectionType.Collection);
                 case "IImmutableDictionary`2":
                     if (genericCollectionType < GenericCollectionType.ImmutableDictionary)
                     {
@@ -56,10 +60,10 @@ internal static (CachedType?, GenericCollectionType?) GetTypeOfGenericCollection
                     }
 
                     break;
-                case "Ilist`1":
-                    if (genericCollectionType < GenericCollectionType.ListType)
+                case "IList`1":
+                    if (genericCollectionType < GenericCollectionType.List)
                     {
-                        genericCollectionType = GenericCollectionType.ListType;
+                        genericCollectionType = GenericCollectionType.List;
                         returnType = cachedType;
                     }
 

diff --git a/src/Generators/AutoFakerGeneratorFactory.cs b/src/Generators/AutoFakerGeneratorFactory.cs
@@ -114,10 +114,18 @@ internal static IAutoFakerGenerator CreateGenerator(AutoFakerContext context)
 
                     return CreateGenericGenerator(CachedTypeService.DictionaryGenerator.Value, keyType, valueType);
                 }
-                case GenericCollectionType.ReadOnlyList:
-                case GenericCollectionType.ListType:
                 case GenericCollectionType.ReadOnlyCollection:
+                {
+                    CachedType elementType = generics[0];
+                    return CreateGenericGenerator(CachedTypeService.ReadOnlyCollectionGenerator.Value, elementType);
+                }
                 case GenericCollectionType.Collection:
+                {
+                    CachedType elementType = generics[0];
+                    return CreateGenericGenerator(CachedTypeService.CollectionGenerator.Value, elementType);
+                }
+                case GenericCollectionType.ReadOnlyList:
+                case GenericCollectionType.List:
                 {
                     CachedType elementType = generics[0];
                     return CreateGenericGenerator(CachedTypeService.ListGenerator.Value, elementType);

diff --git a/src/Generators/Types/CollectionGenerator.cs b/src/Generators/Types/CollectionGenerator.cs
@@ -0,0 +1,42 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Soenneker.Utils.AutoBogus.Context;
+using Soenneker.Utils.AutoBogus.Extensions;
+using Soenneker.Utils.AutoBogus.Generators.Abstract;
+
+namespace Soenneker.Utils.AutoBogus.Generators.Types;
+
+internal sealed class CollectionGenerator<TType> : IAutoFakerGenerator
+{
+    object IAutoFakerGenerator.Generate(AutoFakerContext context)
+    {
+        Collection<TType> collection;
+
+        if (context.CachedType.IsInterface)
+        {
+            collection = [];
+        }
+        else
+        {
+            try
+            {
+                collection = context.CachedType.CreateInstance<Collection<TType>>();
+            }
+            catch (Exception ex)
+            {
+                collection = [];
+            }
+        }
+
+        List<TType> items = context.GenerateMany<TType>();
+
+        for (var i = 0; i < items.Count; i++)
+        {
+            TType item = items[i];
+            collection.Add(item);
+        }
+
+        return collection;
+    }
+}
diff --git a/src/Generators/Types/ReadOnlyCollectionGenerator.cs b/src/Generators/Types/ReadOnlyCollectionGenerator.cs
@@ -0,0 +1,26 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using Soenneker.Utils.AutoBogus.Context;
+using Soenneker.Utils.AutoBogus.Extensions;
+using Soenneker.Utils.AutoBogus.Generators.Abstract;
+
+namespace Soenneker.Utils.AutoBogus.Generators.Types;
+
+internal sealed class ReadOnlyCollectionGenerator<TType> : IAutoFakerGenerator
+{
+    object IAutoFakerGenerator.Generate(AutoFakerContext context)
+    {
+        List<TType> items = context.GenerateMany<TType>();
+
+        try
+        {
+            ReadOnlyCollection<TType> collection = new ReadOnlyCollection<TType>(items);
+            return collection;
+        }
+        catch (Exception ex)
+        {
+            return null!;
+        }
+    }
+}
diff --git a/src/Services/CachedTypeService.cs b/src/Services/CachedTypeService.cs
@@ -10,18 +10,20 @@ internal static class CachedTypeService
 {
     public static ReflectionCache ReflectionCache { get; set; } = new ReflectionCache();
 
-    internal static readonly Lazy<CachedType> TypeGenerator = new(() => ReflectionCache.GetCachedType(typeof(TypeGenerator<>)));
-    internal static readonly Lazy<CachedType> EnumerableGenerator = new(() => ReflectionCache.GetCachedType(typeof(EnumerableGenerator<>)));
-    internal static readonly Lazy<CachedType> ListGenerator = new(() => ReflectionCache.GetCachedType(typeof(ListGenerator<>)));
-    internal static readonly Lazy<CachedType> SetGenerator = new(() => ReflectionCache.GetCachedType(typeof(SetGenerator<>)));
-    internal static readonly Lazy<CachedType> ReadOnlyDictionaryGenerator = new(() => ReflectionCache.GetCachedType(typeof(ReadOnlyDictionaryGenerator<,>)));
-    internal static readonly Lazy<CachedType> NullableGenerator = new(() => ReflectionCache.GetCachedType(typeof(NullableGenerator<>)));
-    internal static readonly Lazy<CachedType> EnumGenerator = new(() => ReflectionCache.GetCachedType(typeof(EnumGenerator<>)));
-    internal static readonly Lazy<CachedType> ArrayGenerator = new(() => ReflectionCache.GetCachedType(typeof(ArrayGenerator<>)));
-    internal static readonly Lazy<CachedType> DictionaryGenerator = new(() => ReflectionCache.GetCachedType(typeof(DictionaryGenerator<,>)));
+    internal static readonly Lazy<CachedType> TypeGenerator = new(() => ReflectionCache.GetCachedType(typeof(TypeGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> EnumerableGenerator = new(() => ReflectionCache.GetCachedType(typeof(EnumerableGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> ListGenerator = new(() => ReflectionCache.GetCachedType(typeof(ListGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> SetGenerator = new(() => ReflectionCache.GetCachedType(typeof(SetGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> ReadOnlyDictionaryGenerator = new(() => ReflectionCache.GetCachedType(typeof(ReadOnlyDictionaryGenerator<,>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> NullableGenerator = new(() => ReflectionCache.GetCachedType(typeof(NullableGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> EnumGenerator = new(() => ReflectionCache.GetCachedType(typeof(EnumGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> ArrayGenerator = new(() => ReflectionCache.GetCachedType(typeof(ArrayGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> DictionaryGenerator = new(() => ReflectionCache.GetCachedType(typeof(DictionaryGenerator<,>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> CollectionGenerator = new(() => ReflectionCache.GetCachedType(typeof(CollectionGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> ReadOnlyCollectionGenerator = new(() => ReflectionCache.GetCachedType(typeof(ReadOnlyCollectionGenerator<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
 
-    internal static readonly Lazy<CachedType> IDictionary = new(() => ReflectionCache.GetCachedType(typeof(IDictionary<,>)));
-    internal static readonly Lazy<CachedType> IEnumerable = new(() => ReflectionCache.GetCachedType(typeof(IEnumerable<>)));
-    internal static readonly Lazy<CachedType> AutoFaker = new(() => ReflectionCache.GetCachedType(typeof(AutoFaker)));
-    internal static readonly Lazy<CachedType> Object = new(() => ReflectionCache.GetCachedType(typeof(object)));
+    internal static readonly Lazy<CachedType> IDictionary = new(() => ReflectionCache.GetCachedType(typeof(IDictionary<,>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> IEnumerable = new(() => ReflectionCache.GetCachedType(typeof(IEnumerable<>)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> AutoFaker = new(() => ReflectionCache.GetCachedType(typeof(AutoFaker)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
+    internal static readonly Lazy<CachedType> Object = new(() => ReflectionCache.GetCachedType(typeof(object)), System.Threading.LazyThreadSafetyMode.PublicationOnly);
 }
diff --git a/test/Soenneker.Utils.AutoBogus.Tests/AutoFakerTests.cs b/test/Soenneker.Utils.AutoBogus.Tests/AutoFakerTests.cs
@@ -80,6 +80,26 @@ public void Generate_TestClassIReadOnlyCollection_should_generate()
         classObj.Ints.Should().NotBeNullOrEmpty();
     }
 
+    [Fact]
+    public void Generate_TestClassCollection_should_generate()
+    {
+        var faker = new AutoFaker();
+
+        var classObj = faker.Generate<TestClassCollection>();
+        classObj.Should().NotBeNull();
+        classObj.Strings.Should().NotBeNullOrEmpty();
+    }
+
+    [Fact]
+    public void Generate_TestClassReadOnlyCollection_should_generate()
+    {
+        var faker = new AutoFaker();
+
+        var classObj = faker.Generate<TestClassReadOnlyCollection>();
+        classObj.Should().NotBeNull();
+        classObj.Strings.Should().NotBeNullOrEmpty();
+    }
+
     [Fact]
     public void Generate_Product_should_generate()
     {

diff --git a/test/Soenneker.Utils.AutoBogus.Tests/AutoGeneratorsFixture.cs b/test/Soenneker.Utils.AutoBogus.Tests/AutoGeneratorsFixture.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.Collections.ObjectModel;
 using System.Dynamic;
 using System.Linq;
 using System.Reflection;
@@ -458,21 +459,19 @@ public void GetGenerator_Should_Return_DictionaryGenerator(Type type)
         }
     }
 
-    public class ListGenerator
-        : AutoGeneratorsFixture
+    public class ListGenerator: AutoGeneratorsFixture
     {
         [Theory]
         [InlineData(typeof(IList<TestEnum>))]
         [InlineData(typeof(IList<TestStruct>))]
         [InlineData(typeof(IList<TestClass>))]
         [InlineData(typeof(IList<ITestInterface>))]
         [InlineData(typeof(IList<TestAbstractClass>))]
-        [InlineData(typeof(ICollection<TestEnum>))]
-        [InlineData(typeof(ICollection<TestStruct>))]
-        [InlineData(typeof(ICollection<TestClass>))]
-        [InlineData(typeof(ICollection<ITestInterface>))]
-        [InlineData(typeof(ICollection<TestAbstractClass>))]
+        [InlineData(typeof(List<TestEnum>))]
         [InlineData(typeof(List<TestClass>))]
+        [InlineData(typeof(List<TestStruct>))]
+        [InlineData(typeof(List<ITestInterface>))]
+        [InlineData(typeof(List<TestAbstractClass>))]
         public void Generate_Should_Return_List(Type type)
         {
             Type[] genericTypes = type.GetGenericArguments();
@@ -484,24 +483,66 @@ public void Generate_Should_Return_List(Type type)
             list.Should().NotBeNull();
         }
 
+        [Theory]
+        [InlineData(typeof(ICollection<TestEnum>))]
+        [InlineData(typeof(ICollection<TestStruct>))]
+        [InlineData(typeof(ICollection<TestClass>))]
+        [InlineData(typeof(ICollection<ITestInterface>))]
+        [InlineData(typeof(ICollection<TestAbstractClass>))]
+        [InlineData(typeof(Collection<TestEnum>))]
+        [InlineData(typeof(Collection<TestClass>))]
+        [InlineData(typeof(Collection<TestStruct>))]
+        [InlineData(typeof(Collection<ITestInterface>))]
+        [InlineData(typeof(Collection<TestAbstractClass>))]
+        public void Generate_Should_Return_Collection(Type type)
+        {
+            Type[] genericTypes = type.GetGenericArguments();
+            Type itemType = genericTypes.ElementAt(0);
+            AutoFakerBinderService.SetBinder(new AutoFakerBinder(new AutoFakerConfig()));
+            IAutoFakerGenerator generator = CreateGenerator(typeof(CollectionGenerator<>), itemType);
+            var collection = InvokeGenerator(type, generator) as IEnumerable;
+
+            collection.Should().NotBeNull();
+        }
+
         [Theory]
         [InlineData(typeof(IList<TestEnum>))]
         [InlineData(typeof(IList<TestStruct>))]
         [InlineData(typeof(IList<TestClass>))]
         [InlineData(typeof(IList<ITestInterface>))]
         [InlineData(typeof(IList<TestAbstractClass>))]
+        [InlineData(typeof(List<TestEnum>))]
+        [InlineData(typeof(List<TestClass>))]
+        [InlineData(typeof(List<TestStruct>))]
+        [InlineData(typeof(List<ITestInterface>))]
+        [InlineData(typeof(List<TestAbstractClass>))]
+        public void GetGenerator_Should_Return_ListGenerator(Type type)
+        {
+            AutoFakerContext context = CreateContext(type);
+            Type[] genericTypes = type.GetGenericArguments();
+            Type itemType = genericTypes.ElementAt(0);
+            Type generatorType = GetGeneratorType(typeof(ListGenerator<>), itemType);
+
+            AutoFakerGeneratorFactory.GetGenerator(context).Should().BeOfType(generatorType);
+        }
+
+        [Theory]
         [InlineData(typeof(ICollection<TestEnum>))]
         [InlineData(typeof(ICollection<TestStruct>))]
         [InlineData(typeof(ICollection<TestClass>))]
         [InlineData(typeof(ICollection<ITestInterface>))]
         [InlineData(typeof(ICollection<TestAbstractClass>))]
-        [InlineData(typeof(List<TestClass>))]
-        public void GetGenerator_Should_Return_ListGenerator(Type type)
+        [InlineData(typeof(Collection<TestEnum>))]
+        [InlineData(typeof(Collection<TestClass>))]
+        [InlineData(typeof(Collection<TestStruct>))]
+        [InlineData(typeof(Collection<ITestInterface>))]
+        [InlineData(typeof(Collection<TestAbstractClass>))]
+        public void GetGenerator_Should_Return_CollectionGenerator(Type type)
         {
             AutoFakerContext context = CreateContext(type);
             Type[] genericTypes = type.GetGenericArguments();
             Type itemType = genericTypes.ElementAt(0);
-            Type generatorType = GetGeneratorType(typeof(ListGenerator<>), itemType);
+            Type generatorType = GetGeneratorType(typeof(CollectionGenerator<>), itemType);
 
             AutoFakerGeneratorFactory.GetGenerator(context).Should().BeOfType(generatorType);
         }

diff --git a/test/Soenneker.Utils.AutoBogus.Tests/Benchmarking/Benchmarks/BogusBenchmarks.cs b/test/Soenneker.Utils.AutoBogus.Tests/Benchmarking/Benchmarks/BogusBenchmarks.cs
@@ -14,15 +14,15 @@ public void Setup()
     }
 
     [Benchmark]
-    public string Bogus_string()
+    public int Bogus_int()
     {
-       return _faker.Random.Word();
+        return _faker.Random.Int();
     }
 
     [Benchmark]
-    public int Bogus_int()
+    public string Bogus_string()
     {
-        return _faker.Random.Int();
+       return _faker.Random.Word();
     }
 
     [Benchmark]