Merge pull request #409 from DannyBen/refactor/config

Config Library: Refactor to allow sections and use the low level INI library

Author: DannyBen

examples/README.md

@@ -58,8 +58,8 @@ Each of these examples demonstrates one aspect or feature of bashly.
 
 ## Bashly library features
 
-- [config](config#readme) - using the config functions
-- [ini](ini#readme) - using the INI handling functions
+- [config](config#readme) - using the config library for easy access to INI files
+- [ini](ini#readme) - using the ini library for direct, low level access to INI files
 - [yaml](yaml#readme) - using the YAML reading functions
 - [colors](colors#readme) - using the color print feature
 - [completions](completions#readme) - adding bash completion functionality

examples/config/README.md

@@ -1,7 +1,10 @@
 # Config Example
 
-Demonstrates how to add functions for reading and writing INI-like files with
-`key = value` pairs.
+Demonstrates how to add functions for reading and writing INI configuration
+files. 
+
+Note that this library uses the [ini library](https://github.com/DannyBen/bashly/tree/master/examples/ini#readme)
+for its low-level INI read/write functions.
 
 This example was generated with:
 
@@ -18,7 +21,7 @@ Running the `bashly add config` command simply added the [src/lib/config.sh](src
 
 See the files in the [src](src) folder for usage examples.
 
-<!-- include: config.ini src/get_command.sh src/list_command.sh src/set_command.sh -->
+<!-- include: config.ini src/get_command.sh src/list_command.sh src/set_command.sh src/del_command.sh -->
 
 -----
 
@@ -44,6 +47,7 @@ commands:
 
   examples:
   - configly set hello world
+  - configly set login.name Megatron
 
 - name: get
   alias: g
@@ -55,20 +59,35 @@ commands:
     help: Config key
 
   examples:
-  - configly set hello
+  - configly get hello
+  - configly get login.name
+
+- name: del
+  alias: d
+  help: Delete a value from the config file
+
+  args:
+  - name: key
+    required: true
+    help: Config key
+
+  examples:
+  - configly del hello
+  - configly del login.name
 
 - name: list
   alias: l
-  help: Show the entire config file
+  help: Show all values
 ```
 
 ## `config.ini`
 
 ```ini
-; comments are allowed
-hello = world
-bashly = works
+theme = dark
 
+[user]
+email = paul@section.one
+name = Operations
 
 ```
 
@@ -112,7 +131,18 @@ done
 ```bash
 # Using the standard library (lib/config.sh) to store a value to the config
 config_set "${args[key]}" "${args[value]}"
-echo "saved: ${args[key]} = ${args[value]}"
+config_show
+
+```
+
+## `src/del_command.sh`
+
+```bash
+# Using the standard library (lib/config.sh) to delete a value from the config
+
+key="${args[key]}"
+config_del "$key"
+config_show
 
 ```
 
@@ -132,7 +162,8 @@ Usage:
 Commands:
   set    Save a value in the config file
   get    Read a value from the config file
-  list   Show the entire config file
+  del    Delete a value from the config file
+  list   Show all values
 
 Options:
   --help, -h
@@ -145,28 +176,63 @@ Options:
 
 ```
 
-### `$ ./configly set hello world`
+### `$ ./configly set theme dark`
 
 ```shell
-saved: hello = world
+theme = dark
+user.email = paul@section.one
+user.name = Operations
 
 
 ```
 
-### `$ ./configly set bashly works`
+### `$ ./configly set user.name Operations`
 
 ```shell
-saved: bashly = works
+theme = dark
+user.email = paul@section.one
+user.name = Operations
 
 
 ```
 
-### `$ ./configly get hello`
+### `$ ./configly set user.email paul@section.one`
 
 ```shell
-world
-world
-world
+theme = dark
+user.email = paul@section.one
+user.name = Operations
+
+
+```
+
+### `$ ./configly set user.password s3cr3t`
+
+```shell
+theme = dark
+user.email = paul@section.one
+user.name = Operations
+user.password = s3cr3t
+
+
+```
+
+### `$ ./configly get theme`
+
+```shell
+dark
+dark
+dark
+
+
+```
+
+### `$ ./configly get user.name`
+
+```shell
+Operations
+Operations
+Operations
 
 
 ```
@@ -181,15 +247,25 @@ the default value
 
 ```
 
-### `$ ./configly list`
+### `$ ./configly del user.password`
 
 ```shell
-; comments are allowed
-hello = world
-bashly = works
+theme = dark
+user.email = paul@section.one
+user.name = Operations
+
 
-hello === world
-bashly === works
+```
+
+### `$ ./configly list`
+
+```shell
+theme = dark
+user.email = paul@section.one
+user.name = Operations
+theme === dark
+user.email === paul@section.one
+user.name === Operations
 
 
 ```

examples/config/config.ini

@@ -1,4 +1,5 @@
-; comments are allowed
-hello = world
-bashly = works
+theme = dark
 
+[user]
+email = paul@section.one
+name = Operations

examples/config/src/bashly.yml

@@ -17,6 +17,7 @@ commands:
 
   examples:
   - configly set hello world
+  - configly set login.name Megatron
 
 - name: get
   alias: g
@@ -28,8 +29,22 @@ commands:
     help: Config key
 
   examples:
-  - configly set hello
+  - configly get hello
+  - configly get login.name
+
+- name: del
+  alias: d
+  help: Delete a value from the config file
+
+  args:
+  - name: key
+    required: true
+    help: Config key
+
+  examples:
+  - configly del hello
+  - configly del login.name
 
 - name: list
   alias: l
-  help: Show the entire config file
+  help: Show all values

examples/config/src/del_command.sh

@@ -0,0 +1,5 @@
+# Using the standard library (lib/config.sh) to delete a value from the config
+
+key="${args[key]}"
+config_del "$key"
+config_show