Merge pull request #40 from specklesystems/claire/collections-refactor

refactor(Collections): changes namespace of collections and adds interfaces

src/Speckle.Core/Models/Collection.cs → src/Speckle.Core/Models/Collections/Collection.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 
-namespace Speckle.Core.Models;
+namespace Speckle.Core.Models.Collections;
 
 /// <summary>
 /// A simple container for organising objects within a model and preserving object hierarchy.

src/Speckle.Core/Models/Collections/Interfaces.cs

@@ -0,0 +1,12 @@
+namespace Speckle.Core.Models.Collections;
+
+/// <summary>
+/// Represents a collection that has a <see cref="IHasColor.color"/>
+/// </summary>
+public interface IHasColor
+{
+  /// <summary>
+  /// The argb int value of the collection color
+  /// </summary>
+  public int color { get; set; }
+}

src/Speckle.Core/Models/Layer.cs → src/Speckle.Core/Models/Collections/Layer.cs

@@ -1,9 +1,9 @@
-namespace Speckle.Core.Models;
+namespace Speckle.Core.Models.Collections;
 
 /// <summary>
 /// A specialized collection that represents a CAD-app layer. We expect this to grow in the future with possibly other shared props.
 /// </summary>
-public class Layer : Collection
+public class Layer : Collection, IHasColor
 {
   public Layer() { }
 

src/Speckle.Core/Models/CommitObjectBuilder.cs

@@ -3,6 +3,7 @@
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using Speckle.Core.Logging;
+using Speckle.Core.Models.Collections;
 using Speckle.Core.Models.Extensions;
 
 namespace Speckle.Core.Models;

src/Speckle.Core/Models/Extensions/BaseExtensions.cs

@@ -2,6 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
+using Speckle.Core.Models.Collections;
 
 namespace Speckle.Core.Models.Extensions;
 

src/Speckle.Core/Speckle.Core.csproj

@@ -13,15 +13,15 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <InternalsVisibleTo Include="Speckle.Core.Tests.Unit"/>
-    <InternalsVisibleTo Include="Speckle.Core.Tests.Integration"/>
-    <InternalsVisibleTo Include="Speckle.Core.Serialization.Tests"/>
+    <InternalsVisibleTo Include="Speckle.Core.Tests.Unit" />
+    <InternalsVisibleTo Include="Speckle.Core.Tests.Integration" />
+    <InternalsVisibleTo Include="Speckle.Core.Serialization.Tests" />
   </ItemGroup>
 
   <ItemGroup>
     <PackageReference Include="GraphQL.Client" />
     <PackageReference Include="Microsoft.CSharp" />
-    <PackageReference Include="Polly"/>
+    <PackageReference Include="Polly" />
     <PackageReference Include="Polly.Contrib.WaitAndRetry" />
     <PackageReference Include="Polly.Extensions.Http" />
     <PackageReference Include="Sentry" />
@@ -32,7 +32,7 @@
     <PackageReference Include="Serilog.Sinks.Console" />
     <PackageReference Include="Serilog.Sinks.Seq" />
     <PackageReference Include="SerilogTimings" />
-    <PackageReference Include="Speckle.Newtonsoft.Json"/>
+    <PackageReference Include="Speckle.Newtonsoft.Json" />
     <PackageReference Include="Microsoft.Data.Sqlite" />
     <PackageReference Include="Speckle.DoubleNumerics" />
   </ItemGroup>

src/Speckle.Objects/GIS/RasterLayer.cs

@@ -1,5 +1,5 @@
 using System.Collections.Generic;
-using Speckle.Core.Models;
+using Speckle.Core.Models.Collections;
 
 namespace Objects.GIS;
 

src/Speckle.Objects/GIS/VectorLayer.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using Speckle.Core.Models;
+using Speckle.Core.Models.Collections;
 
 namespace Objects.GIS;
 

src/Speckle.Objects/Organization/Deprecated/Collection.cs

@@ -2,8 +2,8 @@
 
 namespace Objects.Organization.Deprecated;
 
-[Obsolete("Replaced by " + nameof(Speckle.Core.Models.Collection))]
-public class Collection : Speckle.Core.Models.Collection
+[Obsolete("Replaced by " + nameof(Speckle.Core.Models.Collections.Collection))]
+public class Collection : Speckle.Core.Models.Collections.Collection
 {
   //Deserializer target for 2.13 Collection objects in the `Objects.Orgainzation` namespace
 

tests/Speckle.Core.Tests.Unit/Models/Extensions/BaseExtensionsTests.cs

@@ -1,5 +1,6 @@
 using NUnit.Framework;
 using Speckle.Core.Models;
+using Speckle.Core.Models.Collections;
 using Speckle.Core.Models.Extensions;
 
 namespace Speckle.Core.Tests.Unit.Models.Extensions;
@@ -43,11 +44,11 @@ public void TraverseWithPath()
     var basePaths = collection.TraverseWithPath((obj => obj is not Collection)).ToList();
 
     Assert.That(basePaths.Count, Is.EqualTo(3));
-    Assert.That(basePaths[0].Item2.speckle_type, Is.EqualTo("Speckle.Core.Models.Collection"));
+    Assert.That(basePaths[0].Item2.speckle_type, Is.EqualTo("Speckle.Core.Models.Collections.Collection"));
     Assert.That(basePaths[0].Item2["name"], Is.EqualTo("collection"));
     Assert.That(basePaths[0].Item1, Is.EqualTo(new List<string>()));
 
-    Assert.That(basePaths[1].Item2.speckle_type, Is.EqualTo("Speckle.Core.Models.Collection"));
+    Assert.That(basePaths[1].Item2.speckle_type, Is.EqualTo("Speckle.Core.Models.Collections.Collection"));
     Assert.That(basePaths[1].Item2["name"], Is.EqualTo("subCollection"));
     Assert.That(basePaths[1].Item1, Is.EqualTo(new List<string>() { "collection" }));
 

tests/Speckle.Core.Tests.Unit/Models/GraphTraversal/TraversalContextExtensionsTests.cs

@@ -1,6 +1,7 @@
 using NUnit.Framework;
 using Speckle.Core.Common;
 using Speckle.Core.Models;
+using Speckle.Core.Models.Collections;
 using Speckle.Core.Models.GraphTraversal;
 
 namespace Speckle.Core.Tests.Unit.Models.GraphTraversal;