Updated logic to ensure platform specific samples are inserted in order

Author: jamesmcroft

samples/MADE.Samples/MADE.Samples.Shared/Features/Home/ViewModels/MainPageViewModel.cs

@@ -5,12 +5,14 @@ namespace MADE.Samples.Features.Home.ViewModels
     using System.Windows.Input;
     using CommunityToolkit.Mvvm.Input;
     using CommunityToolkit.Mvvm.Messaging;
-    using Foundation.Platform;
+    using MADE.Collections;
+    using MADE.Data.Validation.Extensions;
+    using MADE.Foundation.Platform;
     using MADE.Samples.Features.Samples.Data;
     using MADE.Samples.Features.Samples.Pages;
+    using MADE.UI.ViewManagement;
     using MADE.UI.Views.Navigation;
     using MADE.UI.Views.Navigation.ViewModels;
-    using UI.ViewManagement;
 
     public class MainPageViewModel : PageViewModel
     {
@@ -49,24 +51,21 @@ private static ICollection<SampleGroup> GetSampleGroups()
                     new Sample(
                         "AppDialog",
                         typeof(AppDialogPage),
-                        "/Features/Samples/Assets/AppDialog/AppDialog.png"),
+                        "/Features/Samples/Assets/AppDialog/AppDialog.png")
                 }
             };
 
             if (PlatformApiHelper.IsTypeSupported(typeof(WindowManager)))
             {
-                helpers.Samples.Add(
+                helpers.Samples.InsertAtPotentialIndex(
                     new Sample(
                         "WindowManager",
                         typeof(WindowManagerPage),
-                        "/Features/Samples/Assets/WindowManager/WindowManager.png"));
+                        "/Features/Samples/Assets/WindowManager/WindowManager.png"),
+                    (item, compare) => compare.Name.IsLessThanOrEqualTo(item.Name));
             }
 
-            var list = new List<SampleGroup>
-            {
-                controls,
-                helpers
-            };
+            var list = new List<SampleGroup> { controls, helpers };
 
             return list;
         }

samples/MADE.Samples/MADE.Samples.Shared/Features/Samples/Data/SampleGroup.cs

@@ -6,6 +6,6 @@ public class SampleGroup
     {
         public string Name { get; set; }
 
-        public ICollection<Sample> Samples { get; } = new List<Sample>();
+        public IList<Sample> Samples { get; } = new List<Sample>();
     }
 }

src/MADE.Collections/CollectionExtensions.cs

@@ -6,7 +6,6 @@ namespace MADE.Collections
     using System;
     using System.Collections.Generic;
     using System.Linq;
-    using System.Runtime.CompilerServices;
 
     /// <summary>
     /// Defines a collection of extensions for enumerables, lists, and collections.
@@ -242,5 +241,43 @@ public static IEnumerable<IEnumerable<T>> Chunk<T>(this IEnumerable<T> source, i
                 .GroupBy(x => x.Index / chunkSize)
                 .Select(x => x.Select(v => v.Value));
         }
+
+        /// <summary>Inserts an item to the specified <paramref name="source"/> at the potential index determined by the <paramref name="predicate"/>.</summary>
+        /// <param name="source">The source where the <paramref name="value" /> should be inserted.</param>
+        /// <param name="value">The object to insert into the <paramref name="source"/>.</param>
+        /// <param name="predicate">The action to run to determine the position of the item based on the provided <paramref name="value"/> and an item in the collection.</param>
+        /// <typeparam name="T">The type of items in the collection.</typeparam>
+        /// <returns>The inserted index of the item.</returns>
+        /// <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1" /> is read-only.</exception>
+        public static int InsertAtPotentialIndex<T>(this IList<T> source, T value, Func<T, T, bool> predicate)
+        {
+            var potentialIndex = source.PotentialIndexOf(value, predicate);
+            source.Insert(potentialIndex, value);
+            return potentialIndex;
+        }
+
+        /// <summary>Gets the potential index of an item that does not currently exist within a collection based on the specified criteria.</summary>
+        /// <param name="source">The collection to get the index from.</param>
+        /// <param name="value">The object to determine an index for in the <paramref name="source"/>.</param>
+        /// <param name="predicate">The action to run to determine the position of the item based on the provided <paramref name="value"/> and an item in the collection.</param>
+        /// <typeparam name="T">The type of items in the collection.</typeparam>
+        /// <returns>The potential index of the item.</returns>
+        public static int PotentialIndexOf<T>(this IList<T> source, T value, Func<T, T, bool> predicate)
+        {
+            var result = 0;
+
+            foreach (var item in source)
+            {
+                if (predicate(value, item))
+                {
+                    result = source.IndexOf(item) + 1;
+                    continue;
+                }
+
+                break;
+            }
+
+            return result;
+        }
     }
 }

src/MADE.Data.Validation/Extensions/ComparableExtensions.cs

@@ -20,6 +20,19 @@ public static bool IsGreaterThan<T>(this T value, T other)
             return value.CompareTo(other) > 0;
         }
 
+        /// <summary>
+        /// Determines whether the value is greater than or equal to the <paramref name="other"/> value.
+        /// </summary>
+        /// <typeparam name="T">The <see cref="IComparable"/> type.</typeparam>
+        /// <param name="value">The value to compare.</param>
+        /// <param name="other">The value to compare against.</param>
+        /// <returns>True if the <paramref name="value"/> is greater than or equal to the <paramref name="other"/> value.</returns>
+        public static bool IsGreaterThanOrEqualTo<T>(this T value, T other)
+            where T : IComparable
+        {
+            return value.CompareTo(other) >= 0;
+        }
+
         /// <summary>
         /// Determines whether the value is less than the <paramref name="other"/> value.
         /// </summary>
@@ -32,5 +45,18 @@ public static bool IsLessThan<T>(this T value, T other)
         {
             return value.CompareTo(other) < 0;
         }
+
+        /// <summary>
+        /// Determines whether the value is less than or equal to the <paramref name="other"/> value.
+        /// </summary>
+        /// <typeparam name="T">The <see cref="IComparable"/> type.</typeparam>
+        /// <param name="value">The value to compare.</param>
+        /// <param name="other">The value to compare against.</param>
+        /// <returns>True if the <paramref name="value"/> is less than or equal to the <paramref name="other"/> value.</returns>
+        public static bool IsLessThanOrEqualTo<T>(this T value, T other)
+            where T : IComparable
+        {
+            return value.CompareTo(other) <= 0;
+        }
     }
 }