initial implememtation for required env vars

DannyBen · DannyBen · commit 1072af7d6e74 · 2019-11-28T09:37:30.000Z
diff --git a/examples/colors/colorly b/examples/colors/colorly
@@ -101,6 +101,7 @@ cyan_underlined() { echo -e "\e[4;36m$*\e[0m" ; }
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/config-ini/configly b/examples/config-ini/configly
@@ -276,6 +276,7 @@ configly_list_command() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -348,6 +349,7 @@ parse_args() {
 
 # :command.parse_args
 configly_set_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -411,6 +413,7 @@ configly_set_parse_args() {
 
 # :command.parse_args
 configly_get_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -463,6 +466,7 @@ configly_get_parse_args() {
 
 # :command.parse_args
 configly_list_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/custom-includes/download b/examples/custom-includes/download
@@ -73,6 +73,7 @@ my_extra_function() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/custom-strings/download b/examples/custom-strings/download
@@ -68,6 +68,7 @@ inspect_args() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/docker-like/docker b/examples/docker-like/docker
@@ -222,6 +222,7 @@ docker_image_ls_command() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -287,6 +288,7 @@ parse_args() {
 
 # :command.parse_args
 docker_container_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -352,6 +354,7 @@ docker_container_parse_args() {
 
 # :command.parse_args
 docker_container_run_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -404,6 +407,7 @@ docker_container_run_parse_args() {
 
 # :command.parse_args
 docker_container_stop_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -456,6 +460,7 @@ docker_container_stop_parse_args() {
 
 # :command.parse_args
 docker_image_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -514,6 +519,7 @@ docker_image_parse_args() {
 
 # :command.parse_args
 docker_image_ls_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/git-like/git b/examples/git-like/git
@@ -125,6 +125,7 @@ git_commit_command() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -190,6 +191,7 @@ parse_args() {
 
 # :command.parse_args
 git_status_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -230,6 +232,7 @@ git_status_parse_args() {
 
 # :command.parse_args
 git_commit_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/minimal/download b/examples/minimal/download
@@ -77,6 +77,7 @@ inspect_args() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/multiline/multi b/examples/multiline/multi
@@ -41,6 +41,8 @@ multi_usage() {
 
     # :command.usage_environment_variables
     echo -e "Environment Variables:"
+    
+    # :environment_variable.usage
     echo "  MULTI_VITAMIN"
     echo -e "    Environment variables can also use multiple lines. This can be useful if we\n    need to explain - in excruciating detail - what the environemnt variable is\n    used for."
     echo
@@ -150,6 +152,7 @@ multi_regular_command() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -215,6 +218,7 @@ parse_args() {
 
 # :command.parse_args
 multi_multiline_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -266,6 +270,7 @@ multi_multiline_parse_args() {
 
 # :command.parse_args
 multi_regular_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/multiline/src/bashly.yml b/examples/multiline/src/bashly.yml
@@ -45,5 +45,6 @@ examples:
       multi multiline --flag
 
 environment_variables:
-  MULTI_VITAMIN: |-
+- name: multi_vitamin
+  help: |-
     Environment variables can also use multiple lines. This can be useful if we need to explain - in excruciating detail - what the environemnt variable is used for.
diff --git a/examples/subcommands/cli b/examples/subcommands/cli
@@ -39,6 +39,8 @@ cli_usage() {
 
     # :command.usage_environment_variables
     echo -e "Environment Variables:"
+    
+    # :environment_variable.usage
     echo "  API_KEY"
     echo -e "    Set your API key"
     echo
@@ -85,6 +87,8 @@ cli_download_usage() {
     echo
     # :command.usage_environment_variables
     echo -e "Environment Variables:"
+    
+    # :environment_variable.usage
     echo "  DEFAULT_TARGET_LOCATION"
     echo -e "    Set the default location to download to"
     echo
@@ -166,6 +170,7 @@ cli_upload_command() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -231,6 +236,7 @@ parse_args() {
 
 # :command.parse_args
 cli_download_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
@@ -292,6 +298,7 @@ cli_download_parse_args() {
 
 # :command.parse_args
 cli_upload_parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/examples/subcommands/src/bashly.yml b/examples/subcommands/src/bashly.yml
@@ -3,7 +3,8 @@ help: Sample application
 version: 0.1.0
 
 environment_variables:
-  API_KEY: Set your API key
+- name: api_key
+  help: Set your API key
 
 commands:
 - name: download
@@ -27,7 +28,8 @@ commands:
   - cli download example.com ./output -f
 
   environment_variables:
-    DEFAULT_TARGET_LOCATION: Set the default location to download to
+  - name: default_target_location
+    help: Set the default location to download to
 
 - name: upload
   short: u
diff --git a/examples/yaml/yaml b/examples/yaml/yaml
@@ -131,6 +131,7 @@ yaml_load() {
 
 # :command.parse_args
 parse_args() {
+  # :command.environment_variables_filter
   # :command.fixed_flag_filter
   case "$1" in
   --version )
diff --git a/lib/bashly/extensions/string.rb b/lib/bashly/extensions/string.rb
@@ -9,7 +9,7 @@ def indent(offset)
   end
 
   def to_underscore
-    gsub(/(.)([A-Z])/,'\1_\2').gsub(' ', '_').downcase
+    gsub(/(.)([A-Z])/,'\1_\2').gsub(/[\- ]/, '_').downcase
   end
 
   def wrap(length = 80)
diff --git a/lib/bashly/models/command.rb b/lib/bashly/models/command.rb
@@ -55,6 +55,14 @@ def deep_commands
         result
       end
 
+      # Returns an array of EnvironmentVariables
+      def environment_variables
+        return [] unless options["environment_variables"]
+        options["environment_variables"].map do |options|
+          EnvironmentVariable.new options
+        end
+      end
+
       # Returns the bash filename that is expected to hold the user code
       # for this command
       def filename
@@ -107,6 +115,11 @@ def required_args
         args.select &:required
       end
 
+      # Returns an array of all the required EnvironmentVariables
+      def required_environment_variables
+        environment_variables.select &:required
+      end
+
       # Returns an array of all the required Flags
       def required_flags
         flags.select &:required
diff --git a/lib/bashly/models/environment_variable.rb b/lib/bashly/models/environment_variable.rb
@@ -0,0 +1,11 @@
+module Bashly
+  module Models
+    class EnvironmentVariable < Base
+      def usage_string(extended: false)
+        result = [name.upcase]
+        result << "(required)" if required and extended
+        result.join " "
+      end
+    end
+  end
+end
diff --git a/lib/bashly/templates/bashly.yml b/lib/bashly/templates/bashly.yml
@@ -3,7 +3,8 @@ help: Sample application
 version: 0.1.0
 
 environment_variables:
-  API_KEY: Set your API key
+- name: api_key
+  help: Set your API key
 
 commands:
 - name: download
@@ -27,7 +28,8 @@ commands:
   - cli download example.com ./output -f
 
   environment_variables:
-    DEFAULT_TARGET_LOCATION: Set the default location to download to
+  - name: default_target_location
+    help: Set the default location to download to
 
 - name: upload
   short: u
diff --git a/lib/bashly/templates/strings.yml b/lib/bashly/templates/strings.yml
@@ -16,4 +16,5 @@ invalid_argument: "invalid argument: %{arg}"
 invalid_flag: "invalid option: %{flag}"
 missing_required_argument: "missing required argument: %{arg}\\nusage: %{usage}"
 missing_required_flag: "missing required flag: %{usage}"
+missing_required_environment_variable: "missing required environment variable: %{var}"
 
diff --git a/lib/bashly/views/command/environment_variables_filter.erb b/lib/bashly/views/command/environment_variables_filter.erb
@@ -0,0 +1,9 @@
+# :command.environment_variables_filter
+<%- if required_environment_variables.any? -%>
+<%- required_environment_variables.each do |env_var| -%>
+if [[ -z "$<%= env_var.name.upcase %>" ]]; then
+  echo -e "<%= strings[:missing_required_environment_variable] % { var: env_var.name.upcase } -%>"
+  exit 1
+fi
+<%- end -%>
+<%- end -%>
diff --git a/lib/bashly/views/command/parse_args.erb b/lib/bashly/views/command/parse_args.erb
@@ -4,6 +4,7 @@ parse_args() {
 <%- else -%>
 <%= function_name %>_parse_args() {
 <%- end -%>
+<%= render(:environment_variables_filter).indent 2 %>
 <%= render(:fixed_flags_filter).indent 2 %>
 <%= render(:command_filter).indent 2 %>
 <%= render(:required_args_filter).indent 2 %>
@@ -12,5 +13,5 @@ parse_args() {
 }
 
 <%- commands.each do |command| %>
-<%= command.render 'parse_args' %>
+<%= command.render :parse_args %>
 <%- end -%>
diff --git a/lib/bashly/views/command/usage.erb b/lib/bashly/views/command/usage.erb
@@ -32,7 +32,7 @@
 <%= render(:usage_fixed_flags).indent 4 %>
 <%= render(:usage_flags).indent 4 if flags.any? %>
 <%= render(:usage_args).indent 4 if args.any? %>
-<%= render(:usage_environment_variables).indent 4 if environment_variables %>
+<%= render(:usage_environment_variables).indent 4 if environment_variables.any? %>
 <%= render(:usage_examples).indent 4 if examples %>
 
   fi
diff --git a/lib/bashly/views/command/usage_environment_variables.erb b/lib/bashly/views/command/usage_environment_variables.erb
@@ -1,7 +1,6 @@
 # :command.usage_environment_variables
 echo -e "<%= strings[:environment_variables] %>"
-<%- environment_variables.each do |name, description| -%>
-echo "  <%= name %>"
-echo -e "<%= description.wrap(76).indent(4).sanitize_for_print %>"
+
+<%- environment_variables.each do |env_var| -%>
+<%= env_var.render(:usage) %>
 <%- end -%>
-echo
diff --git a/lib/bashly/views/environment_variable/usage.erb b/lib/bashly/views/environment_variable/usage.erb
@@ -0,0 +1,4 @@
+# :environment_variable.usage
+echo "  <%= usage_string extended: true %>"
+echo -e "<%= help.wrap(76).indent(4).sanitize_for_print %>"
+echo
diff --git a/spec/bashly/extensions/string_spec.rb b/spec/bashly/extensions/string_spec.rb
@@ -39,8 +39,8 @@
       end
     end
 
-    context "with any string with spaces" do
-      subject { "in any case" }
+    context "with any string with spaces and hyphens" do
+      subject { "in any-case" }
 
       it "returns its snake_case version" do
         expect(subject.to_underscore).to eq "in_any_case"
