✨ added string::join

Author: jcaillon

libraries.d/lib-string

@@ -661,7 +661,7 @@ function string::getFormattedHeader() {
 
   if ((availableSpaceForLeft - leftPartLength >= 0)); then
     if ((middlePartLength > 0)); then
-      padding="${spaces:0:availableSpaceForLeft - leftPartLength}"
+      padding="${spaces:0:availableSpaceForLeft-leftPartLength}"
       finalString="${leftPart}${paddingStyle}${padding//" "/"${paddingChar}"}${paddingStyleReset}${finalString}"
     else
       finalString="${leftPart}"
@@ -690,7 +690,7 @@ function string::getFormattedHeader() {
   fi
 
   if ((availableSpaceForRight - rightPartLength >= 0)); then
-    padding="${spaces:0:availableSpaceForRight - rightPartLength}"
+    padding="${spaces:0:availableSpaceForRight-rightPartLength}"
     finalString+="${paddingStyle}${padding//" "/"${paddingChar}"}${paddingStyleReset}${rightPart}"
     remainingWidth=$((remainingWidth - rightPartLength))
   elif [[ ${noEllipsis} != "true" && availableSpaceForRight -eq 1 ]]; then
@@ -751,11 +751,11 @@ function string::truncateWithEllipsis() {
 
   # shortcut if no invisible characters
   if [[ ${inputString_NameRef} != *$'\e'* ]]; then
-    if (( ${#inputString_NameRef} > maxLength )); then
+    if ((${#inputString_NameRef} > maxLength)); then
       if [[ ${noEllipsis} == "true" ]]; then
         inputString_NameRef="${inputString_NameRef:0:maxLength}"
       else
-        inputString_NameRef="${inputString_NameRef:0:maxLength - 1}…"
+        inputString_NameRef="${inputString_NameRef:0:maxLength-1}…"
       fi
       REPLY=0
     else
@@ -799,4 +799,47 @@ function string::truncateWithEllipsis() {
   done
 
   REPLY=$((maxLength - displayedLength))
-}
+}
+
+# ## string::join
+#
+# Join an array of strings into a single string using a separator.
+#
+# - $1: **array variable name** _as string_:
+#       The variable name that contains the array to join.
+# - ${separator} _as string_:
+#       The separator character to use.
+#       (defaults to $'\n')
+#
+# Returns:
+# - ${REPLY}: the joined string
+#
+# ```bash
+# MY_ARRAY=("name" "first_name" "address")
+# string::join MY_ARRAY separator=","
+# echo "${REPLY}"
+# ```
+function string::join() {
+  local -n inputArray_NameRef="${1?"The function ⌜${FUNCNAME:-?}⌝ requires more than $# arguments."}"
+  local \
+    separator=$'\n' \
+    IFS=$' '
+  shift 1
+  eval "local a= ${*@Q}"
+  if ((${#separator} == 1)); then
+    # optimization for single character separator
+    IFS="${separator}"
+    REPLY="${inputArray_NameRef[*]}"
+  else
+    REPLY=""
+    local item
+    local -i index=0
+    for item in "${inputArray_NameRef[@]}"; do
+      if ((index > 0)); then
+        REPLY+="${separator}"
+      fi
+      REPLY+="${item}"
+      ((index++))
+    done
+  fi
+}

tests.d/lib-string/00.tests.sh

@@ -4,6 +4,7 @@
 source string
 
 function main() {
+  test_string::join
   test_string::truncateWithEllipsis
   test_string::getFormattedHeader
   test_string::get KebabCase
@@ -26,6 +27,18 @@ function main() {
   test_string::doForEachLine
 }
 
+function test_string::join() {
+  test::title "✅ Testing string::join"
+
+  local -a myArray
+  myArray=(one two 3 four 5)
+  test::printVars myArray
+  test::func string::join myArray
+  test::func string::join myArray separator='@'
+  test::func string::join myArray separator=''
+  test::func string::join myArray separator=$'\n  - '
+}
+
 function test_string::truncateWithEllipsis() {
   test::title "✅ Testing string::truncateWithEllipsis"
 
@@ -38,7 +51,7 @@ function test_string::truncateWithEllipsis() {
   test::funcWithInPlaceString string::truncateWithEllipsis 'This is a test string' maxLength=1
   test::funcWithInPlaceString string::truncateWithEllipsis 'This is a test string' maxLength=2
 
-  for ((i=6; i>=0; i--)); do
+  for ((i = 6; i >= 0; i--)); do
     local myString="${ESC__FG_BRIGHT_CYAN}a${ESC__FG_BRIGHT_CYAN}b${ESC__FG_BRIGHT_CYAN}c${ESC__FG_BRIGHT_CYAN}d${ESC__FG_BRIGHT_CYAN}e"
     string::truncateWithEllipsis myString maxLength="${i}"
     echo "REPLY=${REPLY} → ${myString}"
@@ -60,13 +73,13 @@ function test_string::getFormattedHeader() {
   test_printFormattedHeader "left||" width=50
   test_printFormattedHeader "||right" width=50
 
-  for ((i=20; i>=0; i--)); do
+  for ((i = 20; i >= 0; i--)); do
     test_printFormattedHeader "${ESC__FG_BRIGHT_CYAN}le${ESC__FG_BRIGHT_CYAN}ft|${ESC__FG_BRIGHT_CYAN}middle|ri${ESC__FG_BRIGHT_CYAN}gh${ESC__FG_BRIGHT_CYAN}t" width="${i}"
   done
-  for ((i=20; i>=0; i--)); do
+  for ((i = 20; i >= 0; i--)); do
     test_printFormattedHeader "left|middle|right" width="${i}" paddingStyle=$'\e[1;34m' paddingStyleReset=$'\e[0m'
   done
-  for ((i=20; i>=0; i--)); do
+  for ((i = 20; i >= 0; i--)); do
     test_printFormattedHeader "left|middle|right" width="${i}" noEllipsis=true
   done
 
@@ -250,7 +263,7 @@ function test_string::wrapWords() {
 function test_string::wrapCharacters() {
   test::title "✅ Testing string::wrapCharacters"
 
-  test::markdown  "Wrapping characters at column 20 with padding of 3 on all lines"
+  test::markdown "Wrapping characters at column 20 with padding of 3 on all lines"
   test::func string::wrapCharacters MULTI_LINES_TEXT width=20 newLinePadString="   " firstLineWidth=17
 
   test::markdown "Wrapping characters at 20, no other options"
@@ -347,4 +360,4 @@ MULTI_LINES_TEXT3="1 line one
 3 line three
 4 line four"
 
-main
+main

tests.d/lib-string/results.approved.md

@@ -2,6 +2,62 @@
 
 ## Test script 00.tests
 
+### ✅ Testing string::join
+
+```text
+myArray=(
+[0]='one'
+[1]='two'
+[2]='3'
+[3]='four'
+[4]='5'
+)
+```
+
+❯ `string::join myArray`
+
+Returned variables:
+
+```text
+REPLY='one
+two
+3
+four
+5'
+```
+
+❯ `string::join myArray separator=@`
+
+Returned variables:
+
+```text
+REPLY='one@two@3@four@5'
+```
+
+❯ `string::join myArray separator=`
+
+Returned code: `1`
+
+Returned variables:
+
+```text
+REPLY='onetwo3four5'
+```
+
+❯ `string::join myArray $'separator=\n  - '`
+
+Returned code: `1`
+
+Returned variables:
+
+```text
+REPLY='one
+  - two
+  - 3
+  - four
+  - 5'
+```
+
 ### ✅ Testing string::truncateWithEllipsis
 
 ```text

version

@@ -1 +1 @@
-0.36.5
+0.36.9