Merge pull request #130 from DannyBen/add/validations

Add optional arg/flag validation functions

Author: DannyBen

examples/README.md

@@ -43,3 +43,4 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [colors](colors#readme) - using the color print feature
 - [yaml](yaml#readme) - using the YAML reading functions
 - [completions](completions#readme) - adding bash completion functionality
+- [validations](validations#readme) - adding argument validation functions

examples/validations/.gitignore

@@ -0,0 +1 @@
+calc

examples/validations/README.md

@@ -0,0 +1,127 @@
+# Validations Example
+
+Demonstrates how to add validation functions to arguments and flag arguments.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+$ bashly add validations
+$ bashly generate
+```
+
+Running the `bashly add validations` command simply adds the
+[src/lib/validations](src/lib/validations) folder, which includes some built in
+validation functions. You can add custom function by adding a function that
+starts with `validate_`. Thee functions must return a string on validation
+failure, or an empty string on success.
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: calc
+help: Sample application demonstrating validations
+version: 0.1.0
+
+commands:
+- name: add
+  short: a
+  help: Add two numbers
+
+  args:
+  - name: first
+    help: First number
+    required: true
+
+    # Specify one or more validation types (as string or array)
+    # This validation will look for a function named `validate_integer` in your
+    # script.
+    validate: integer
+  - name: second
+    help: Second number
+
+    # Using the array syntax, you can specify more than one validations
+    validate:
+      - integer
+
+  flags:
+  - long: --multiply
+    short: -m
+    arg: factor
+    help: Multiply the result
+
+    # Validations also work on flags (when they have arguments)
+    validate: integer
+```
+
+
+
+## Generated script output
+
+### `$ ./calc -h`
+
+```shell
+calc - Sample application demonstrating validations
+
+Usage:
+  calc [command]
+  calc [command] --help | -h
+  calc --version | -v
+
+Commands:
+  add   Add two numbers
+
+Options:
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
+
+
+```
+
+### `$ ./calc add 1 2 --multiply 3`
+
+```shell
+# this file is located in 'src/add_command.sh'
+# code for 'calc add' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[first]} = 1
+- ${args[--multiply]} = 3
+- ${args[second]} = 2
+
+
+```
+
+### `$ ./calc add A`
+
+```shell
+validation error: FIRST must be an integer
+
+
+```
+
+### `$ ./calc add 1 B`
+
+```shell
+validation error: SECOND must be an integer
+
+
+```
+
+### `$ ./calc add 1 2 --multiply C`
+
+```shell
+validation error: --multiply, -m FACTOR must be an integer
+
+
+```
+
+
+

examples/validations/src/add_command.sh

@@ -0,0 +1,4 @@
+echo "# this file is located in 'src/add_command.sh'"
+echo "# code for 'calc add' goes here"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/validations/src/bashly.yml

@@ -0,0 +1,33 @@
+name: calc
+help: Sample application demonstrating validations
+version: 0.1.0
+
+commands:
+- name: add
+  short: a
+  help: Add two numbers
+
+  args:
+  - name: first
+    help: First number
+    required: true
+
+    # Specify one or more validation types (as string or array)
+    # This validation will look for a function named `validate_integer` in your
+    # script.
+    validate: integer
+  - name: second
+    help: Second number
+
+    # Using the array syntax, you can specify more than one validations
+    validate:
+      - integer
+
+  flags:
+  - long: --multiply
+    short: -m
+    arg: factor
+    help: Multiply the result
+
+    # Validations also work on flags (when they have arguments)
+    validate: integer

examples/validations/src/initialize.sh

@@ -0,0 +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.

examples/validations/src/lib/validations/validate_integer.sh

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

examples/validations/test.sh

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+rm -f ./src/*.sh
+rm -rf ./src/lib
+
+set -x
+
+bashly add validations
+bashly generate
+
+### Try Me ###
+
+./calc -h
+./calc add 1 2 --multiply 3
+./calc add A
+./calc add 1 B
+./calc add 1 2 --multiply C
+
+

lib/bashly/commands/add.rb

@@ -8,6 +8,7 @@ class Add < Base
       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 @@ class Add < Base
       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 @@ def strings_command
       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 @@ def comp_command
 
     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")].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)

lib/bashly/models/base.rb

@@ -25,6 +25,7 @@ class Base
         parent_name
         required
         short
+        validate
         version
       ]
 
@@ -46,6 +47,15 @@ def help
         options['help'] ||= ''
       end
 
+      def validations
+        return [] unless options['validate']
+        if options['validate'].is_a? String
+          [options['validate']]
+        else
+          options['validate']
+        end
+      end
+
       def method_missing(method_name, *arguments, &block)
         key = method_name.to_s
         respond_to?(method_name) ? options[key] : super