bashly 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f0b22d0ac9bf41f91fed37e60996fa5175346a9e2e5e56158b760ededfef2a0
-  data.tar.gz: 39ffcd5e199b6b79fd04a4bd38e93d4703ad7aebce0ec4970b8250280112c5db
+  metadata.gz: c76c3000789b54fa2d9be8f7a61d93556e6a8665f4ea7769588797a25fa78f49
+  data.tar.gz: a5a0eae36b00cf879082836211f2aa21b38b280993e2dccfc907f3e6fcb99104
 SHA512:
-  metadata.gz: fd57501ae8a6fc8b3072320dc7358b2097ef9b280b5e8b80efa52155c91a9fe56abbb73821ffc2b8a8a8e55caf7a61dd46ef29d8c88f49b2232cddfccff77a32
-  data.tar.gz: 83f7293f9b543d6330daedf6421678b3c321166751708dba0985d7aa18a9191510a3832bd2ac8d2a3510b09f9eb2064403798b38894c7227a63f8c86f52f04dc
+  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/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/models/base.rb

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

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/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.8"
+  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/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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bashly
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-12 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
@@ -143,6 +148,7 @@ 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