add specs for COMPLETELY_CONFIG_PATH

DannyBen · DannyBen · commit 531d4d4b18dc · 2022-05-21T07:10:23.000Z
diff --git a/lib/completely/commands/base.rb b/lib/completely/commands/base.rb
@@ -6,13 +6,17 @@ class Base < MisterBin::Command
 
       class << self
         def param_config_path
-          param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]"
+          param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
         end
 
         def option_function
           option "-f --function NAME", "Modify the name of the function in the generated script"
         end
 
+        def environment_config_path
+          environment "COMPLETELY_CONFIG_PATH", "Path to a completely configuration file [default: completely.yaml]"
+        end
+
         def environment_debug
           environment "COMPLETELY_DEBUG", "It not empty, the generated script will include an additional debugging snippet that outputs the compline and current word to a text file when a completion is requested"
         end
diff --git a/lib/completely/commands/generate.rb b/lib/completely/commands/generate.rb
@@ -13,6 +13,8 @@ class Generate < Base
 
       param_config_path
       param "OUTPUT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension"
+
+      environment_config_path
       environment_debug
 
       def run
diff --git a/lib/completely/commands/init.rb b/lib/completely/commands/init.rb
@@ -9,6 +9,7 @@ class Init < Base
       usage "completely init (-h|--help)"
 
       param_config_path
+      environment_config_path
 
       def run
         if File.exist? config_path
diff --git a/lib/completely/commands/preview.rb b/lib/completely/commands/preview.rb
@@ -10,6 +10,7 @@ class Preview < Base
 
       option_function
       param_config_path
+      environment_config_path
       environment_debug
 
       def run
diff --git a/lib/completely/commands/test.rb b/lib/completely/commands/test.rb
@@ -18,7 +18,7 @@ class Test < Base
 
       param "COMPLINE", "The command to test completions for. This will be handled as if a TAB was pressed immediately at the end of it, so the last word is considered the active cursor. If you wish to complete for the next word instead, end your command with a space."
 
-      environment "COMPLETELY_CONFIG_PATH", "Path to a completely configuration file [default: completely.yaml]"
+      environment_config_path
       environment "COMPLETELY_SCRIPT_PATH", "Path to a completions script. When set, this script will be tested instead of the completely configuration file"
       environment "COMPLETELY_SCRIPT_FUNCTION", "The main completion function to call when using a custom script. If not set, the basename of the script path will be used, prefixed by an underscore"
       environment_debug
diff --git a/spec/approvals/cli/generate/custom-path-env b/spec/approvals/cli/generate/custom-path-env
@@ -0,0 +1 @@
+Saved hello.bash
diff --git a/spec/approvals/cli/generate/help b/spec/approvals/cli/generate/help
@@ -18,12 +18,16 @@ Options:
 Parameters:
   CONFIG_PATH
     Path to the YAML configuration file [default: completely.yaml]
+    Can also be set by an environment variable
 
   OUTPUT_PATH
     Path to the output bash script. When not provided, the name of the input
     file will be used with a .bash extension
 
 Environment Variables:
+  COMPLETELY_CONFIG_PATH
+    Path to a completely configuration file [default: completely.yaml]
+
   COMPLETELY_DEBUG
     It not empty, the generated script will include an additional debugging
     snippet that outputs the compline and current word to a text file when a
diff --git a/spec/approvals/cli/init/custom-path-env b/spec/approvals/cli/init/custom-path-env
@@ -0,0 +1 @@
+Saved spec/tmp/hello.yml
diff --git a/spec/approvals/cli/init/help b/spec/approvals/cli/init/help
@@ -11,3 +11,8 @@ Options:
 Parameters:
   CONFIG_PATH
     Path to the YAML configuration file [default: completely.yaml]
+    Can also be set by an environment variable
+
+Environment Variables:
+  COMPLETELY_CONFIG_PATH
+    Path to a completely configuration file [default: completely.yaml]
diff --git a/spec/approvals/cli/preview/help b/spec/approvals/cli/preview/help
@@ -14,8 +14,12 @@ Options:
 Parameters:
   CONFIG_PATH
     Path to the YAML configuration file [default: completely.yaml]
+    Can also be set by an environment variable
 
 Environment Variables:
+  COMPLETELY_CONFIG_PATH
+    Path to a completely configuration file [default: completely.yaml]
+
   COMPLETELY_DEBUG
     It not empty, the generated script will include an additional debugging
     snippet that outputs the compline and current word to a text file when a
diff --git a/spec/completely/commands/generate_spec.rb b/spec/completely/commands/generate_spec.rb
@@ -25,6 +25,26 @@
     end
   end
 
+  context "with COMPLETELY_CONFIG_PATH env var" do
+    before do
+      reset_tmp_dir
+      system "cp lib/completely/templates/sample.yaml spec/tmp/hello.yml"
+      system "rm -f completely.yaml"
+      ENV['COMPLETELY_CONFIG_PATH'] = 'spec/tmp/hello.yml'
+    end
+
+    after do
+      ENV['COMPLETELY_CONFIG_PATH'] = nil
+      system "rm -f hello.bash"
+    end
+
+    it "generates the bash script to completely.bash" do
+      expect { subject.run %w[generate] }.to output_approval('cli/generate/custom-path-env')
+      expect(File.read "hello.bash").to match_approval('cli/generated-script')
+    end
+  end
+
+
   context "with CONFIG_PATH OUTPUT_PATH" do
     before { reset_tmp_dir }
 
diff --git a/spec/completely/commands/init_spec.rb b/spec/completely/commands/init_spec.rb
@@ -29,6 +29,21 @@
     end
   end
 
+  context "with COMPLETELY_CONFIG_PATH env var" do
+    before do
+      reset_tmp_dir
+      ENV['COMPLETELY_CONFIG_PATH'] = 'spec/tmp/hello.yml'
+    end
+
+    after { ENV['COMPLETELY_CONFIG_PATH'] = nil }
+
+    it "creates a new sample file with the requested name" do
+      expect { subject.run %w[init] }
+        .to output_approval('cli/init/custom-path-env')
+      expect(File.read 'spec/tmp/hello.yml').to eq sample
+    end
+  end
+
   context "when the config file already exists" do
     before { system "cp lib/completely/templates/sample.yaml completely.yaml" }
     after  { system "rm -f completely.yaml" }
diff --git a/spec/completely/commands/preview_spec.rb b/spec/completely/commands/preview_spec.rb
@@ -25,6 +25,22 @@
     end
   end
 
+  context "with COMPLETELY_CONFIG_PATH env var" do
+    before do
+      reset_tmp_dir
+      system "cp lib/completely/templates/sample.yaml spec/tmp/hello.yml"
+      system "rm -f completely.yaml"
+      ENV['COMPLETELY_CONFIG_PATH'] = 'spec/tmp/hello.yml'
+    end
+
+    after { ENV['COMPLETELY_CONFIG_PATH'] = nil }
+
+    it "outputs the generated script to STDOUT" do
+      expect { subject.run %w[preview] }
+        .to output_approval('cli/generated-script')
+    end
+  end
+
   context "with an invalid configuration" do
     it "outputs a warning to STDERR" do
       expect { subject.run %w[preview spec/fixtures/broken.yaml] }
diff --git a/spec/completely/completions_spec.rb b/spec/completely/completions_spec.rb
@@ -41,7 +41,7 @@
       end
     end
 
-    context "when COMPLETELY_DEBUG is set", :focus do
+    context "when COMPLETELY_DEBUG is set" do
       before { ENV['COMPLETELY_DEBUG'] = '1' }
       after  { ENV['COMPLETELY_DEBUG'] = nil }
 
@@ -59,7 +59,7 @@
     end
   end
 
-  describe '#tester', :focus do
+  describe '#tester' do
     it "returns a Tester object" do
       expect(subject.tester).to be_a Tester
     end
