Merge branch 'feature/default-not-marked-as-exists' into develop

Author: moebrowne

README.md

@@ -43,7 +43,7 @@ argExpected['a|A']="argumentName - Argument description"
 argExpected['d|deamon|D']="argumentName - Argument description"
 ```
 
-The `argumentName` part of the definition is the name given to the argument and what should be passed to the `argValue` and `argExists` functions, see below. The argument name is case sensitive and must not contain spaces or an equals sign.
+The `argumentName` part of the definition is the name given to the argument and what should be passed to the `argValue` and `argPassed` functions, see below. The argument name is case sensitive and must not contain spaces or an equals sign.
 
 By default if an argument is passed that hasn't been defined an error will be thrown and the script will exit.
 This feature can be turned off by setting `ARG_MUST_BE_DEFINED` to `false`, note that the argument names will default to the argument its self, without the preceding hyphen(s).
@@ -65,7 +65,8 @@ The default value can also be set to an empty string (`argExpected['e']="argumen
 There is a helper function named `argValue()` which takes the name of 
 an argument as its only parameter and returns the value given to the argument.
 
-If the argument doesn't have a value or hasn't been passed nothing is returned.
+If the argument doesn't have a value or hasn't been passed nothing is returned 
+unless it's been given a default, in which case the default value will be returned.
 
 ```bash
 # -a 'some text'
@@ -100,30 +101,32 @@ esac
 
 ### Check If An Argument Has Been Passed
 
-There is a helper function named `argExists()` which takes the name of 
+There is a helper function named `argPassed` which takes the name of 
 an argument as its only parameter and returns a boolean.
 
+`argPassed` will return false if the argument has fallen back to its default value*
+
 ```bash
 # -v
-if argExists 'v'; then
+if argPassed 'v'; then
 	echo "The -v argument has been passed"
 fi
 
 # -rMd
-argExists 'r' && echo "The -r argument was passed"
+argPassed 'r' && echo "The -r argument was passed"
 
 # --long-argument-name
-if argExists 'long-argument-name'; then
+if argPassed 'long-argument-name'; then
 	# Do something awesome
 fi
 
 # --protocol=HTTP
-if argExists 'protocol'; then
+if argPassed 'protocol'; then
 	# Do something awesome
 fi
 
 # -O 43
-argExists 'O' && echo "Found the -O argument"
+argPassed 'O' && echo "Found the -O argument"
 ```
 
 ## Supported Argument Formats

argument-parser.sh

@@ -12,6 +12,8 @@ regexArgDesc='^.* - (.*)'
 # Initialise some variables
 declare -A argv;
 argv=()
+declare -A argd;
+argd=()
 declare -a argChunks
 argChunks=()
 declare -a parameters
@@ -123,17 +125,30 @@ argUnexpected() {
 	echo "UNEXPECTED ARGUMENT $1"
 }
 
-argExists() {
+argPassed() {
 	if [ -z ${argv["$1"]+abc} ]; then
-		return 1
+		return 1 # false
 	else
-		return 0
+		return 0 # true
+	fi
+}
+
+argHasDefault() {
+	if [ -z ${argd["$1"]+abc} ]; then
+		return 1 # false
+	else
+		return 0 # true
 	fi
 }
 
 argValue() {
-	if argExists "$1"; then
+	if argPassed "$1"; then
 		echo "${argv["$1"]}"
+		exit 0
+	fi
+
+	if argHasDefault "$1"; then
+		echo "${argd["$1"]}"
 	fi
 }
 
@@ -149,7 +164,7 @@ argParseDefaults() {
 		# Get the name of this argument
 		local argumentName="$(argGetName "$arguments")"
 
-		argv["$argumentName"]="${BASH_REMATCH[1]}"
+		argd["$argumentName"]="${BASH_REMATCH[1]}"
 	done
 }
 

tests/default.sh

@@ -19,9 +19,9 @@ source ../argument-parser.sh
 [ "$(argValue "hyphenated-arg")" == "hyphenated" ] && pass || fail
 
 
-argExists "alphaArg" && pass || fail
-argExists "bravoArg" && pass || fail
-argExists "charlieArg" && pass || fail
-argExists "deltaArg" && pass || fail
-argExists "numericArg" && pass || fail
-argExists "hyphenated-arg" && pass || fail
+argPassed "alphaArg" && fail || pass
+argPassed "bravoArg" && fail || pass
+argPassed "charlieArg" && fail || pass
+argPassed "deltaArg" && fail || pass
+argPassed "numericArg" && fail || pass
+argPassed "hyphenated-arg" && fail || pass

tests/simple.sh

@@ -21,10 +21,10 @@ source ../argument-parser.sh
 [ "$(argValue "hyphenated-arg")" == "hyphenated" ] && pass || fail
 
 
-argExists "alphaArg" && pass || fail
-argExists "bravoArg" && pass || fail
-argExists "charlieArg" && pass || fail
-argExists "deltaArg" && pass || fail
-argExists "numericArg" && pass || fail
-argExists "quotedArg" && pass || fail
-argExists "hyphenated-arg" && pass || fail
+argPassed "alphaArg" && pass || fail
+argPassed "bravoArg" && pass || fail
+argPassed "charlieArg" && pass || fail
+argPassed "deltaArg" && pass || fail
+argPassed "numericArg" && pass || fail
+argPassed "quotedArg" && pass || fail
+argPassed "hyphenated-arg" && pass || fail