FormatFunctions.ps1


Function Format-Percent {

    [cmdletbinding(DefaultParameterSetName = "None")]
    [OutputType([Double], ParameterSetName = "None")]
    [OutputType([String], ParameterSetName = "String")]
    Param(
        [Parameter(Position = 0, Mandatory, HelpMessage = "What is the value?")]
        [ValidateNotNullorEmpty()]
        [Alias("X", "Numerator")]
        $Value,
        [Parameter(Position = 1, Mandatory, HelpMessage = "What is the total value?")]
        [ValidateNotNullorEmpty()]
        [Alias("Y", "Denominator")]
        $Total,
        [ValidateNotNullorEmpty()]
        [ValidateRange(0, 15)]
        [int]$Decimal = 2,
        [Parameter(ParameterSetName = "String")]
        [Switch]$AsString
    )

    Write-Debug "STARTING: $($MyInvocation.Mycommand)"  
    Write-Debug "STATUS: Calculating percentage from $Value/$Total to $decimal places"
    $result = $Value / $Total

    if ($AsString) {
        Write-Debug "STATUS: Writing string result"
        #use the -F operator to build a percent string to X number of decimal places
        $pctstring = "{0:p$Decimal}" -f $result
        #remove the space before the % symbol
        $pctstring.Replace(" ", "")

    }
    else {
        Write-Debug "STATUS: Writing numeric result"
        #round the result to the specified number of decimal places
        [math]::Round( ($result * 100), $Decimal)
    }

    Write-Debug "ENDING: $($MyInvocation.Mycommand)"

} #end function

Function Format-Value {

    [cmdletbinding(DefaultParameterSetName = "Default")]

    Param(
        [Parameter(Position = 1, Mandatory, ValueFromPipeline)]
        [ValidateNotNullorEmpty()]
        $InputObject,
        [Parameter(Position = 0, ParameterSetName = "Default")]
        [ValidateSet("KB", "MB", "GB", "TB", "PB")]
        [string]$Unit,
        [ValidateRange(0, 15)]
        [Parameter(ParameterSetName = "Default")]
        [Parameter(ParameterSetName = "Auto")]
        [Parameter(ParameterSetName = "Number")]
        [int]$Decimal,
        [Parameter(ParameterSetName = "Auto")]
        [switch]$Autodetect,
        [Parameter(ParameterSetName = "Currency")]
        [switch]$AsCurrency,
        [Parameter(ParameterSetName = "Number")]
        [switch]$AsNumber
    )

    Begin {
        Write-Debug "STARTING: $($MyInvocation.Mycommand)"  
        Write-Debug "STATUS: Using parameter set $($PSCmdlet.ParameterSetName)"
    } #begin

    Process {
        Write-Debug "STATUS: Formatting $Inputobject"

        <#
        divide the incoming value by the specified unit
        There is no need to process other statements so I'm using the Break keyword
        although in reality the rest of the statements wouldn't be processed anyway
        #>
        Switch ($PSCmdlet.ParameterSetName) {
            "Default" {
                Write-Debug "..as $Unit"
                Switch ($Unit) {
                    "KB" { $value = $Inputobject / 1KB ; break }
                    "MB" { $value = $Inputobject / 1MB ; break }
                    "GB" { $value = $Inputobject / 1GB ; break }
                    "TB" { $value = $Inputobject / 1TB ; break }
                    "PB" { $value = $Inputobject / 1PB ; break }
                    default { 
                        #just use the raw value
                        $value = $Inputobject 
                    }
                } #default
            }
            "Auto" {
                Write-Debug "STATUS: Using Autodetect"
      
                if ($InputObject -ge 1PB) {
                    Write-Debug "..as PB"
                    $value = $Inputobject / 1PB
                }
                elseif ($InputObject -ge 1TB) {
                    Write-Debug "..as TB"
                    $value = $Inputobject / 1TB
                }
                elseif ($InputObject -ge 1GB) {
                    Write-Debug "..as GB"
                    $value = $Inputobject / 1GB
                }
                elseif ($InputObject -ge 1MB) {
                    Write-Debug "..as MB"
                    $value = $Inputobject / 1MB
                }
                elseif ($InputObject -ge 1KB) {
                    Write-Debug "..as KB"
                    $value = $Inputobject / 1KB
                }
                else { 
                    Write-Debug "..as bytes"
                    $value = $InputObject
                }
                Break
            } #Auto
            "Currency" {
                Write-Debug "...as currency"
                "{0:c}" -f $InputObject
                #if using currency no other code in the Process block will be run
                Break
            }#Currency
            "Number" {
                Write-Debug "...as number"
                #if -Decimal not used explicitly set it to 0
                if (-Not $Decimal) {
                    $Decimal = 0
                }
                #format as a number to the specified number of decimal points
                "{0:n$($decimal)}" -f $InputObject
                Break
            }
        } #switch parameterset name

        if ($PSCmdlet.ParameterSetName -notmatch "Currency|Number") {
            Write-Debug "STATUS: Reformatting $value"
            if ($decimal) {
                Write-Debug "..to $decimal decimal places"
                #round the number to the specified number of decimal places
                [math]::Round($value, $decimal)
            }
            else {
                #if not a currency and not using a decimal then treat the value as an integer
                #and write the result to the pipeline
                Write-Debug "..as [int]"
                $value -as [int]
            }
        } #parameter set <> currency
    } #process

    End {
        Write-Debug "ENDING: $($MyInvocation.Mycommand)"
    } #end
} 

Function Format-String {

    [cmdletbinding()]
    [OutputType([string])]
    Param(
        [Parameter(Position = 0, Mandatory, ValueFromPipeline)]
        [ValidateNotNullorEmpty()]
        [string]$Text,
        [switch]$Reverse,
        [ValidateSet("Upper", "Lower", "Proper", "Toggle", "Alternate")]
        [string]$Case,
        [hashtable]$Replace,
        [switch]$Randomize
    )

    Begin {
        Write-Debug "STARTING: $($MyInvocation.Mycommand)"  
        Write-Debug "STATUS: Using parameter set $($PSCmdlet.parameterSetName)"
    } #begin

    Process {
        Write-Debug "STATUS: Processing $Text"
        if ($Reverse) {
            Write-Debug "STATUS: Reversing $($Text.length) characters"
            $rev = for ($i = $Text.length; $i -ge 0 ; $i--) { $Text[$i]}
            #join the reverse array back into a string
            $str = $rev -join ""
        }
        else {
            #copy the Text value to this internal variable
            $str = $Text
        } 

        if ($Randomize) {
            Write-Debug "STATUS: Randomizing text"
            #get a random number of characters that is the same length as the original string
            #and join them back together
            $str = ($str.ToCharArray() | Get-Random -count $str.length) -join ""
        } #Randomize

        if ($Replace) {
            foreach ($key in $Replace.keys) {
                Write-Debug "STATUS: Replacing $key with $($replace.item($key))"
                $str = $str.replace($key, $replace.item($key))
            } #foreach
        } #replace
        Switch ($case) {
            "Upper" {
                Write-Debug "STATUS: Setting to upper case"
                $str = $str.ToUpper()
            } #upper
            "Lower" {
                Write-Debug "STATUS: Setting to lower case"
                $str = $str.ToLower()
            } #lower
            "Proper" {
                Write-Debug "STATUS: Setting to proper case"
                $str = "{0}{1}" -f $str[0].toString().toUpper(), -join $str.Substring(1).ToLower()
            } #proper
            "Alternate" {
                Write-Debug "STATUS: Setting to alternate case"
                $alter = for ($i = 0 ; $i -lt $str.length ; $i++) {
                    #Odd numbers are uppercase
                    if ($i % 2) {
                        $str[$i].ToString().Tolower()
                    }
                    else {
                        $str[$i].ToString().ToUpper()
                    }
                } #for
                $str = $alter -join ""
            } #alternate
            "Toggle" {
                Write-Debug "STATUS: setting to toggle case"
                <#
            use a regular expression pattern for a case sensitive match
            Other characters like ! and numbers will fail the test 
            but the ToUpper() method will have no effect.
        #>
       
                #code to use methods from [CHAR] which should better handle other cultures
                $toggle = for ($i = 0 ; $i -lt $str.length ; $i++) {
                    if ([char]::IsUpper($str[$i])) {
                        $str[$i].ToString().ToLower()
                    }
                    else {
                        $str[$i].ToString().ToUpper()
                    }
                } #for
                $str = $toggle -join ""
            } #toggle

            Default {
                Write-Debug "STATUS: no further formatting"
            }
        }
        #write result to the pipeline
        $str

    } #process

    End {
        Write-Debug "ENDING: $($MyInvocation.Mycommand)"
    } #end
}