- Add optional arg/flag validation functions

Author: DannyBen

lib/bashly/models/argument.rb

@@ -4,6 +4,15 @@ class Argument < Base
       def usage_string
         required ? name.upcase : "[#{name.upcase}]"
       end
+
+      def validations
+        return [] unless options['validate']
+        if options['validate'].is_a? String
+          [options['validate']]
+        else
+          options['validate']
+        end
+      end
     end
   end
 end

lib/bashly/models/base.rb

@@ -25,6 +25,7 @@ class Base
         parent_name
         required
         short
+        validate
         version
       ]
 

lib/bashly/models/flag.rb

@@ -21,6 +21,15 @@ def usage_string(extended: false)
         result << strings[:required] if required and extended
         result.join " "
       end
+
+      def validations
+        return [] unless options['validate']
+        if options['validate'].is_a? String
+          [options['validate']]
+        else
+          options['validate']
+        end
+      end
     end
   end
 end

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: %s"

lib/bashly/views/argument/validations.erb

@@ -0,0 +1,6 @@
+% validations.each do |validation_function|
+if [[ -n $(validate_<%= validation_function %> "$1") ]]; then
+  printf "<%= strings[:validation_error] %>\n" "<%= name.upcase %> $(validate_<%= validation_function %> "$1")"
+  exit 1
+fi
+% end

lib/bashly/views/command/parse_requirements_case.erb

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

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
+<%= arg.render(:validations).indent 2 %>
   args[<%= arg.name %>]=$1
   shift
 else

lib/bashly/views/flag/case.erb

@@ -2,6 +2,7 @@
 <%= aliases.join " | " %> )
 % if arg
   if [[ $2 ]]; then
+<%= render(:validations).indent 4 %>
     args[<%= name %>]="$2"
     shift
     shift

lib/bashly/views/flag/validations.erb

@@ -0,0 +1,6 @@
+% validations.each do |validation_function|
+if [[ -n $(validate_<%= validation_function %> "$2") ]]; then
+  printf "<%= strings[:validation_error] %>\n" "<%= usage_string %> $(validate_<%= validation_function %> "$2")"
+  exit 1
+fi
+% end

spec/fixtures/workspaces/flag-args-with-dash/argflag

@@ -143,6 +143,7 @@ parse_requirements() {
     # :flag.case
     --options | -o )
       if [[ $2 ]]; then
+
         args[--options]="$2"
         shift
         shift