Refactoring

Fixing IP-Validation
Refactoring code
Restructuring project

Author: RespectMathias

VLSMistique/AppShell.xaml

@@ -3,7 +3,7 @@
     x:Class="VLSMistique.AppShell"
     xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
     xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
-    xmlns:local="clr-namespace:VLSMistique"
+    xmlns:local="clr-namespace:VLSMistique.Views"
     Shell.FlyoutBehavior="Disabled"
     Shell.NavBarIsVisible="False">
 

VLSMistique/Interfaces/ICsvConverter.cs

@@ -0,0 +1,35 @@
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+/*
+ *    Copyright 2023 Mathias Lund-Hansen
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using VLSMistique.Models;
+
+namespace VLSMistique.Interfaces
+{
+    /// <summary> Interface for converting a collection of subnet models to a CSV string. </summary>
+    public interface ICsvConverter
+    {
+        /// <summary> Converts the collection of subnet models to a CSV string. </summary>
+        /// <param name="subnets">The collection of subnet models to convert.</param>
+        /// <returns>The CSV string representation of the subnet models.</returns>
+        string Convert(ObservableCollection<SubnetModel> subnets);
+    }
+}

VLSMistique/Interfaces/IInputValidator.cs

@@ -0,0 +1,37 @@
+/*
+ *    Copyright 2023 Mathias Lund-Hansen
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+using System;
+using System.Collections.Generic;
+using System.Collections.ObjectModel;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using VLSMistique.Models;
+
+namespace VLSMistique.Interfaces
+{
+    /// <summary> Interface responsible for validating input data. </summary>
+    public interface IInputValidator
+    {
+        /// <summary> Validates the given address, subnet amount, and subnets collection. </summary>
+        /// <param name="address">The address to validate.</param>
+        /// <param name="subnetAmount">The number of subnets.</param>
+        /// <param name="subnets">The collection of subnets.</param>
+        /// <returns><c>true</c> if the input is valid, otherwise <c>false</c>.</returns>
+        bool Validate(string address, int subnetAmount, ObservableCollection<SubnetModel> subnets);
+    }
+}

VLSMistique/Interfaces/IVLSMCalculatorModel.cs

@@ -1,4 +1,5 @@
-/*   Copyright 2023 Mathias Lund-Hansen
+/*
+ *    Copyright 2023 Mathias Lund-Hansen
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -10,7 +11,8 @@
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
- *  limitations under the License. */
+ *  limitations under the License.
+ */
 
 using System;
 using System.Collections.Generic;
@@ -21,10 +23,14 @@
 
 namespace VLSMistique.Interfaces
 {
-    /// <summary> Interface for the VLSM calculator model. </summary>
+    /// <summary> Rhe interface for VLSM calculator model. </summary>
     public interface IVLSMCalculatorModel
     {
-        /// <summary> Calculates the subnets based on the given IP addres, the amont of subnets, and a list of host per subnet. </summary>
+        /// <summary> Calculates subnets based on the provided IP address, subnet amount, and host amounts. </summary>
+        /// <param name="ipAddress">The IP address.</param>
+        /// <param name="subnetAmount">The number of subnets.</param>
+        /// <param name="hostAmounts">The list of host amounts for each subnet.</param>
+        /// <returns>A list of subnet models.</returns>
         List<SubnetModel> CalculateSubnets(string ipAddress, int subnetAmount, List<int> hostAmounts);
     }
 }

VLSMistique/MauiProgram.cs

@@ -1,4 +1,22 @@
-using Microsoft.Extensions.Logging;
+/*
+ *    Copyright 2023 Mathias Lund-Hansen
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+using CommunityToolkit.Maui;
+using CommunityToolkit.Maui.Storage;
+using Microsoft.Maui.LifecycleEvents;
 #if WINDOWS10_0_17763_0_OR_GREATER
 using Microsoft.UI;
 using Microsoft.UI.Windowing;
@@ -10,43 +28,39 @@
 
 namespace VLSMistique;
 
-using CommunityToolkit.Maui;
-using CommunityToolkit.Maui.Storage;
-using Microsoft.Maui.LifecycleEvents;
-
+/// <summary> The main entry point for creating a Maui application. </summary>
 public static class MauiProgram
 {
     public static MauiApp CreateMauiApp()
     {
+        // Create a builder for configuring the Maui app.
         var builder = MauiApp.CreateBuilder();
         builder
-            .UseMauiApp<App>()
-            // Initialize the .NET MAUI Community Toolkit by adding the below line of code
-            .UseMauiCommunityToolkit()
-            // After initializing the .NET MAUI Community Toolkit, optionally add additional fonts
+            .UseMauiApp<App>() // Set the startup App for Maui.
+            .UseMauiCommunityToolkit() // Initialize the .NET MAUI Community Toolkit.
+
+            // Configure custom fonts.
             .ConfigureFonts(fonts =>
             {
                 fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
                 fonts.AddFont("OpenSans-Semibold.ttf", "OpenSansSemibold");
-            });
+            })
+            .Services.AddSingleton<IFileSaver>(FileSaver.Default); // Register the default file saver service.
 
         // Add support to use the WinUI library.
         builder.ConfigureLifecycleEvents(events =>
         {
-#if WINDOWS10_0_17763_0_OR_GREATER
+            #if WINDOWS10_0_17763_0_OR_GREATER
             events.AddWindows(wndLifeCycleBuilder =>
             {
                 wndLifeCycleBuilder.OnWindowCreated(window =>
                 {
-                    window.TryMicaOrAcrylic(); //Adds Mica effect.
+                    window.TryMicaOrAcrylic(); //Adds the Mica or Acrylic effect depending on if it's Windows 10 or 11.
                 });
             });
-#endif
+            #endif
         });
 
-        // Continue initializing your .NET MAUI App here
-
-        builder.Services.AddSingleton<IFileSaver>(FileSaver.Default);
-        return builder.Build();
+        return builder.Build(); // Build and return the configured Maui app.
     }
-}
+}

VLSMistique/Models/SubnetModel.cs

@@ -1,4 +1,5 @@
-/*   Copyright 2023 Mathias Lund-Hansen
+/*
+ *    Copyright 2023 Mathias Lund-Hansen
  *
  *  Licensed under the Apache License, Version 2.0 (the "License");
  *  you may not use this file except in compliance with the License.
@@ -10,18 +11,19 @@
  *  distributed under the License is distributed on an "AS IS" BASIS,
  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  *  See the License for the specific language governing permissions and
- *  limitations under the License. */
+ *  limitations under the License.
+ */
 
 using CommunityToolkit.Mvvm.ComponentModel;
 using System.Net;
 
 namespace VLSMistique.Models
 {
-    /// <summary> The class that represents a subnet. </summary>
+    /// <summary> Representation of a subnet. </summary>
     public partial class SubnetModel : ObservableObject
     {
         private int _hostAmount;
-        /// <summary> The required amount of hosts of the subnet. </summary>
+        /// <summary> Gets or sets the number of hosts in the subnet. </summary>
         public int HostAmount
         {
             get => _hostAmount;
@@ -35,27 +37,27 @@ public int HostAmount
         }
         public event EventHandler HostAmountChanged;
 
-        /// <summary> The Broadcast Address of the subnet. </summary>
+        /// <summary> The last IP address in the subnet, which is reserved for broadcast. </summary>
         [ObservableProperty]
         public IPAddress _broadcastAddress;
 
-        /// <summary> The Network Address of the subnet. </summary>
+        /// <summary> The first IP address in the subnet, which is reserved for network addressing. </summary>
         [ObservableProperty]
         public IPAddress _networkAddress;
 
-        /// <summary> The Subnet Mask of the subnet. </summary>
+        /// <summary> The subnet mask which determines the IP range of the subnet. </summary>
         [ObservableProperty]
         public IPAddress _mask;
 
         /// <summary> The IP-range of the subnet. Meaning the first and last IP-address of the subnet. </summary>
         [ObservableProperty]
         public string _range;
 
-        /// <summary> The maximum amount of hosts in the subnet. </summary>
+        /// <summary> The maximum number of hosts that the subnet can support. </summary>
         [ObservableProperty]
         public string _maxSubnetHosts;
 
-        /// <summary> Contains the values of the subnet. </summary>
+        /// <summary> Constructs a new instance of the SubnetModel class. Which represents a subnet. </summary>
         public SubnetModel(IPAddress broadcastAddress, IPAddress networkAddress, IPAddress mask, string range, string maxSubnetHosts, int hostAmount)
         {
             BroadcastAddress = broadcastAddress;