Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Quote tab completion items with PS special chars. #413

Merged
merged 4 commits into from
Feb 14, 2017
Merged

Quote tab completion items with PS special chars. #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4fb926e
Quote tab completion items with PS special chars.
rkeithhill Feb 12, 2017
8440c88
Consistently use the quote special char function.
rkeithhill Feb 13, 2017
32c9a2b
Address most PR review issues.
rkeithhill-keysight Feb 13, 2017
39d559e
Simplify ResetGitTempRepoWorkingDir, plus clean
dahlbyk Feb 14, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions src/GitTabExpansion.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,16 @@ catch {
Write-Debug "Search for 'flow' in 'git help' output failed with error: $_"
}

filter quoteStringWithSpecialChars {
if ($_ -and ($_ -match '\s+|#|@|\$|;|,|''|\{|\}|\(|\)')) {
$str = $_ -replace "'", "''"
"'$str'"
}
else {
$_
}
}

function script:gitCommands($filter, $includeAliases) {
$cmdList = @()
if (-not $global:GitTabSettings.AllCommands) {
Expand Down Expand Up @@ -86,7 +96,8 @@ function script:gitBranches($filter, $includeHEAD = $false, $prefix = '') {

$branches |
Where-Object { $_ -ne '(no branch)' -and $_ -like "$filter*" } |
ForEach-Object { $prefix + $_ }
ForEach-Object { $prefix + $_ } |
quoteStringWithSpecialChars
}

function script:gitRemoteUniqueBranches($filter) {
Expand All @@ -95,45 +106,49 @@ function script:gitRemoteUniqueBranches($filter) {
Group-Object -NoElement |
Where-Object { $_.Count -eq 1 } |
Select-Object -ExpandProperty Name |
Where-Object { $_ -like "$filter*" }
Where-Object { $_ -like "$filter*" } |
quoteStringWithSpecialChars
}

function script:gitTags($filter, $prefix = '') {
git tag |
Where-Object { $_ -like "$filter*" } |
ForEach-Object { $prefix + $_ }
ForEach-Object { $prefix + $_ } |
quoteStringWithSpecialChars
}

function script:gitFeatures($filter, $command){
$featurePrefix = git config --local --get "gitflow.prefix.$command"
$branches = @(git branch --no-color | ForEach-Object { if ($_ -match "^\*?\s*$featurePrefix(?<ref>.*)") { $matches['ref'] } })
$branches |
Where-Object { $_ -ne '(no branch)' -and $_ -like "$filter*" } |
ForEach-Object { $prefix + $_ }
ForEach-Object { $prefix + $_ } |
quoteStringWithSpecialChars
}

function script:gitRemoteBranches($remote, $ref, $filter, $prefix = '') {
git branch --no-color -r |
Where-Object { $_ -like " $remote/$filter*" } |
ForEach-Object { $prefix + $ref + ($_ -replace " $remote/","") }
ForEach-Object { $prefix + $ref + ($_ -replace " $remote/","") } |
quoteStringWithSpecialChars
}

function script:gitStashes($filter) {
(git stash list) -replace ':.*','' |
Where-Object { $_ -like "$filter*" } |
ForEach-Object { "'$_'" }
quoteStringWithSpecialChars
}

function script:gitTfsShelvesets($filter) {
(git tfs shelve-list) |
Where-Object { $_ -like "$filter*" } |
ForEach-Object { "'$_'" }
quoteStringWithSpecialChars
}

function script:gitFiles($filter, $files) {
$files | Sort-Object |
Where-Object { $_ -like "$filter*" } |
ForEach-Object { if ($_ -like '* *') { "'$_'" } else { $_ } }
quoteStringWithSpecialChars
}

function script:gitIndex($GitStatus, $filter) {
Expand Down
22 changes: 22 additions & 0 deletions test/Shared.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,28 @@ function MakeGitPath([string]$Path) {
$Path -replace '\\', '/'
}

function NewGitTempRepo {
Push-Location
$temp = [System.IO.Path]::GetTempPath()
$repoPath = Join-Path $temp ([IO.Path]::GetRandomFileName())
git.exe init $repoPath *>$null
Set-Location $repoPath
$repoPath
}

function RemoveGitTempRepo($RepoPath) {
Pop-Location
if (Test-Path $repoPath) {
Remove-Item $repoPath -Recurse -Force
}
}

function ResetGitTempRepoWorkingDir($RepoPath, $Branch = 'master') {
Set-Location $repoPath
git.exe checkout -fq $Branch 2>$null
git.exe clean -xdfq 2>$null
}

# Force the posh-git prompt to be installed. Could be runnng on dev system where
# user has customized the prompt.
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssigments', '')]
Expand Down
73 changes: 58 additions & 15 deletions test/TabExpansion.Tests.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,33 +120,76 @@ Describe 'TabExpansion Tests' {
}
}
}

Context 'Add/Reset/Checkout TabExpansion Tests' {
BeforeEach {
[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssigments', '')]
$origPath = Get-Location
$temp = [System.IO.Path]::GetTempPath()
$repoPath = Join-Path $temp ([IO.Path]::GetRandomFileName())

git init $repoPath
Set-Location $repoPath
$repoPath = NewGitTempRepo
}
AfterEach {
Set-Location $origPath
if (Test-Path $repoPath) {
Remove-Item $repoPath -Recurse -Force
}
RemoveGitTempRepo $repoPath
}
It 'Tab completes non-ASCII file name' {
git config core.quotepath true # Problematic (default) config
git.exe config core.quotepath true # Problematic (default) config

$fileName = "posh$([char]8226)git.txt"
New-Item $fileName
New-Item $fileName -ItemType File

$GitStatus = & $module Get-GitStatus

$result = & $module GitTabExpansionInternal 'git add ' $GitStatus
$gitStatus = & $module Get-GitStatus

$result = & $module GitTabExpansionInternal 'git add ' $gitStatus
$result | Should BeExactly $fileName
}
}

Context 'PowerShell Special Chars Tests' {
BeforeAll {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is bound to be a pretty common pattern. Is it possible to write a Pester helper that would encapsulate a BeforeAll/AfterAll pairing that initializes and cleans up a Git repo, with its path left in $repoPath? Something like:

Context 'Awesome test' {
    TempRepo {
        # Set up the repo
    }
    It 'Uses $repoPath' {
        # ...
    }
}

[System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssigments', '')]
$repoPath = NewGitTempRepo

'readme' | Out-File .\README.md -Encoding ascii
git.exe add .\README.md
git.exe commit -m "initial commit."
}
AfterAll {
RemoveGitTempRepo $repoPath
}
AfterEach {
ResetGitTempRepoWorkingDir $repoPath
}
It 'Tab completes branch name with special char as quoted' {
git.exe branch '#develop' 2>$null

$result = & $module GitTabExpansionInternal 'git checkout #'
$result | Should BeExactly "'#develop'"
}
It 'Tab completes git feature branch name with special char as quoted' {
git.exe branch '#develop' 2>$null

$result = & $module GitTabExpansionInternal 'git flow feature list #'
$result | Should BeExactly "'#develop'"
}
It 'Tab completes a tag name with special char as quoted' {
$tag = "v1.0.0;abcdef"
git.exe tag $tag

$result = & $module GitTabExpansionInternal 'git show v1'
$result | Should BeExactly "'$tag'"
}
It 'Tab completes a tag name with single quote correctly' {
git.exe tag "v2.0.0'"

$result = & $module GitTabExpansionInternal 'git show v2'
$result | Should BeExactly "'v2.0.0'''"
}
It 'Tab completes add file in working dir with special char as quoted' {
$filename = 'foo{bar} (x86).txt';
New-Item $filename -ItemType File

$gitStatus = & $module Get-GitStatus

$result = & $module GitTabExpansionInternal 'git add ' $gitStatus
$result | Should BeExactly "'$filename'"
}
}
}