dry.module.ad

0.1.0

helpers/dry.module.adlog/functions/New-DryHeader.ps1

function New-DryHeader {
    [CmdletBinding(DefaultParameterSetName="multilineheader")]
    [OutputType([array],ParameterSetName="multilineheader")]
    [OutputType([string],ParameterSetName="singlelineheader")]
    param (
        [Parameter(Mandatory)]
        [PSObject]$Message,

        [Parameter(HelpMessage="Number of whitespaces on the right side of screen, after each message line")]
        [int]$PostBuffer = 3,

        [Parameter(HelpMessage="A sequence of characters of a specific length")]
        [string]$HeaderChars = '.',

        [Alias("sh")]
        [Parameter(Mandatory,ParameterSetName="singlelineheader",HelpMessage="Get a smaller, one-line header")]
        [switch]$Small,

        [Parameter(HelpMessage="Converts 'Message' to 'M e s s a g e'")]
        [switch]$Air,

        [Parameter(Mandatory,ParameterSetName="singlelineheader")]
        [Parameter(Mandatory,ParameterSetName="multilineheader")]
        [int]$TargetMessageLength
    )

    # Make an array of the header chars
    for ($hca = 0; $hca -lt $HeaderChars.length; $hca++) {
        [array]$HeaderCharsArray += $HeaderChars[$hca]
    }

    # Converts 'Message' to 'M e s s a g e'
    if ($Air) {
        $AiredMessage = ''
        for ($LetterCount = 0; $LetterCount -lt $Message.Length; $LetterCount++) {
            $AiredMessage += $Message.SubString($LetterCount,1)
            $AiredMessage = "$AiredMessage "
        }
        $Message = $AiredMessage
    }

    switch ($PSCmdlet.ParameterSetName) {
        'singlelineheader' {
            # add $PostBuffer
            for ($b = 0; $b -lt $PostBuffer; $b++) {
                $Message = "$Message "
            }

            # Determine which of the elements in the array to start on - this is to make HeaderChars aligned
            $HeaderCharIndex = ($Message.length)%($HeaderCharsArray.length)
            while ($Message.Length -lt $TargetMessageLength) {
                $Message = $Message + $HeaderCharsArray[$HeaderCharIndex]
                $HeaderCharIndex++
                if ($HeaderCharIndex -gt ($HeaderCharsArray.length-1)) {
                    $HeaderCharIndex = 0
                }
            }
            $Message
         }
        'multilineheader' {
            # Just output the header line
            [string]$HeaderLine = ''
            $HeaderCharIndex = 0
            while ($HeaderLine.Length -lt $TargetMessageLength) {
                $HeaderLine = $HeaderLine + $HeaderCharsArray[$HeaderCharIndex]
                $HeaderCharIndex++
                if ($HeaderCharIndex -gt ($HeaderCharsArray.length-1)) {
                    $HeaderCharIndex = 0
                }
            }
            # Output the header line and message
            $HeaderLine,$Message
        }
    }
}