# [PATCH 2/2] completion: simplify query for config variables 4 messages from 2015-05-10 to 2015-05-12. Participants: SZEDER Gábor, Junio C Hamano. Thread: https://gitlist.dev/t/39289 ## SZEDER Gábor, 2015-05-10 12:50 Subject: [PATCH 1/2] completion: add a helper function to get config variables Message-ID: <1431262218-7304-1-git-send-email-szeder@ira.uka.de> URL: https://gitlist.dev/e/1431262218-7304-1-git-send-email-szeder%40ira.uka.de ``` Currently there are a few completion functions that perform similar 'git config' queries and filtering to get config variable names: the completion of pretty aliases, aliases, and remote groups for 'git remote update'. Unify those 'git config' queries in a helper function to eliminate code duplication. Though the helper functions to get pretty aliases and alieses are reduced to mere one-liner wrappers around the newly added function, keep these helpers still, because users' completion functions out there might depend on them. And they keep their callers a tad easier to read, too. Add tests for the pretty alias and alias helper to show that they work as before; not for the remote groups query, though, because that's not extracted into a helper function and it's not worth the effort to do so for a sole callsite. Signed-off-by: SZEDER Gábor --- contrib/completion/git-completion.bash | 34 ++++++++++++++-------------------- t/t9902-completion.sh | 22 ++++++++++++++++++++++ 2 files changed, 36 insertions(+), 20 deletions(-) diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash index 5944c824ab..6973620857 100644 --- a/contrib/completion/git-completion.bash +++ b/contrib/completion/git-completion.bash @@ -740,30 +740,29 @@ __git_compute_porcelain_commands () __git_porcelain_commands=$(__git_list_porcelain_commands) } -__git_pretty_aliases () +# Lists all set config variables starting with the given section prefix, +# with the prefix removed. +__git_get_config_variables () { - local i IFS=$'\n' - for i in $(git --git-dir="$(__gitdir)" config --get-regexp "pretty\..*" 2>/dev/null); do + local section="$1" i IFS=$'\n' + for i in $(git --git-dir="$(__gitdir)" config --get-regexp "$section\..*" 2>/dev/null); do case "$i" in - pretty.*) - i="${i#pretty.}" + $section.*) + i="${i#$section.}" echo "${i/ */}" ;; esac done } +__git_pretty_aliases () +{ + __git_get_config_variables "pretty" +} + __git_aliases () { - local i IFS=$'\n' - for i in $(git --git-dir="$(__gitdir)" config --get-regexp "alias\..*" 2>/dev/null); do - case "$i" in - alias.*) - i="${i#alias.}" - echo "${i/ */}" - ;; - esac - done + __git_get_config_variables "alias" } # __git_aliased_command requires 1 argument @@ -2260,12 +2259,7 @@ _git_remote () __git_complete_remote_or_refspec ;; update) - local i c='' IFS=$'\n' - for i in $(git --git-dir="$(__gitdir)" config --get-regexp "remotes\..*" 2>/dev/null); do - i="${i#remotes.}" - c="$c ${i/ */}" - done - __gitcomp "$c" + __gitcomp "$(__git_get_config_variables "remotes")" ;; *) ;; diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh index 4a14a5892e..07f2478c9b 100755 --- a/t/t9902-completion.sh +++ b/t/t9902-completion.sh @@ -370,6 +370,28 @@ test_expect_success '__git_remotes - list remotes from $GIT_DIR/remotes and from test_cmp expect actual ' +test_expect_success '__git_pretty_aliases' ' + cat >expect <<-EOF && + author + hash + EOF + test_config pretty.author "%an %ae" && + test_config pretty.hash %H && + __git_pretty_aliases >actual && + test_cmp expect actual +' + +test_expect_success '__git_aliases' ' + cat >expect <<-EOF && + ci + co + EOF + test_config alias.ci commit && + test_config alias.co checkout && + __git_aliases >actual && + test_cmp expect actual +' + test_expect_success 'basic' ' run_completion "git " && # built-in -- 1.9.5.msysgit.0 ``` ## SZEDER Gábor, 2015-05-10 12:50 Subject: [PATCH 2/2] completion: simplify query for config variables Message-ID: <1431262218-7304-2-git-send-email-szeder@ira.uka.de> URL: https://gitlist.dev/e/1431262218-7304-2-git-send-email-szeder%40ira.uka.de In-Reply-To: <1431262218-7304-1-git-send-email-szeder@ira.uka.de> ``` To get the name of all config variables in a given section we perform a 'git config --get-regex' query for all config variables containing the name of that section, and then filter its output through a case statement to throw away those that though contain but don't start with the given section. Modify the regex to match only at the beginning, so the case statement becomes unnecessary and we can get rid of it. Add a test to check that a match in the middle doesn't fool us. Signed-off-by: SZEDER Gábor --- contrib/completion/git-completion.bash | 10 +++------- t/t9902-completion.sh | 12 ++++++++++++ 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/contrib/completion/git-completion.bash b/contrib/completion/git-completion.bash index 6973620857..63f960b33d 100644 --- a/contrib/completion/git-completion.bash +++ b/contrib/completion/git-completion.bash @@ -745,13 +745,9 @@ __git_compute_porcelain_commands () __git_get_config_variables () { local section="$1" i IFS=$'\n' - for i in $(git --git-dir="$(__gitdir)" config --get-regexp "$section\..*" 2>/dev/null); do - case "$i" in - $section.*) - i="${i#$section.}" - echo "${i/ */}" - ;; - esac + for i in $(git --git-dir="$(__gitdir)" config --get-regexp "^$section\..*" 2>/dev/null); do + i="${i#$section.}" + echo "${i/ */}" done } diff --git a/t/t9902-completion.sh b/t/t9902-completion.sh index 07f2478c9b..2ba62fbc17 100755 --- a/t/t9902-completion.sh +++ b/t/t9902-completion.sh @@ -370,6 +370,18 @@ test_expect_success '__git_remotes - list remotes from $GIT_DIR/remotes and from test_cmp expect actual ' +test_expect_success '__git_get_config_variables' ' + cat >expect <<-EOF && + name-1 + name-2 + EOF + test_config interesting.name-1 good && + test_config interesting.name-2 good && + test_config subsection.interesting.name-3 bad && + __git_get_config_variables interesting >actual && + test_cmp expect actual +' + test_expect_success '__git_pretty_aliases' ' cat >expect <<-EOF && author -- 1.9.5.msysgit.0 ``` ## SZEDER Gábor, 2015-05-10 13:16 Subject: Re: [PATCH 1/2] completion: add a helper function to get config variables Message-ID: <20150510151652.Horde.FOfYcnwZZkdBJUYkl0pDQg1@webmail.informatik.kit.edu> URL: https://gitlist.dev/e/20150510151652.Horde.FOfYcnwZZkdBJUYkl0pDQg1%40webmail.informatik.kit.edu In-Reply-To: <1431262218-7304-1-git-send-email-szeder@ira.uka.de> ``` Quoting SZEDER Gábor : > Currently there are a few completion functions that perform similar 'git > config' queries and filtering to get config variable names: the completion > of pretty aliases, aliases, and remote groups for 'git remote update'. > > Unify those 'git config' queries in a helper function to eliminate code > duplication. > > Though the helper functions to get pretty aliases and alieses are reduced > to mere one-liner wrappers around the newly added function, keep these > helpers still, because users' completion functions out there might depend > on them. And they keep their callers a tad easier to read, too. > > Add tests for the pretty alias and alias helper to show that they work > as before; not for the remote groups query, though, because that's not > extracted into a helper function and it's not worth the effort to do so > for a sole callsite. > > Signed-off-by: SZEDER Gábor > --- > @@ -2260,12 +2259,7 @@ _git_remote () > __git_complete_remote_or_refspec > ;; > update) > - local i c='' IFS=$'\n' > - for i in $(git --git-dir="$(__gitdir)" config --get-regexp > "remotes\..*" 2>/dev/null); do > - i="${i#remotes.}" > - c="$c ${i/ */}" > - done > - __gitcomp "$c" > + __gitcomp "$(__git_get_config_variables "remotes")" I just noticed that this query for remote groups does lack that filtering case statement eliminated in the next patch and the regex is not limited to the beginning of the config variable name. So, let's suppose we have a branch named 'remotes', for which we add a branch description (and no remote groups, for symplicity's sake): $ git config branch.remotes.description uh-oh $ git remote update This will complete to: $ git remote update branch.remotes.description and that's obviously bad. This series fixes this. Best, Gábor ``` ## Junio C Hamano, 2015-05-12 22:14 Subject: Re: [PATCH 1/2] completion: add a helper function to get config variables Message-ID: URL: https://gitlist.dev/e/xmqqa8x9e93w.fsf%40gitster.dls.corp.google.com In-Reply-To: <1431262218-7304-1-git-send-email-szeder@ira.uka.de> ``` SZEDER Gábor writes: > + for i in $(git --git-dir="$(__gitdir)" config --get-regexp "$section\..*" 2>/dev/null); do > case "$i" in > - pretty.*) > - i="${i#pretty.}" > + $section.*) > + i="${i#$section.}" The case arm treats $section as a shell glob, --get-regexp treats it as a regex fragment and then the shell expansion uses it as a literal. The current set of callers give simple single-token like pretty, remote, etc. to it so this is safe, but you may want to give a comment to the function to help future generation, perhaps? Other than that, looks quite straight-forward. Thanks. ```