remove support for string value in filters

Author: DannyBen

examples/filters/README.md

@@ -8,14 +8,11 @@ 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 ...
+# ... now edit src/lib/filters.sh to match the example ...
 $ bashly generate
 ```
 
-<!-- include: src/lib/filter_docker_running.sh src/lib/filter_redis_running.sh -->
-
----
+<!-- include: src/lib/filters.sh -->
 
 -----
 
@@ -30,11 +27,11 @@ 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
+  filters:
+  - docker_running
 
   args:
   - name: id
@@ -43,26 +40,30 @@ commands:
 
 - name: redis
   help: Perform actions in redis
-  filters: [docker_running, redis_running]
+  
+  # When multiple filters are present, the command will halt if any of them
+  # prints an error string.
+  filters:
+  - docker_running
+  - redis_running
 ```
 
-## `src/lib/filter_docker_running.sh`
+## `src/lib/filters.sh`
 
 ```bash
+# These filter functions can reside in any path under the `lib` directory.
+# You can use a single file for all filter functions, or a separate file
+# for each function.
+
 # 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)"
+  echo "Redis must be running (always fails)"
 }
 
 ```
@@ -85,7 +86,7 @@ args:
 ### `$ ./cli redis`
 
 ```shell
-Redis must be running (fake)
+Redis must be running (always fails)
 
 
 ```

examples/filters/src/bashly.yml

@@ -6,11 +6,11 @@ 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
+  filters:
+  - docker_running
 
   args:
   - name: id
@@ -19,4 +19,9 @@ commands:
 
 - name: redis
   help: Perform actions in redis
-  filters: [docker_running, redis_running]
+  
+  # When multiple filters are present, the command will halt if any of them
+  # prints an error string.
+  filters:
+  - docker_running
+  - redis_running

examples/filters/src/lib/filter_docker_running.sh

@@ -0,0 +1,14 @@
+# These filter functions can reside in any path under the `lib` directory.
+# You can use a single file for all filter functions, or a separate file
+# for each function.
+
+# 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"
+}
+
+# This is just a sample filter designed to always fail
+filter_redis_running() {
+  echo "Redis must be running (always fails)"
+}

examples/filters/src/lib/filter_redis_running.sh

@@ -72,14 +72,6 @@ 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']
@@ -137,13 +129,13 @@ 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
       assert_array "#{key}.commands", value['commands'], of: :command
       assert_array "#{key}.completions", value['completions'], of: :string
       assert_array "#{key}.dependencies", value['dependencies'], of: :string
+      assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
       assert_array "#{key}.examples", value['examples'], of: :string
     end

examples/filters/src/lib/filters.sh

@@ -58,13 +58,6 @@ def filename
         options["filename"] || "#{action_name.to_underscore}_command.sh"
       end
 
-      # Returns an array of filters
-      def filters
-        return nil unless options["filters"]
-        result = options["filters"]
-        result.is_a?(Array) ? result : [result]
-      end
-
       # Returns an array of Flags
       def flags
         return [] unless options["flags"]

lib/bashly/config_validator.rb

@@ -12,4 +12,4 @@ run ./cli --help to test your bash script
 args:
 - ${args[id]} = sample-id
 + ./cli redis
-Redis must be running (fake)
+Redis must be running (always fails)

lib/bashly/script/command.rb

@@ -1 +1 @@
-#<Bashly::ConfigurationError: root.filters must be an array or a string>
+#<Bashly::ConfigurationError: root.filters[0] must be a string>

spec/approvals/examples/filters

@@ -1 +1 @@
-#<Bashly::ConfigurationError: root.filters must be an array or a string>
+#<Bashly::ConfigurationError: root.filters must be an array>