V8.00.000.2025.06.17

Signed-off-by: Marc S. Weidner <msw@coresecret.dev>

lib/cdi_0005_guard/0008_guard_variable.sh

@@ -13,14 +13,120 @@
 guard_sourcing
 
 #######################################
-# Ensures the value of the provided VAR is always lowercase.
-# Use: ensure_lowercase VAR
+# Converts the value of a passed variable to lowercase.
+# Example:
+#   ensure_lowercase "VAR"
 # Arguments:
 #   1: VARIABLE name only
+# Returns:
+#   0: on success
+#   ERR_UNBOUND_VARIABLE
 #######################################
 ensure_lowercase() {
-  declare -r name="${1}"
+  declare -r name="$1"
+  if ! declare -p "${name}" &>/dev/null; then
+    do_log "emergency" "file_only" "0008() Unbound variable: [${name}]."
+    return "${ERR_UNBOUND_VARIABLE}"
+  fi
   declare -n ref="${name}"
   ref="${ref,,}"
+  return 0
+}
+
+#######################################
+# Converts the value of a passed variable to uppercase.
+# Example:
+#   ensure_uppercase "VAR"
+# Arguments:
+#   1: VARIABLE name only
+# Returns:
+#   0: on success
+#   ERR_UNBOUND_VARIABLE
+#######################################
+ensure_uppercase() {
+  declare -r name="$1"
+  if ! declare -p "${name}" &>/dev/null; then
+    do_log "emergency" "file_only" "0008() Unbound variable: [${name}]."
+    return "${ERR_UNBOUND_VARIABLE}"
+  fi
+  declare -n ref="${name}"
+  ref="${ref^^}"
+  return 0
+}
+
+#######################################
+# Removes leading and trailing spaces in the value.
+# Example:
+#   ensure_trimmed "VAR"
+# Arguments:
+#   1: VARIABLE name only
+# Returns:
+#   0: on success
+#   ERR_UNBOUND_VARIABLE
+#######################################
+ensure_trimmed() {
+  declare -r name="$1"
+  if ! declare -p "${name}" &>/dev/null; then
+    do_log "emergency" "file_only" "0008() Unbound variable: [${name}]."
+    return "${ERR_UNBOUND_VARIABLE}"
+  fi
+  declare -n ref="${name}"
+  ref="${ref#"${ref%%[![:space:]]*}"}"
+  ref="${ref%"${ref##*[![:space:]]}"}"
+  return 0
+}
+
+#######################################
+# Resets the value of the variable to a default value if it is empty or contains only whitespace.
+# Example:
+#   reset_to_default "VAR" "fallback"
+# Arguments:
+#   1: VARIABLE name only
+#   2: Fallback value
+# Returns:
+#   0: on success
+#   ERR_UNBOUND_VARIABLE
+#######################################
+reset_to_default() {
+  declare -r name="$1"
+  declare -r fallback="$2"
+  if ! declare -p "${name}" &>/dev/null; then
+    do_log "emergency" "file_only" "0008() Unbound variable: [${name}]."
+    return "${ERR_UNBOUND_VARIABLE}"
+  fi
+  declare -n ref="${name}"
+  declare    trimmed="${ref#"${ref%%[![:space:]]*}"}"
+  trimmed="${trimmed%"${trimmed##*[![:space:]]}"}"
+  if [[ -z "${trimmed}" ]]; then
+    ref="${fallback}"
+  fi
+  return 0
+}
+
+#######################################
+# Checks whether the content of a variable matches a specific regex.
+# Example:
+#   assert_match "FOO" '^[a-z0-9_-]+$'
+# Arguments:
+#   1: VARIABLE name only
+#   2: Regex in 'single quotes'
+# Returns:
+#   0: on success
+#   ERR_UNBOUND_VARIABLE
+#   ERR_VAR_REGEX_CHK
+#######################################
+assert_match() {
+  declare -r name="$1"
+  declare -r pattern="$2"
+  if ! declare -p "${name}" &>/dev/null; then
+    do_log "emergency" "file_only" "0008() Unbound variable: [${name}]."
+    return "${ERR_UNBOUND_VARIABLE}"
+  fi
+  declare -n ref="${name}"
+  if ! [[ "${ref}" =~ ${pattern} ]]; then
+    do_log "emergency" "file_only" "0008() Variable: [${name}] not matching Regex: [${pattern}]: [${ref}]."
+    return "${ERR_VAR_REGEX_CHK}"
+  fi
+  return 0
 }
 # vim: number et ts=2 sw=2 sts=2 ai tw=128 ft=sh