Add CompressToBase64

Author: Jaykul

Source/Private/CompressToBase64.ps1

@@ -0,0 +1,57 @@
+function CompressToBase64 {
+    <#
+        .SYNOPSIS
+            Compresses and encodes a module file for embedding into a script
+        .DESCRIPTION
+            Reads the raw bytes and then compress (gzip) them, before base64 encoding the result
+        .EXAMPLE
+            Get-ChildItem *.dll, *.psm1 | CompressToBase64 -ExpandScript ImportBase64Module > Script.ps1
+
+            Script.ps1 will contain the base64 encoded (and compressed) contents of the files, piped to the ImportBase64Module function
+        .LINK
+            ImportBase64Module
+    #>
+    [CmdletBinding(DefaultParameterSetName = "Base64")]
+    [OutputType([string])]
+    param(
+        # The path to the dll or script file to compress
+        [Parameter(Mandatory, Position = 0, ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [Alias("PSPath")]
+        [string[]]$Path,
+
+        # If set, wraps the Base64 encoded content in the specified command
+        [Parameter(Mandatory, Position = 1, ParameterSetName = "ExpandScriptName")]
+        [string]$ExpandScriptName,
+
+        # If set, wraps the Base64 encoded content in the specified command
+        [Parameter(Mandatory, Position = 1, ParameterSetName = "ExpandScript")]
+        [ScriptBlock]$ExpandScript
+    )
+    begin {
+        $Result = @()
+        if ($ExpandScriptName -and !$ExpandScript) {
+            $ExpandScript = (Get-Command $ExpandScriptName).ScriptBlock
+        }
+    }
+    process {
+        foreach ($File in $Path | Convert-Path) {
+            $Source = [System.IO.MemoryStream][System.IO.File]::ReadAllBytes($File)
+            $OutputStream = [System.IO.Compression.DeflateStream]::new(
+                [System.IO.MemoryStream]::new(),
+                [System.IO.Compression.CompressionMode]::Compress)
+            $Source.CopyTo($OutputStream)
+            $OutputStream.Flush()
+            $ByteArray = $OutputStream.BaseStream.ToArray()
+            if (!$ExpandScript) {
+                [Convert]::ToBase64String($ByteArray)
+            } else {
+                $Result += [Convert]::ToBase64String($ByteArray)
+            }
+        }
+    }
+    end {
+        if ($ExpandScript) {
+            [ScriptBlock]::Create("@(`n'$($Result -join "'`n'")'`n)|.{`n${ExpandScript}`n}").ToString()
+        }
+    }
+}

Tests/Private/CompressToBase64.Tests.ps1

@@ -0,0 +1,63 @@
+#! requires -Module ModuleBuilder
+Describe "CompressToBase64" {
+
+    Context "It compresses and encodes a file for embedding into a script" {
+        BeforeAll {
+            $Base64 = InModuleScope ModuleBuilder {
+                CompressToBase64 $PSCommandPath
+            }
+        }
+
+        It "Returns a base64 encoded string" {
+            $Base64 | Should -BeOfType [string]
+            $Base64 | Should -Match "^[A-Za-z0-9\+\/]+=*$"
+            $Base64.Length | Should -BeGreaterThan 0
+        }
+
+        It "Returns the gzipped and encoded script" {
+            $OutputStream = [System.IO.MemoryStream]::new()
+            $InputStream = [System.IO.MemoryStream][System.Convert]::FromBase64String($Base64)
+            $DeflateStream = [System.IO.Compression.DeflateStream]::new($InputStream, [System.IO.Compression.CompressionMode]::Decompress)
+            $DeflateStream.CopyTo($OutputStream)
+            $OutputStream.Seek(0, "Begin")
+            $Source = [System.IO.StreamReader]::new($OutputStream, $true).ReadToEnd()
+
+            $Source | Should -Be (Get-Content $PSCommandPath -Raw)
+        }
+    }
+
+    Context "It wraps the Base64 encoded content in the specified command" {
+        BeforeAll {
+            $Base64 = InModuleScope ModuleBuilder {
+                CompressToBase64 $PSCommandPath -ExpandScriptName ImportBase64Module
+            }
+        }
+
+        It "Returns a string" {
+            $Base64 | Should -BeOfType [string]
+        }
+
+        It "Pipes the encoding into the command" {
+            $Block = InModuleScope ModuleBuilder {
+                (Get-Command ImportBase64Module).ScriptBlock
+            }
+
+            $Base64 | Should -Match "|.{`n$Block`n}$"
+        }
+    }
+
+    Context "It wraps the Base64 encoded content in the specified scriptblock" {
+        BeforeAll {
+            $Base64 = InModuleScope ModuleBuilder {
+                Get-ChildItem $PSCommandPath | CompressToBase64 -ExpandScript { ImportBase64Module }
+            }
+        }
+
+        It "Returns a string" {
+            $Base64 | Should -BeOfType [string]
+        }
+        It "Pipes the encoding into the scriptblock" {
+            $Base64 | Should -Match "|.{`nImportBase64Module`n}$"
+        }
+    }
+}