Merge pull request #17 from aks/fix-hash-print

fix sort keys when printing a hash

Author: aks

DONE

@@ -1,5 +1,16 @@
+# DONE
+# Copyright 2006-2022 Alan K. Stebbens <[email protected]>
+#
+# A change log for the bash-lib
+
+2022/07/17
+* Makefile:
+  - make invocation path explicitly relative
+* hash-utils.sh:
+  - sort the keys for printing on hash_print
+
 2015/05/31
-* sh-utils.sh: 
+* sh-utils.sh:
   - refactored into talk-utils, arg-utils, run-utils
 * Makefile:
   - added the newly refactored modules
@@ -21,7 +32,7 @@
 * test-text-utils.sh:
   - refactored all the tests to support new STDIN feature
 * sh-utils.sh:
-  - added args_or_stdin function to pass along ars, or 
+  - added args_or_stdin function to pass along ars, or
     read from STDIN
 
 2014/06/11

hash-utils.sh

@@ -1,5 +1,5 @@
 # hash-utils.sh
-# Copyright 2014-2015 Alan K. Stebbens <[email protected]>
+# Copyright 2014-2022 Alan K. Stebbens <[email protected]>
 #
 # bash script utilities for managing hashes (associative arrays)
 
@@ -313,23 +313,16 @@ print_hash() { "$@" ; }
 # hash_print_items VAR
 hash_print_items() {
   help_args_func hash_help $# || return
-  local var="$1" k
+  local var="$1" key val
   local -a keys
   hash_get_keys $var
-  for k in "${keys[@]}" ; do
-    hash_print_item $var "$k"
-    echo ''
+  __list_sort keys
+  for key in "${keys[@]}" ; do
+    val=`hash_get $var "$key"`
+    printf "%s['%s']='%s'\n" $var "$key" "$val"
   done
 }
 
-# hash_print_item VAR KEY
-
-hash_print_item() {
-  local var="$1" key="$2"
-  local val=`hash_get $var "$key"`
-  printf "%s['%s']='%s'" $var "$key" "$val"
-}
-
 # _set_args "OPT1 OPT2 ..." "$@"
 #
 # Scan the arguments looking for OPTn=VAL, and set each OPTn to the

test-hash-utils.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
-# Copyright 2006-2014, Alan K. Stebbens <[email protected]>
-# 
+# Copyright 2006-2022, Alan K. Stebbens <[email protected]>
+#
 # Test module for hash-utils.sh
 #
 
@@ -136,7 +136,7 @@ test_10_print_hash() {
     apple banana cherry dog elephant fox giraffe hawk indigo manzana milk november
     october december january february march april may june july august
   )
-  hash_init hash10 
+  hash_init hash10
   for ((i=0; i<${#words[@]}; i++)) ; do
     hash_set hash10 ${words[i]} $i
   done

test/phout1.out.ref

@@ -1,8 +1,8 @@
-hash10['april']='17'     hash10['apple']='0'      hash10['november']='11'
-hash10['cherry']='2'     hash10['march']='16'     hash10['august']='21'
-hash10['october']='12'   hash10['indigo']='8'     hash10['may']='18'
-hash10['giraffe']='6'    hash10['june']='19'      hash10['banana']='1'
-hash10['february']='15'  hash10['milk']='10'      hash10['manzana']='9'
-hash10['july']='20'      hash10['january']='14'   hash10['fox']='5'
-hash10['dog']='3'        hash10['hawk']='7'       
-hash10['elephant']='4'   hash10['december']='13'  
+hash10['apple']='0'      hash10['february']='15'  hash10['manzana']='9'
+hash10['april']='17'     hash10['fox']='5'        hash10['march']='16'
+hash10['august']='21'    hash10['giraffe']='6'    hash10['may']='18'
+hash10['banana']='1'     hash10['hawk']='7'       hash10['milk']='10'
+hash10['cherry']='2'     hash10['indigo']='8'     hash10['november']='11'
+hash10['december']='13'  hash10['january']='14'   hash10['october']='12'
+hash10['dog']='3'        hash10['july']='20'      
+hash10['elephant']='4'   hash10['june']='19'      

test/phout2.out.ref

@@ -1,8 +1,8 @@
- hash10['april']='17'     hash10['apple']='0'      hash10['november']='11'
- hash10['cherry']='2'     hash10['march']='16'     hash10['august']='21'
- hash10['october']='12'   hash10['indigo']='8'     hash10['may']='18'
- hash10['giraffe']='6'    hash10['june']='19'      hash10['banana']='1'
- hash10['february']='15'  hash10['milk']='10'      hash10['manzana']='9'
- hash10['july']='20'      hash10['january']='14'   hash10['fox']='5'
- hash10['dog']='3'        hash10['hawk']='7'
- hash10['elephant']='4'   hash10['december']='13'
+ hash10['apple']='0'      hash10['february']='15'  hash10['manzana']='9'
+ hash10['april']='17'     hash10['fox']='5'        hash10['march']='16'
+ hash10['august']='21'    hash10['giraffe']='6'    hash10['may']='18'
+ hash10['banana']='1'     hash10['hawk']='7'       hash10['milk']='10'
+ hash10['cherry']='2'     hash10['indigo']='8'     hash10['november']='11'
+ hash10['december']='13'  hash10['january']='14'   hash10['october']='12'
+ hash10['dog']='3'        hash10['july']='20'
+ hash10['elephant']='4'   hash10['june']='19'

test/phout3.out.ref

@@ -1,6 +1,6 @@
-  hash10['april']='17'     hash10['dog']='3'        hash10['milk']='10'      hash10['may']='18'
-  hash10['cherry']='2'     hash10['elephant']='4'   hash10['january']='14'   hash10['banana']='1'
-  hash10['october']='12'   hash10['apple']='0'      hash10['hawk']='7'       hash10['manzana']='9'
-  hash10['giraffe']='6'    hash10['march']='16'     hash10['december']='13'  hash10['fox']='5'
-  hash10['february']='15'  hash10['indigo']='8'     hash10['november']='11'
-  hash10['july']='20'      hash10['june']='19'      hash10['august']='21'
+  hash10['apple']='0'      hash10['dog']='3'        hash10['indigo']='8'     hash10['may']='18'
+  hash10['april']='17'     hash10['elephant']='4'   hash10['january']='14'   hash10['milk']='10'
+  hash10['august']='21'    hash10['february']='15'  hash10['july']='20'      hash10['november']='11'
+  hash10['banana']='1'     hash10['fox']='5'        hash10['june']='19'      hash10['october']='12'
+  hash10['cherry']='2'     hash10['giraffe']='6'    hash10['manzana']='9'
+  hash10['december']='13'  hash10['hawk']='7'       hash10['march']='16'

test/phout4.out.ref

@@ -1,8 +1,8 @@
-   hash10['april']='17'     hash10['apple']='0'      hash10['november']='11'
-   hash10['cherry']='2'     hash10['march']='16'     hash10['august']='21'
-   hash10['october']='12'   hash10['indigo']='8'     hash10['may']='18'
-   hash10['giraffe']='6'    hash10['june']='19'      hash10['banana']='1'
-   hash10['february']='15'  hash10['milk']='10'      hash10['manzana']='9'
-   hash10['july']='20'      hash10['january']='14'   hash10['fox']='5'
-   hash10['dog']='3'        hash10['hawk']='7'
-   hash10['elephant']='4'   hash10['december']='13'
+   hash10['apple']='0'      hash10['february']='15'  hash10['manzana']='9'
+   hash10['april']='17'     hash10['fox']='5'        hash10['march']='16'
+   hash10['august']='21'    hash10['giraffe']='6'    hash10['may']='18'
+   hash10['banana']='1'     hash10['hawk']='7'       hash10['milk']='10'
+   hash10['cherry']='2'     hash10['indigo']='8'     hash10['november']='11'
+   hash10['december']='13'  hash10['january']='14'   hash10['october']='12'
+   hash10['dog']='3'        hash10['july']='20'
+   hash10['elephant']='4'   hash10['june']='19'

test/phout5.out.ref

@@ -1,11 +1,11 @@
- hash10['april']='17'     hash10['june']='19'
- hash10['cherry']='2'     hash10['milk']='10'
- hash10['october']='12'   hash10['january']='14'
- hash10['giraffe']='6'    hash10['hawk']='7'
- hash10['february']='15'  hash10['december']='13'
- hash10['july']='20'      hash10['november']='11'
- hash10['dog']='3'        hash10['august']='21'
+ hash10['apple']='0'      hash10['hawk']='7'
+ hash10['april']='17'     hash10['indigo']='8'
+ hash10['august']='21'    hash10['january']='14'
+ hash10['banana']='1'     hash10['july']='20'
+ hash10['cherry']='2'     hash10['june']='19'
+ hash10['december']='13'  hash10['manzana']='9'
+ hash10['dog']='3'        hash10['march']='16'
  hash10['elephant']='4'   hash10['may']='18'
- hash10['apple']='0'      hash10['banana']='1'
- hash10['march']='16'     hash10['manzana']='9'
- hash10['indigo']='8'     hash10['fox']='5'
+ hash10['february']='15'  hash10['milk']='10'
+ hash10['fox']='5'        hash10['november']='11'
+ hash10['giraffe']='6'    hash10['october']='12'