Merge pull request #356 from DannyBen/change/config-dependencies

Update dependencies option to support 'any' (e.g. wget or curl)

Author: DannyBen

.gitignore

@@ -9,4 +9,4 @@
 /spec/tmp
 /tmp
 /toc.txt
-/helpers/debug.runfile
+/support/runfile/debug.runfile

examples/README.md

@@ -15,6 +15,7 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [command-aliases](command-aliases#readme) - allowing a command to be called with multiple names
 - [command-examples](command-examples#readme) - configuring command examples
 - [dependencies](dependencies#readme) - halting script execution unless certain dependencies are installed
+- [dependencies-alt](dependencies-alt#readme) - halting script execution unless one of the required dependencies is installed
 - [environment-variables](environment-variables#readme) - halting script execution unless certain environment variables are set
 - [default-values](default-values#readme) - arguments and flags with default values
 - [minus-v](minus-v#readme) - using `-v` and `-h` in your script

examples/dependencies-alt/.gitignore

@@ -0,0 +1 @@
+cli

examples/dependencies-alt/README.md

@@ -0,0 +1,69 @@
+# Alternate Dependencies Example
+
+Demonstrates how to require your script's user to have at least one of a list
+of dependencies (commands) installed prior to using your script.
+
+This example was generated with:
+
+```bash
+$ bashly init
+$ bashly add colors
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: cli
+help: Sample application that requires alternate dependencies
+version: 0.1.0
+
+commands:
+- name: download
+  help: Download something
+
+  # This is the explicit way of defining dependencies.
+  # The generated script will be halted (with a friendly error message) if
+  # any of these programs are not installed:
+  dependencies:
+    # Abort with just the default 'missing dependency: git' message if git
+    # is not found
+    git:
+
+    # Abort with an additional help message if ruby is not found
+    ruby: visit $(blue_underlined https://www.ruby-lang.org) to install
+
+    # Abort if both curl and wget are not found, and show an additional help
+    # message.
+    # Note that the path to the first found dependency will be available to
+    # your script in the `deps` associative array.
+    http_client:
+      command: [curl, wget]
+      help: install with $(green sudo apt install curl)
+```
+
+
+
+## Generated script output
+
+### `$ ./cli download`
+
+```shell
+# this file is located in 'src/download_command.sh'
+# code for 'cli download' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+
+deps:
+- ${deps[git]} = /usr/bin/git
+- ${deps[http_client]} = /usr/bin/curl
+- ${deps[ruby]} = /home/vagrant/.rbenv/versions/3.1.3/bin/ruby
+
+
+```
+
+
+

examples/dependencies-alt/src/bashly.yml

@@ -0,0 +1,26 @@
+name: cli
+help: Sample application that requires alternate dependencies
+version: 0.1.0
+
+commands:
+- name: download
+  help: Download something
+
+  # This is the explicit way of defining dependencies.
+  # The generated script will be halted (with a friendly error message) if
+  # any of these programs are not installed:
+  dependencies:
+    # Abort with just the default 'missing dependency: git' message if git
+    # is not found
+    git:
+
+    # Abort with an additional help message if ruby is not found
+    ruby: visit $(blue_underlined https://www.ruby-lang.org) to install
+
+    # Abort if both curl and wget are not found, and show an additional help
+    # message.
+    # Note that the path to the first found dependency will be available to
+    # your script in the `deps` associative array.
+    http_client:
+      command: [curl, wget]
+      help: install with $(green sudo apt install curl)

examples/dependencies-alt/src/download_command.sh

@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/download_command.sh'"
+echo "# code for 'cli download' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/dependencies-alt/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 variables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.

examples/dependencies-alt/src/lib/colors.sh

@@ -0,0 +1,42 @@
+## Color functions [@bashly-upgrade colors]
+## This file is a part of Bashly standard library
+##
+## Usage:
+## Use any of the functions below to color or format a portion of a string.
+##
+##   echo "before $(red this is red) after"
+##   echo "before $(green_bold this is green_bold) after"
+##
+## Color output will be disabled if `NO_COLOR` environment variable is set
+## in compliance with https://no-color.org/
+##
+print_in_color() {
+  local color="$1"
+  shift
+  if [[ -z ${NO_COLOR+x} ]]; then
+    printf "$color%b\e[0m\n" "$*"
+  else
+    printf "%b\n" "$*"
+  fi
+}
+
+red() { print_in_color "\e[31m" "$*"; }
+green() { print_in_color "\e[32m" "$*"; }
+yellow() { print_in_color "\e[33m" "$*"; }
+blue() { print_in_color "\e[34m" "$*"; }
+magenta() { print_in_color "\e[35m" "$*"; }
+cyan() { print_in_color "\e[36m" "$*"; }
+bold() { print_in_color "\e[1m" "$*"; }
+underlined() { print_in_color "\e[4m" "$*"; }
+red_bold() { print_in_color "\e[1;31m" "$*"; }
+green_bold() { print_in_color "\e[1;32m" "$*"; }
+yellow_bold() { print_in_color "\e[1;33m" "$*"; }
+blue_bold() { print_in_color "\e[1;34m" "$*"; }
+magenta_bold() { print_in_color "\e[1;35m" "$*"; }
+cyan_bold() { print_in_color "\e[1;36m" "$*"; }
+red_underlined() { print_in_color "\e[4;31m" "$*"; }
+green_underlined() { print_in_color "\e[4;32m" "$*"; }
+yellow_underlined() { print_in_color "\e[4;33m" "$*"; }
+blue_underlined() { print_in_color "\e[4;34m" "$*"; }
+magenta_underlined() { print_in_color "\e[4;35m" "$*"; }
+cyan_underlined() { print_in_color "\e[4;36m" "$*"; }

examples/dependencies-alt/test.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+rm -f src/lib/colors.sh
+rm -f src/*.sh
+
+set -x
+
+bashly add colors
+bashly generate
+
+### Try Me ###
+
+./cli download

lib/bashly/concerns/validation_helpers.rb

@@ -35,19 +35,13 @@ def assert_array(key, value, of: nil)
       end
     end
 
-    def assert_hash(key, value, keys: nil, of: nil)
+    def assert_hash(key, value, keys: nil)
       assert value.is_a?(Hash), "#{key} must be a hash"
 
-      if keys
-        invalid_keys = value.keys.map(&:to_sym) - keys
-        assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
-      end
-
-      return unless of
+      return unless keys
 
-      value.each do |k, v|
-        send "assert_#{of}".to_sym, "#{key}.#{k}", v
-      end
+      invalid_keys = value.keys.map(&:to_sym) - keys
+      assert invalid_keys.empty?, "#{key} contains invalid options: #{invalid_keys.join ', '}"
     end
 
     def assert_uniq(key, value, array_keys)