Merge pull request #175 from DannyBen/add/filters

Add custom command filters

Author: DannyBen

examples/filters/.gitignore

@@ -0,0 +1 @@
+cli

examples/filters/README.md

@@ -0,0 +1,94 @@
+# Filters Example
+
+Demonstrates the use of filters that run before a command, and possibly halt
+its execution.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+# ... now edit src/lib/filter_docker_running.sh to match the example ...
+# ... now edit src/lib/filter_redis_running.sh to match the example ...
+$ bashly generate
+```
+
+<!-- include: src/lib/filter_docker_running.sh src/lib/filter_redis_running.sh -->
+
+---
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: cli
+help: Sample application
+version: 0.1.0
+
+commands:
+- name: container
+  help: Perform actions on a docker container
+
+  # The filters option can be a string or an array of strings.
+  # When the command is executed, your script will look for a function named
+  # "filter_docker_running" and execute it. If it prints a string, it will be
+  # considered an error and the command execution will be halted.
+  filters: docker_running
+
+  args:
+  - name: id
+    required: true
+    help: Container ID
+
+- name: redis
+  help: Perform actions in redis
+  filters: [docker_running, redis_running]
+```
+
+## `src/lib/filter_docker_running.sh`
+
+```bash
+# Print an error string if docker is not running.
+# The script will automatically exit if this function prints anything.
+filter_docker_running() {
+  docker info > /dev/null 2>&1 || echo "Docker must be running"
+}
+
+```
+
+## `src/lib/filter_redis_running.sh`
+
+```bash
+# This is just a sample filter designed to always fail
+filter_redis_running() {
+  echo "Redis must be running (fake)"
+}
+
+```
+
+
+## Generated script output
+
+### `$ ./cli container sample-id`
+
+```shell
+# this file is located in 'src/container_command.sh'
+# code for 'cli container' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[id]} = sample-id
+
+
+```
+
+### `$ ./cli redis`
+
+```shell
+Redis must be running (fake)
+
+
+```
+
+
+

examples/filters/src/bashly.yml

@@ -0,0 +1,22 @@
+name: cli
+help: Sample application
+version: 0.1.0
+
+commands:
+- name: container
+  help: Perform actions on a docker container
+
+  # The filters option can be a string or an array of strings.
+  # When the command is executed, your script will look for a function named
+  # "filter_docker_running" and execute it. If it prints a string, it will be
+  # considered an error and the command execution will be halted.
+  filters: docker_running
+
+  args:
+  - name: id
+    required: true
+    help: Container ID
+
+- name: redis
+  help: Perform actions in redis
+  filters: [docker_running, redis_running]

examples/filters/src/container_command.sh

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

examples/filters/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/filters/src/lib/filter_docker_running.sh

@@ -0,0 +1,5 @@
+# Print an error string if docker is not running.
+# The script will automatically exit if this function prints anything.
+filter_docker_running() {
+  docker info > /dev/null 2>&1 || echo "Docker must be running"
+}

examples/filters/src/lib/filter_redis_running.sh

@@ -0,0 +1,4 @@
+# This is just a sample filter designed to always fail
+filter_redis_running() {
+  echo "Redis must be running (fake)"
+}

examples/filters/src/redis_command.sh

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

examples/filters/test.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./cli container sample-id
+./cli redis

lib/bashly/config_validator.rb

@@ -72,6 +72,14 @@ def assert_extensible(key, value)
         "#{key} must be a boolean or a string" 
     end
 
+    def assert_filters(key, value)
+      return unless value
+      assert [Array, String].include?(value.class),
+        "#{key} must be an array or a string" 
+
+      assert_array key, value, of: :string if value.is_a? Array
+    end
+
     def assert_arg(key, value)
       assert_hash key, value
       assert_string "#{key}.name", value['name']
@@ -129,6 +137,7 @@ def assert_command(key, value)
       assert_version "#{key}.version", value['version']
       assert_catch_all "#{key}.catch_all", value['catch_all']
       assert_extensible "#{key}.extensible", value['extensible']
+      assert_filters "#{key}.filters", value['filters']
 
       assert_array "#{key}.args", value['args'], of: :arg
       assert_array "#{key}.flags", value['flags'] , of: :flag