bashly 0.6.8 → 0.7.2

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

@@ -1,24 +1,23 @@
-# ---
-# Config functions
-# This file is a part of Bashly standard library
-#
-# Usage:
-# - In your script, set the CONFIG_FILE variable. For rxample:
-#   CONFIG_FILE=settings.ini.
-#   If it is unset, it will default to 'config.ini'.
-# - Use any of the functions below to access the config file.
-# ---
-
-# Create a new config file.
-# There is normally no need to use this function, it is used by other
-# functions as needed.
+## Config functions [@bashly-upgrade config]
+## This file is a part of Bashly standard library
+##
+## Usage:
+## - In your script, set the CONFIG_FILE variable. For rxample:
+##   CONFIG_FILE=settings.ini.
+##   If it is unset, it will default to 'config.ini'.
+## - Use any of the functions below to access the config file.
+##
+## Create a new config file.
+## There is normally no need to use this function, it is used by other
+## functions as needed.
+##
 config_init() {
   CONFIG_FILE=${CONFIG_FILE:=config.ini}
   [[ -f "$CONFIG_FILE" ]] || touch "$CONFIG_FILE"
 }
 
-# Get a value from the config.
-# Usage: result=$(config_get hello)
+## Get a value from the config.
+## Usage: result=$(config_get hello)
 config_get() {
   local key=$1
   local regex="^$key *= *(.+)$"
@@ -36,8 +35,8 @@ config_get() {
   echo "$value"
 }
 
-# Add or update a key=value pair in the config.
-# Usage: config_set key value
+## Add or update a key=value pair in the config.
+## Usage: config_set key value
 config_set() {
   local key=$1
   shift
@@ -68,8 +67,8 @@ config_set() {
   printf "%b\n" "$output" > "$CONFIG_FILE"
 }
 
-# Delete a key from the config.
-# Usage: config_del key
+## Delete a key from the config.
+## Usage: config_del key
 config_del() {
   local key=$1
 
@@ -87,19 +86,19 @@ config_del() {
   printf "%b\n" "$output" > "$CONFIG_FILE"
 }
 
-# Show the config file
+## Show the config file
 config_show() {
   config_init
   cat "$CONFIG_FILE"
 }
 
-# Return an array of the keys in the config file.
-# Usage:
-#
-#   for k in $(config_keys); do
-#     echo "- $k = $(config_get "$k")";
-#   done
-#
+## Return an array of the keys in the config file.
+## Usage:
+##
+##   for k in $(config_keys); do
+##     echo "- $k = $(config_get "$k")";
+##   done
+##
 config_keys() {
   local regex="^([a-zA-Z0-9_\-\/\.]+) *="
 
@@ -117,13 +116,13 @@ config_keys() {
   echo "${keys[@]}"
 }
 
-# Returns true if the specified key exists in the config file.
-# Usage:
-#
-#   if config_has_key "key" ; then
-#     echo "key exists"
-#   fi
-#
+## Returns true if the specified key exists in the config file.
+## Usage:
+##
+##   if config_has_key "key" ; then
+##     echo "key exists"
+##   fi
+##
 config_has_key() {
   [[ $(config_get "$1") ]]
 }

data/lib/bashly/templates/lib/sample_function.sh

@@ -1,13 +1,13 @@
-# Add any function here that is needed in more than one parts of your
-# application, or that you otherwise wish to extract from the main function
-# scripts.
-#
-# Note that code here should be wrapped inside bash functions, and it is
-# recommended to have a separate file for each function.
-#
-# Subdirectories will also be scanned for *.sh, so you have no reason not
-# to organize your code neatly.
-#
+## Add any function here that is needed in more than one parts of your
+## application, or that you otherwise wish to extract from the main function
+## scripts.
+##
+## Note that code here should be wrapped inside bash functions, and it is
+## recommended to have a separate file for each function.
+##
+## Subdirectories will also be scanned for *.sh, so you have no reason not
+## to organize your code neatly.
+##
 sample_function() {
   echo "it works"
 }

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

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_dir_exists() {
+  [[ -d "$1" ]] || echo "must be an existing directory"
+}

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

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_file_exists() {
+  [[ -f "$1" ]] || echo "must be an existing file"
+}

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

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

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

@@ -0,0 +1,4 @@
+## [@bashly-upgrade validations]
+validate_not_empty() {
+  [[ -z "$1" ]] && echo "must not be empty"
+}

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

@@ -1,18 +1,15 @@
-# ---
-# YAML parser
-# This file is a part of Bashly standard library
-# Does not support arrays, only hashes
-#
-# Source: https://stackoverflow.com/a/21189044/413924
-#
-# Usage:
-#
-#   yaml_load "settings.yml"             # print variables
-#   yaml_load "settings.yml" "config_"   # use prefix
-#   eval $(yaml_load "settings.yml")     # create variables in scope
-#
-# ---
-
+## YAML parser [@bashly-upgrade yaml]
+## This file is a part of Bashly standard library
+## Does not support arrays, only hashes
+##
+## Source: https://stackoverflow.com/a/21189044/413924
+##
+## Usage:
+##
+##   yaml_load "settings.yml"             # print variables
+##   yaml_load "settings.yml" "config_"   # use prefix
+##   eval $(yaml_load "settings.yml")     # create variables in scope
+##
 yaml_load() {
    local prefix=$2
    local s='[[:space:]]*' w='[a-zA-Z0-9_]*'

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.8"
+  VERSION = "0.7.2"
 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/catch_all_filter.erb

@@ -1,7 +1,7 @@
 # :command.catch_all_filter
-% if catch_all_required?
+% if catch_all.required?
 if [[ ${#other_args[@]} -eq 0 ]]; then
-  printf "<%= strings[:missing_required_argument] % { arg: catch_all_label, usage: usage_string } %>\n"
+  printf "<%= strings[:missing_required_argument] % { arg: catch_all.label, usage: usage_string } %>\n"
   exit 1
 fi
 % end

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

@@ -1,6 +1,6 @@
 # :command.command_filter
 % if commands.any?
-action=$1
+action=${1:-}
 
 case $action in
 -* )

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

@@ -1,7 +1,7 @@
 # :command.default_assignments
 % default_args.each do |arg|
-[[ -n ${args[<%= arg.name %>]} ]] || args[<%= arg.name %>]="<%= arg.default %>"
+[[ -n ${args[<%= arg.name %>]:-} ]] || args[<%= arg.name %>]="<%= arg.default %>"
 % end
 % default_flags.each do |flag|
-[[ -n ${args[<%= flag.long %>]} ]] || args[<%= flag.long %>]="<%= flag.default %>"
+[[ -n ${args[<%= flag.long %>]:-} ]] || args[<%= flag.long %>]="<%= flag.default %>"
 % end

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

@@ -1,6 +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 vairables:
-# CONFIG_FILE=settings.ini
-#
-# Feel free to empty (but not delete) this file.
+## Code here runs inside the initialize() function
+## Use it for anything that you need to run before any other function, like
+## setting environment vairables:
+## CONFIG_FILE=settings.ini
+##
+## Feel free to empty (but not delete) this file.

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

@@ -6,7 +6,7 @@ export <%= env_var.name.upcase %>="${<%= env_var.name.upcase %>:-<%= env_var.def
 % end
 % if required_environment_variables.any?
 % required_environment_variables.each do |env_var|
-if [[ -z "$<%= env_var.name.upcase %>" ]]; then
+if [[ -z "${<%= env_var.name.upcase %>:-}" ]]; then
   printf "<%= strings[:missing_required_environment_variable] % { var: env_var.name.upcase } %>\n"
   exit 1
 fi

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

@@ -1,5 +1,5 @@
 # :command.fixed_flag_filter
-case "$1" in
+case "${1:-}" in
 % if short_flag_exist? "-v"
 --version )
 % else

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

@@ -2,7 +2,7 @@
 initialize() {
   version="<%= version %>"
   long_usage=''
-  set -e
+  <%= ENV['BASHLY_STRICT'] ? "set -euo pipefail" : "set -e" %>
 
 <%= load_user_file("initialize.sh", placeholder: false).indent 2 %>
 }

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

@@ -8,9 +8,9 @@ parse_requirements() {
 <%= render(:environment_variables_filter).indent 2 %>
 <%= render(:dependencies_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
+<%= render(:parse_requirements_while).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>
 <%= render(:required_flags_filter).indent 2 %>
-<%= render(:parse_requirements_while).indent 2 %>
 <%= render(:catch_all_filter).indent 2 %>
 <%= render(:default_assignments).indent 2 %>
 <%= render(:whitelist_filter).indent 2 %>

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

@@ -2,13 +2,14 @@
 % 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"
 % end
 else
-% if catch_all
+% if catch_all.enabled?
   other_args+=("$1")
   shift
 % else
@@ -16,7 +17,7 @@ else
   exit 1
 % end
 fi
-% elsif catch_all
+% elsif catch_all.enabled?
   other_args+=("$1")
   shift
 % else

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

@@ -7,8 +7,8 @@ while [[ $# -gt 0 ]]; do
 
 % end
 
-  -* )
-% if catch_all
+  -?* )
+% if catch_all.enabled?
     other_args+=("$1")
     shift
     ;;

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

@@ -1,11 +1,7 @@
 # :command.required_args_filter
 % required_args.each do |arg|
-if [[ $1 && $1 != -* ]]; then
-  args[<%= arg.name %>]=$1
-  shift
-else
+if [[ -z ${args[<%= arg.name %>]+x} ]]; then
   printf "<%= strings[:missing_required_argument] % { arg: arg.name.upcase, usage: usage_string } %>\n"
   exit 1
 fi
-
 % end

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

@@ -1,9 +1,6 @@
 # :command.required_flags_filter
-% if required_flags.any?
-argstring="$*"
-% end
 % required_flags.each do |flag|
-if [[ <%= flag.aliases.map { |a| %Q["$argstring" != *#{a}*] }.join " && " %> ]]; then
+if [[ -z ${args[<%= flag.long %>]+x} ]]; then
   printf "<%= strings[:missing_required_flag] % { usage: flag.usage_string } %>\n"
   exit 1
 fi

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

@@ -1,15 +1,15 @@
 # :command.run
 run() {
-  declare -A args
-  declare -a other_args
-  declare -a input
+  declare -A args=()
+  declare -a other_args=()
+  declare -a input=()
   normalize_input "$@"
   parse_requirements "${input[@]}"
 
   <%- condition = "if" -%>
   <%- deep_commands.each do |command| -%>
   <%= condition %> [[ $action == "<%= command.action_name %>" ]]; then
-    if [[ ${args[--help]} ]]; then
+    if [[ ${args[--help]:-} ]]; then
       long_usage=yes
       <%= command.function_name %>_usage
     else

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

@@ -37,7 +37,7 @@
     printf "<%= strings[:options] %>\n"
 <%= render(:usage_fixed_flags).indent 4 %>
 <%= render(:usage_flags).indent 4 if flags.any? %>
-<%= render(:usage_args).indent 4 if args.any? or catch_all_help %>
+<%= render(:usage_args).indent 4 if args.any? or catch_all.help %>
 <%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
 <%= render(:footer).indent 4 if footer %>

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

@@ -6,9 +6,9 @@ printf "<%= strings[:arguments] %>\n"
 <%= arg.render(:usage) %>
 % end
 % end
-% if catch_all_help
+% if catch_all.help
 
-echo "  <%= catch_all_label %>"
-printf "<%= catch_all_help.wrap(76).indent(4).sanitize_for_print %>\n"
+echo "  <%= catch_all.label %>"
+printf "<%= catch_all.help.wrap(76).indent(4).sanitize_for_print %>\n"
 echo
 % end

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

@@ -3,7 +3,7 @@
 printf "<%= strings[:commands] %>\n"
 % end
 % maxlen = command_names.map(&:size).max
-% commands.each do |command|
+% commands.reject(&:private).each do |command|
 % summary = command.summary
 % summary = strings[:default_command_summary] % { summary: summary } if command.default
 % if command.group

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.rb

@@ -9,6 +9,8 @@ requires 'bashly/concerns'
 
 requires 'bashly/settings'
 requires 'bashly/exceptions'
-requires 'bashly/models/base'
+requires 'bashly/refinements'
+requires 'bashly/script/base'
 requires 'bashly/commands/base'
+requires 'bashly/libraries/base'
 requires 'bashly'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-12 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: mister_bin
   requirement: !ruby/object:Gem::Requirement
@@ -82,30 +82,48 @@ files:
 - lib/bashly/commands/generate.rb
 - lib/bashly/commands/init.rb
 - lib/bashly/commands/preview.rb
+- lib/bashly/commands/validate.rb
 - lib/bashly/concerns/asset_helper.rb
+- lib/bashly/concerns/command_scopes.rb
 - lib/bashly/concerns/completions.rb
 - lib/bashly/concerns/renderable.rb
 - lib/bashly/config.rb
+- lib/bashly/config_validator.rb
 - lib/bashly/exceptions.rb
 - lib/bashly/extensions/array.rb
+- lib/bashly/extensions/file.rb
 - lib/bashly/extensions/string.rb
+- lib/bashly/libraries.yml
+- lib/bashly/libraries/base.rb
+- lib/bashly/libraries/completions.rb
+- lib/bashly/libraries/completions_function.rb
+- lib/bashly/libraries/completions_script.rb
+- lib/bashly/libraries/completions_yaml.rb
+- lib/bashly/library.rb
 - lib/bashly/message_strings.rb
-- lib/bashly/models/argument.rb
-- lib/bashly/models/base.rb
-- lib/bashly/models/command.rb
-- lib/bashly/models/environment_variable.rb
-- lib/bashly/models/flag.rb
-- lib/bashly/models/script.rb
+- lib/bashly/refinements/compose_refinements.rb
+- lib/bashly/script/argument.rb
+- lib/bashly/script/base.rb
+- lib/bashly/script/catch_all.rb
+- lib/bashly/script/command.rb
+- lib/bashly/script/environment_variable.rb
+- lib/bashly/script/flag.rb
+- lib/bashly/script/wrapper.rb
 - lib/bashly/settings.rb
 - lib/bashly/templates/bashly.yml
 - 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
@@ -143,9 +161,10 @@ files:
 - lib/bashly/views/environment_variable/usage.erb
 - lib/bashly/views/flag/case.erb
 - lib/bashly/views/flag/usage.erb
-- lib/bashly/views/script/bash3_bouncer.erb
-- lib/bashly/views/script/header.erb
-- lib/bashly/views/script/wrapper.erb
+- lib/bashly/views/flag/validations.erb
+- lib/bashly/views/wrapper/bash3_bouncer.erb
+- lib/bashly/views/wrapper/header.erb
+- lib/bashly/views/wrapper/wrapper.erb
 homepage: https://github.com/dannyben/bashly
 licenses:
 - MIT
@@ -169,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.25
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: Bash Command Line Tool Generator