Merge pull request #19 from DannyBen/add/config-path-env-var

Add in/out path configuration via environment variables

Author: DannyBen

lib/completely/commands/base.rb

@@ -5,15 +5,19 @@ module Commands
     class Base < MisterBin::Command
 
       class << self
-        def config_path_usage
-          param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]"
+        def param_config_path
+          param "CONFIG_PATH", "Path to the YAML configuration file [default: completely.yaml]\nCan also be set by an environment variable"
         end
 
-        def function_usage
+        def option_function
           option "-f --function NAME", "Modify the name of the function in the generated script"
         end
 
-        def debug_usage
+        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
       end
@@ -29,7 +33,15 @@ def completions
       end
 
       def config_path
-        args['CONFIG_PATH'] || 'completely.yaml'
+        @config_path ||= args['CONFIG_PATH'] || ENV['COMPLETELY_CONFIG_PATH'] || 'completely.yaml'
+      end
+
+      def script_path
+        @script_path ||= args['SCRIPT_PATH'] || ENV['COMPLETELY_SCRIPT_PATH'] || "#{config_basename}.bash"
+      end
+
+      def config_basename
+        File.basename config_path, File.extname(config_path)
       end
 
       def syntax_warning

lib/completely/commands/generate.rb

@@ -5,21 +5,24 @@ module Commands
     class Generate < Base
       help "Generate the bash completion script to a file"
 
-      usage "completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]"
+      usage "completely generate [CONFIG_PATH SCRIPT_PATH --function NAME --wrap NAME]"
       usage "completely generate (-h|--help)"
 
-      function_usage
+      option_function
       option "-w --wrap NAME", "Wrap the completion script inside a function that echos the script. This is useful if you wish to embed it directly in your script"
 
-      config_path_usage
-      param "OUTPUT_PATH", "Path to the output bash script [default: completely.bash]"
-      debug_usage
+      param_config_path
+      param "SCRIPT_PATH", "Path to the output bash script. When not provided, the name of the input file will be used with a .bash extension\nCan also be set by an environment variable"
+
+      environment_config_path
+      environment "COMPLETELY_SCRIPT_PATH", "Path to the output bash script"
+      environment_debug
 
       def run
         wrap = args['--wrap']
         output = wrap ? wrapper_function(wrap) : script
-        File.write output_path, output
-        say "Saved !txtpur!#{output_path}"
+        File.write script_path, output
+        say "Saved !txtpur!#{script_path}"
         syntax_warning unless completions.valid?
       end
 
@@ -29,10 +32,6 @@ def wrapper_function(wrapper_name)
         completions.wrapper_function wrapper_name
       end
 
-      def output_path
-        @output_path ||= args['OUTPUT_PATH'] || "completely.bash"
-      end
-
     end
   end
 end

lib/completely/commands/init.rb

@@ -8,7 +8,8 @@ class Init < Base
       usage "completely init [CONFIG_PATH]"
       usage "completely init (-h|--help)"
 
-      config_path_usage
+      param_config_path
+      environment_config_path
 
       def run
         if File.exist? config_path

lib/completely/commands/preview.rb

@@ -8,9 +8,10 @@ class Preview < Base
       usage "completely preview [CONFIG_PATH --function NAME]"
       usage "completely preview (-h|--help)"
 
-      function_usage
-      config_path_usage
-      debug_usage
+      option_function
+      param_config_path
+      environment_config_path
+      environment_debug
 
       def run
         puts script

lib/completely/commands/test.rb

@@ -18,10 +18,10 @@ 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"
-      debug_usage
+      environment_debug
 
       example %q[completely test "mygit pu"]
       example %q[completely test "mygit pull "]

lib/completely/templates/template.erb

@@ -7,6 +7,7 @@
 <%= function_name %>() {
   local cur compline
   _init_completion -s || return
+
   cur=${COMP_WORDS[COMP_CWORD]}
   compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
@@ -20,7 +21,10 @@
   case "$compline" in
 % patterns.each do |pattern|
 % next if pattern.empty?
-    <%= pattern.case_string %>) COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur")) ;;
+    <%= pattern.case_string %>)
+      COMPREPLY=($(compgen <%= pattern.compgen %> -- "$cur"))
+      ;;
+
 % end
   esac
 } &&

spec/approvals/cli/generate/custom-path-env

@@ -0,0 +1 @@
+Saved hello.bash

spec/approvals/cli/generate/custom-path-env2

@@ -0,0 +1 @@
+Saved spec/tmp/tada.bash

spec/approvals/cli/generate/help

@@ -1,7 +1,7 @@
 Generate the bash completion script to a file
 
 Usage:
-  completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]
+  completely generate [CONFIG_PATH SCRIPT_PATH --function NAME --wrap NAME]
   completely generate (-h|--help)
 
 Options:
@@ -18,11 +18,20 @@ 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 [default: completely.bash]
+  SCRIPT_PATH
+    Path to the output bash script. When not provided, the name of the input
+    file will be used with a .bash extension
+    Can also be set by an environment variable
 
 Environment Variables:
+  COMPLETELY_CONFIG_PATH
+    Path to a completely configuration file [default: completely.yaml]
+
+  COMPLETELY_SCRIPT_PATH
+    Path to the output bash script
+
   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

spec/approvals/cli/generated-script

@@ -7,14 +7,27 @@
 _mygit_completions() {
   local cur compline
   _init_completion -s || return
+
   cur=${COMP_WORDS[COMP_CWORD]}
   compline="${COMP_WORDS[@]:1:$COMP_CWORD-1}"
 
   case "$compline" in
-    'status'*) COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur")) ;;
-    'commit'*) COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur")) ;;
-    'init'*) COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur")) ;;
-    *) COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur")) ;;
+    'status'*)
+      COMPREPLY=($(compgen -W "--help --verbose --branch $(git branch 2> /dev/null)" -- "$cur"))
+      ;;
+
+    'commit'*)
+      COMPREPLY=($(compgen -A file -W "--help --message --all -a --quiet -q" -- "$cur"))
+      ;;
+
+    'init'*)
+      COMPREPLY=($(compgen -A directory -W "--bare" -- "$cur"))
+      ;;
+
+    *)
+      COMPREPLY=($(compgen -W "--help --version status init commit" -- "$cur"))
+      ;;
+
   esac
 } &&
 complete -F _mygit_completions mygit