Merge pull request #563 from DannyBen/add/command-variables

Add `command.variables` as a convenience utility for defining global command variables

Author: DannyBen

examples/variables/.gitignore

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

examples/variables/README.md

@@ -0,0 +1,113 @@
+# Variables Example
+
+Demonstrates how to define variables from the bashly.yml configuration.
+
+This example was generated with:
+
+```bash
+$ bashly init
+# ... now edit src/bashly.yml to match the example ...
+# ... now edit src/download_command.sh to match the example ...
+# ... now edit src/compress_command.sh to match the example ...
+$ bashly generate
+```
+
+<!-- include: src/download_command.sh src/compress_command.sh -->
+
+-----
+
+## `bashly.yml`
+
+````yaml
+name: cli
+help: Sample application demonstrating the use of variables
+version: 0.1.0
+
+# The `build_number` variable will be available globally
+variables:
+- name: build_number
+  value: 1337
+
+commands:
+- name: download
+  alias: d
+  help: Download a profile
+
+  args:
+  - name: profile
+    required: true
+    help: Profile to download information from
+
+  # These variables will be declared when the `download` command is executed.
+  # Note the use of an array value.
+  variables:
+  - name: output_folder
+    value: output
+  - name: download_sources
+    value:
+    - youtube
+    - instagram
+
+- name: compress
+  alias: c
+  help: Compress data
+
+  # These variables will be declared when the `compress` command is executed.
+  # Note the use of an associative array value.
+  variables:
+  - name: zip_options
+    value:
+      pattern: "*.json"
+      compression_level: fast
+````
+
+## `src/download_command.sh`
+
+````bash
+echo "build_number: $build_number"
+echo "output_folder: $output_folder"
+echo "download_sources:"
+for value in "${download_sources[@]}"; do
+  echo "- $value"
+done
+````
+
+## `src/compress_command.sh`
+
+````bash
+echo "build_number: $build_number"
+echo "zip_options:"
+for key in "${!zip_options[@]}"; do
+  echo "  $key: ${zip_options[$key]}"
+done
+
+````
+
+
+## Output
+
+### `$ ./cli download something`
+
+````shell
+build_number: 1337
+output_folder: output
+download_sources:
+- youtube
+- instagram
+
+
+````
+
+### `$ ./cli compress`
+
+````shell
+build_number: 1337
+zip_options:
+  compression_level: fast
+  pattern: *.json
+
+
+````
+
+
+

examples/variables/src/bashly.yml

@@ -0,0 +1,40 @@
+name: cli
+help: Sample application demonstrating the use of variables
+version: 0.1.0
+
+# The `build_number` variable will be available globally
+variables:
+- name: build_number
+  value: 1337
+
+commands:
+- name: download
+  alias: d
+  help: Download a profile
+
+  args:
+  - name: profile
+    required: true
+    help: Profile to download information from
+
+  # These variables will be declared when the `download` command is executed.
+  # Note the use of an array value.
+  variables:
+  - name: output_folder
+    value: output
+  - name: download_sources
+    value:
+    - youtube
+    - instagram
+
+- name: compress
+  alias: c
+  help: Compress data
+
+  # These variables will be declared when the `compress` command is executed.
+  # Note the use of an associative array value.
+  variables:
+  - name: zip_options
+    value:
+      pattern: "*.json"
+      compression_level: fast

examples/variables/src/compress_command.sh

@@ -0,0 +1,5 @@
+echo "build_number: $build_number"
+echo "zip_options:"
+for key in "${!zip_options[@]}"; do
+  echo "  $key: ${zip_options[$key]}"
+done

examples/variables/src/download_command.sh

@@ -0,0 +1,6 @@
+echo "build_number: $build_number"
+echo "output_folder: $output_folder"
+echo "download_sources:"
+for value in "${download_sources[@]}"; do
+  echo "- $value"
+done

examples/variables/test.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./cli download something
+./cli compress

lib/bashly/config_validator.rb

@@ -24,7 +24,7 @@ def assert_version(key, value)
     def assert_catch_all(key, value)
       return unless value
 
-      assert [TrueClass, String, Hash].include?(value.class),
+      assert [TrueClass, FalseClass, String, Hash].include?(value.class),
         "#{key} must be a boolean, a string or a hash"
 
       assert_catch_all_hash key, value if value.is_a? Hash
@@ -77,7 +77,7 @@ def assert_dependency(key, value)
     def assert_extensible(key, value)
       return unless value
 
-      assert [TrueClass, String].include?(value.class),
+      assert [TrueClass, FalseClass, String].include?(value.class),
         "#{key} must be a boolean or a string"
     end
 
@@ -173,6 +173,11 @@ def assert_env_var(key, value)
       refute value['required'] && value['default'], "#{key} cannot have both nub`required` and nub`default`"
     end
 
+    def assert_var(key, value)
+      assert_hash key, value, keys: %i[name value]
+      assert_string "#{key}.name", value['name']
+    end
+
     def assert_command(key, value)
       assert_hash key, value, keys: Script::Command.option_keys
 
@@ -207,6 +212,7 @@ def assert_command(key, value)
       assert_array "#{key}.completions", value['completions'], of: :string
       assert_array "#{key}.filters", value['filters'], of: :string
       assert_array "#{key}.environment_variables", value['environment_variables'], of: :env_var
+      assert_array "#{key}.variables", value['variables'], of: :var
 
       assert_uniq "#{key}.commands", value['commands'], %w[name alias]
       assert_uniq "#{key}.flags", value['flags'], 'long'

lib/bashly/docs/command.yml

@@ -309,6 +309,28 @@ command.private:
       help: Send bash completions
       private: true
 
+command.variables:
+  help: Define a list of global bash variables.
+  url: https://bashly.dannyb.co/configuration/command/#variables
+  example: |-
+    variables:
+    # Simple value
+    - name: output_folder
+      value: output
+
+    # Array
+    - name: download_sources
+      value:
+      - youtube
+      - instagram
+
+    # Associative array
+    - name: zip_options
+      value:
+        pattern: "*.json"
+        compression_level: fast
+
+
 command.version:
   help: Specify the version to show when running with `--version`.
   url: https://bashly.dannyb.co/configuration/command/#version

lib/bashly/script/command.rb

@@ -17,7 +17,7 @@ def option_keys
             default dependencies environment_variables examples
             extensible expose filename filters flags
             footer function group help name
-            private version
+            private variables version
           ]
         end
       end

lib/bashly/views/command/function.gtx

@@ -1,6 +1,7 @@
 = view_marker
 
 > {{ function_name }}_command() {
+= render(:variables).indent(2) if variables&.any?
 = load_user_file(filename).indent 2
 > }
 >