- Add a 'deps' associative array to the generated bash script

Author: DannyBen

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 in this case you will also have a `deps` hash in your
+    # bash script, with the path to the first found program.
+    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 in this case you will also have a `deps` hash in your
+    # bash script, with the path to the first found program.
+    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/config_validator.rb

@@ -64,10 +64,10 @@ def assert_dependencies_hash(key, value)
     end
 
     def assert_dependency(key, value)
-      assert [String, Hash].include?(value.class),
-        "#{key} must be a string or a hash"
+      assert [String, Hash, NilClass].include?(value.class),
+        "#{key} must be a string, a hash or nil"
 
-      return if value.is_a? String
+      return unless value.is_a? Hash
 
       assert_hash key, value, keys: Script::Dependency.option_keys
       assert_string_or_array "#{key}.command", value['command']

lib/bashly/docs/command.yml

@@ -113,10 +113,11 @@ command.dependencies:
     - docker
     - curl
 
-    # Simple hash syntax, to provide additional help message
+    # Simple hash syntax, to provide additional (optional) help message
     dependencies:
       docker: see https://docker.com for installation instructions
       git: "install by running: sudo apt install git"
+      ruby:
 
     # Explicit hash syntax, to provide additional help message and
     # look for "one of" a given list of dependencies

lib/bashly/script/dependency.rb

@@ -30,12 +30,12 @@ def initialize(label: nil, commands: nil, help: nil)
         @help = help&.empty? ? nil : help
       end
 
+      def multi?
+        @multi ||= commands.size > 1
+      end
+
       def name
-        @name ||= if commands.size == 1
-          commands.first
-        else
-          "#{label} (#{commands.join '/'})"
-        end
+        @name ||= multi? ? "#{label} (#{commands.join '/'})" : label
       end
     end
   end