Merge pull request #87 from DannyBen/add/default-env-var-value

DannyBen · web-flow · commit e35d69592c14 · 2021-07-27T10:35:14.000+03:00
Add default option for environment variables
diff --git a/Runfile b/Runfile
@@ -83,7 +83,13 @@ class Example
   end
 
   def test_commands
-    File.read("#{dir}/test.sh").scan(/\.\/#{config['name']}.*/)
+    filename = "#{dir}/test.sh"
+    result = File.read(filename)
+      .split(/\s*### Try Me ###\s*/).last
+      .split("\n")
+      .reject { |line| line.empty? or line.start_with? '#' }
+    abort "Can't find ### Try Me ### marker in #{filename}" if result.empty?
+    result
   end
 
   def test_output
diff --git a/examples/catch-all-advanced/test.sh b/examples/catch-all-advanced/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli download -h
 ./cli download source
diff --git a/examples/catch-all/test.sh b/examples/catch-all/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./download
 ./download -h
 ./download something
diff --git a/examples/colors/test.sh b/examples/colors/test.sh
@@ -4,4 +4,6 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./colorly
diff --git a/examples/command-default/test.sh b/examples/command-default/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./ftp
 ./ftp -h
 ./ftp download something
diff --git a/examples/command-groups/test.sh b/examples/command-groups/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./ftp
 ./ftp -h
 ./ftp login
diff --git a/examples/commands-nested/test.sh b/examples/commands-nested/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli -h
 ./cli dir
diff --git a/examples/commands/test.sh b/examples/commands/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli -h
 ./cli --version
diff --git a/examples/completions/test.sh b/examples/completions/test.sh
@@ -5,6 +5,8 @@ set -x
 bashly add comp function
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli -h
 ./cli completions -h
diff --git a/examples/config-ini/test.sh b/examples/config-ini/test.sh
@@ -4,6 +4,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./configly -h
 ./configly set hello world
 ./configly set bashly works
diff --git a/examples/custom-includes/test.sh b/examples/custom-includes/test.sh
@@ -4,4 +4,6 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./download
diff --git a/examples/custom-strings/test.sh b/examples/custom-strings/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./download
 ./download -h
 ./download somesource
diff --git a/examples/default-values/test.sh b/examples/default-values/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./convert
 ./convert -h
 ./convert *.bmp
diff --git a/examples/dependencies/test.sh b/examples/dependencies/test.sh
@@ -4,5 +4,7 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli download
 ./cli upload
diff --git a/examples/docker-like/test.sh b/examples/docker-like/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./docker
 ./docker -h
 ./docker container
diff --git a/examples/environment-variables/README.md b/examples/environment-variables/README.md
@@ -22,12 +22,19 @@ commands:
   help: Verify your user
 
   # This option belongs to the `verify` command and will appear in its help
-  # message. In addition, setting `required: true` will halt the script's 
-  # execution with a friendly error message, unless the variable is set.
+  # message.
   environment_variables:
+  # Setting `required: true` will halt the script's execution with a
+  # friendly error message, unless the variable is set.
   - name: my_secret
     help: Your secret
     required: true
+  
+  # Using the `default: value` option will cause the value to variable to be 
+  # set if it is not provided by the user.
+  - name: environment
+    help: One of development, production or test
+    default: development
 ```
 
 ## Generated script output
@@ -96,6 +103,10 @@ Environment Variables:
   MY_SECRET (required)
     Your secret
 
+  ENVIRONMENT
+    One of development, production or test
+    Default: development
+
 
 
 ```
@@ -108,10 +119,32 @@ missing required environment variable: MY_SECRET
 
 ```
 
-### `$ ./cli verify`
+### `$ MY_SECRET="there is no spoon" ./cli verify`
 
 ```shell
-missing required environment variable: MY_SECRET
+# this file is located in 'src/verify_command.sh'
+# code for 'cli verify' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+environment:
+- API_KEY=
+- ENVIRONMENT=development
+- MY_SECRET=there is no spoon
+
+
+```
+
+### `$ ENVIRONMENT=production MY_SECRET=safe-with-me ./cli verify`
+
+```shell
+# this file is located in 'src/verify_command.sh'
+# code for 'cli verify' goes here
+# you can edit it freely and regenerate (it will not be overwritten)
+args: none
+environment:
+- API_KEY=
+- ENVIRONMENT=production
+- MY_SECRET=safe-with-me
 
 
 ```
diff --git a/examples/environment-variables/cli b/examples/environment-variables/cli
@@ -80,6 +80,12 @@ cli_verify_usage() {
     echo "  MY_SECRET (required)"
     printf "    Your secret\n"
     echo
+    
+    # :environment_variable.usage
+    echo "  ENVIRONMENT"
+    printf "    One of development, production or test\n"
+    printf "    Default: development\n"
+    echo
 
   fi
 }
@@ -114,6 +120,8 @@ cli_verify_command() {
   inspect_args
   
   echo "environment:"
+  echo "- API_KEY=$API_KEY"
+  echo "- ENVIRONMENT=$ENVIRONMENT"
   echo "- MY_SECRET=$MY_SECRET"
 }
 
@@ -197,6 +205,7 @@ cli_verify_parse_requirements() {
   
   esac
   # :command.environment_variables_filter
+  export ENVIRONMENT="${ENVIRONMENT:-development}"
   if [[ -z "$MY_SECRET" ]]; then
     printf "missing required environment variable: MY_SECRET\n"
     exit 1
diff --git a/examples/environment-variables/src/bashly.yml b/examples/environment-variables/src/bashly.yml
@@ -13,9 +13,16 @@ commands:
   help: Verify your user
 
   # This option belongs to the `verify` command and will appear in its help
-  # message. In addition, setting `required: true` will halt the script's 
-  # execution with a friendly error message, unless the variable is set.
+  # message.
   environment_variables:
+  # Setting `required: true` will halt the script's execution with a
+  # friendly error message, unless the variable is set.
   - name: my_secret
     help: Your secret
     required: true
+  
+  # Using the `default: value` option will cause the value to variable to be 
+  # set if it is not provided by the user.
+  - name: environment
+    help: One of development, production or test
+    default: development
diff --git a/examples/environment-variables/src/verify_command.sh b/examples/environment-variables/src/verify_command.sh
@@ -4,4 +4,6 @@ echo "# you can edit it freely and regenerate (it will not be overwritten)"
 inspect_args
 
 echo "environment:"
+echo "- API_KEY=$API_KEY"
+echo "- ENVIRONMENT=$ENVIRONMENT"
 echo "- MY_SECRET=$MY_SECRET"
diff --git a/examples/environment-variables/test.sh b/examples/environment-variables/test.sh
@@ -4,8 +4,11 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli -h
 ./cli verify -h
 ./cli verify
 MY_SECRET="there is no spoon" ./cli verify
+ENVIRONMENT=production MY_SECRET=safe-with-me ./cli verify
diff --git a/examples/extensible-delegate/test.sh b/examples/extensible-delegate/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./mygit
 ./mygit push
 
diff --git a/examples/extensible/test.sh b/examples/extensible/test.sh
@@ -9,5 +9,7 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli status --some --flags
diff --git a/examples/footer/test.sh b/examples/footer/test.sh
@@ -6,5 +6,7 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./download
 ./download -h
diff --git a/examples/git-like/test.sh b/examples/git-like/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./git
 ./git -h
 ./git s
diff --git a/examples/minimal/test.sh b/examples/minimal/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./download
 ./download -h
 ./download -v
diff --git a/examples/minus-v/test.sh b/examples/minus-v/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./cli
 ./cli --help
 ./cli --version
diff --git a/examples/multiline/test.sh b/examples/multiline/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./multi
 ./multi -h
 ./multi multiline
diff --git a/examples/whitelist/test.sh b/examples/whitelist/test.sh
@@ -6,6 +6,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./login
 ./login -h
 ./login america
diff --git a/examples/yaml/test.sh b/examples/yaml/test.sh
@@ -4,6 +4,8 @@ set -x
 
 bashly generate
 
+### Try Me ###
+
 ./yaml -h
 ./yaml settings.yml
 ./yaml settings.yml --prefix config_
diff --git a/lib/bashly/models/command.rb b/lib/bashly/models/command.rb
@@ -92,6 +92,11 @@ def default_command
         commands.find { |c| c.default }
       end
 
+      # Returns an array of all the default Environment Variables
+      def default_environment_variables
+        environment_variables.select &:default
+      end
+
       # Returns an array of all the default Flags
       def default_flags
         flags.select &:default
diff --git a/lib/bashly/views/command/environment_variables_filter.erb b/lib/bashly/views/command/environment_variables_filter.erb
@@ -1,4 +1,9 @@
 # :command.environment_variables_filter
+<%- if default_environment_variables.any? -%>
+<%- default_environment_variables.each do |env_var| -%>
+export <%= env_var.name.upcase %>="${<%= env_var.name.upcase %>:-<%= env_var.default %>}"
+<%- end -%>
+<%- end -%>
 <%- if required_environment_variables.any? -%>
 <%- required_environment_variables.each do |env_var| -%>
 if [[ -z "$<%= env_var.name.upcase %>" ]]; then
diff --git a/lib/bashly/views/environment_variable/usage.erb b/lib/bashly/views/environment_variable/usage.erb
@@ -1,4 +1,7 @@
 # :environment_variable.usage
 echo "  <%= usage_string extended: true %>"
 printf "<%= help.wrap(76).indent(4).sanitize_for_print %>\n"
+<%- if default -%>
+printf "    <%= strings[:default] % { value: default } -%>\n"
+<%- end -%>
 echo
diff --git a/spec/approvals/examples/environment-variables b/spec/approvals/examples/environment-variables
