Merge ColorMine. Refactor script functions to compiled cmdlets

Originally, ColorMine had an external maintainer,
but he's taken his work down and sold the source...
I'm getting rid of the external library and the namespace.

+semver:breaking

Author: Jaykul

Docs/Get-Complement.md

@@ -1,7 +1,7 @@
 ---
 external help file: Pansies-help.xml
 Module Name: Pansies
-online version: 
+online version:
 schema: 2.0.0
 ---
 
@@ -14,16 +14,16 @@ Get the Hue complement color
 ## SYNTAX
 
 ```
-Get-Complement [-Color] <RgbColor> [-ForceContrast] [-ConsoleColor] [-Passthru]
+Get-Complement [-Color] <RgbColor> [-HighContrast] [-BlackAndWhite] [-Passthru]
 ```
 
 ## DESCRIPTION
 
 Returns a color that is 180 degrees opposite around the Hue component of the HSL color space.
 
-The primary reason for Get-Complement to exist is for generating contrasting colors for foreground and background. For that reason, it's usually called with `-ForceContrast` mode, which changes the lightness or darkness to increase the contrast of the returned color.
+The primary reason for Get-Complement to exist is for generating contrasting colors for foreground and background. For that reason, it's usually called with `-HighContrast` mode, which changes the lightness or darkness to increase the contrast of the returned color.
 
-It also has a `-ConsoleColor` switch that causes it to assume only 16 colors will work (PowerLine currently uses this mode by default because so many terminals don't support more --including Windows 10 prior to Creators Update). In ConsoleColor mode, it always returns White or Black.
+It also has a `-BlackAndWhite` switch that causes it to assume only 16 colors will work (PowerLine currently uses this mode by default because so many terminals don't support more --including Windows 10 prior to Creators Update). In BlackAndWhite mode, it always returns White or Black.
 
 ## EXAMPLES
 
@@ -39,13 +39,13 @@ Gets the color Red back, as the complement for Cyan.
 ### ---- Example 2 -------------------------------------------------------------
 
 ```
-PS C:\> $Background, $Foreground = Get-Complement Cyan -Passthru -ConsoleColor
-PS C:\> Write-Host " Hello World " -Foreground $Foreground.ConsoleColor -Background $Background.ConsoleColor
+PS C:\> $Background, $Foreground = Get-Complement Cyan -Passthru -BlackAndWhite
+PS C:\> Microsoft.PowerShell.Utility\Write-Host " Hello World " -Foreground $Foreground.ConsoleColor -Background $Background.ConsoleColor
 ```
 
-This example shows how using `-Passthru` returns both the original color and the contrasting color, and how using `-ConsoleColor` results in a better contrast when you're being forced to use ConsoleColor (as with the built-in Write-Host command).
+This example shows how using `-Passthru` returns both the original color and the contrasting color, and how using `-BlackAndWhite` results in a better contrast when you're being forced to use BlackAndWhite (as with the built-in Write-Host command).
 
-You can try the example without `-ConsoleColor` to see the difference: with it, you'll get Black on Cyan, without, you'll get Red on Cyan. Note that using -ForceContrast will make almost no difference if you're using the `ConsoleColor` property, because downsampling to 16 colors has to result in either Red or DarkRed...
+You can try the example without `-BlackAndWhite` to see the difference: with it, you'll get Black on Cyan, without, you'll get Red on Cyan. Note that using -HighContrast will make almost no difference if you're using the `BlackAndWhite` property, because downsampling to 16 colors has to result in either Red or DarkRed...
 
 
 
@@ -58,7 +58,7 @@ The source color to calculate the complement of
 ```yaml
 Type: RgbColor
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -67,13 +67,14 @@ Accept pipeline input: True (ByValue)
 Accept wildcard characters: False
 ```
 
-### -ForceContrast
+### -HighContrast
+
 Force the luminance to have "enough" contrast
 
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -82,13 +83,14 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
-### -ConsoleColor
-Assume there are only 16 colors. Return either black or white to get a readable contrast color.
+### -BlackAndWhite
+
+Returns either black or white to get a readable contrast color.
 
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -104,7 +106,7 @@ If set, output the input $Color before the complement
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named

Docs/Get-Gradient.md

@@ -1,7 +1,7 @@
 ---
 external help file: Pansies-help.xml
 Module Name: Pansies
-online version: 
+online version:
 schema: 2.0.0
 ---
 
@@ -14,7 +14,7 @@ Get a range of colors between two colors
 ## SYNTAX
 
 ```
-Get-Gradient [-StartColor] <RgbColor> [-EndColor] <RgbColor> [[-Height] <Int32>] [[-Width] <Int32>] [[-ColorSpace] <Object>] [-Reverse] [-Flatten]
+Get-Gradient [-StartColor] <RgbColor> [-EndColor] <RgbColor> [[-Width] <Int32>] [[-Height] <Int32>] [[-ColorSpace] <Object>] [-Reverse] [-Flatten]
 ```
 
 ## DESCRIPTION
@@ -38,19 +38,18 @@ Gets a simple array of ten colors between Red and Blue.
 PS C:\> Get-Gradient Red Blue
 ```
 
-Gets a 2D gradient from the ConsoleColor Red to Blue, with the width x height the current size of the console.
-
-
+Gets a 2D gradient from the ConsoleColor Red to Blue, with as many colors as the current width of the console.
 
 ## PARAMETERS
 
 ### -StartColor
+
 The left color to start the gradient from.
 
 ```yaml
 Type: RgbColor
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 1
@@ -67,7 +66,7 @@ The right color to end the gradient at.
 ```yaml
 Type: RgbColor
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: True
 Position: 2
@@ -77,6 +76,7 @@ Accept wildcard characters: False
 ```
 
 ### -Width
+
 The number of columns to generate in the gradient. Defaults to the width of the console.
 
 ```yaml
@@ -92,12 +92,13 @@ Accept wildcard characters: False
 ```
 
 ### -Height
+
 The number of rows to generate in the gradient. Defaults to 1
 
 ```yaml
 Type: Int32
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: 4
@@ -107,13 +108,14 @@ Accept wildcard characters: False
 ```
 
 ### -ColorSpace
-A color space to render the gradient in. Defaults to HunterLab, but can be any of
-CMY, CMYK, LAB, LCH, LUV, HunterLAB, HSL, HSV, HSB, RGB, XYZ, YXY
+A color space to render the gradient in. Defaults to HunterLab, which
+generates gradients that are very consistent in their brightness,
+but can be any of CMY, CMYK, LAB, LCH, LUV, HunterLAB, HSL, HSV, HSB, RGB, XYZ, YXY
 
 ```yaml
 Type: Object
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -128,7 +130,7 @@ For color spaces with Hue (HSL, HSV, HSB), setting this generates the gradient t
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named
@@ -143,7 +145,7 @@ Flattens the 2D array to a single array.
 ```yaml
 Type: SwitchParameter
 Parameter Sets: (All)
-Aliases: 
+Aliases:
 
 Required: False
 Position: Named

Pansies.csproj

@@ -15,6 +15,15 @@
       <Generator>TextTemplatingFileGenerator</Generator>
       <LastGenOutput>Colors.cs</LastGenOutput>
     </None>
+    <Compile Update="Source\Assembly\ColorSpaces\ColorSpaces.cs">
+      <DependentUpon>ColorSpaces.tt</DependentUpon>
+      <DesignTime>True</DesignTime>
+      <AutoGen>True</AutoGen>
+    </Compile>
+    <None Update="Source\Assembly\ColorSpaces\ColorSpaces.tt">
+      <LastGenOutput>ColorSpaces.cs</LastGenOutput>
+      <Generator>TextTemplatingFileGenerator</Generator>
+    </None>
   </ItemGroup>
   <ItemGroup>
     <!-- I wouldn't want to double-compile the stuff in here -->
@@ -28,7 +37,6 @@
     <PackageReference Include="PowerShellStandard.Library" Version="5.1.0-preview-04" />
   </ItemGroup>
   <ItemGroup>
-    <ProjectReference Include="lib\ColorMine\ColorMine\ColorMine.csproj" />
     <ProjectReference Include="lib\p2f\src\CodeOwls.PowerShell\CodeOwls.PowerShell.Paths\CodeOwls.PowerShell.Paths.csproj" />
     <ProjectReference Include="lib\p2f\src\CodeOwls.PowerShell\CodeOwls.PowerShell.Provider\CodeOwls.PowerShell.Provider.csproj" />
   </ItemGroup>

Pansies.sln

@@ -1,12 +1,10 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.27703.2000
+# Visual Studio Version 16
+VisualStudioVersion = 16.0.29806.167
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Pansies", "Pansies.csproj", "{A70FB8C2-26DB-45A8-AEFC-CC3496AF1FAD}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ColorMine", "lib\ColorMine\ColorMine\ColorMine.csproj", "{25D4CBB8-B010-4768-95D5-F21B54547FB6}"
-EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CodeOwls.PowerShell.Paths", "lib\p2f\src\CodeOwls.PowerShell\CodeOwls.PowerShell.Paths\CodeOwls.PowerShell.Paths.csproj", "{F9F6FA51-1579-4F16-8F5E-3CE16FAA9B43}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CodeOwls.PowerShell.Provider", "lib\p2f\src\CodeOwls.PowerShell\CodeOwls.PowerShell.Provider\CodeOwls.PowerShell.Provider.csproj", "{3D3741C8-A7A9-4532-A84A-0E7C90214800}"
@@ -21,10 +19,6 @@ Global
 		{A70FB8C2-26DB-45A8-AEFC-CC3496AF1FAD}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{A70FB8C2-26DB-45A8-AEFC-CC3496AF1FAD}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{A70FB8C2-26DB-45A8-AEFC-CC3496AF1FAD}.Release|Any CPU.Build.0 = Release|Any CPU
-		{25D4CBB8-B010-4768-95D5-F21B54547FB6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{25D4CBB8-B010-4768-95D5-F21B54547FB6}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{25D4CBB8-B010-4768-95D5-F21B54547FB6}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{25D4CBB8-B010-4768-95D5-F21B54547FB6}.Release|Any CPU.Build.0 = Release|Any CPU
 		{F9F6FA51-1579-4F16-8F5E-3CE16FAA9B43}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{F9F6FA51-1579-4F16-8F5E-3CE16FAA9B43}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{F9F6FA51-1579-4F16-8F5E-3CE16FAA9B43}.Release|Any CPU.ActiveCfg = Release|Any CPU

Source/Assembly/ColorSpaces/ColorSpace.cs

@@ -0,0 +1,83 @@
+using PoshCode.Pansies.ColorSpaces.Comparisons;
+
+namespace PoshCode.Pansies.ColorSpaces
+{
+    public delegate double ComparisonAlgorithm(IColorSpace a, IColorSpace b);
+
+    /// <summary>
+    /// Defines the public methods for all color spaces
+    /// </summary>
+    public interface IColorSpace
+    {
+        /// <summary>
+        /// Initialize settings from an Rgb object
+        /// </summary>
+        /// <param name="color"></param>
+        void Initialize(IRgb color);
+
+        /// <summary>
+        /// Convert the color space to Rgb, you should probably using the "To" method instead. Need to figure out a way to "hide" or otherwise remove this method from the public interface.
+        /// </summary>
+        /// <returns></returns>
+        IRgb ToRgb();
+
+        /// <summary>
+        /// Convert any IColorSpace to any other IColorSpace.
+        /// </summary>
+        /// <typeparam name="T">IColorSpace type to convert to</typeparam>
+        /// <returns></returns>
+        T To<T>() where T : IColorSpace, new();
+
+        /// <summary>
+        /// Determine how close two IColorSpaces are to each other using a passed in algorithm
+        /// </summary>
+        /// <param name="compareToValue">Other IColorSpace to compare to</param>
+        /// <param name="comparer">Algorithm to use for comparison</param>
+        /// <returns>Distance in 3d space as double</returns>
+        double Compare(IColorSpace compareToValue, IColorSpaceComparison comparer);
+
+        /// <summary>
+        /// Array of signifigant values in a consistent order. Useful for generic n-dimensional math.
+        /// </summary>
+        double[] Ordinals { get; set; }
+    }
+
+    /// <summary>
+    /// Abstract ColorSpace class, defines the To method that converts between any IColorSpace.
+    /// </summary>
+    public abstract class ColorSpace : IColorSpace
+    {
+        public abstract void Initialize(IRgb color);
+        public abstract IRgb ToRgb();
+        public abstract double[] Ordinals { get; set; }
+
+        /// <summary>
+        /// Convienience method for comparing any IColorSpace
+        /// </summary>
+        /// <param name="compareToValue"></param>
+        /// <param name="comparer"></param>
+        /// <returns>Single number representing the difference between two colors</returns>
+        public double Compare(IColorSpace compareToValue, IColorSpaceComparison comparer)
+        {
+            return comparer.Compare(this, compareToValue);
+        }
+
+        /// <summary>
+        /// Convert any IColorSpace to any other IColorSpace
+        /// </summary>
+        /// <typeparam name="T">Must implement IColorSpace, new()</typeparam>
+        /// <returns></returns>
+        public T To<T>() where T : IColorSpace, new()
+        {
+            if (typeof(T) == GetType())
+            {
+                return (T)MemberwiseClone();
+            }
+
+            var newColorSpace = new T();
+            newColorSpace.Initialize(ToRgb());
+
+            return newColorSpace;
+        }
+    }
+}