🩹 [Patch]: Update Format-Hashtable to handle objects (#11)

## Description

This pull request includes updates to the `Format-Hashtable` function to
improve type handling and formatting, as well as adding corresponding
tests in `Hashtable.Tests.ps1`.

### Improvements to `Format-Hashtable`:

* Changed the parameter type for `Hashtable` to
`System.Collections.IDictionary` to ensure compatibility with different
dictionary types.
* Simplified the check for an empty hashtable by removing the redundant
type check.
* Unified the condition for nested hashtable formatting to use
`System.Collections.IDictionary` for consistency.
* Updated the handling of `PSCustomObject` and `PSObject` values to use
`ConvertTo-Hashtable` for proper conversion before formatting.

### Enhancements to `Hashtable.Tests.ps1`:

* Added comprehensive test cases to cover various scenarios including
nested objects and arrays of hashtables.

## Type of change

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [ ] 📖 [Docs]
- [ ] 🪲 [Fix]
- [x] 🩹 [Patch]
- [ ] ⚠️ [Security fix]
- [ ] 🚀 [Feature]
- [ ] 🌟 [Breaking change]

## Checklist

<!-- Use the check-boxes [x] on the options that are relevant. -->

- [x] I have performed a self-review of my own code
- [x] I have commented my code, particularly in hard-to-understand areas

Author: MariusStorhaug

src/functions/public/Format-Hashtable.ps1

@@ -56,15 +56,15 @@
             ValueFromPipeline,
             ValueFromPipelineByPropertyName
         )]
-        [object] $Hashtable,
+        [System.Collections.IDictionary] $Hashtable,
 
         # The indentation level for formatting nested structures.
         [Parameter()]
         [int] $IndentLevel = 1
     )
 
     # If the hashtable is empty, return '@{}' immediately.
-    if ($Hashtable -is [System.Collections.IDictionary] -and $Hashtable.Count -eq 0) {
+    if ($Hashtable.Count -eq 0) {
         return '@{}'
     }
 
@@ -88,14 +88,14 @@
             continue
         }
         Write-Verbose "Value type: [$($value.GetType().Name)]"
-        if (($value -is [System.Collections.Hashtable]) -or ($value -is [System.Collections.Specialized.OrderedDictionary])) {
+        if (($value -is [System.Collections.IDictionary])) {
             $nestedString = Format-Hashtable -Hashtable $value -IndentLevel ($IndentLevel + 1)
             $lines += "$levelIndent$paddedKey = $nestedString"
         } elseif ($value -is [System.Management.Automation.PSCustomObject]) {
-            $nestedString = Format-Hashtable -Hashtable $value -IndentLevel ($IndentLevel + 1)
+            $nestedString = $value | ConvertTo-Hashtable | Format-Hashtable -IndentLevel ($IndentLevel + 1)
             $lines += "$levelIndent$paddedKey = $nestedString"
         } elseif ($value -is [System.Management.Automation.PSObject]) {
-            $nestedString = Format-Hashtable -Hashtable $value -IndentLevel ($IndentLevel + 1)
+            $nestedString = $value | ConvertTo-Hashtable | Format-Hashtable -IndentLevel ($IndentLevel + 1)
             $lines += "$levelIndent$paddedKey = $nestedString"
         } elseif ($value -is [bool]) {
             $lines += "$levelIndent$paddedKey = `$$($value.ToString().ToLower())"

tests/Hashtable.Tests.ps1

@@ -402,6 +402,29 @@
                             }
                         )
                     }
+                    Run             = [ordered]@{
+                        ABoolean            = $true
+                        AString             = 'Hello'
+                        AnArray             = @('One', 'Two', 'Three')
+                        AnObject            = [ordered]@{
+                            NestedKey1 = 'NestedValue1'
+                            NestedKey2 = 'NestedValue2'
+                        }
+                        AnArrayOfHashtables = @(
+                            [ordered]@{
+                                Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Planets\Planets.Tests.ps1'
+                                Data = [pscustomobject]@{
+                                    Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Planets\Planets.Data.ps1'
+                                }
+                            },
+                            [ordered]@{
+                                Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Sheep\Sheep.Tests.ps1'
+                                Data = [pscustomobject]@{
+                                    Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Sheep\Sheep.Data.ps1'
+                                }
+                            }
+                        )
+                    }
                 }
 
                 # Act - Run the function
@@ -441,7 +464,35 @@
             }
         )
     }
+    Run             = @{
+        ABoolean            = $true
+        AString             = 'Hello'
+        AnArray             = @(
+            'One'
+            'Two'
+            'Three'
+        )
+        AnObject            = @{
+            NestedKey1 = 'NestedValue1'
+            NestedKey2 = 'NestedValue2'
+        }
+        AnArrayOfHashtables = @(
+            @{
+                Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Planets\Planets.Tests.ps1'
+                Data = @{
+                    Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Planets\Planets.Data.ps1'
+                }
+            }
+            @{
+                Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Sheep\Sheep.Tests.ps1'
+                Data = @{
+                    Path = 'C:\Repos\GitHub\PSModule\Action\Invoke-Pester\tests\3-Advanced\Sheep\Sheep.Data.ps1'
+                }
+            }
+        )
+    }
 }
+
 '@.Trim() # Trim to remove any unintended whitespace
 
                 # Compare function output to expected output