StringBuilder.psm1
|
$script:ModuleRoot = $PSScriptRoot $script:ModuleVersion = (Import-PowerShellDataFile -Path "$($script:ModuleRoot)\StringBuilder.psd1").ModuleVersion # Detect whether at some level dotsourcing was enforced $script:doDotSource = Get-PSFConfigValue -FullName StringBuilder.Import.DoDotSource -Fallback $false if ($StringBuilder_dotsourcemodule) { $script:doDotSource = $true } <# Note on Resolve-Path: All paths are sent through Resolve-Path/Resolve-PSFPath in order to convert them to the correct path separator. This allows ignoring path separators throughout the import sequence, which could otherwise cause trouble depending on OS. Resolve-Path can only be used for paths that already exist, Resolve-PSFPath can accept that the last leaf my not exist. This is important when testing for paths. #> # Detect whether at some level loading individual module files, rather than the compiled module was enforced $importIndividualFiles = Get-PSFConfigValue -FullName StringBuilder.Import.IndividualFiles -Fallback $false if ($StringBuilder_importIndividualFiles) { $importIndividualFiles = $true } if (Test-Path (Resolve-PSFPath -Path "$($script:ModuleRoot)\..\.git" -SingleItem -NewChild)) { $importIndividualFiles = $true } if ("<was compiled>" -eq '<was not compiled>') { $importIndividualFiles = $true } function Import-ModuleFile { <# .SYNOPSIS Loads files into the module on module import. .DESCRIPTION This helper function is used during module initialization. It should always be dotsourced itself, in order to proper function. This provides a central location to react to files being imported, if later desired .PARAMETER Path The path to the file to load .EXAMPLE PS C:\> . Import-ModuleFile -File $function.FullName Imports the file stored in $function according to import policy #> [CmdletBinding()] Param ( [string] $Path ) $resolvedPath = $ExecutionContext.SessionState.Path.GetResolvedPSPathFromPSPath($Path).ProviderPath if ($doDotSource) { . $resolvedPath } else { $ExecutionContext.InvokeCommand.InvokeScript($false, ([scriptblock]::Create([io.file]::ReadAllText($resolvedPath))), $null, $null) } } #region Load individual files if ($importIndividualFiles) { # Execute Preimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\preimport.ps1")) { . Import-ModuleFile -Path $path } # Import all internal functions foreach ($function in (Get-ChildItem "$ModuleRoot\internal\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Import all public functions foreach ($function in (Get-ChildItem "$ModuleRoot\functions" -Filter "*.ps1" -Recurse -ErrorAction Ignore)) { . Import-ModuleFile -Path $function.FullName } # Execute Postimport actions foreach ($path in (& "$ModuleRoot\internal\scripts\postimport.ps1")) { . Import-ModuleFile -Path $path } # End it here, do not load compiled code below return } #endregion Load individual files #region Load compiled code <# This file loads the strings documents from the respective language folders. This allows localizing messages and errors. Load psd1 language files for each language you wish to support. Partial translations are acceptable - when missing a current language message, it will fallback to English or another available language. #> Import-PSFLocalizedString -Path "$($script:ModuleRoot)\en-us\*.psd1" -Module 'StringBuilder' -Language 'en-US' function Assert-StringBuilder { <# .SYNOPSIS Asserts a valid stringbuilder has been created. .DESCRIPTION Asserts a valid stringbuilder has been created. .PARAMETER Name Name of the stringbuilder that must exist. .PARAMETER Cmdlet The $PSCmdlet variable of the calling command. Causes the error record to be created in the context of that command .EXAMPLE PS C:\> Assert-StringBuilder -Name 'MyModule' -Cmdlet $Cmdlet Ensures that the string builder 'MyModule' exists. #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [string] $Name, [Parameter(Mandatory = $true)] $Cmdlet ) process { if ($script:builders[$Name]) { return } $exception = [Exception]::new("String builder '$Name' not found! Ensure a proper string builder has been created!") $record = [System.Management.Automation.ErrorRecord]::new($exception, 'MissingStringBuilder', [System.Management.Automation.ErrorCategory]::InvalidOperation, $null) $Cmdlet.ThrowTerminatingError($record) } } function Add-SBLine { <# .SYNOPSIS Add a line of text to a string builder. .DESCRIPTION Add a line of text to a string builder. .PARAMETER Text The text to add. .PARAMETER Values Any values to format into the text specified. Uses the -f operator. .PARAMETER Name Name of the string builder to work with. Defaults to the caller's module name (if present) or '<none>' (if not so) .EXAMPLE PS C:\> Add-SBLine -Text 'Example line of text' Adds the specified string into the open string builder. .EXAMPLE PS C:\> Add-SBLine -Text '{0} is larger than {1}' -Values 42,23 Adds the specified string into the open string builder, after formatting in the values offered. #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, Position = 0)] [string] $Text, [Alias('f')] [object[]] $Values, [PsfArgumentCompleter('StringBuilder.Name')] [string] $Name ) begin { $sbName = [PSFramework.Utility.UtilityHost]::FriendlyCallstack.Entries[1].InvocationInfo.MyCommand.Module.Name if (-not $sbName) { $sbName = '<none>' } if ($Name) { $sbName = $Name } Assert-StringBuilder -Name $sbName -Cmdlet $PSCmdlet } process { $newLine = $Text if ($Values) { $newLine = $Text -f $Values } $null = $script:builders[$sbName].AppendLine($newLine) } } function Add-SBString { <# .SYNOPSIS Add a piece of text to a string builder, without adding a linebreak. .DESCRIPTION Add a piece of text to a string builder, without adding a linebreak. .PARAMETER Text The text to add. .PARAMETER Values Any values to format into the text specified. Uses the -f operator. .PARAMETER Name Name of the string builder to work with. Defaults to the caller's module name (if present) or '<none>' (if not so) .EXAMPLE PS C:\> Add-SBString -Text 'Example line of text' Adds the specified string into the open string builder. .EXAMPLE PS C:\> Add-SBString -Text '{0} is larger than {1}' -Values 42,23 Adds the specified string into the open string builder, after formatting in the values offered. #> [CmdletBinding()] param ( [Parameter(Mandatory = $true, Position = 0)] [string] $Text, [object[]] $Values, [PsfArgumentCompleter('StringBuilder.Name')] [string] $Name ) begin { $sbName = [PSFramework.Utility.UtilityHost]::FriendlyCallstack.Entries[1].InvocationInfo.MyCommand.Module.Name if (-not $sbName) { $sbName = '<none>' } if ($Name) { $sbName = $Name } Assert-StringBuilder -Name $sbName -Cmdlet $PSCmdlet } process { $newText = $Text if ($Values) { $newText = $Text -f $Values } $null = $script:builders[$sbName].Append($newText) } } function Close-SBStringBuilder { <# .SYNOPSIS Closes out an open stringbuilder, returning its string value content. .DESCRIPTION Closes out an open stringbuilder, returning its string value content. .PARAMETER Name Name of the string builder to work with. Defaults to the caller's module name (if present) or '<none>' (if not so) .EXAMPLE PS C:\> Close-SBStringBuilder Close out the current stringbuilder object. #> [OutputType([string])] [CmdletBinding()] param ( [PsfArgumentCompleter('StringBuilder.Name')] [string] $Name ) begin { $sbName = [PSFramework.Utility.UtilityHost]::FriendlyCallstack.Entries[1].InvocationInfo.MyCommand.Module.Name if (-not $sbName) { $sbName = '<none>' } if ($Name) { $sbName = $Name } Assert-StringBuilder -Name $sbName -Cmdlet $PSCmdlet } process { $script:builders[$sbName].ToString() $script:builders.Remove($sbName) } } function Get-SBStringBuilder { <# .SYNOPSIS Return a specific stringbuilder object. .DESCRIPTION Return a specific stringbuilder object. .PARAMETER Name Name of the string builder to retrieve. Defaults to the caller's module name (if present) or '<none>' (if not so) .EXAMPLE PS C:\> Get-SBStringBuilder Return the current stringbuilder of the calling module. #> [CmdletBinding()] param ( [PsfArgumentCompleter('StringBuilder.Name')] [string] $Name ) begin { $sbName = [PSFramework.Utility.UtilityHost]::FriendlyCallstack.Entries[1].InvocationInfo.MyCommand.Module.Name if (-not $sbName) { $sbName = '<none>' } if ($Name) { $sbName = $Name } } process { $script:builders[$sbName] } } function New-SBStringBuilder { <# .SYNOPSIS Create a new stringbuilder object. .DESCRIPTION Create a new stringbuilder object. .PARAMETER Register Register the string builder under the name (if specified) or the current module (if not so). .PARAMETER Name Name under which to register a string builder. Defaults to the caller's module name (if present) or '<none>' (if not so) .EXAMPLE PS C:\> New-SBStringBuilder Create a new string builder under the current module's name. #> [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")] [OutputType([System.Text.StringBuilder])] [CmdletBinding()] Param ( [switch] $Register, [PsfArgumentCompleter('StringBuilder.Name')] [string] $Name ) begin{ $sbName = [PSFramework.Utility.UtilityHost]::FriendlyCallstack.Entries[1].InvocationInfo.MyCommand.Module.Name if (-not $sbName) { $sbName = '<none>' } if ($Name) { $sbName = $Name } } process { $stringBuilder = [System.Text.StringBuilder]::new() if ($Register -or $Name) { $script:builders[$sbName] = $stringBuilder } $stringBuilder } } function Register-SBStringBuilder { <# .SYNOPSIS Registers the specified string builder under a name. .DESCRIPTION Registers the specified string builder under a name. Useful to add an externally created string builder object to the system .PARAMETER StringBuilder The stringbuilder object to add. .PARAMETER Name Name of the string builder to work with. Defaults to the caller's module name (if present) or '<none>' (if not so) .EXAMPLE PS C:\> Register-SBStringBuilder -StringBuilder $StringBuilder Adds the specified stringbuilder object under the current module's name. #> [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.Text.StringBuilder] $StringBuilder, [PsfArgumentCompleter('StringBuilder.Name')] [string] $Name ) begin { $sbName = [PSFramework.Utility.UtilityHost]::FriendlyCallstack.Entries[1].InvocationInfo.MyCommand.Module.Name if (-not $sbName) { $sbName = '<none>' } if ($Name) { $sbName = $Name } } process { $script:builders[$sbName] = $stringBuilder } } <# This is an example configuration file By default, it is enough to have a single one of them, however if you have enough configuration settings to justify having multiple copies of it, feel totally free to split them into multiple files. #> <# # Example Configuration Set-PSFConfig -Module 'StringBuilder' -Name 'Example.Setting' -Value 10 -Initialize -Validation 'integer' -Handler { } -Description "Example configuration setting. Your module can then use the setting using 'Get-PSFConfigValue'" #> Set-PSFConfig -Module 'StringBuilder' -Name 'Import.DoDotSource' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be dotsourced on import. By default, the files of this module are read as string value and invoked, which is faster but worse on debugging." Set-PSFConfig -Module 'StringBuilder' -Name 'Import.IndividualFiles' -Value $false -Initialize -Validation 'bool' -Description "Whether the module files should be imported individually. During the module build, all module code is compiled into few files, which are imported instead by default. Loading the compiled versions is faster, using the individual files is easier for debugging and testing out adjustments." <# Stored scriptblocks are available in [PsfValidateScript()] attributes. This makes it easier to centrally provide the same scriptblock multiple times, without having to maintain it in separate locations. It also prevents lengthy validation scriptblocks from making your parameter block hard to read. Set-PSFScriptblock -Name 'StringBuilder.ScriptBlockName' -Scriptblock { } #> Register-PSFTeppScriptblock -Name 'StringBuilder.Name' -ScriptBlock { & (Get-Module StringBuilder) { $script:builders.Keys } } <# # Example: Register-PSFTeppArgumentCompleter -Command Get-Alcohol -Parameter Type -Name StringBuilder.alcohol #> New-PSFLicense -Product 'StringBuilder' -Manufacturer 'Friedrich Weinmann' -ProductVersion $script:ModuleVersion -ProductType Module -Name MIT -Version "1.0.0.0" -Date (Get-Date "2021-08-05") -Text @" Copyright (c) 2021 Friedrich Weinmann Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. "@ # Store current string builders # Storage separated by module $script:builders = @{ } #endregion Load compiled code |