zsh-workers
 help / color / mirror / code / Atom feed
From: doron.behar@gmail.com
To: zsh-workers@zsh.org
Subject: [PATCH 10/25] Write all simple sub commands completions.
Date: Sat, 26 May 2018 18:06:19 +0300	[thread overview]
Message-ID: <20180526150634.15683-11-doron.behar@gmail.com> (raw)
In-Reply-To: <20180526150634.15683-1-doron.behar@gmail.com>

From: Doron Behar <doron.behar@gmail.com>

Most importantly, write (using `_cache_` functions) helpers that
complete installed rocks with their descriptions generated with
`luarocks show <>`.
---
 Completion/Unix/Command/_luarocks | 125 ++++++++++++++++++++++++++++--
 1 file changed, 119 insertions(+), 6 deletions(-)

diff --git a/Completion/Unix/Command/_luarocks b/Completion/Unix/Command/_luarocks
index de296a084..4f3271360 100644
--- a/Completion/Unix/Command/_luarocks
+++ b/Completion/Unix/Command/_luarocks
@@ -59,20 +59,102 @@ __luarocks_lua_version(){
 	_values -s , 
 }
 # }}}
-# {{{ helper: rockspec file / rockpack (.src.rock file) / external according to demand
+# {{{ helper: installed rocks cache policy
+___luarocks_installed_rocks_cache_policy(){
+	# the number of seconds since 1970-01-01 the manifest file was modified
+	local manifest_last_date_modified="$(date -r ~/.luarocks/lib/luarocks/rocks-5.3/manifest +%s 2>/dev/null)"
+	# the number of seconds since 1970-01-01 the cache file was modified
+	local cache_last_date_modified="$(date -r $1 +%s 2>/dev/null)"
+	if [[ ! -z ${cache_last_date_modified} && ! -z ${manifest_last_date_modified} ]]; then
+		# if the manifest file is newer then the cache:
+		if [ ${manifest_last_date_modified} -ge ${cache_last_date_modified} ]; then
+			(( 1 ))
+		else
+			(( 0 ))
+		fi
+	fi
+}
+# }}}
+# {{{ helper: installed rocks
+__luarocks_installed_rocks(){
+	local update_policy ret=1
+	zstyle -s ":completion:${curcontext}:" cache-policy update_policy
+	if [[ -z "$update_policy" ]]; then
+		zstyle ":completion:${curcontext}:" cache-policy ___luarocks_installed_rocks_cache_policy
+	fi
+	if _cache_invalid luarocks_installed_list; then
+		rocks_list=($(luarocks list --porcelain))
+		_store_cache luarocks_installed_list rocks_list
+	else
+		_retrieve_cache luarocks_installed_list
+	fi
+	if _cache_invalid luarocks_installed_names; then
+		rocks_names=()
+		for i in {1.."${#rocks_list[@]}"..4}; do
+			rocks_names+=("${rocks_list[$i]}")
+		done
+		_store_cache luarocks_installed_names rocks_names
+	else
+		_retrieve_cache luarocks_installed_names
+	fi
+	if _cache_invalid luarocks_installed_versions; then
+		rocks_versions=()
+		for i in {2.."${#rocks_list[@]}"..4}; do
+			rocks_versions+=("${rocks_list[$i]}")
+		done
+		_store_cache luarocks_installed_versions rocks_versions
+	else
+		_retrieve_cache luarocks_installed_versions
+	fi
+	if _cache_invalid luarocks_installed_descriptions; then
+		rocks_descriptions=()
+		for i in {1.."${#rocks_names[@]}"}; do
+			name_version_description="$(luarocks show ${rocks_names[$i]} | head -2 | tail -1)"
+			total_length=${#name_version_description}
+			garbage_length="$((${#rocks_names[$i]} + ${#rocks_versions[$i]} + 5))"
+			description="${name_version_description[${garbage_length},${total_length}]}"
+			rocks_descriptions+=("${description}")
+		done
+		_store_cache luarocks_installed_descriptions rocks_descriptions
+	else
+		_retrieve_cache luarocks_installed_descriptions
+	fi
+	if _cache_invalid luarocks_installed_names_and_descriptions; then
+		rocks_names_and_descriptions=()
+		for i in {1.."${#rocks_names[@]}"}; do
+			name_and_description=${rocks_names[$i]}:${rocks_descriptions[$i]}
+			rocks_names_and_descriptions+=(${name_and_description})
+		done
+	else
+		_store_cache luarocks_installed_names_and_descriptions rocks_names_and_descriptions
+	fi
+	_describe 'installed rocks' rocks_names_and_descriptions
+}
+# }}}
+# {{{ helper: rocks wrapper
+# Used to complete one or more of the followings:
+# - .rockspec file
+# - .src.rock file
+# - external rock
 __luarocks_rock(){
-	local -a arguments=()
+	local -a alts=()
 	for arg in "$@"; do
 		case $arg in
-			(file)
-				arguments+=(':rock file:{_files -g "*.rockspec"}')
+			(rockspec)
+				alts+=(':rock file:{_files -g "*.rockspec"}')
+				;;
+			(rockpack)
+				alts+=(':rock file:{_files -g "*.src.rock"}')
 				;;
 			(external)
-				arguments+=(':external rock:')
+				alts+=(':external rock:')
+				;;
+			(installed)
+				alts+=(':local rock:__luarocks_installed_rocks')
 				;;
 		esac
 	done
-	_alternative ${arguments[@]}
+	_alternative ${alts[@]}
 }
 # }}}
 
@@ -91,6 +173,10 @@ local build_command_options=(
 	$option_deps_mode
 )
 _luarocks_build(){
+	_arguments -A "-*" \
+		"${build_command_options[@]}" \
+		'1: :{__luarocks_rock "rockspec" "external"}' \
+		'2:: :__luarocks_rock_version'
 }
 # }}}
 # {{{ `config` command
@@ -127,12 +213,17 @@ local download_command_options=(
 	'--arch=[Download rock for a specific architecture]:ARCH:'
 )
 _luarocks_download(){
+	_arguments -A "-*" \
+		"${download_command_options[@]}" \
+		'1: :{__luarocks_rock "external"}' \
+		'2:: :__luarocks_rock_version'
 }
 # }}}
 # {{{ `help` command
 # arguments:
 # must: luarocks sub command
 _luarocks_help(){
+	_arguments '1: :__luarocks_command'
 }
 # }}}
 # {{{ `install` command
@@ -141,12 +232,14 @@ _luarocks_help(){
 # - optional: version
 # NOTE: it receives the same argument as the build command and it accepts the same options as well
 _luarocks_install(){
+	_luarocks_build
 }
 # }}}
 # {{{ `lint` command
 # arguments:
 # must: rockspec file (first and last)
 _luarocks_lint(){
+	_arguments '1:ROCKSPEC_FILE:{__luarocks_rock "rockspec"}'
 }
 # }}}
 # {{{ `list` command
@@ -156,6 +249,7 @@ local list_command_options=(
 	'--porcelain[Produce machine-friendly output]'
 )
 _luarocks_list(){
+	_arguments "${list_command_options[@]}"
 }
 # }}}
 # {{{ `make` command
@@ -163,6 +257,7 @@ _luarocks_list(){
 # - optional: rockspec file
 # NOTE: it's options were already described above.
 _luarocks_make(){
+	_arguments '1:: :{__luarocks_rock "rockspec"}'
 }
 # }}}
 # {{{ `new_version` command
@@ -181,6 +276,7 @@ _luarocks_new_version(){
 # - must: .rockspec file / external rock
 # - optional: version
 _luarocks_pack(){
+	_luarocks_build
 }
 # }}}
 # {{{ `path` command
@@ -193,6 +289,7 @@ local path_command_options=(
 	'--lr-bin[Exports the system path (not formatted as shell command)]'
 )
 _luarocks_path(){
+	_arguments "${path_command_options[@]}"
 }
 # }}}
 # {{{ `purge` command
@@ -217,6 +314,10 @@ local remove_command_options=(
 	$option_force_fast
 )
 _luarocks_remove(){
+	_arguments -A "-*" \
+		"${remove_command_options[@]}" \
+		'1: :{__luarocks_rock "installed"}' \
+		'2:: :__luarocks_rock_version'
 }
 # }}}
 # {{{ `search` command
@@ -228,6 +329,9 @@ local search_command_options=(
 	'--all[List all contents of the server that are suitable to this platform, do not filter by name]'
 )
 _luarocks_search(){
+	_arguments \
+		"${search_command_options[@]}" \
+		'*:SEARCH QUERY:'
 }
 # }}}
 # {{{ `show` command
@@ -243,6 +347,9 @@ local show_command_options=(
 	'--rock-dir[data directory of the installed rock]'
 )
 _luarocks_show(){
+	_arguments \
+		"${show_command_options[@]}" \
+		'1: :{__luarocks_rock "installed"}'
 }
 # }}}
 # {{{ `unpack` command
@@ -253,6 +360,9 @@ local unpack_command_options=(
 	'--force[Unpack files even if the output directory already exists]'
 )
 _luarocks_unpack(){
+	_arguments \
+		"${unpack_command_options[@]}" \
+		'1: :{__luarocks_rock "rockpack" "external"}'
 }
 # }}}
 # {{{ `upload` command
@@ -264,6 +374,9 @@ local upload_command_options=(
 	'--force[Replace existing rockspec if the same revision of a module already exists]'
 )
 _luarocks_upload(){
+	_arguments \
+		"${upload_command_options[@]}" \
+		'1: :{__luarocks_rock "rockspec"}'
 }
 # }}}
 # {{{ `write_rockspec` command
-- 
2.17.0


  parent reply	other threads:[~2018-05-26 15:07 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-05-26 15:06 [PATCH 00/25] *** Add completion for luarocks *** doron.behar
2018-05-26 15:06 ` [PATCH 01/25] Add variables for all commands and options doron.behar
2018-05-26 15:06 ` [PATCH 02/25] Remove architecture related option completion doron.behar
2018-05-26 15:06 ` [PATCH 03/25] Add marker style comments doron.behar
2018-05-26 15:06 ` [PATCH 04/25] Remove variables and use their contents directly doron.behar
2018-05-26 15:06 ` [PATCH 05/25] Add curcontext case for every subcommand doron.behar
2018-05-26 15:06 ` [PATCH 06/25] Use better naming scheme for common helpers doron.behar
2018-05-26 15:06 ` [PATCH 07/25] Write better sub commands comments doron.behar
2018-05-26 15:06 ` [PATCH 08/25] Add helpers section doron.behar
2018-05-26 15:06 ` [PATCH 09/25] Make *all* helpers functions begin with __luarocks doron.behar
2018-05-26 15:06 ` doron.behar [this message]
2018-05-26 15:06 ` [PATCH 11/25] General internal conventions sync doron.behar
2018-05-26 15:06 ` [PATCH 12/25] Finish helper `__luarocks_lua_versions` doron.behar
2018-05-26 15:06 ` [PATCH 13/25] General cleanup doron.behar
2018-05-26 15:06 ` [PATCH 14/25] Finish `_luarocks_doc` and `_luarocks_config` doron.behar
2018-05-26 15:06 ` [PATCH 15/25] Expand __luarocks_rock_version so it accpets args doron.behar
2018-05-26 15:06 ` [PATCH 16/25] Finish completions for purge and new_version doron.behar
2018-05-26 15:06 ` [PATCH 17/25] Write a better comment for last TODO doron.behar
2018-05-26 15:06 ` [PATCH 18/25] Make cache policy function safer doron.behar
2018-05-26 15:06 ` [PATCH 19/25] Fix git tag completion by autoloading _git doron.behar
2018-05-26 15:06 ` [PATCH 20/25] Use a generic sub command completer doron.behar
2018-05-26 15:06 ` [PATCH 21/25] Use 2 spaces instead of tabs doron.behar
2018-05-26 15:06 ` [PATCH 22/25] Use +functions[] for all helpers doron.behar
2018-05-26 15:06 ` [PATCH 23/25] Improve `___luarocks_installed_rocks_cache_policy` doron.behar
2018-05-26 15:06 ` [PATCH 24/25] Consider `--tree` when searching installed rocks doron.behar
2018-05-26 15:06 ` [PATCH 25/25] Consider `--tree` in versions completion doron.behar
2018-05-26 15:37 ` [PATCH 00/25] *** Add completion for luarocks *** Eitan Adler
2018-05-26 16:09   ` Doron Behar

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20180526150634.15683-11-doron.behar@gmail.com \
    --to=doron.behar@gmail.com \
    --cc=zsh-workers@zsh.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/zsh/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).