bashly 0.8.9 → 0.9.0

data/lib/bashly/script/base.rb

@@ -12,7 +12,8 @@ module Bashly
       end
 
       def initialize(options)
-        raise Error, "Invalid options provided" unless options.respond_to? :keys
+        raise Error, 'Invalid options provided' unless options.respond_to? :keys
+
         @options = options
       end
 
@@ -21,7 +22,7 @@ module Bashly
       end
 
       def summary
-        help.empty? ? "" : help.split("\n").first
+        help.empty? ? '' : help.split("\n").first
       end
 
       def help

data/lib/bashly/script/catch_all.rb

@@ -18,12 +18,15 @@ module Bashly
             {}
           end
 
-          new **options
+          new(**options)
         end
       end
 
       def initialize(label: nil, help: nil, required: false, enabled: true)
-        @label, @help, @required, @enabled = label, help, required, enabled
+        @label = label
+        @help = help
+        @required = required
+        @enabled = enabled
       end
 
       def enabled?
@@ -44,10 +47,9 @@ module Bashly
 
       def usage_string
         return nil unless enabled?
+
         required? ? label : "[#{label}]"
       end
-
     end
   end
 end
-

data/lib/bashly/script/command.rb

@@ -26,7 +26,7 @@ module Bashly
       #   by space. For example, for a command like "docker container run"
       #   the action name is "container run".
       def action_name
-        parents.any? ? (parents[1..-1] + [name]).join(' ') : "root"
+        parents.any? ? (parents[1..] + [name]).join(' ') : 'root'
       end
 
       # Returns all the possible aliases for this command
@@ -34,28 +34,20 @@ module Bashly
         [name] + alt
       end
 
-      # Returns an array of all full names (including aliases and aliases of
-      # parents)
-      def all_full_names
-        if parent_command
-          parent_command.all_full_names.product(aliases).map { |a| a.join ' ' }
-        else
-          aliases
-        end
-      end
-
       # Returns an array of alternative aliases if any
       def alt
         # DEPRECATION 0.8.0
         options['alias'] ||= options['short']
-        return [] unless options["alias"]
+        return [] unless options['alias']
+
         options['alias'].is_a?(String) ? [options['alias']] : options['alias']
       end
 
       # Returns an array of Arguments
       def args
-        return [] unless options["args"]
-        options["args"].map do |options|
+        return [] unless options['args']
+
+        options['args'].map do |options|
           Argument.new options
         end
       end
@@ -85,8 +77,8 @@ module Bashly
 
           command.public_commands.each do |subcommand|
             result[command.group_string]["#{command.name} #{subcommand.name}"] = {
-              summary: subcommand.summary_string,
-              help_only: command.expose != 'always'
+              summary:   subcommand.summary_string,
+              help_only: command.expose != 'always',
             }
           end
         end
@@ -96,13 +88,14 @@ module Bashly
 
       # Returns only the names of the Commands
       def command_names
-        commands.map &:name
+        commands.map(&:name)
       end
 
       # Returns an array of the Commands
       def commands
-        return [] unless options["commands"]
-        options["commands"].map do |options|
+        return [] unless options['commands']
+
+        options['commands'].map do |options|
           result = Command.new options
           result.parents = parents + [name]
           result.parent_command = self
@@ -126,42 +119,51 @@ module Bashly
       # If any of this command's subcommands has the default option set to
       # true, this default command will be returned, nil otherwise.
       def default_command
-        commands.find { |c| c.default }
+        commands.find(&:default)
       end
 
       # Returns an array of all the default Args
       def default_args
-        args.select &:default
+        args.select(&:default)
       end
 
       # Returns an array of all the default Environment Variables
       def default_environment_variables
-        environment_variables.select &:default
+        environment_variables.select(&:default)
       end
 
       # Returns an array of all the default Flags
       def default_flags
-        flags.select &:default
+        flags.select(&:default)
       end
 
       # Returns an array of EnvironmentVariables
       def environment_variables
-        return [] unless options["environment_variables"]
-        options["environment_variables"].map do |options|
+        return [] unless options['environment_variables']
+
+        options['environment_variables'].map do |options|
           EnvironmentVariable.new options
         end
       end
 
+      # Returns an array of examples
+      def examples
+        return nil unless options['examples']
+
+        options['examples'].is_a?(Array) ? options['examples'] : [options['examples']]
+      end
+
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
-        options["filename"] || "#{action_name.to_underscore}_command.sh"
+        options['filename'] || "#{action_name.to_underscore}_command.sh"
       end
 
       # Returns an array of Flags
       def flags
-        return [] unless options["flags"]
-        options["flags"].map do |options|
+        return [] unless options['flags']
+
+        options['flags'].map do |options|
           Flag.new options
         end
       end
@@ -186,7 +188,7 @@ module Bashly
       # Returns the string for the group caption
       def group_string
         if group
-          strings[:group] % { group: group } 
+          strings[:group] % { group: group }
         else
           strings[:commands]
         end
@@ -194,18 +196,17 @@ module Bashly
 
       # Returns a mode identifier
       def mode
-        @mode ||= begin
-          if global_flags?               then :global_flags
-          elsif commands.any?            then :commands
-          elsif args.any? and flags.any? then :args_and_flags
-          elsif args.any?                then :args
-          elsif flags.any?               then :flags
-          else                           :empty
-          end
+        @mode ||= if global_flags?    then :global_flags
+        elsif commands.any?           then :commands
+        elsif args.any? && flags.any? then :args_and_flags
+        elsif args.any?               then :args
+        elsif flags.any?              then :flags
+        else
+          :empty
         end
       end
 
-      # Returns an array of all parents. For example, the command 
+      # Returns an array of all parents. For example, the command
       # "docker container run" will have [docker, container] as its parents
       def parents
         @parents ||= []
@@ -213,7 +214,7 @@ module Bashly
 
       # Returns only commands that are not private
       def public_commands
-        commands.reject &:private
+        commands.reject(&:private)
       end
 
       # Returns true if one of the args is repeatable
@@ -223,17 +224,17 @@ module Bashly
 
       # Returns an array of all the required Arguments
       def required_args
-        args.select &:required
+        args.select(&:required)
       end
 
       # Returns an array of all the required EnvironmentVariables
       def required_environment_variables
-        environment_variables.select &:required
+        environment_variables.select(&:required)
       end
 
       # Returns an array of all the required Flags
       def required_flags
-        flags.select &:required
+        flags.select(&:required)
       end
 
       # Returns true if this is the root command (no parents)
@@ -260,21 +261,20 @@ module Bashly
         result = [full_name]
 
         result.push case mode
-        when :global_flags    then ["[OPTIONS]", "COMMAND"]
-        when :commands        then ["COMMAND"]
-        when :args_and_flags  then usage_string_args + ["[OPTIONS]"]
+        when :global_flags    then ['[OPTIONS]', 'COMMAND']
+        when :commands        then ['COMMAND']
+        when :args_and_flags  then usage_string_args + ['[OPTIONS]']
         when :args            then usage_string_args
-        when :flags           then ["[OPTIONS]"]
-        else                  nil
+        when :flags           then ['[OPTIONS]']
         end
 
         result.push catch_all.usage_string if catch_all.enabled? && commands.empty?
-        result.compact.join " "
+        result.compact.join ' '
       end
 
       # Returns an array of args usage_string for the command's usage_string
       def usage_string_args
-        args.map { |arg| arg.usage_string }
+        args.map(&:usage_string)
       end
 
       # Returns an array of files to include as is inside the script
@@ -286,12 +286,12 @@ module Bashly
 
       # Returns an array of all the args with a whitelist
       def whitelisted_args
-        args.select &:allowed
+        args.select(&:allowed)
       end
 
       # Returns an array of all the flags with a whitelist arg
       def whitelisted_flags
-        flags.select &:allowed
+        flags.select(&:allowed)
       end
     end
   end

data/lib/bashly/script/environment_variable.rb

@@ -3,15 +3,15 @@ module Bashly
     class EnvironmentVariable < Base
       class << self
         def option_keys
-          @option_keys ||= %i[default help name required]
+          @option_keys ||= %i[default help name required private]
         end
       end
-      
+
       def usage_string(extended: false)
         result = [name.upcase]
-        result << strings[:required] if required and extended
-        result.join " "
+        result << strings[:required] if required && extended
+        result.join ' '
       end
     end
   end
-end
+end

data/lib/bashly/script/flag.rb

@@ -11,9 +11,9 @@ module Bashly
           ]
         end
       end
-      
+
       def aliases
-        if long and short
+        if long && short
           [long, short]
         elsif long
           [long]
@@ -27,12 +27,12 @@ module Bashly
       end
 
       def usage_string(extended: false)
-        result = [aliases.join(", ")]
+        result = [aliases.join(', ')]
         result << arg.upcase if arg
-        result << strings[:required] if required and extended
-        result << strings[:repeatable] if repeatable and extended
-        result.join " "
+        result << strings[:required] if required && extended
+        result << strings[:repeatable] if repeatable && extended
+        result.join ' '
       end
     end
   end
-end
+end

data/lib/bashly/script/wrapper.rb

@@ -6,7 +6,8 @@ module Bashly
       attr_reader :command, :function_name
 
       def initialize(command, function_name = nil)
-        @command, @function_name = command, function_name
+        @command = command
+        @function_name = function_name
       end
 
       def code(tab_indent: false)
@@ -38,13 +39,13 @@ module Bashly
       end
 
       def default_header
-        result = render('header')
+        result = render 'header'
         result += render('bash3_bouncer') unless function_name
         result
       end
 
       def body
-        @body ||= command.render('master_script')
+        @body ||= command.render 'master_script'
       end
 
       def custom_header_path
@@ -52,4 +53,4 @@ module Bashly
       end
     end
   end
-end
+end

data/lib/bashly/settings.rb

@@ -51,8 +51,8 @@ module Bashly
       def get(key)
         case env_value key
         when nil                 then config[key.to_s]
-        when "0", "false", "no"  then false
-        when "1", "true", "yes"  then true
+        when '0', 'false', 'no'  then false
+        when '1', 'true', 'yes'  then true
         else                     env_value key
         end
       end
@@ -70,13 +70,12 @@ module Bashly
       end
 
       def defsult_settings
-        @defsult_settings ||= Config.new(default_settings_path)
+        @defsult_settings ||= Config.new default_settings_path
       end
 
       def default_settings_path
-        asset "templates/settings.yml"
+        asset 'templates/settings.yml'
       end
-
     end
   end
 end

data/lib/bashly/templates/help/help_command.sh

@@ -0,0 +1,30 @@
+## Help command [@bashly-upgrade help]
+## This file is a part of Bashly standard library
+##
+## Add this as a command to your bashly.yml:
+##
+##   commands:
+##     - name: help
+##       help: Show help about a command
+##       args:
+##       - name: command
+##         help: Help subject
+##
+command="${args[command]}"
+long_usage=yes
+
+if [[ -z "$command" ]]; then
+  # No command argument, show the global help
+  help_function=%{name}_usage
+else
+  # Show the help for the requested command
+  help_function="%{name}_${command}_usage"
+fi
+
+# Call the help function if it exists
+if [[ $(type -t "$help_function") ]]; then
+  "$help_function"
+else
+  echo "No help available for this command"
+  exit 1
+fi

data/lib/bashly/templates/lib/colors.sh

@@ -14,9 +14,9 @@ print_in_color() {
   local color="$1"
   shift
   if [[ -z ${NO_COLOR+x} ]]; then
-    printf "$color%b\e[0m\n" "$*";
+    printf "$color%b\e[0m\n" "$*"
   else
-    printf "%b\n" "$*";
+    printf "%b\n" "$*"
   fi
 }
 

data/lib/bashly/templates/lib/config.sh

@@ -24,13 +24,13 @@ config_get() {
   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"
+  done <"$CONFIG_FILE"
 
   echo "$value"
 }
@@ -48,7 +48,7 @@ config_set() {
   local output=""
   local found_key=""
   local newline
-  
+
   while IFS= read -r line || [ -n "$line" ]; do
     newline=$line
     if [[ $line =~ $regex ]]; then
@@ -58,13 +58,13 @@ config_set() {
     elif [[ $line ]]; then
       output="$output$line\n"
     fi
-  done < "$CONFIG_FILE"
+  done <"$CONFIG_FILE"
 
   if [[ -z $found_key ]]; then
     output="$output$key = $value\n"
   fi
 
-  printf "%b\n" "$output" > "$CONFIG_FILE"
+  printf "%b\n" "$output" >"$CONFIG_FILE"
 }
 
 ## Delete a key from the config.
@@ -81,9 +81,9 @@ config_del() {
     if [[ $line ]] && [[ ! $line =~ $regex ]]; then
       output="$output$line\n"
     fi
-  done < "$CONFIG_FILE"
+  done <"$CONFIG_FILE"
 
-  printf "%b\n" "$output" > "$CONFIG_FILE"
+  printf "%b\n" "$output" >"$CONFIG_FILE"
 }
 
 ## Show the config file
@@ -106,20 +106,20 @@ config_keys() {
 
   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"
+  done <"$CONFIG_FILE"
   echo "${keys[@]}"
 }
 
 ## Returns true if the specified key exists in the config file.
 ## Usage:
 ##
-##   if config_has_key "key" ; then
+##   if config_has_key "key"; then
 ##     echo "key exists"
 ##   fi
 ##

data/lib/bashly/templates/lib/yaml.sh

@@ -11,16 +11,16 @@
 ##   eval $(yaml_load "settings.yml")     # create variables in scope
 ##
 yaml_load() {
-   local prefix=$2
-   local s='[[:space:]]*' w='[a-zA-Z0-9_]*'
-   local fs
+  local prefix=$2
+  local s='[[:space:]]*' w='[a-zA-Z0-9_]*'
+  local fs
 
-   fs=$(echo @|tr @ '\034')
+  fs=$(echo @ | tr @ '\034')
 
-   sed -ne "s|^\($s\):|\1|" \
-        -e "s|^\($s\)\($w\)$s:${s}[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
-        -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p"  "$1" |
-   awk -F"$fs" '{
+  sed -ne "s|^\($s\):|\1|" \
+    -e "s|^\($s\)\($w\)$s:${s}[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
+    -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" "$1" |
+    awk -F"$fs" '{
       indent = length($1)/2;
       vname[indent] = $2;
       for (i in vname) {if (i > indent) {delete vname[i]}}
@@ -28,5 +28,5 @@ yaml_load() {
          vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}
          printf("%s%s%s=\"%s\"\n", "'"$prefix"'",vn, $2, $3);
       }
-   }'
+    }'
 }

data/lib/bashly/templates/test/approvals.bash

@@ -1,14 +1,14 @@
-# approvals.bash v0.2.7
+# approvals.bash v0.3.3
 #
 # Interactive approval testing for Bash.
 # https://github.com/DannyBen/approvals.bash
 approve() {
   local expected approval approval_file actual cmd
   approvals_dir=${APPROVALS_DIR:=approvals}
-  
+
   cmd=$1
-  actual=$(eval "$cmd" 2>&1)  
-  last_exit_code=$?
+  last_exit_code=0
+  actual=$(eval "$cmd" 2>&1) || last_exit_code=$?
   approval=$(printf "%b" "$cmd" | tr -s -c "[:alnum:]" _)
   approval_file="$approvals_dir/${2:-"$approval"}"
 
@@ -26,26 +26,32 @@ approve() {
   fi
 
   if [[ "$(printf "%b" "$actual")" = "$(printf "%b" "$expected")" ]]; then
-    green "PASS $cmd"
+    pass "$cmd"
   else
     echo "--- [$(blue "diff: $cmd")] ---"
-    $diff_cmd <(printf "%b" "$expected\n") <(printf "%b" "$actual\n" )  | tail -n +4
+    $diff_cmd <(printf "%b" "$expected\n") <(printf "%b" "$actual\n") | tail -n +4
     echo "--- [$(blue "diff: $cmd")] ---"
     user_approval "$cmd" "$actual" "$approval_file"
   fi
 }
 
 describe() {
-  cyan "TEST $*"
+  echo
+  blue "= $*"
+}
+
+context() {
+  echo
+  magenta "= $*"
 }
 
 fail() {
-  red "FAIL $*"
+  red "  FAILED: $*"
   exit 1
 }
 
 pass() {
-  green "PASS $*"
+  green "  approved: $*"
   return 0
 }
 
@@ -74,19 +80,37 @@ user_approval() {
     fail "$cmd"
   fi
 
-  echo 
+  echo
   printf "[A]pprove? \n"
   response=$(bash -c "read -n 1 key; echo \$key")
   printf "\r"
   if [[ $response =~ [Aa] ]]; then
-    printf "%b\n" "$actual" > "$approval_file"
+    printf "%b\n" "$actual" >"$approval_file"
     pass "$cmd"
   else
     fail "$cmd"
   fi
 }
 
-if diff --help | grep -- --color > /dev/null 2>&1; then
+onexit() {
+  exitcode=$?
+  if [[ "$exitcode" == 0 ]]; then
+    green "\nFinished successfully"
+  else
+    red "\nFinished with failures"
+  fi
+  exit $exitcode
+}
+
+onerror() {
+  fail "Caller: $(caller)"
+}
+
+set -e
+trap 'onexit' EXIT
+trap 'onerror' ERR
+
+if diff --help | grep -- --color >/dev/null 2>&1; then
   diff_cmd="diff --unified --color=always"
 else
   diff_cmd="diff --unified"

data/lib/bashly/templates/test/approve

@@ -3,18 +3,23 @@
 
 cd ./test || exit
 source approvals.bash
-PATH="$PATH:../"
 
 # Update me
-cli=download
+cli=./download
 
-# Tests
-describe "root command"
-  approve "$cli"
-  approve "$cli --help"
+# Tests (context, describe and indentation are optional)
+context "when DEBUG is on"
+  export DEBUG=1
 
-describe "some other command"
-  approve "$cli other"
-  approve "$cli other --help"
+  describe "root command"
+    approve "$cli"
+    approve "$cli --help"
+
+context "when DEBUG is off"
+  unset DEBUG
+
+  describe "some other command"
+    approve "$cli other"
+    approve "$cli other --help"
 
 # ...more tests...