Enforcing constructor creation of QueryDescription by making attribut…

…es private and updating tests to .Net8 and new API.
genaray · Aug 12, 2024 · d1fdb23 · d1fdb23
1 parent 70f9f27
commit d1fdb23
Show file tree

Hide file tree

Showing 9 changed files with 53 additions and 47 deletions.
diff --git a/src/Arch.Tests/Arch.Tests.csproj b/src/Arch.Tests/Arch.Tests.csproj
@@ -8,6 +8,7 @@
     <Nullable>enable</Nullable>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
     <Configurations>Debug;Release;Release-Pure;Release-PureECS;Release-Events;Debug-PureECS;Debug-Events</Configurations>
+    <LangVersion>12</LangVersion>
     <!--<TreatWarningsAsErrors>true</TreatWarningsAsErrors>-->
   </PropertyGroup>
 

diff --git a/src/Arch.Tests/BitSetTest.cs b/src/Arch.Tests/BitSetTest.cs
@@ -16,9 +16,9 @@ public sealed class BitSetTest
     [Test]
     public void ComponentHashOrder()
     {
-        ComponentType[] array1 = { typeof(int), typeof(byte) };
-        ComponentType[] array2 = { typeof(int), typeof(byte) };
-        ComponentType[] array3 = { typeof(byte), typeof(int) };
+        ComponentType[] array1 = [typeof(int), typeof(byte)];
+        ComponentType[] array2 = [typeof(int), typeof(byte)];
+        ComponentType[] array3 = [typeof(byte), typeof(int)];
 
         That(Component.GetHashCode(array2), Is.EqualTo(Component.GetHashCode(array1)));
         That(Component.GetHashCode(array3), Is.EqualTo(Component.GetHashCode(array1)));
@@ -243,8 +243,8 @@ public void Component32Hash(int borderComponentId)
         var componentTypeNotOnBorder = new ComponentType(borderComponentId - 10, 0);
         var componentTypeOnBorder = new ComponentType(borderComponentId, 0);
 
-        ComponentType[] array1 = { componentTypeNotOnBorder, componentTypeOnBorder };
-        ComponentType[] array2 = { componentTypeNotOnBorder };
+        ComponentType[] array1 = [componentTypeNotOnBorder, componentTypeOnBorder];
+        ComponentType[] array2 = [componentTypeNotOnBorder];
 
         That(Component.GetHashCode(array1), Is.Not.EqualTo(Component.GetHashCode(array2)));
     }

diff --git a/src/Arch.Tests/ChunkTest.cs b/src/Arch.Tests/ChunkTest.cs
@@ -12,7 +12,7 @@ namespace Arch.Tests;
 public sealed class ChunkTest
 {
     private Chunk _chunk;
-    private readonly ComponentType[] _types = { typeof(Transform), typeof(Rotation) };
+    private readonly ComponentType[] _types = [typeof(Transform), typeof(Rotation)];
 
     /// <summary>
     ///     Checks if data inside the chunk is being set correctly.

diff --git a/src/Arch.Tests/CommandBufferTest.cs b/src/Arch.Tests/CommandBufferTest.cs
@@ -10,9 +10,9 @@ namespace Arch.Tests;
 public sealed partial class CommandBufferTest
 {
 
-    private static readonly ComponentType[] _group = { typeof(Transform), typeof(Rotation) };
-    private static readonly ComponentType[] _secondGroup = { typeof(Transform), typeof(Rotation), typeof(Ai), typeof(int) };
-    private readonly QueryDescription _queryDescription = new() { All = _group };
+    private static readonly ComponentType[] _group = [typeof(Transform), typeof(Rotation)];
+    private static readonly ComponentType[] _secondGroup = [typeof(Transform), typeof(Rotation), typeof(Ai), typeof(int)];
+    private readonly QueryDescription _queryDescription = new(all: _group);
 
     [Test]
     public void CommandBufferSparseSet()
@@ -38,7 +38,7 @@ public void CommandBufferForExistingEntity()
         var world = World.Create();
         var commandBuffer = new CommandBuffer();
 
-        var entity = world.Create(new ComponentType[] { typeof(Transform), typeof(Rotation), typeof(int) });
+        var entity = world.Create([typeof(Transform), typeof(Rotation), typeof(int)]);
         commandBuffer.Set(in entity, new Transform { X = 20, Y = 20 });
         commandBuffer.Add(in entity, new Ai());
         commandBuffer.Remove<int>(in entity);
@@ -58,7 +58,7 @@ public void CommandBuffer()
         var world = World.Create();
         var commandBuffer = new CommandBuffer();
 
-        var entity = commandBuffer.Create(new ComponentType[] { typeof(Transform), typeof(Rotation), typeof(int) });
+        var entity = commandBuffer.Create([typeof(Transform), typeof(Rotation), typeof(int)]);
         commandBuffer.Set(in entity, new Transform { X = 20, Y = 20 });
         commandBuffer.Add(in entity, new Ai());
         commandBuffer.Remove<int>(in entity);
@@ -82,9 +82,9 @@ public void CommandBufferCreateMultipleEntities()
         var entities = new List<Entity>();
         using (var commandBuffer = new CommandBuffer())
         {
-            entities.Add(commandBuffer.Create(new ComponentType[] { typeof(Transform) }));
-            entities.Add(commandBuffer.Create(new ComponentType[] { typeof(Transform) }));
-            entities.Add(commandBuffer.Create(new ComponentType[] { typeof(Transform) }));
+            entities.Add(commandBuffer.Create([typeof(Transform)]));
+            entities.Add(commandBuffer.Create([typeof(Transform)]));
+            entities.Add(commandBuffer.Create([typeof(Transform)]));
             commandBuffer.Playback(world);
         }
 
@@ -100,16 +100,16 @@ public void CommandBufferCreateAndDestroy()
 
         using (var commandBuffer = new CommandBuffer())
         {
-            commandBuffer.Create(new ComponentType[] { typeof(Transform) });
-            commandBuffer.Create(new ComponentType[] { typeof(Transform) });
-            var e = commandBuffer.Create(new ComponentType[] { typeof(Transform) });
+            commandBuffer.Create([typeof(Transform)]);
+            commandBuffer.Create([typeof(Transform)]);
+            var e = commandBuffer.Create([typeof(Transform)]);
             commandBuffer.Destroy(e);
             commandBuffer.Playback(world);
         }
 
         That(world.Size, Is.EqualTo(2));
 
-        var query = new QueryDescription { All = new ComponentType[] { typeof(Transform) } };
+        var query = new QueryDescription(all: [typeof(Transform)]);
         var entities = new Entity[world.CountEntities(query)];
         world.GetEntities(query, entities);
 
@@ -132,14 +132,14 @@ public void CommandBufferModify()
         // Create an entity
         using (var commandBuffer = new CommandBuffer())
         {
-            commandBuffer.Create( new ComponentType[] { typeof(int) });
+            commandBuffer.Create([typeof(int)]);
             commandBuffer.Playback(world);
         }
 
         That(world.Size, Is.EqualTo(1));
 
         // Retrieve the entity we just created
-        var query = new QueryDescription { All = new ComponentType[] { typeof(int) } };
+        var query = new QueryDescription(all: [typeof(int)]);
         var entities = new Entity[world.CountEntities(query)];
         world.GetEntities(query, entities);
 
@@ -190,8 +190,8 @@ public void CommandBufferCombined()
         var world = World.Create();
         var commandBuffer = new CommandBuffer();
 
-        var entity = world.Create(new ComponentType[] { typeof(Transform), typeof(Rotation), typeof(int) });
-        var bufferedEntity = commandBuffer.Create(new ComponentType[] { typeof(Transform), typeof(Rotation), typeof(int) });
+        var entity = world.Create([typeof(Transform), typeof(Rotation), typeof(int)]);
+        var bufferedEntity = commandBuffer.Create([typeof(Transform), typeof(Rotation), typeof(int)]);
 
         commandBuffer.Set(in entity, new Transform { X = 20, Y = 20 });
         commandBuffer.Add(in entity, new Ai());

diff --git a/src/Arch.Tests/EntityTest.cs b/src/Arch.Tests/EntityTest.cs
@@ -23,7 +23,7 @@ public void Setup()
     }
 
     private World _world;
-    private readonly ComponentType[] _group = { typeof(Transform), typeof(Rotation) };
+    private readonly ComponentType[] _group = [typeof(Transform), typeof(Rotation)];
     private Entity _entity;
 
     /// <summary>

diff --git a/src/Arch.Tests/EnumeratorTest.cs b/src/Arch.Tests/EnumeratorTest.cs
@@ -13,9 +13,9 @@ namespace Arch.Tests;
 [TestFixture]
 public sealed class EnumeratorTest
 {
-    private static readonly ComponentType[] _group = { typeof(Transform), typeof(Rotation) };
-    private static readonly ComponentType[] _otherGroup = { typeof(Transform), typeof(Rotation), typeof(Ai) };
-    private readonly QueryDescription _description = new() { All = _group };
+    private static readonly ComponentType[] _group = [typeof(Transform), typeof(Rotation)];
+    private static readonly ComponentType[] _otherGroup = [typeof(Transform), typeof(Rotation), typeof(Ai)];
+    private readonly QueryDescription _description = new(all: _group);
 
     private World _world;
 

diff --git a/src/Arch.Tests/QueryTest.cs b/src/Arch.Tests/QueryTest.cs
@@ -11,11 +11,11 @@ public sealed partial class QueryTest
     private JobScheduler _jobScheduler;
     private World? _world;
 
-    private static readonly ComponentType[] _entityGroup = { typeof(Transform), typeof(Rotation) };
-    private static readonly ComponentType[] _entityAiGroup = { typeof(Transform), typeof(Rotation), typeof(Ai) };
+    private static readonly ComponentType[] _entityGroup = [typeof(Transform), typeof(Rotation)];
+    private static readonly ComponentType[] _entityAiGroup = [typeof(Transform), typeof(Rotation), typeof(Ai)];
 
-    private readonly QueryDescription _withoutAiQuery = new() { All = new ComponentType[] { typeof(Transform) }, Any = new ComponentType[] { typeof(Rotation) }, None = new ComponentType[] { typeof(Ai) } };
-    private readonly QueryDescription _allQuery = new() { All = new ComponentType[] { typeof(Transform), typeof(Rotation) }, Any = new ComponentType[] { typeof(Ai) } };
+    private readonly QueryDescription _withoutAiQuery = new( all: [typeof(Transform)], any: [typeof(Rotation)], none: [typeof(Ai)]);
+    private readonly QueryDescription _allQuery = new(all: [typeof(Transform), typeof(Rotation)], any: [typeof(Ai)]);
 
     [OneTimeSetUp]
     public void Setup()
@@ -39,7 +39,7 @@ public void Teardown()
     [Test]
     public void AllQuery()
     {
-        var query = new QueryDescription { All = new ComponentType[] { typeof(Transform) } };
+        var query = new QueryDescription(all: [typeof(Transform)]);
 
         _world = World.Create();
         for (var index = 0; index < 100; index++)
@@ -48,14 +48,14 @@ public void AllQuery()
         }
 
         var count = 0;
-        _world.Query(query, (Entity entity) => count++);
+        _world.Query(query, _ => count++);
         That(count, Is.EqualTo(100));
     }
 
     [Test]
     public void AnyQuery()
     {
-        var query = new QueryDescription { Any = new ComponentType[] { typeof(Transform) } };
+        var query = new QueryDescription(any: [typeof(Transform)]);
 
         _world = World.Create();
         for (var index = 0; index < 100; index++)
@@ -64,14 +64,14 @@ public void AnyQuery()
         }
 
         var count = 0;
-        _world.Query(query, (Entity entity) => count++);
+        _world.Query(query, _ => count++);
         That(count, Is.EqualTo(100));
     }
 
     [Test]
     public void NoneQuery()
     {
-        var query = new QueryDescription { None = new ComponentType[] { typeof(Transform) } };
+        var query = new QueryDescription(none: [typeof(Transform)]);
 
         _world = World.Create();
         for (var index = 0; index < 100; index++)
@@ -80,14 +80,14 @@ public void NoneQuery()
         }
 
         var count = 0;
-        _world.Query(query, (Entity entity) => count++);
+        _world.Query(query, _ => count++);
         That(count, Is.EqualTo(0));
     }
 
     [Test]
     public void EmptyQuery()
     {
-        var query = new QueryDescription { None = new ComponentType[] { typeof(int) } };
+        var query = new QueryDescription(none: [typeof(int)]);
 
         _world = World.Create();
         _world.Create();
@@ -101,7 +101,7 @@ public void EmptyQuery()
     public void ExclusiveQuery()
     {
         var exclusiveGroup = new ComponentType[] { typeof(Transform), typeof(Rotation) };
-        var query = new QueryDescription { Exclusive = exclusiveGroup };
+        var query = new QueryDescription(exclusive: exclusiveGroup);
 
         _world = World.Create();
         for (var index = 0; index < 100; index++)

diff --git a/src/Arch.Tests/WorldTest.cs b/src/Arch.Tests/WorldTest.cs
@@ -17,8 +17,8 @@ public sealed partial class WorldTest
 {
     private World _world;
 
-    private readonly ComponentType[] _entityGroup = { typeof(Transform), typeof(Rotation) };
-    private readonly ComponentType[] _entityAiGroup = { typeof(Transform), typeof(Rotation), typeof(Ai) };
+    private readonly ComponentType[] _entityGroup = [typeof(Transform), typeof(Rotation)];
+    private readonly ComponentType[] _entityAiGroup = [typeof(Transform), typeof(Rotation), typeof(Ai)];
 
     [SetUp]
     public void Setup()
@@ -90,7 +90,7 @@ public void Destroy()
     [Test]
     public void DestroyAll()
     {
-        var query = new QueryDescription { All = new ComponentType[] { typeof(Transform) } };
+        var query = new QueryDescription(all: [typeof(Transform)]);
 
         var entities = new Entity[_world.CountEntities(query)];
         _world.GetEntities(query, entities.AsSpan());
@@ -357,7 +357,7 @@ public void GetEntitesTest()
     {
         // Query
         var archTypes = new ComponentType[] { typeof(Transform) };
-        var query = new QueryDescription { All = archTypes };
+        var query = new QueryDescription(all: archTypes);
 
         // World
         using var world = World.Create();
@@ -385,7 +385,7 @@ public void CountEntitiesTest()
     {
         // Query
         var archTypes = new ComponentType[] { typeof(Transform) };
-        var query = new QueryDescription { All = archTypes };
+        var query = new QueryDescription(all: archTypes);
 
         // World
         using var world = World.Create();

diff --git a/src/Arch/Core/Query.cs b/src/Arch/Core/Query.cs
@@ -226,26 +226,26 @@ public partial struct QueryDescription : IEquatable<QueryDescription>
     ///     An <see cref="Signature"/> of all components that an <see cref="Entity"/> should have mandatory.
     /// <remarks>If the content of the array is subsequently changed, a <see cref="Rebuild"/> should be carried out.</remarks>
     /// </summary>
-    public Signature All { get; set; } = new();
+    public Signature All { get; private set; } = new();
 
     /// <summary>
     ///     An array of all components of which an <see cref="Entity"/> should have at least one.
     /// <remarks>If the content of the array is subsequently changed, a <see cref="Rebuild"/> should be carried out.</remarks>
     /// </summary>
-    public Signature Any { get; set; } = new();
+    public Signature Any { get; private set; } = new();
 
     /// <summary>
     ///     An array of all components of which an <see cref="Entity"/> should not have any.
     /// <remarks>If the content of the array is subsequently changed, a <see cref="Rebuild"/> should be carried out.</remarks>
     /// </summary>
-    public Signature None { get; set; } = new();
+    public Signature None { get; private set; } = new();
 
     /// <summary>
     ///     An array of all components that exactly match the structure of an <see cref="Entity"/>.
     ///     <see cref="Entity"/>'s with more or less components than those defined in the array are not addressed.
     /// <remarks>If the content of the array is subsequently changed, a <see cref="Rebuild"/> should be carried out.</remarks>
     /// </summary>
-    public Signature Exclusive { get; set; } = new();
+    public Signature Exclusive { get; private set; } = new();
 
     /// <summary>
     ///     Initializes a new instance of the <see cref="QueryDescription"/> struct.
@@ -273,6 +273,11 @@ public QueryDescription(ComponentType[]? all = null, ComponentType[]? any = null
         _hashCode = GetHashCode();
     }
 
+    public QueryDescription(Signature all) : this()
+    {
+        All = all;
+    }
+
     /// <summary>
     ///     Recreates this instance by calculating a new <see cref="_hashCode"/>.
     ///     Is actually only needed if the passed arrays are changed afterwards.