bashly 0.6.5 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b02a163470ebeb4c59a97f475b40b760477d36df16189addb48049b11b8842a
-  data.tar.gz: 625b89b6a09fc59f6a4a19fceaf05f645dec0c45cc33cda3a445fe123f43dbb6
+  metadata.gz: c76c3000789b54fa2d9be8f7a61d93556e6a8665f4ea7769588797a25fa78f49
+  data.tar.gz: a5a0eae36b00cf879082836211f2aa21b38b280993e2dccfc907f3e6fcb99104
 SHA512:
-  metadata.gz: 6e2bd2c31ab003d916efa2590e8571b7cbf3b6e88c3cee9122f5bc24d57b9624e52d7589bffdf2604132d55b040ff735effc02d49e4b6a8479817122ce98f612
-  data.tar.gz: 8fe5d95ea5061d88fb0b0da02266b69ed6530379d3e030d5f71fd1edf8bd97c3690ea82a89c36bb55a27790363ccd52be4de9e4aa1ba5ae07cb0c8ce87b8fd89
+  metadata.gz: ae77cd9b8fa000d9e12f2948fb5c41bd02e34bd6bdcdd91f3a3a627778f66c9472e956e92fb65b502fa78fe2e77ba6c4dfb12c1f35abed36f1012ce502b7cab9
+  data.tar.gz: 5e14659441abf6b11ca53a5d0d656e5097519acc7a2e842f3cdfb6374fd52a0403c6ddeacf4f193da1ab18687de909b074e4d581ce4700c9fc28e2b589ef961d

data/README.md

@@ -40,7 +40,7 @@ a [docker image](https://hub.docker.com/r/dannyben/bashly).
    file for you ([example](https://github.com/DannyBen/bashly/tree/master/examples/minimal#bashlyyml)).
 2. Bashly then automatically generates a bash script (when you run
    `bashly generate`) that can parse and validate user input, provide help
-   messages, and run your code for each command ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/download)).
+   messages, and run your code for each command.
 3. Your code for each command is kept in a separate file, and can be merged
    again if you change it ([example](https://github.com/DannyBen/bashly/blob/master/examples/minimal/src/root_command.sh)).
 
@@ -67,11 +67,13 @@ Bashly is responsible for:
 ## Contributing / Support
 
 If you experience any issue, have a question or a suggestion, or if you wish
-to contribute, feel free to [open an issue][issues].
+to contribute, feel free to [open an issue][issues] or
+[start a discussion][discussions].
 
 
 
 [issues]: https://github.com/DannyBen/bashly/issues
+[discussions]: https://github.com/DannyBen/bashly/discussions
 [docs]: https://bashly.dannyb.co/
 [examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
 

data/lib/bashly/commands/add.rb

@@ -8,6 +8,7 @@ module Bashly
       usage "bashly add config [--force]"
       usage "bashly add colors [--force]"
       usage "bashly add yaml [--force]"
+      usage "bashly add validations [--force]"
       usage "bashly add comp FORMAT [OUTPUT]"
       usage "bashly add (-h|--help)"
 
@@ -21,6 +22,7 @@ module Bashly
       command "config", "Add standard functions for handling INI files to the lib directory."
       command "colors", "Add standard functions for printing colorful and formatted text to the lib directory."
       command "yaml", "Add standard functions for reading YAML files to the lib directory."
+      command "validations", "Add argument validation functions to the lib directory."
       command "comp", "Generate a bash completions script or function."
 
       example "bashly add strings --force"
@@ -34,19 +36,23 @@ module Bashly
       end
 
       def lib_command
-        safe_copy_lib "sample_function.sh"
+        safe_copy_file "sample_function.sh"
       end
 
       def config_command
-        safe_copy_lib "config.sh"
+        safe_copy_file "config.sh"
       end
 
       def colors_command
-        safe_copy_lib "colors.sh"
+        safe_copy_file "colors.sh"
       end
 
       def yaml_command
-        safe_copy_lib "yaml.sh"
+        safe_copy_file "yaml.sh"
+      end
+
+      def validations_command
+        safe_copy_dir "validations"
       end
 
       def comp_command
@@ -68,8 +74,14 @@ module Bashly
 
     private
 
-      def safe_copy_lib(libfile)
-        safe_copy asset("templates/lib/#{libfile}"), "#{Settings.source_dir}/lib/#{libfile}"
+      def safe_copy_dir(dir)
+        Dir[asset("templates/lib/#{dir}/*.sh")].sort.each do |file|
+          safe_copy_file "#{dir}/#{File.basename file}"
+        end
+      end
+
+      def safe_copy_file(file)
+        safe_copy asset("templates/lib/#{file}"), "#{Settings.source_dir}/lib/#{file}"
       end
 
       def safe_copy(source, target)

data/lib/bashly/commands/generate.rb

@@ -3,11 +3,12 @@ module Bashly
     class Generate < Base
       help "Generate the bash script and required files"
 
-      usage "bashly generate [--force --wrap FUNCTION]"
+      usage "bashly generate [--force --quiet --wrap FUNCTION]"
       usage "bashly generate (-h|--help)"
 
       option "-f --force", "Overwrite existing files"
       option "-w --wrap FUNCTION", "Wrap the entire script in a function so it can also be sourced"
+      option "-q --quiet", "Disable on-screen progress report"
 
       environment "BASHLY_SOURCE_DIR", "The path containing the bashly configuration and source files [default: src]"
       environment "BASHLY_TARGET_DIR", "The path to use for creating the bash script [default: .]"
@@ -18,13 +19,17 @@ module Bashly
       def run
         create_user_files
         create_master_script
-        say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
+        quiet_say "run !txtpur!#{master_script_path} --help!txtrst! to test your bash script"
       end
 
     private
 
+      def quiet_say(message)
+        say message unless args['--quiet']
+      end
+
       def create_user_files
-        say "creating user files in !txtgrn!#{Settings.source_dir}"
+        quiet_say "creating user files in !txtgrn!#{Settings.source_dir}"
 
         create_file "#{Settings.source_dir}/initialize.sh", command.render(:default_initialize_script)
 
@@ -50,17 +55,17 @@ module Bashly
 
       def create_file(file, content)
         if File.exist? file and !args['--force']
-          say "skipped !txtgrn!#{file}!txtrst! (exists)"
+          quiet_say "skipped !txtgrn!#{file}!txtrst! (exists)"
         else
           File.write file, content
-          say "created !txtgrn!#{file}"
+          quiet_say "created !txtgrn!#{file}"
         end
       end
 
       def create_master_script
         File.write master_script_path, script.code
         FileUtils.chmod "+x", master_script_path
-        say "created !txtgrn!#{master_script_path}"
+        quiet_say "created !txtgrn!#{master_script_path}"
       end
 
       def script

data/lib/bashly/concerns/completions.rb

@@ -31,12 +31,16 @@ module Bashly
       flags.map(&:name) + flags.map(&:short)
     end
 
+    def completion_allowed_args
+      flags.map(&:allowed).flatten + args.map(&:allowed).flatten
+    end
+
     def completion_words(with_version: false)
       trivial_flags = %w[--help -h]
       trivial_flags += %w[--version -v] if with_version
       all = (
         command_names + trivial_flags +
-        completion_flag_names
+        completion_flag_names + completion_allowed_args
       )
 
       all += completions if completions

data/lib/bashly/extensions/string.rb

@@ -24,7 +24,7 @@ class String
   end
 
   def lint
-    gsub(/\n{2,}/, "\n\n")
+    gsub(/\s+\n/m, "\n\n")
   end
 
 end

data/lib/bashly/models/base.rb

@@ -25,6 +25,7 @@ module Bashly
         parent_name
         required
         short
+        validate
         version
       ]
 

data/lib/bashly/models/command.rb

@@ -209,7 +209,7 @@ module Bashly
       # This is meant to provide the user with the ability to add custom
       # functions
       def user_lib
-        @user_lib ||= Dir["#{Settings.source_dir}/lib/**/*.sh"]
+        @user_lib ||= Dir["#{Settings.source_dir}/lib/**/*.sh"].sort
       end
 
       # Raise an exception if there are some serious issues with the command
@@ -238,4 +238,4 @@ module Bashly
 
     end
   end
-end
+end

data/lib/bashly/models/script.rb

@@ -22,12 +22,30 @@ module Bashly
     private
 
       def header
-        @header ||= render('header')
+        @header ||= header!
+      end
+
+      def header!
+        if File.exist? custom_header_path
+          File.read custom_header_path
+        else
+          default_header
+        end
+      end
+
+      def default_header
+        result = render('header')
+        result += render('bash3_bouncer') unless function_name
+        result
       end
 
       def body
         @body ||= command.render('master_script')
       end
+
+      def custom_header_path
+        @custom_header_path ||= "#{Settings.source_dir}/header.sh"
+      end
     end
   end
 end

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

@@ -4,29 +4,42 @@
 #
 # 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/
+#
 # ---
 
-red() { printf "\e[31m%b\e[0m\n" "$*"; }
-green() { printf "\e[32m%b\e[0m\n" "$*"; }
-yellow() { printf "\e[33m%b\e[0m\n" "$*"; }
-blue() { printf "\e[34m%b\e[0m\n" "$*"; }
-magenta() { printf "\e[35m%b\e[0m\n" "$*"; }
-cyan() { printf "\e[36m%b\e[0m\n" "$*"; }
-bold() { printf "\e[1m%b\e[0m\n" "$*"; }
-underlined() { printf "\e[4m%b\e[0m\n" "$*"; }
-red_bold() { printf "\e[1;31m%b\e[0m\n" "$*"; }
-green_bold() { printf "\e[1;32m%b\e[0m\n" "$*"; }
-yellow_bold() { printf "\e[1;33m%b\e[0m\n" "$*"; }
-blue_bold() { printf "\e[1;34m%b\e[0m\n" "$*"; }
-magenta_bold() { printf "\e[1;35m%b\e[0m\n" "$*"; }
-cyan_bold() { printf "\e[1;36m%b\e[0m\n" "$*"; }
-red_underlined() { printf "\e[4;31m%b\e[0m\n" "$*"; }
-green_underlined() { printf "\e[4;32m%b\e[0m\n" "$*"; }
-yellow_underlined() { printf "\e[4;33m%b\e[0m\n" "$*"; }
-blue_underlined() { printf "\e[4;34m%b\e[0m\n" "$*"; }
-magenta_underlined() { printf "\e[4;35m%b\e[0m\n" "$*"; }
-cyan_underlined() { printf "\e[4;36m%b\e[0m\n" "$*"; }
+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" "$*"; }

data/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]}"

data/lib/bashly/templates/lib/validations/validate_dir_exists.sh

@@ -0,0 +1,3 @@
+validate_dir_exists() {
+  [[ -d "$1" ]] || echo "must be an existing directory"
+}

data/lib/bashly/templates/lib/validations/validate_file_exists.sh

@@ -0,0 +1,3 @@
+validate_file_exists() {
+  [[ -f "$1" ]] || echo "must be an existing file"
+}

data/lib/bashly/templates/lib/validations/validate_integer.sh

@@ -0,0 +1,3 @@
+validate_integer() {
+  [[ "$1" =~ ^[0-9]+$ ]] || echo "must be an integer"
+}

data/lib/bashly/templates/lib/validations/validate_not_empty.sh

@@ -0,0 +1,3 @@
+validate_not_empty() {
+  [[ -z "$1" ]] && echo "must not be empty"
+}

data/lib/bashly/templates/strings.yml

@@ -32,3 +32,4 @@ missing_dependency: "missing dependency: %{dependency}"
 disallowed_flag: "%{name} must be one of: %{allowed}"
 disallowed_argument: "%{name} must be one of: %{allowed}"
 unsupported_bash_version: "bash version 4 or higher is required"
+validation_error: "validation error in %s:\\n%s"

data/lib/bashly/version.rb

@@ -1,3 +1,3 @@
 module Bashly
-  VERSION = "0.6.5"
+  VERSION = "0.6.9"
 end

data/lib/bashly/views/argument/validations.erb

@@ -0,0 +1,8 @@
+# :argument.validations
+% if validate
+if [[ -n $(validate_<%= validate %> "$1") ]]; then
+  printf "<%= strings[:validation_error] %>\n" "<%= name.upcase %>" "$(validate_<%= validate %> "$1")"
+  exit 1
+fi
+
+% end

data/lib/bashly/views/command/initialize.erb

@@ -4,10 +4,5 @@ initialize() {
   long_usage=''
   set -e
 
-  if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
-    printf "<%= strings[:unsupported_bash_version] -%>\n"
-    exit 1
-  fi
-
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

data/lib/bashly/views/command/master_script.erb

@@ -1,6 +1,7 @@
 <%= render :root_command if commands.empty? %>
 <%= render :version_command %>
 <%= render :usage %>
+<%= render :normalize_input %>
 <%= render :inspect_args %>
 <%= render :user_lib if user_lib.any? %>
 <%= render :command_functions %>

data/lib/bashly/views/command/normalize_input.erb

@@ -0,0 +1,24 @@
+# :command.normalize_input
+normalize_input() {
+  local arg flags
+
+  while [[ $# -gt 0 ]]; do
+    arg="$1"
+    if [[ $arg =~ ^(--[a-zA-Z0-9_\-]+)=(.+)$ ]]; then
+      input+=("${BASH_REMATCH[1]}")
+      input+=("${BASH_REMATCH[2]}")
+    elif [[ $arg =~ ^(-[a-zA-Z0-9])=(.+)$ ]]; then
+      input+=("${BASH_REMATCH[1]}")
+      input+=("${BASH_REMATCH[2]}")
+    elif [[ $arg =~ ^-([a-zA-Z0-9][a-zA-Z0-9]+)$ ]]; then
+      flags="${BASH_REMATCH[1]}"
+      for (( i=0 ; i < ${#flags} ; i++ )); do
+        input+=("-${flags:i:1}")
+      done
+    else
+      input+=("$arg")
+    fi
+
+    shift
+  done
+}

data/lib/bashly/views/command/parse_requirements_case.erb

@@ -2,7 +2,8 @@
 % if args.any?
 % condition = "if"
 % args.each do |arg|
-<%= condition %> [[ ! ${args[<%= arg.name %>]} ]]; then
+<%= condition %> [[ -z ${args[<%= arg.name %>]+x} ]]; then
+<%= arg.render(:validations).indent 2 %>
   args[<%= arg.name %>]=$1
   shift
 % condition = "elif"

data/lib/bashly/views/command/required_args_filter.erb

@@ -1,6 +1,7 @@
 # :command.required_args_filter
 % required_args.each do |arg|
-if [[ $1 && $1 != -* ]]; then
+if [[ -n ${1+x} && $1 != -* ]]; then
+<%= arg.render(:validations).indent 2 %>
   args[<%= arg.name %>]=$1
   shift
 else

data/lib/bashly/views/command/run.erb

@@ -2,7 +2,9 @@
 run() {
   declare -A args
   declare -a other_args
-  parse_requirements "$@"
+  declare -a input
+  normalize_input "$@"
+  parse_requirements "${input[@]}"
 
   <%- condition = "if" -%>
   <%- deep_commands.each do |command| -%>

data/lib/bashly/views/flag/case.erb

@@ -1,7 +1,8 @@
 # :flag.case
 <%= aliases.join " | " %> )
 % if arg
-  if [[ $2 ]]; then
+  if [[ -n ${2+x} ]]; then
+<%= render(:validations).indent 4 %>
     args[<%= name %>]="$2"
     shift
     shift

data/lib/bashly/views/flag/validations.erb

@@ -0,0 +1,8 @@
+# :flag.validations
+% if validate
+if [[ -n $(validate_<%= validate %> "$2") ]]; then
+  printf "<%= strings[:validation_error] %>\n" "<%= usage_string %>" "$(validate_<%= validate %> "$2")"
+  exit 1
+fi
+
+% end

data/lib/bashly/views/script/bash3_bouncer.erb

@@ -0,0 +1,5 @@
+# :script.bash3_bouncer
+if [[ "${BASH_VERSINFO:-0}" -lt 4 ]]; then
+  printf "<%= strings[:unsupported_bash_version] -%>\n"
+  exit 1
+fi

data/lib/bashly/views/script/header.erb

@@ -1,3 +1,4 @@
 #!/usr/bin/env bash
 # This script was generated by bashly (https://github.com/DannyBen/bashly)
 # Modifying it manually is not recommended
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.5
+  version: 0.6.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-03 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -101,11 +101,16 @@ files:
 - lib/bashly/templates/lib/colors.sh
 - lib/bashly/templates/lib/config.sh
 - lib/bashly/templates/lib/sample_function.sh
+- lib/bashly/templates/lib/validations/validate_dir_exists.sh
+- lib/bashly/templates/lib/validations/validate_file_exists.sh
+- lib/bashly/templates/lib/validations/validate_integer.sh
+- lib/bashly/templates/lib/validations/validate_not_empty.sh
 - lib/bashly/templates/lib/yaml.sh
 - lib/bashly/templates/minimal.yml
 - lib/bashly/templates/strings.yml
 - lib/bashly/version.rb
 - lib/bashly/views/argument/usage.erb
+- lib/bashly/views/argument/validations.erb
 - lib/bashly/views/command/catch_all_filter.erb
 - lib/bashly/views/command/command_fallback.erb
 - lib/bashly/views/command/command_filter.erb
@@ -122,6 +127,7 @@ files:
 - lib/bashly/views/command/initialize.erb
 - lib/bashly/views/command/inspect_args.erb
 - lib/bashly/views/command/master_script.erb
+- lib/bashly/views/command/normalize_input.erb
 - lib/bashly/views/command/parse_requirements.erb
 - lib/bashly/views/command/parse_requirements_case.erb
 - lib/bashly/views/command/parse_requirements_while.erb
@@ -142,6 +148,8 @@ files:
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
 - lib/bashly/views/flag/usage.erb
+- lib/bashly/views/flag/validations.erb
+- lib/bashly/views/script/bash3_bouncer.erb
 - lib/bashly/views/script/header.erb
 - lib/bashly/views/script/wrapper.erb
 homepage: https://github.com/dannyben/bashly