backfill missing introspection specs

Author: DannyBen

lib/bashly/script/introspection/environment_variables.rb

@@ -2,7 +2,7 @@ module Bashly
   module Script
     module Introspection
       module EnvironmentVariables
-        # Returns an array of all the default Environment Variables
+        # Returns an array of all the Environment Variables with default values
         def default_environment_variables
           environment_variables.select(&:default)
         end

spec/approvals/cli/doc/full

@@ -539,12 +539,23 @@ environment_variable.required
 
   Specify that this variable is required.
 
+    environment_variables:
     - name: api_key
       help: Your API key
       required: true
 
   See https://bashly.dannyb.co/configuration/environment-variable/#required
 
+environment_variable.validate
+
+  Apply custom validation functions.
+
+    environment_variables:
+    - name: build_dir
+      validate: dir_exists
+
+  See https://bashly.dannyb.co/configuration/environment-variable/#validate
+
 flag
 
   Define option flags.

spec/approvals/cli/doc/index

@@ -34,6 +34,7 @@ environment_variable.help
 environment_variable.name
 environment_variable.private
 environment_variable.required
+environment_variable.validate
 flag
 flag.allowed
 flag.arg

spec/bashly/script/introspection/environment_variables_spec.rb

@@ -6,19 +6,47 @@
   end
 
   let(:fixtures) { load_fixture 'script/commands' }
-  let(:fixture) { :basic_command }
+  let(:fixture) { :environment_variable_enthusiast }
 
-  describe '#environment_cariables' do
+  describe '#default_environment_variables' do
+    it 'returns an array of all the Environment Variables with default values' do
+      expect(subject.default_environment_variables.size).to eq 1
+      expect(subject.default_environment_variables.first.name).to eq 'file'
+    end
+  end
+
+  describe '#environment_variables' do
     it 'returns an array of EnvironmentVariable objects' do
       expect(subject.environment_variables).to be_an Array
-      expect(subject.environment_variables.first).to be_a Script::EnvironmentVariable
+      expect(subject.environment_variables).to all(be_a Script::EnvironmentVariable)
+    end
+  end
+
+  describe '#public_environment_variables' do
+    it 'returns only environment variables that are not private' do
+      expect(subject.public_environment_variables.size).to eq 4
+      expect(subject.public_environment_variables.map(&:name)).not_to include 'secret'
     end
   end
 
   describe '#required_environment_variables' do
     it 'returns an array of only the required Argument objects' do
       expect(subject.required_environment_variables.size).to eq 1
-      expect(subject.required_environment_variables.first.name).to eq 'secret_key'
+      expect(subject.required_environment_variables.first.name).to eq 'username'
+    end
+  end
+
+  describe '#validated_environment_variables' do
+    it 'returns an array of all the environment variables with a validation' do
+      expect(subject.validated_environment_variables.size).to eq 1
+      expect(subject.validated_environment_variables.first.name).to eq 'config_dir'
+    end
+  end
+
+  describe '#whitelisted_environment_variables' do
+    it 'returns an array of all the environment_variables with a whitelist arg' do
+      expect(subject.whitelisted_environment_variables.size).to eq 1
+      expect(subject.whitelisted_environment_variables.first.name).to eq 'protocol'
     end
   end
 end

spec/bashly/script/introspection/flags_spec.rb

@@ -50,12 +50,28 @@
     end
   end
 
-  describe '#whitelisted_flags' do
-    let(:fixture) { :whitelist }
+  describe '#needy_flags' do
+    let(:fixture) { :needy_flags }
 
-    it 'returns an array of flags that have a whitelist' do
-      expect(subject.whitelisted_flags.size).to eq 1
-      expect(subject.whitelisted_flags.first.long).to eq '--user'
+    it 'returns an array of only the needy Flag objects' do
+      expect(subject.needy_flags.size).to eq 2
+      expect(subject.needy_flags.first.long).to eq '--add'
+    end
+  end
+
+  describe '#public_flags' do
+    let(:fixture) { :private_flags }
+
+    it 'returns an array of only the non private Flag objects' do
+      expect(subject.public_flags.size).to eq 1
+      expect(subject.public_flags.first.long).to eq '--new'
+    end
+  end
+
+  describe '#required_flags' do
+    it 'returns an array of only the required Flag objects' do
+      expect(subject.required_flags.size).to eq 1
+      expect(subject.required_flags.first.long).to eq '--force'
     end
   end
 
@@ -75,19 +91,12 @@
     end
   end
 
-  describe '#needy_flags' do
-    let(:fixture) { :needy_flags }
-
-    it 'returns an array of only the needy Flag objects' do
-      expect(subject.needy_flags.size).to eq 2
-      expect(subject.needy_flags.first.long).to eq '--add'
-    end
-  end
+  describe '#whitelisted_flags' do
+    let(:fixture) { :whitelist }
 
-  describe '#required_flags' do
-    it 'returns an array of only the required Flag objects' do
-      expect(subject.required_flags.size).to eq 1
-      expect(subject.required_flags.first.long).to eq '--force'
+    it 'returns an array of flags that have a whitelist' do
+      expect(subject.whitelisted_flags.size).to eq 1
+      expect(subject.whitelisted_flags.first.long).to eq '--user'
     end
   end
 end

spec/fixtures/script/commands.yml

@@ -199,6 +199,20 @@
   help: perform docker container run
   parents: [docker, container]
 
+:environment_variable_enthusiast:
+  name: get
+  environment_variables:
+  - name: username
+    required: true
+  - name: file
+    default: README.md
+  - name: config_dir
+    validate: dir_exists
+  - name: protocol
+    allowed: [ssh, https]
+  - name: secret
+    private: true
+
 :examples_array:
   name: get
   help: get something from somewhere
@@ -404,6 +418,14 @@
     alias: cf
     private: true
 
+:private_flags:
+  name: status
+  help: perform git status
+  flags:
+  - long: --legacy
+    private: true
+  - long: --new
+
 :repeatable_arg:
   name: get
   args: