Updating NuGet package name back to L5Sharp

src/L5Sharp.Core/L5Sharp.Core.csproj

@@ -18,9 +18,10 @@
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <!--<PackageIcon>icon.png</PackageIcon>-->
         <RepositoryType>git</RepositoryType>
-        <PackageReleaseNotes>Initial release.</PackageReleaseNotes>
+        <PackageReleaseNotes>Merged library into single namespace L5Sharp.Core</PackageReleaseNotes>
         <Copyright>Copyright (c) Timothy Nunnink 2022</Copyright>
         <PackageReadmeFile>README.md</PackageReadmeFile>
+        <PackageId>L5Sharp</PackageId>
     </PropertyGroup>
 
     <ItemGroup>

src/L5Sharp/Common/Address.cs

@@ -0,0 +1,175 @@
+using System;
+using System.Linq;
+using System.Net;
+using System.Text.RegularExpressions;
+
+namespace L5Sharp.Core;
+
+/// <summary>
+/// Provides a wrapper around the string port address value to indicate what type of address the value is.
+/// </summary>
+public class Address
+{
+    private readonly string _value;
+
+    /// <summary>
+    /// Creates a new <see cref="Address"/> with the provided string value.
+    /// </summary>
+    /// <param name="address"></param>
+    /// <exception cref="ArgumentNullException"></exception>
+    public Address(string address)
+    {
+        _value = address ?? throw new ArgumentNullException(nameof(address));
+    }
+
+    /// <summary>
+    /// Indicates whether the current <see cref="Address"/> is a slot number address.
+    /// </summary>
+    /// <returns>true if the address value is a valid byte address; otherwise, false.</returns>
+    public bool IsSlot => byte.TryParse(_value, out _);
+
+    /// <summary>
+    /// Indicates whether the current <see cref="Address"/> is a IPv4 address.
+    /// </summary>
+    /// <returns>true if the address value is a valid IPv4 address; otherwise, false.</returns>
+    public bool IsIPv4 => _value.Count(c => c == '.') == 3 && IPAddress.TryParse(_value, out _);
+
+    /// <summary>
+    /// Indicates whether the current <see cref="Address"/> is a host name address.
+    /// </summary>
+    /// <returns>true if the address value is a valid host name address; otherwise, false.</returns>
+    /// <remarks>
+    /// A host name must start with a letter, contain only alpha-numeric characters or special characters '.' and '-',
+    /// and have a maximum length of 64 characters.
+    /// </remarks>
+    public bool IsHostName => Regex.IsMatch(_value, "^[A-Za-z][A-Za-z0-9.-]{1,63}$");
+
+    /// <summary>
+    /// Indicates that the address value is an empty string.
+    /// </summary>
+    public bool IsEmpty => _value.IsEmpty();
+
+    /// <summary>
+    /// Represents no address value, or an empty string.
+    /// </summary>
+    public static Address None => new(string.Empty);
+
+    /// <summary>
+    /// Converts the current <see cref="string"/> to a <see cref="Address"/> value.
+    /// </summary>
+    /// <param name="address">The value to convert.</param>
+    /// <returns>A <see cref="Address"/> representing the address value.</returns>
+    public static implicit operator Address(string address) => new(address);
+
+    /// <summary>
+    /// Converts the current <see cref="Address"/> to a <see cref="string"/> value.
+    /// </summary>
+    /// <param name="address">The value to convert.</param>
+    /// <returns>A <see cref="string"/> representing the address value.</returns>
+    public static implicit operator string(Address address) => address.ToString();
+
+    /// <summary>
+    /// Converts the current <see cref="string"/> to a <see cref="Address"/> value.
+    /// </summary>
+    /// <param name="address">The value to convert.</param>
+    /// <returns>A <see cref="Address"/> representing the address value.</returns>
+    public static implicit operator Address(byte address) => new(address.ToString());
+
+    /// <summary>
+    /// Converts the current <see cref="Address"/> to a <see cref="string"/> value.
+    /// </summary>
+    /// <param name="address">The value to convert.</param>
+    /// <returns>A <see cref="string"/> representing the address value.</returns>
+    public static implicit operator byte(Address address) => byte.Parse(address._value);
+
+    /// <summary>
+    /// Creates a new <see cref="Address"/> instance from the provided <see cref="IPAddress"/> object.
+    /// </summary>
+    /// <param name="ipAddress">The <see cref="IPAddress"/> value that represents the port address.</param>
+    /// <returns>A new <see cref="Address"/> value from the provided IP.</returns>
+    /// <exception cref="ArgumentNullException">ipAddress is null.</exception>
+    public static Address FromIP(IPAddress ipAddress)
+    {
+        if (ipAddress is null) throw new ArgumentNullException(nameof(ipAddress));
+        return new Address(ipAddress.ToString());
+    }
+
+    /// <summary>
+    /// Creates a new <see cref="Address"/> instance from the provided byte slot number value.
+    /// </summary>
+    /// <param name="slot">the byte number value that represents the port address.</param>
+    /// <returns>A new <see cref="Address"/> value from the provided slot number.</returns>
+    public static Address FromSlot(byte slot) => new(slot.ToString());
+
+    /// <summary>
+    /// Creates a new <see cref="Address"/> with the common default IP of 192.168.0.1.
+    /// </summary>
+    /// <returns>A <see cref="Address"/> with the default IP value.</returns>
+    public static Address DefaultIP() => new("192.168.0.1");
+
+    /// <summary>
+    /// Creates a new <see cref="Address"/> with the default slot 0.
+    /// </summary>
+    /// <returns>A <see cref="Address"/> with the default slot value.</returns>
+    public static Address DefaultSlot() => new("0");
+
+    /// <summary>
+    /// Creates a new <see cref="Address"/> with the specified slot number.
+    /// </summary>
+    /// <param name="slot">The slot number to create.</param>
+    /// <returns></returns>
+    public static Address Slot(byte slot) => new($"{slot}");
+
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
+    public IPAddress ToIPAddress() => IsIPv4
+        ? IPAddress.Parse(_value)
+        : throw new InvalidOperationException($"The current address '{_value}' is not a valid IP address");
+
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
+    public byte ToSlot() => IsSlot
+        ? byte.Parse(_value)
+        : throw new InvalidOperationException($"The current address '{_value}' is not a valid slot number");
+
+    /// <inheritdoc />
+    public override string ToString() => _value;
+
+    /// <inheritdoc />
+    public override bool Equals(object? obj)
+    {
+        return obj switch
+        {
+            Address other => string.Equals(_value, other._value, StringComparison.OrdinalIgnoreCase),
+            string other => string.Equals(_value, other, StringComparison.OrdinalIgnoreCase),
+            byte other => string.Equals(_value, other.ToString(), StringComparison.OrdinalIgnoreCase),
+            IPAddress other => string.Equals(_value, other.ToString(), StringComparison.OrdinalIgnoreCase),
+            _ => false
+        };
+    }
+
+    /// <inheritdoc />
+    public override int GetHashCode() => _value.GetHashCode();
+
+    /// <summary>
+    /// Determines if the provided objects are equal.
+    /// </summary>
+    /// <param name="left">An object to compare.</param>
+    /// <param name="right">An object to compare.</param>
+    /// <returns>true if the provided objects are equal; otherwise, false.</returns>
+    public static bool operator ==(Address? left, Address? right) => Equals(left, right);
+
+    /// <summary>
+    /// Determines if the provided objects are not equal.
+    /// </summary>
+    /// <param name="left">An object to compare.</param>
+    /// <param name="right">An object to compare.</param>
+    /// <returns>true if the provided objects are not equal; otherwise, false.</returns>
+    public static bool operator !=(Address? left, Address? right) => !Equals(left, right);
+}