Merge pull request #136 from DannyBen/add/validations

Add more custom validations

Author: DannyBen

examples/validations/.gitignore

@@ -1 +1 @@
-calc
+validate

examples/validations/README.md

@@ -22,103 +22,77 @@ failure, or an empty string on success.
 ## `bashly.yml`
 
 ```yaml
-name: calc
+name: validate
 help: Sample application demonstrating validations
 version: 0.1.0
 
 commands:
-- name: add
-  short: a
+- name: calc
   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.
+    # Specify a validation function.
+    # Bashly will look for a function named `validate_integer` in your
+    # script, you can use any name as long as it has a matching function.
     validate: integer
   - name: second
     help: Second number
-
-    # Using the array syntax, you can specify more than one validations
-    validate:
-      - integer
+    validate: integer
 
   flags:
-  - long: --multiply
-    short: -m
-    arg: factor
-    help: Multiply the result
+  - long: --save
+    arg: path
+    help: Save the result to a file
 
     # Validations also work on flags (when they have arguments)
-    validate: integer
+    validate: file_exists
 ```
 
 
 
 ## 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`
+### `$ ./validate calc 1 2 --save README.md`
 
 ```shell
-# this file is located in 'src/add_command.sh'
-# code for 'calc add' goes here
+# this file is located in 'src/calc_command.sh'
+# code for 'validate calc' goes here
 # you can edit it freely and regenerate (it will not be overwritten)
 args:
 - ${args[first]} = 1
-- ${args[--multiply]} = 3
+- ${args[--save]} = README.md
 - ${args[second]} = 2
 
 
 ```
 
-### `$ ./calc add A`
+### `$ ./validate calc A`
 
 ```shell
-validation error: FIRST must be an integer
+validation error in FIRST:
+must be an integer
 
 
 ```
 
-### `$ ./calc add 1 B`
+### `$ ./validate calc 1 B`
 
 ```shell
-validation error: SECOND must be an integer
+validation error in SECOND:
+must be an integer
 
 
 ```
 
-### `$ ./calc add 1 2 --multiply C`
+### `$ ./validate calc 1 2 --save no-such-file.txt`
 
 ```shell
-validation error: --multiply, -m FACTOR must be an integer
+validation error in --save PATH:
+must be an existing file
 
 
 ```

examples/validations/src/add_command.sh

@@ -1,33 +1,29 @@
-name: calc
+name: validate
 help: Sample application demonstrating validations
 version: 0.1.0
 
 commands:
-- name: add
-  short: a
+- name: calc
   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.
+    # Specify a validation function.
+    # Bashly will look for a function named `validate_integer` in your
+    # script, you can use any name as long as it has a matching function.
     validate: integer
   - name: second
     help: Second number
-
-    # Using the array syntax, you can specify more than one validations
-    validate:
-      - integer
+    validate: integer
 
   flags:
-  - long: --multiply
-    short: -m
-    arg: factor
-    help: Multiply the result
+  - long: --save
+    arg: path
+    help: Save the result to a file
 
     # Validations also work on flags (when they have arguments)
-    validate: integer
+    validate: file_exists
+

examples/validations/src/bashly.yml

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

examples/validations/src/calc_command.sh

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

examples/validations/src/lib/validations/validate_dir_exists.sh

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

examples/validations/src/lib/validations/validate_file_exists.sh

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

examples/validations/src/lib/validations/validate_not_empty.sh

@@ -5,15 +5,12 @@ rm -rf ./src/lib
 
 set -x
 
-bashly add validations
+bashly add validations --force
 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
-
-
+./validate calc 1 2 --save README.md
+./validate calc A
+./validate calc 1 B
+./validate calc 1 2 --save no-such-file.txt

examples/validations/test.sh

@@ -75,7 +75,7 @@ def comp_command
     private
 
       def safe_copy_dir(dir)
-        Dir[asset("templates/lib/#{dir}/*.sh")].each do |file|
+        Dir[asset("templates/lib/#{dir}/*.sh")].sort.each do |file|
           safe_copy_file "#{dir}/#{File.basename file}"
         end
       end