From a701b425199fd6547919b0882288cde36f2d71ba Mon Sep 17 00:00:00 2001
From: Maniack Crudelis <maniackcrudelis@users.noreply.github.com>
Date: Fri, 21 Dec 2018 20:40:02 +0100
Subject: [PATCH]  Use getopts for network's helpers

---
 data/helpers.d/network | 66 +++++++++++++++++++++++++++---------------
 1 file changed, 43 insertions(+), 23 deletions(-)

diff --git a/data/helpers.d/network b/data/helpers.d/network
index f9e37e6cc..fc7eb3f69 100644
--- a/data/helpers.d/network
+++ b/data/helpers.d/network
@@ -8,10 +8,15 @@
 #          ynh_normalize_url_path /example/ -> /example
 #          ynh_normalize_url_path / -> /
 #
-# usage: ynh_normalize_url_path path_to_normalize
-# | arg: url_path_to_normalize - URL path to normalize before using it
+# usage: ynh_normalize_url_path --path_url=path_to_normalize
+# | arg: -p, --path_url - URL path to normalize before using it
 ynh_normalize_url_path () {
-	local path_url=$1
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [p]=path_url= )
+	local path_url
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing."
 	if [ "${path_url:0:1}" != "/" ]; then    # If the first character is not a /
 		path_url="/$path_url"    # Add / at begin of path variable
@@ -24,12 +29,17 @@ ynh_normalize_url_path () {
 
 # Find a free port and return it
 #
-# example: port=$(ynh_find_port 8080)
+# example: port=$(ynh_find_port --port=8080)
 #
-# usage: ynh_find_port begin_port
-# | arg: begin_port - port to start to search
+# usage: ynh_find_port --port=begin_port
+# | arg: -p, --port - port to start to search
 ynh_find_port () {
-	local port=$1
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [p]=port= )
+	local port
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port."
 	while netcat -z 127.0.0.1 $port       # Check if the port is free
 	do
@@ -40,28 +50,38 @@ ynh_find_port () {
 
 # Check availability of a web path
 #
-# example: ynh_webpath_available some.domain.tld /coffee
+# example: ynh_webpath_available --domain=some.domain.tld --path_url=/coffee
 #
-# usage: ynh_webpath_available domain path
-# | arg: domain - the domain/host of the url
-# | arg: path - the web path to check the availability of
+# usage: ynh_webpath_available --domain=domain --path_url=path
+# | arg: -d, --domain - the domain/host of the url
+# | arg: -p, --path_url - the web path to check the availability of
 ynh_webpath_available () {
-	local domain=$1
-	local path=$2
-	sudo yunohost domain url-available $domain $path
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [d]=domain= [p]=path_url= )
+	local domain
+	local path_url
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	sudo yunohost domain url-available $domain $path_url
 }
 
 # Register/book a web path for an app
 #
-# example: ynh_webpath_register wordpress some.domain.tld /coffee
+# example: ynh_webpath_register --app=wordpress --domain=some.domain.tld --path_url=/coffee
 #
-# usage: ynh_webpath_register app domain path
-# | arg: app - the app for which the domain should be registered
-# | arg: domain - the domain/host of the web path
-# | arg: path - the web path to be registered
+# usage: ynh_webpath_register --app=app --domain=domain --path_url=path
+# | arg: -a, --app - the app for which the domain should be registered
+# | arg: -d, --domain - the domain/host of the web path
+# | arg: -p, --path_url - the web path to be registered
 ynh_webpath_register () {
-	local app=$1
-	local domain=$2
-	local path=$3
-	sudo yunohost app register-url $app $domain $path
+	# Declare an array to define the options of this helper.
+	declare -Ar args_array=( [a]=app= [d]=domain= [p]=path_url= )
+	local app
+	local domain
+	local path_url
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	sudo yunohost app register-url $app $domain $path_url
 }