Merge pull request #304 from DannyBen/add/private-env-var

Add ability to define a private environment variable

Author: DannyBen

lib/bashly/config_validator.rb

@@ -124,6 +124,11 @@ def assert_env_var(key, value)
       assert_optional_string "#{key}.help", value['help']
       assert_optional_string "#{key}.default", value['default']
       assert_boolean "#{key}.required", value['required']
+      assert_boolean "#{key}.private", value['private']
+
+      if value['private']
+        assert value['default'], "#{key}.private makes no sense without default"
+      end
     end
 
     def assert_command(key, value)

lib/bashly/script/environment_variable.rb

@@ -3,7 +3,7 @@ module Script
     class EnvironmentVariable < Base
       class << self
         def option_keys
-          @option_keys ||= %i[default help name required]
+          @option_keys ||= %i[default help name required private]
         end
       end
 

lib/bashly/views/command/usage_environment_variables.gtx

@@ -3,7 +3,7 @@
 > printf "{{ strings[:environment_variables] }}\n"
 > 
 
-environment_variables.each do |env_var|
+environment_variables.reject(&:private).each do |env_var|
   = env_var.render :usage
 end
 

spec/approvals/validations/env_var_private

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.environment_variables[0].private must be a boolean>

spec/approvals/validations/env_var_private_without_default

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: root.environment_variables[0].private makes no sense without default>

spec/approvals/validations/env_var renamed to spec/approvals/validations/env_var_required

@@ -132,13 +132,28 @@
   - name: sub
     default: true
 
-:env_var:
+:env_var_required:
   name: invalid
   help: env_var.required should be a boolean
   environment_variables:
   - name: api_key
     required: 1
 
+:env_var_private:
+  name: invalid
+  help: env_var.private should be a boolean
+  environment_variables:
+  - name: server_env
+    default: development
+    private: 1
+
+:env_var_private_without_default:
+  name: invalid
+  help: env_var.private makes no sense without default
+  environment_variables:
+  - name: server_env
+    private: true
+
 :flag_long:
   name: invalid
   help: the long flag is not in the form of --force