feat(decompress): Add pipeline support

lib/decompress.ps1

@@ -1,12 +1,13 @@
 function Expand-7zipArchive {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
+        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [String]
         $Path,
-        [Parameter(Position = 1)]
+        [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)]
         [String]
         $DestinationPath = (Split-Path $Path),
+        [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)]
         [String]
         $ExtractDir,
         [Parameter(ValueFromRemainingArguments = $true)]
@@ -18,61 +19,65 @@ function Expand-7zipArchive {
         [Switch]
         $Removal
     )
-    if ((get_config USE_EXTERNAL_7ZIP)) {
-        try {
-            $7zPath = (Get-Command '7z' -CommandType Application -ErrorAction Stop | Select-Object -First 1).Source
-        } catch [System.Management.Automation.CommandNotFoundException] {
-            abort "`nCannot find external 7-Zip (7z.exe) while 'use_external_7zip' is 'true'!`nRun 'scoop config use_external_7zip false' or install 7-Zip manually and try again."
-        }
-    } else {
-        $7zPath = Get-HelperPath -Helper 7zip
-    }
-    $LogPath = "$(Split-Path $Path)\7zip.log"
-    $DestinationPath = $DestinationPath.TrimEnd('\')
-    $ArgList = @('x', $Path, "-o$DestinationPath", '-xr!*.nsis', '-y')
-    $IsTar = ((strip_ext $Path) -match '\.tar$') -or ($Path -match '\.t[abgpx]z2?$')
-    if (!$IsTar -and $ExtractDir) {
-        $ArgList += "-ir!$ExtractDir\*"
-    }
-    if ($Switches) {
-        $ArgList += (-split $Switches)
-    }
-    switch ($Overwrite) {
-        'All' { $ArgList += '-aoa' }
-        'Skip' { $ArgList += '-aos' }
-        'Rename' { $ArgList += '-aou' }
-    }
-    $Status = Invoke-ExternalCommand $7zPath $ArgList -LogPath $LogPath
-    if (!$Status) {
-        abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
-    }
-    if (!$IsTar -and $ExtractDir) {
-        movedir "$DestinationPath\$ExtractDir" $DestinationPath | Out-Null
-    }
-    if (Test-Path $LogPath) {
-        Remove-Item $LogPath -Force
-    }
-    if ($IsTar) {
-        # Check for tar
-        $Status = Invoke-ExternalCommand $7zPath @('l', $Path) -LogPath $LogPath
-        if ($Status) {
-            # get inner tar file name
-            $TarFile = (Select-String -Path $LogPath -Pattern '[^ ]*tar$').Matches.Value
-            Expand-7zipArchive -Path "$DestinationPath\$TarFile" -DestinationPath $DestinationPath -ExtractDir $ExtractDir -Removal
+    begin {
+        if ((get_config USE_EXTERNAL_7ZIP)) {
+            try {
+                $7zPath = (Get-Command '7z' -CommandType Application -ErrorAction Stop | Select-Object -First 1).Source
+            } catch [System.Management.Automation.CommandNotFoundException] {
+                abort "`nCannot find external 7-Zip (7z.exe) while 'use_external_7zip' is 'true'!`nRun 'scoop config use_external_7zip false' or install 7-Zip manually and try again."
+            }
         } else {
-            abort "Failed to list files in $Path.`nNot a 7-Zip supported archive file."
+            $7zPath = Get-HelperPath -Helper 7zip
         }
     }
-    if ($Removal) {
-        # Remove original archive file
-        if (($Path -replace '.*\.([^\.]*)$', '$1') -eq '001') {
-            # Remove splited 7-zip archive parts
-            Get-ChildItem "$($Path -replace '\.[^\.]*$', '').???" | Remove-Item -Force
-        } elseif (($Path -replace '.*\.part(\d+)\.rar$', '$1')[-1] -eq '1') {
-            # Remove splitted RAR archive parts
-            Get-ChildItem "$($Path -replace '\.part(\d+)\.rar$', '').part*.rar" | Remove-Item -Force
-        } else {
-            Remove-Item $Path -Force
+    process {
+        $LogPath = "$(Split-Path $Path)\7zip.log"
+        $DestinationPath = $DestinationPath.TrimEnd('\')
+        $ArgList = @('x', $Path, "-o$DestinationPath", '-xr!*.nsis', '-y')
+        $IsTar = ((strip_ext $Path) -match '\.tar$') -or ($Path -match '\.t[abgpx]z2?$')
+        if (!$IsTar -and $ExtractDir) {
+            $ArgList += "-ir!$ExtractDir\*"
+        }
+        if ($Switches) {
+            $ArgList += (-split $Switches)
+        }
+        switch ($Overwrite) {
+            'All' { $ArgList += '-aoa' }
+            'Skip' { $ArgList += '-aos' }
+            'Rename' { $ArgList += '-aou' }
+        }
+        $Status = Invoke-ExternalCommand $7zPath $ArgList -LogPath $LogPath
+        if (!$Status) {
+            abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
+        }
+        if (!$IsTar -and $ExtractDir) {
+            movedir "$DestinationPath\$ExtractDir" $DestinationPath | Out-Null
+        }
+        if (Test-Path $LogPath) {
+            Remove-Item $LogPath -Force
+        }
+        if ($IsTar) {
+            # Check for tar
+            $Status = Invoke-ExternalCommand $7zPath @('l', $Path) -LogPath $LogPath
+            if ($Status) {
+                # get inner tar file name
+                $TarFile = (Select-String -Path $LogPath -Pattern '[^ ]*tar$').Matches.Value
+                Expand-7zipArchive -Path "$DestinationPath\$TarFile" -DestinationPath $DestinationPath -ExtractDir $ExtractDir -Removal
+            } else {
+                abort "Failed to list files in $Path.`nNot a 7-Zip supported archive file."
+            }
+        }
+        if ($Removal) {
+            # Remove original archive file
+            if ($Path -match '\.001$') {
+                # Remove splited 7-zip archive parts
+                Get-ChildItem "$($Path -replace '\.[^\.]*$', '').???" | Remove-Item -Force
+            } elseif ($Path -match '\.part0+1\.rar$') {
+                # Remove splitted RAR archive parts
+                Get-ChildItem "$($Path -replace '\.part0+1\.rar$', '').part*.rar" | Remove-Item -Force
+            } else {
+                Remove-Item $Path -Force
+            }
         }
     }
 }
@@ -80,12 +85,13 @@ function Expand-7zipArchive {
 function Expand-ZstdArchive {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
+        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [String]
         $Path,
-        [Parameter(Position = 1)]
+        [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)]
         [String]
         $DestinationPath = (Split-Path $Path),
+        [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)]
         [String]
         $ExtractDir,
         [Parameter(ValueFromRemainingArguments = $true)]
@@ -94,46 +100,51 @@ function Expand-ZstdArchive {
         [Switch]
         $Removal
     )
-    $ZstdPath = Get-HelperPath -Helper Zstd
-    $LogPath = Join-Path (Split-Path $Path) 'zstd.log'
-    $DestinationPath = $DestinationPath.TrimEnd('\')
-    ensure $DestinationPath | Out-Null
-    $ArgList = @('-d', $Path, '--output-dir-flat', $DestinationPath, '-f', '-v')
+    begin {
+        $zstdPath = Get-HelperPath -Helper zstd
+    }
+    process {
+        $LogPath = Join-Path (Split-Path $Path) 'zstd.log'
+        $DestinationPath = $DestinationPath.TrimEnd('\')
+        ensure $DestinationPath | Out-Null
+        $ArgList = @('-d', $Path, '--output-dir-flat', $DestinationPath, '-f', '-v')
 
-    if ($Switches) {
-        $ArgList += (-split $Switches)
-    }
-    if ($Removal) {
-        # Remove original archive file
-        $ArgList += '--rm'
-    }
-    $Status = Invoke-ExternalCommand $ZstdPath $ArgList -LogPath $LogPath
-    if (!$Status) {
-        abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
-    }
-    $IsTar = (strip_ext $Path) -match '\.tar$'
-    if (!$IsTar -and $ExtractDir) {
-        movedir (Join-Path $DestinationPath $ExtractDir) $DestinationPath | Out-Null
-    }
-    if (Test-Path $LogPath) {
-        Remove-Item $LogPath -Force
-    }
-    if ($IsTar) {
-        # Check for tar
-        $TarFile = Join-Path $DestinationPath (strip_ext (fname $Path))
-        Expand-7zipArchive -Path $TarFile -DestinationPath $DestinationPath -ExtractDir $ExtractDir -Removal
+        if ($Switches) {
+            $ArgList += (-split $Switches)
+        }
+        if ($Removal) {
+            # Remove original archive file
+            $ArgList += '--rm'
+        }
+        $Status = Invoke-ExternalCommand $zstdPath $ArgList -LogPath $LogPath
+        if (!$Status) {
+            abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
+        }
+        $IsTar = (strip_ext $Path) -match '\.tar$'
+        if (!$IsTar -and $ExtractDir) {
+            movedir (Join-Path $DestinationPath $ExtractDir) $DestinationPath | Out-Null
+        }
+        if (Test-Path $LogPath) {
+            Remove-Item $LogPath -Force
+        }
+        if ($IsTar) {
+            # Check for tar
+            $TarFile = Join-Path $DestinationPath (strip_ext (fname $Path))
+            Expand-7zipArchive -Path $TarFile -DestinationPath $DestinationPath -ExtractDir $ExtractDir -Removal
+        }
     }
 }
 
 function Expand-MsiArchive {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
+        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [String]
         $Path,
-        [Parameter(Position = 1)]
+        [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)]
         [String]
         $DestinationPath = (Split-Path $Path),
+        [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)]
         [String]
         $ExtractDir,
         [Parameter(ValueFromRemainingArguments = $true)]
@@ -142,56 +153,59 @@ function Expand-MsiArchive {
         [Switch]
         $Removal
     )
-    $DestinationPath = $DestinationPath.TrimEnd('\')
-    if ($ExtractDir) {
-        $OriDestinationPath = $DestinationPath
-        $DestinationPath = "$DestinationPath\_tmp"
-    }
-    if ((get_config USE_LESSMSI)) {
-        $MsiPath = Get-HelperPath -Helper Lessmsi
-        $ArgList = @('x', $Path, "$DestinationPath\")
-    } else {
-        $MsiPath = 'msiexec.exe'
-        $ArgList = @('/a', "`"$Path`"", '/qn', "TARGETDIR=`"$DestinationPath\SourceDir`"")
-    }
-    $LogPath = "$(Split-Path $Path)\msi.log"
-    if ($Switches) {
-        $ArgList += (-split $Switches)
-    }
-    $Status = Invoke-ExternalCommand $MsiPath $ArgList -LogPath $LogPath
-    if (!$Status) {
-        abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
-    }
-    if ($ExtractDir -and (Test-Path "$DestinationPath\SourceDir")) {
-        movedir "$DestinationPath\SourceDir\$ExtractDir" $OriDestinationPath | Out-Null
-        Remove-Item $DestinationPath -Recurse -Force
-    } elseif ($ExtractDir) {
-        movedir "$DestinationPath\$ExtractDir" $OriDestinationPath | Out-Null
-        Remove-Item $DestinationPath -Recurse -Force
-    } elseif (Test-Path "$DestinationPath\SourceDir") {
-        movedir "$DestinationPath\SourceDir" $DestinationPath | Out-Null
-    }
-    if (($DestinationPath -ne (Split-Path $Path)) -and (Test-Path "$DestinationPath\$(fname $Path)")) {
-        Remove-Item "$DestinationPath\$(fname $Path)" -Force
-    }
-    if (Test-Path $LogPath) {
-        Remove-Item $LogPath -Force
-    }
-    if ($Removal) {
-        # Remove original archive file
-        Remove-Item $Path -Force
+    process {
+        $DestinationPath = $DestinationPath.TrimEnd('\')
+        if ($ExtractDir) {
+            $OriDestinationPath = $DestinationPath
+            $DestinationPath = "$DestinationPath\_tmp"
+        }
+        if ((get_config USE_LESSMSI)) {
+            $MsiPath = Get-HelperPath -Helper Lessmsi
+            $ArgList = @('x', $Path, "$DestinationPath\")
+        } else {
+            $MsiPath = 'msiexec.exe'
+            $ArgList = @('/a', "`"$Path`"", '/qn', "TARGETDIR=`"$DestinationPath\SourceDir`"")
+        }
+        $LogPath = "$(Split-Path $Path)\msi.log"
+        if ($Switches) {
+            $ArgList += (-split $Switches)
+        }
+        $Status = Invoke-ExternalCommand $MsiPath $ArgList -LogPath $LogPath
+        if (!$Status) {
+            abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
+        }
+        if ($ExtractDir -and (Test-Path "$DestinationPath\SourceDir")) {
+            movedir "$DestinationPath\SourceDir\$ExtractDir" $OriDestinationPath | Out-Null
+            Remove-Item $DestinationPath -Recurse -Force
+        } elseif ($ExtractDir) {
+            movedir "$DestinationPath\$ExtractDir" $OriDestinationPath | Out-Null
+            Remove-Item $DestinationPath -Recurse -Force
+        } elseif (Test-Path "$DestinationPath\SourceDir") {
+            movedir "$DestinationPath\SourceDir" $DestinationPath | Out-Null
+        }
+        if (($DestinationPath -ne (Split-Path $Path)) -and (Test-Path "$DestinationPath\$(fname $Path)")) {
+            Remove-Item "$DestinationPath\$(fname $Path)" -Force
+        }
+        if (Test-Path $LogPath) {
+            Remove-Item $LogPath -Force
+        }
+        if ($Removal) {
+            # Remove original archive file
+            Remove-Item $Path -Force
+        }
     }
 }
 
 function Expand-InnoArchive {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
+        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [String]
         $Path,
-        [Parameter(Position = 1)]
+        [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)]
         [String]
         $DestinationPath = (Split-Path $Path),
+        [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)]
         [String]
         $ExtractDir,
         [Parameter(ValueFromRemainingArguments = $true)]
@@ -200,66 +214,74 @@ function Expand-InnoArchive {
         [Switch]
         $Removal
     )
-    $LogPath = "$(Split-Path $Path)\innounp.log"
-    $ArgList = @('-x', "-d$DestinationPath", $Path, '-y')
-    switch -Regex ($ExtractDir) {
-        '^[^{].*' { $ArgList += "-c{app}\$ExtractDir" }
-        '^{.*' { $ArgList += "-c$ExtractDir" }
-        Default { $ArgList += '-c{app}' }
+    begin {
+        $innounpPath = Get-HelperPath -Helper Innounp
     }
-    if ($Switches) {
-        $ArgList += (-split $Switches)
-    }
-    $Status = Invoke-ExternalCommand (Get-HelperPath -Helper Innounp) $ArgList -LogPath $LogPath
-    if (!$Status) {
-        abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
-    }
-    if (Test-Path $LogPath) {
-        Remove-Item $LogPath -Force
-    }
-    if ($Removal) {
-        # Remove original archive file
-        Remove-Item $Path -Force
+    process {
+        $LogPath = "$(Split-Path $Path)\innounp.log"
+        $ArgList = @('-x', "-d$DestinationPath", $Path, '-y')
+        switch -Regex ($ExtractDir) {
+            '^[^{].*' { $ArgList += "-c{app}\$ExtractDir" }
+            '^{.*' { $ArgList += "-c$ExtractDir" }
+            Default { $ArgList += '-c{app}' }
+        }
+        if ($Switches) {
+            $ArgList += (-split $Switches)
+        }
+        $Status = Invoke-ExternalCommand $innounpPath $ArgList -LogPath $LogPath
+        if (!$Status) {
+            abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
+        }
+        if (Test-Path $LogPath) {
+            Remove-Item $LogPath -Force
+        }
+        if ($Removal) {
+            # Remove original archive file
+            Remove-Item $Path -Force
+        }
     }
 }
 
 function Expand-ZipArchive {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
+        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [String]
         $Path,
-        [Parameter(Position = 1)]
+        [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)]
         [String]
         $DestinationPath = (Split-Path $Path),
+        [Parameter(Position = 2, ValueFromPipelineByPropertyName = $true)]
         [String]
         $ExtractDir,
         [Switch]
         $Removal
     )
-    if ($ExtractDir) {
-        $OriDestinationPath = $DestinationPath
-        $DestinationPath = "$DestinationPath\_tmp"
-    }
-    # Compatible with Pscx v3 (https://github.com/Pscx/Pscx) ('Microsoft.PowerShell.Archive' is not needed for Pscx v4)
-    Microsoft.PowerShell.Archive\Expand-Archive -Path $Path -DestinationPath $DestinationPath -Force
-    if ($ExtractDir) {
-        movedir "$DestinationPath\$ExtractDir" $OriDestinationPath | Out-Null
-        Remove-Item $DestinationPath -Recurse -Force
-    }
-    if ($Removal) {
-        # Remove original archive file
-        Remove-Item $Path -Force
+    process {
+        if ($ExtractDir) {
+            $OriDestinationPath = $DestinationPath
+            $DestinationPath = "$DestinationPath\_tmp"
+        }
+        # Compatible with Pscx v3 (https://github.com/Pscx/Pscx) ('Microsoft.PowerShell.Archive' is not needed for Pscx v4)
+        Microsoft.PowerShell.Archive\Expand-Archive -Path $Path -DestinationPath $DestinationPath -Force
+        if ($ExtractDir) {
+            movedir "$DestinationPath\$ExtractDir" $OriDestinationPath | Out-Null
+            Remove-Item $DestinationPath -Recurse -Force
+        }
+        if ($Removal) {
+            # Remove original archive file
+            Remove-Item $Path -Force
+        }
     }
 }
 
 function Expand-DarkArchive {
     [CmdletBinding()]
     param (
-        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true)]
+        [Parameter(Mandatory = $true, Position = 0, ValueFromPipeline = $true, ValueFromPipelineByPropertyName = $true)]
         [String]
         $Path,
-        [Parameter(Position = 1)]
+        [Parameter(Position = 1, ValueFromPipelineByPropertyName = $true)]
         [String]
         $DestinationPath = (Split-Path $Path),
         [Parameter(ValueFromRemainingArguments = $true)]
@@ -268,20 +290,25 @@ function Expand-DarkArchive {
         [Switch]
         $Removal
     )
-    $LogPath = "$(Split-Path $Path)\dark.log"
-    $ArgList = @('-nologo', '-x', $DestinationPath, $Path)
-    if ($Switches) {
-        $ArgList += (-split $Switches)
+    begin {
+        $darkPath = Get-HelperPath -Helper Dark
     }
-    $Status = Invoke-ExternalCommand (Get-HelperPath -Helper Dark) $ArgList -LogPath $LogPath
-    if (!$Status) {
-        abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
-    }
-    if (Test-Path $LogPath) {
-        Remove-Item $LogPath -Force
-    }
-    if ($Removal) {
-        # Remove original archive file
-        Remove-Item $Path -Force
+    process {
+        $LogPath = "$(Split-Path $Path)\dark.log"
+        $ArgList = @('-nologo', '-x', $DestinationPath, $Path)
+        if ($Switches) {
+            $ArgList += (-split $Switches)
+        }
+        $Status = Invoke-ExternalCommand $darkPath $ArgList -LogPath $LogPath
+        if (!$Status) {
+            abort "Failed to extract files from $Path.`nLog file:`n  $(friendly_path $LogPath)`n$(new_issue_msg $app $bucket 'decompress error')"
+        }
+        if (Test-Path $LogPath) {
+            Remove-Item $LogPath -Force
+        }
+        if ($Removal) {
+            # Remove original archive file
+            Remove-Item $Path -Force
+        }
     }
 }