feat: Add universal manifest helpers (#60)

Ash258 · Dec 5, 2020 · f3b767c · f3b767c
1 parent fbdf67c
commit f3b767c
Show file tree

Hide file tree

Showing 4 changed files with 238 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,8 @@
 
 ### 0.55-pre5
 
+- **manifests**: Introduce manifest helpers to avoid repeating lines in manifests
+    - `Assert-Administrator`, `Assert-WindowsMinimalVersion`, `Assert-ScoopConfigValue`, `Test-Persistence`, `Edit-File`, `Remove-AppDirItem`, `New-JavaShortcutWrapper`
 - **install**
     - Remove mutually exclusivity of `installer.script` and `installer.file`
         - `script` property is executed after `file`

diff --git a/lib/Helpers.ps1 b/lib/Helpers.ps1
@@ -80,6 +80,31 @@ function Write-UserMessage {
     }
 }
 
+function Confirm-DirectoryExistence {
+    <#
+    .SYNOPSIS
+        Make sure that directory exists.
+    .PARAMETER Directory
+        Specifies directory to be tested and created.
+    .OUTPUTS
+        System.Management.Automation.PathInfo
+            Resolved path
+    #>
+    [CmdletBinding()]
+    [OutputType([System.Management.Automation.PathInfo])]
+    param(
+        [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [Alias('Dir', 'Path', 'LiteralPath', 'InputObject')]
+        [String] $Directory
+    )
+
+    process {
+        if (!(Test-Path $Directory -PathType 'Container')) { New-Item $Directory -ItemType 'Directory' | Out-Null }
+
+        return Resolve-Path $Directory
+    }
+}
+
 function Set-TerminatingError {
     <#
     .SYNOPSIS

diff --git a/lib/ManifestHelpers.ps1 b/lib/ManifestHelpers.ps1
@@ -0,0 +1,210 @@
+'Helpers', 'core', 'Versions' | ForEach-Object {
+    . (Join-Path $PSScriptRoot "$_.ps1")
+}
+
+#region Persistence
+function Test-Persistence {
+    <#
+    .SYNOPSIS
+        Persistence check helper for files.
+    .DESCRIPTION
+        This will save some lines to not always write `if (!(Test-Path "$persist_dir\$file")) { New-item "$dir\$file" | Out-Null }` inside manifests.
+        variables `$currentFile`, `$currentFilePersist`, `$currentFileDir` are exposed and could be used inside `Execution` block.
+    .PARAMETER File
+        Specifies the file to be checked.
+        Do not prefix with $dir. All files are already checked against $dir and $persist_dir.
+    .PARAMETER Content
+        Specifies the content/value of the created file.
+        Value should be array of strings or string.
+    .PARAMETER Execution
+        Specifies custom scriptblock to run when file is not persisted.
+        https://github.com/lukesampson/scoop-extras/blob/a84b257fd9636d02295b48c3fd32826487ca9bd3/bucket/ditto.json#L25-L33
+    #>
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [Alias('Path', 'LiteralPath', 'Name', 'InputObject')]
+        [String[]] $File,
+        [Parameter(ValueFromPipelineByPropertyName)]
+        [Alias('Value')]
+        [Object[]] $Content,
+        [Parameter(ValueFromPipelineByPropertyName)]
+        [Alias('ScriptBlock')]
+        [ScriptBlock] $Execution
+    )
+
+    process {
+        for ($ind = 0; $ind -lt $File.Count; ++$ind) {
+            $currentFile = $File[$ind]
+            $currentFileDir = Join-Path $dir $currentFile
+            $currentFilePersist = Join-Path $persist_dir $currentFile
+
+            if (!(Test-Path -LiteralPath $currentFilePersist -PathType 'Leaf')) {
+                if ($Execution) {
+                    & $Execution
+                } else {
+                    # Handle edge case when there is only one file and multiple contents caused by
+                    # If `Test-Persistence alfa.txt @('new', 'beta')` is used,
+                    # Powershell will bind Content as simple array with 2 values instead of Array with nested array with 2 values.
+                    if (($File.Count -eq 1) -and ($Content.Count -gt 1)) {
+                        $cont = $Content
+                    } elseif ($ind -lt $Content.Count) {
+                        $cont = $Content[$ind]
+                    } else {
+                        $cont = $null
+                    }
+
+                    # File needs to be precreated in case of nested directories
+                    New-Item -Path $currentFileDir -ItemType 'File' -Force | Out-Null
+                    if ($cont) { Out-UTF8File -Path $currentFileDir -Value $cont }
+                }
+            }
+        }
+    }
+}
+#endregion Persistence
+
+function Remove-AppDirItem {
+    <#
+    .SYNOPSIS
+        Removes the given item from application directory.
+    .PARAMETER Item
+        Specifies the item, which should be removed from $dir.
+        Wildcards are supported.
+    #>
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, ValueFromPipeline)]
+        [ValidateNotNullOrEmpty()]
+        [SupportsWildcards()]
+        [String[]] $Item
+    )
+
+    process {
+        # GCI is not suitable as it do not support nested folder with include
+        foreach ($it in $Item) {
+            Join-Path $dir $it | Remove-Item -ErrorAction 'SilentlyContinue' -Force -Recurse
+        }
+    }
+}
+
+function Edit-File {
+    <#
+    .SYNOPSIS
+        Finds and replaces text in given file.
+    .PARAMETER File
+        Specifies the file, which will be loaded.
+        File could be passed as full path (used for changing files outside $dir) or just relative path to $dir.
+    .PARAMETER Find
+        Specifies the string to be replaced.
+    .PARAMETER Replace
+        Specifies the string for replacing all occurrences.
+        Empty string is default => Found string will be removed.
+    .PARAMETER Regex
+        Specifies to use regular expression instead of simple match.
+    #>
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, ValueFromPipeline)]
+        [System.IO.FileInfo] $File,
+        [Parameter(Mandatory)]
+        [String[]] $Find,
+        [String[]] $Replace,
+        [Switch] $Regex
+    )
+
+    begin {
+        # Use file from $dir
+        if (Join-Path $dir $File | Test-Path -PathType 'Leaf') { $File = Join-Path $dir $File }
+    }
+
+    process {
+        if (!(Test-Path $File -PathType 'Leaf')) {
+            Write-UserMessage -Message "File '$File' does not exist" -Err
+            return
+        }
+
+        $content = Get-Content $File
+
+        for ($i = 0; $i -lt $Find.Count; ++$i) {
+            $toFind = $Find[$i]
+            if (!$Replace -or ($null -eq $Replace[$i])) {
+                $toReplace = ''
+            } else {
+                $toReplace = $Replace[$i]
+            }
+
+            if ($Regex) {
+                $content = $content -replace $toFind, $toReplace
+            } else {
+                $content = $content.Replace($toFind, $toReplace)
+            }
+        }
+
+        Out-UTF8File -Path $File -Value $content
+    }
+}
+
+function New-JavaShortcutWrapper {
+    <#
+    .SYNOPSIS
+        Creates new shim-like batch file wrapper to spawn jar files within start menu (using shortcut).
+    .PARAMETER FileName
+        Specifies the jar executable filename without .jar extension.
+        Do not pass fullpath, just FILENAME!
+    #>
+    [CmdletBinding()]
+    param(
+        [Parameter(Mandatory, ValueFromPipeline, ValueFromPipelineByPropertyName)]
+        [Alias('Name', 'InputObject')]
+        [System.IO.FileInfo[]] $FileName
+    )
+
+    process {
+        foreach ($f in $FileName) {
+            Join-Path $dir "$f.bat" | Out-UTF8Content -Value "@start javaw.exe -jar `"%~dp0$f.jar`" %*"
+        }
+    }
+}
+
+#region Asserts
+function Assert-Administrator {
+    <#
+    .SYNOPSIS
+        Test administrator privileges.
+    #>
+    if (!(is_admin)) { throw [ScoopException] 'Administrator privileges are required' }
+}
+
+function Assert-WindowsMinimalVersion {
+    <#
+    .SYNOPSIS
+        Test minimal windows version requirement.
+    #>
+    param([String] $Version)
+
+    $cmp = Compare-Version -ReferenceVersion ([Environment]::OSVersion.Version.ToString()) -DifferenceVersion $Version
+    if ($cmp -eq 1) {
+        throw [ScoopException] "Application requires at least '$Version' Windows version"
+    }
+}
+
+function Assert-ScoopConfigValue {
+    <#
+    .SYNOPSIS
+        Test specific value of scoop's configuration.
+    #>
+    param(
+        [Parameter(Mandatory)]
+        [String] $ConfigOption,
+        [Parameter(Mandatory)]
+        $ExpectedValue
+        # TODO: Add parameter to define operator (Where-Object)
+    )
+
+    process {
+        $actualValue = get_config $ConfigOption
+        if ($actualValue -ne $ExpectedValue) { throw [ScoopException] "Configuration option '$ConfigOption' needs to be set to '$ExpectedValue'" }
+    }
+}
+#endregion Asserts
diff --git a/lib/install.ps1 b/lib/install.ps1
@@ -1,4 +1,4 @@
-'Helpers', 'autoupdate', 'buckets', 'decompress', 'manifest' | ForEach-Object {
+'Helpers', 'autoupdate', 'buckets', 'decompress', 'manifest', 'ManifestHelpers' | ForEach-Object {
     . (Join-Path $PSScriptRoot "$_.ps1")
 }