Merge pull request #108 from DannyBen/fix/107

Fix config library context contamination

Author: DannyBen

lib/bashly/templates/lib/config.sh

@@ -20,8 +20,9 @@ config_init() {
 # Get a value from the config.
 # Usage: result=$(config_get hello)
 config_get() {
-  key=$1
-  regex="^$key *= *(.+)$"
+  local key=$1
+  local regex="^$key *= *(.+)$"
+  local value=""
 
   config_init
 
@@ -38,15 +39,16 @@ config_get() {
 # Add or update a key=value pair in the config.
 # Usage: config_set key value
 config_set() {
-  key=$1
+  local key=$1
   shift
-  value="$*"
+  local value="$*"
 
   config_init
 
-  regex="^($key) *= *.+$"
-  output=""
-  found_key=""
+  local regex="^($key) *= *.+$"
+  local output=""
+  local found_key=""
+  local newline
 
   while IFS= read -r line || [ -n "$line" ]; do
     newline=$line
@@ -69,15 +71,14 @@ config_set() {
 # Delete a key from the config.
 # Usage: config_del key
 config_del() {
-  key=$1
+  local key=$1
 
-  regex="^($key) *="
-  output=""
+  local regex="^($key) *="
+  local output=""
 
   config_init
 
   while IFS= read -r line || [ -n "$line" ]; do
-    newline=$line
     if [[ $line ]] && [[ ! $line =~ $regex ]]; then
       output="$output$line\n"
     fi
@@ -100,11 +101,13 @@ config_show() {
 #   done
 #
 config_keys() {
-  regex="^([a-zA-Z0-9_\-\/\.]+) *="
+  local regex="^([a-zA-Z0-9_\-\/\.]+) *="
 
   config_init
 
-  keys=()
+  local keys=()
+  local key
+  
   while IFS= read -r line || [ -n "$line" ]; do
     if [[ $line =~ $regex ]]; then
       key="${BASH_REMATCH[1]}"

spec/approvals/examples/config-lib

@@ -0,0 +1,11 @@
++ bundle exec bashly add config --force
+created src/lib/config.sh
++ bundle exec bashly generate
+creating user files in src
+skipped src/initialize.sh (exists)
+skipped src/root_command.sh (exists)
+created ./download
+run ./download --help to test your bash script
++ ./download
+foo=BOOM
+bar=

spec/fixtures/workspaces/config-lib/.gitignore

@@ -0,0 +1 @@
+download

spec/fixtures/workspaces/config-lib/README.md

@@ -0,0 +1,2 @@
+This fixture tests that the config lib scope bug
+Reference issue: https://github.com/DannyBen/bashly/issues/107

spec/fixtures/workspaces/config-lib/config.ini

@@ -0,0 +1,2 @@
+foo = BOOM
+

spec/fixtures/workspaces/config-lib/src/bashly.yml

@@ -0,0 +1,3 @@
+name: download
+help: Sample minimal application without commands
+version: 0.1.0

spec/fixtures/workspaces/config-lib/src/initialize.sh

@@ -0,0 +1,6 @@
+# Code here runs inside the initialize() function
+# Use it for anything that you need to run before any other function, like
+# setting environment vairables:
+# CONFIG_FILE=settings.ini
+#
+# Feel free to empty (but not delete) this file.

spec/fixtures/workspaces/config-lib/src/lib/config.sh

@@ -0,0 +1,129 @@
+# ---
+# Config functions
+# This file is a part of Bashly standard library
+#
+# Usage:
+# - In your script, set the CONFIG_FILE variable. For rxample:
+#   CONFIG_FILE=settings.ini.
+#   If it is unset, it will default to 'config.ini'.
+# - Use any of the functions below to access the config file.
+# ---
+
+# Create a new config file.
+# There is normally no need to use this function, it is used by other
+# functions as needed.
+config_init() {
+  CONFIG_FILE=${CONFIG_FILE:=config.ini}
+  [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
+}
+
+# Get a value from the config.
+# Usage: result=$(config_get hello)
+config_get() {
+  local key=$1
+  local regex="^$key *= *(.+)$"
+  local value=""
+
+  config_init
+  
+  while IFS= read -r line || [ -n "$line" ]; do
+    if [[ $line =~ $regex ]]; then
+      value="${BASH_REMATCH[1]}"
+      break
+    fi
+  done < "$CONFIG_FILE"
+
+  echo "$value"
+}
+
+# Add or update a key=value pair in the config.
+# Usage: config_set key value
+config_set() {
+  local key=$1
+  shift
+  local value="$*"
+
+  config_init
+
+  local regex="^($key) *= *.+$"
+  local output=""
+  local found_key=""
+  local newline
+  
+  while IFS= read -r line || [ -n "$line" ]; do
+    newline=$line
+    if [[ $line =~ $regex ]]; then
+      found_key="${BASH_REMATCH[1]}"
+      newline="$key = $value"
+      output="$output$newline\n"
+    elif [[ $line ]]; then
+      output="$output$line\n"
+    fi
+  done < "$CONFIG_FILE"
+
+  if [[ -z $found_key ]]; then
+    output="$output$key = $value\n"
+  fi
+
+  printf "%b\n" "$output" > "$CONFIG_FILE"
+}
+
+# Delete a key from the config.
+# Usage: config_del key
+config_del() {
+  local key=$1
+
+  local regex="^($key) *="
+  local output=""
+
+  config_init
+
+  while IFS= read -r line || [ -n "$line" ]; do
+    if [[ $line ]] && [[ ! $line =~ $regex ]]; then
+      output="$output$line\n"
+    fi
+  done < "$CONFIG_FILE"
+
+  printf "%b\n" "$output" > "$CONFIG_FILE"
+}
+
+# Show the config file
+config_show() {
+  config_init
+  cat "$CONFIG_FILE"
+}
+
+# Return an array of the keys in the config file.
+# Usage:
+#
+#   for k in $(config_keys); do
+#     echo "- $k = $(config_get "$k")";
+#   done
+#
+config_keys() {
+  local regex="^([a-zA-Z0-9_\-\/\.]+) *="
+
+  config_init
+
+  local keys=()
+  local key
+  
+  while IFS= read -r line || [ -n "$line" ]; do
+    if [[ $line =~ $regex ]]; then
+      key="${BASH_REMATCH[1]}"
+      keys+=("$key")
+    fi
+  done < "$CONFIG_FILE"
+  echo "${keys[@]}"
+}
+
+# Returns true if the specified key exists in the config file.
+# Usage:
+#
+#   if config_has_key "key" ; then
+#     echo "key exists"
+#   fi
+#
+config_has_key() {
+  [[ $(config_get "$1") ]]
+}

spec/fixtures/workspaces/config-lib/src/root_command.sh

@@ -0,0 +1,3 @@
+config_set foo BOOM
+echo "foo=$(config_get foo)"
+echo "bar=$(config_get bar)"

spec/fixtures/workspaces/config-lib/test.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+# This fixture tests that the config lib scope bug
+# It is executed as part of the Runfile examples test
+# Reference issue: https://github.com/DannyBen/bashly/issues/107
+
+rm -f ./download
+
+set -x
+
+bundle exec bashly add config --force
+bundle exec bashly generate
+
+./download