completely 0.7.2 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e2d4ef0dc7d503f77387c199d75989c8aca7408f73421086219bfab91823dd0
-  data.tar.gz: 4c5650a43490f9d35417a808c532391c9a0e7cf52d47b36ef5ffe56ab0d28ed2
+  metadata.gz: bc1feb2ea4f84471fa2e014aed467122163556f6f92c0ec5ad536065f3789438
+  data.tar.gz: 747d77ca9ce9f351bd914656423f92d8501aa2e0b19789f227bbcd1130de7cb2
 SHA512:
-  metadata.gz: 655e9090c78451ffc8ba5f8b4f309e92756c02b769b4f60d9df2520f5ddc572b6eb7e761aeb8d0a2e1f3113bd1bcf05be186c75a95d833fc9938ad6bf706057c
-  data.tar.gz: 81b519ae5db4f3eed6475b1a8b601c8bb873ed6cf0a67c2862b893e878342e031c60b3c58b600c2bc80b080f9c63a0a6ead68d37ef5b42924d5e687ac514feb1
+  metadata.gz: 9bd666b63af2f8a48a085d7025d39d5980eb93c796193144a29e3c730f80f9c409b99584ffbd6bbbd240819ba3af9013915ff090f04850e9bd09c01d928d056e
+  data.tar.gz: b2a6fa4704ba2c6004e4ceb4735a7cc92cfb24bc9e277779562180153102d1983f1716a59a829f2269042f2e02528af1d75de87196c8e86a17a043097e4c0d42

data/README.md

@@ -1,5 +1,7 @@
 # Completely - Bash Completions Generator
 
+![repocard](https://repocard.dannyben.com/svg/completely.svg)
+
 Completely is a command line utility and a Ruby library that lets you generate
 bash completion scripts from simple YAML configuration.
 
@@ -167,6 +169,13 @@ mygit:
 The `2> /dev/null` is used so that if the command is executed in a directory
 without a git repository, it will still behave as expected.
 
+### Completion scope and limitations
+
+- Completion words are treated as whitespace-delimited tokens.
+- Literal completion phrases that contain spaces are not supported as a single completion item.
+- Quotes and other special shell characters in literal completion words are not escaped automatically.
+- Dynamic `$(...)` completion commands should output plain whitespace-delimited words.
+
 ### Suggesting flag arguments
 
 Adding a `*` wildcard in the middle of a pattern can be useful for suggesting

data/lib/completely/commands/base.rb

@@ -35,7 +35,13 @@ module Completely
       end
 
       def completions
-        @completions ||= Completions.load(config_path, function_name: args['--function'])
+        @completions ||= if config_path == '-'
+          raise Error, 'Nothing is piped on stdin' if $stdin.tty?
+
+          Completions.read $stdin, function_name: args['--function']
+        else
+          Completions.load config_path, function_name: args['--function']
+        end
       end
 
       def config_path
@@ -43,7 +49,11 @@ module Completely
       end
 
       def output_path
-        @output_path ||= args['OUTPUT_PATH'] || ENV['COMPLETELY_OUTPUT_PATH'] || "#{config_basename}.bash"
+        @output_path ||= args['OUTPUT_PATH'] || ENV['COMPLETELY_OUTPUT_PATH'] || stdout || "#{config_basename}.bash"
+      end
+
+      def stdout
+        @stdout ||= config_path == '-' ? '-' : nil
       end
 
       def config_basename

data/lib/completely/commands/generate.rb

@@ -3,19 +3,31 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Generate < Base
-      help 'Generate the bash completion script to a file'
+      help 'Generate the bash completion script to file or stdout'
 
       usage 'completely generate [CONFIG_PATH OUTPUT_PATH --function NAME --wrap NAME]'
+      usage 'completely generate [CONFIG_PATH --install PROGRAM --function NAME]'
       usage 'completely generate (-h|--help)'
 
       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.'
 
-      param_config_path
+      option '-i --install PROGRAM', 'Install the generated script as completions for PROGRAM.'
+
+      param 'CONFIG_PATH', <<~USAGE
+        Path to the YAML configuration file [default: completely.yaml].
+        Use '-' to read from stdin.
+
+        Can also be set by an environment variable.
+      USAGE
+
       param 'OUTPUT_PATH', <<~USAGE
         Path to the output bash script.
-        When not provided, the name of the input file will be used with a .bash extension.
+        Use '-' for stdout.
+
+        When not provided, the name of the input file will be used with a .bash extension, unless the input is stdin - in this case the default will be to output to stdout.
+
         Can also be set by an environment variable.
       USAGE
 
@@ -26,13 +38,35 @@ module Completely
       def run
         wrap = args['--wrap']
         output = wrap ? wrapper_function(wrap) : script
-        File.write output_path, output
-        say "Saved m`#{output_path}`"
-        syntax_warning unless completions.valid?
+
+        if args['--install']
+          install output
+        elsif output_path == '-'
+          show output
+        else
+          save output
+        end
       end
 
     private
 
+      def install(content)
+        installer = Installer.from_string program: args['--install'], string: content
+        success = installer.install force: true
+        raise InstallError, "Failed running command:\nnb`#{installer.install_command_string}`" unless success
+
+        say "Saved m`#{installer.target_path}`"
+        say 'You may need to restart your session to test it'
+      end
+
+      def show(content) = puts content
+
+      def save(content)
+        File.write output_path, content
+        say "Saved m`#{output_path}`"
+        syntax_warning unless completions.valid?
+      end
+
       def wrapper_function(wrapper_name)
         completions.wrapper_function wrapper_name
       end

data/lib/completely/commands/install.rb

@@ -17,7 +17,10 @@ module Completely
       option '-d --dry', 'Show the installation command but do not run it'
 
       param 'PROGRAM', 'Name of the program the completions are for.'
-      param 'SCRIPT_PATH', 'Path to the source bash script [default: completely.bash].'
+      param 'SCRIPT_PATH', <<~USAGE
+        Path to the source bash script [default: completely.bash].
+        Use '-' to provide the script via stdin.
+      USAGE
 
       def run
         if args['--dry']
@@ -32,15 +35,19 @@ module Completely
         say 'You may need to restart your session to test it'
       end
 
-    private
-
       def installer
-        Installer.new program: args['PROGRAM'], script_path: script_path
+        @installer ||= if stdin?
+          Installer.from_io program:
+        else
+          Installer.new program:, script_path: input_script_path
+        end
       end
 
-      def script_path
-        args['SCRIPT_PATH'] || 'completely.bash'
-      end
+    private
+
+      def program = args['PROGRAM']
+      def stdin? = input_script_path == '-'
+      def input_script_path = args['SCRIPT_PATH'] || 'completely.bash'
     end
   end
 end

data/lib/completely/commands/preview.rb

@@ -3,7 +3,7 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Preview < Base
-      help 'Generate the bash completion script to STDOUT'
+      help 'Generate the bash completion script to stdout'
 
       usage 'completely preview [CONFIG_PATH --function NAME]'
       usage 'completely preview (-h|--help)'

data/lib/completely/completions.rb

@@ -6,9 +6,12 @@ module Completely
     attr_reader :config
 
     class << self
-      def load(config_path, function_name: nil)
-        config = Config.load config_path
-        new config, function_name: function_name
+      def load(path, function_name: nil)
+        new Config.load(path), function_name: function_name
+      end
+
+      def read(io, function_name: nil)
+        new Config.read(io), function_name: function_name
       end
     end
 
@@ -26,7 +29,7 @@ module Completely
     end
 
     def valid?
-      pattern_prefixes.uniq.count == 1
+      pattern_prefixes.uniq.one?
     end
 
     def script

data/lib/completely/config.rb

@@ -3,17 +3,14 @@ module Completely
     attr_reader :config, :options
 
     class << self
-      def load(config_path)
-        begin
-          config = YAML.load_file config_path, aliases: true
-        rescue ArgumentError
-          # :nocov:
-          config = YAML.load_file config_path
-          # :nocov:
-        end
-
-        new config
+      def parse(str)
+        new YAML.load(str, aliases: true)
+      rescue Psych::Exception => e
+        raise ParseError, "Invalid YAML: #{e.message}"
       end
+
+      def load(path) = parse(File.read(path))
+      def read(io) = parse(io.read)
     end
 
     def initialize(config)

data/lib/completely/exceptions.rb

@@ -1,4 +1,5 @@
 module Completely
   class Error < StandardError; end
   class InstallError < Error; end
+  class ParseError < Error; end
 end

data/lib/completely/installer.rb

@@ -1,5 +1,38 @@
+require 'fileutils'
+
 module Completely
   class Installer
+    class << self
+      def from_io(program:, io: nil)
+        io ||= $stdin
+
+        raise InstallError, 'io must respond to #read' unless io.respond_to?(:read)
+        raise InstallError, 'io is closed' if io.respond_to?(:closed?) && io.closed?
+
+        from_string program:, string: io.read
+      end
+
+      def from_string(program:, string:)
+        tempfile = create_tempfile
+        script_path = tempfile.path
+        begin
+          File.write script_path, string
+        ensure
+          tempfile.close
+        end
+
+        new program:, script_path:
+      end
+
+      def create_tempfile
+        tempfile = Tempfile.new ['completely-', '.bash']
+        tempfiles.push tempfile
+        tempfile
+      end
+
+      def tempfiles = @tempfiles ||= []
+    end
+
     attr_reader :program, :script_path
 
     def initialize(program:, script_path: nil)
@@ -7,18 +40,8 @@ module Completely
       @script_path = script_path
     end
 
-    def target_directories
-      @target_directories ||= %W[
-        /usr/share/bash-completion/completions
-        /usr/local/etc/bash_completion.d
-        #{Dir.home}/.local/share/bash-completion/completions
-        #{Dir.home}/.bash_completion.d
-      ]
-    end
-
     def install_command
-      result = root_user? ? [] : %w[sudo]
-      result + %W[cp #{script_path} #{target_path}]
+      %W[cp #{script_path} #{target_path}]
     end
 
     def install_command_string
@@ -26,8 +49,7 @@ module Completely
     end
 
     def uninstall_command
-      result = root_user? ? [] : %w[sudo]
-      result + %w[rm -f] + target_directories.map { |dir| "#{dir}/#{program}" }
+      %W[rm -f #{target_path}]
     end
 
     def uninstall_command_string
@@ -39,14 +61,12 @@ module Completely
     end
 
     def install(force: false)
-      unless completions_path
-        raise InstallError, 'Cannot determine system completions directory'
-      end
-
       unless script_exist?
         raise InstallError, "Cannot find script: m`#{script_path}`"
       end
 
+      FileUtils.mkdir_p completions_path
+
       if target_exist? && !force
         raise InstallError, "File exists: m`#{target_path}`"
       end
@@ -68,20 +88,20 @@ module Completely
       File.exist? script_path
     end
 
-    def root_user?
-      Process.uid.zero?
+    def completions_path
+      @completions_path ||= "#{user_completions_base_dir}/completions"
     end
 
-    def completions_path
-      @completions_path ||= completions_path!
+    def user_completions_base_dir
+      @user_completions_base_dir ||= bash_completion_user_dir || "#{data_home}/bash-completion"
     end
 
-    def completions_path!
-      target_directories.each do |target|
-        return target if Dir.exist? target
-      end
+    def bash_completion_user_dir
+      ENV['BASH_COMPLETION_USER_DIR']&.split(':')&.find { |entry| !entry.empty? }
+    end
 
-      nil
+    def data_home
+      ENV['XDG_DATA_HOME'] || "#{Dir.home}/.local/share"
     end
   end
 end

data/lib/completely/pattern.rb

@@ -49,6 +49,10 @@ module Completely
       @compgen ||= compgen!
     end
 
+    def filename_action?
+      actions.include?('-A file') || actions.include?('-A directory')
+    end
+
   private
 
     def compgen!

data/lib/completely/templates/template.erb

@@ -9,24 +9,46 @@
   local cur=${COMP_WORDS[COMP_CWORD]}
   local result=()
 
+  # words the user already typed (excluding the command itself)
+  local used=()
+  if ((COMP_CWORD > 1)); then
+    used=("${COMP_WORDS[@]:1:$((COMP_CWORD - 1))}")
+  fi
+
   if [[ "${cur:0:1}" == "-" ]]; then
+    # Completing an option: offer everything (including options)
     echo "$words"
 
   else
+    # Completing a non-option: offer only non-options,
+    # and don't re-offer ones already used earlier in the line.
     for word in $words; do
-      [[ "${word:0:1}" != "-" ]] && result+=("$word")
+      [[ "${word:0:1}" == "-" ]] && continue
+
+      local seen=0
+      for u in "${used[@]}"; do
+        if [[ "$u" == "$word" ]]; then
+          seen=1
+          break
+        fi
+      done
+      ((!seen)) && result+=("$word")
     done
 
     echo "${result[*]}"
-
   fi
 }
 
 <%= function_name %>() {
   local cur=${COMP_WORDS[COMP_CWORD]}
-  local compwords=("${COMP_WORDS[@]:1:$COMP_CWORD-1}")
+  local compwords=()
+  if ((COMP_CWORD > 0)); then
+    compwords=("${COMP_WORDS[@]:1:$((COMP_CWORD - 1))}")
+  fi
   local compline="${compwords[*]}"
 
+  COMPREPLY=()
+
 % if ENV['COMPLETELY_DEBUG']
   if [[ -n "$COMPLETELY_DEBUG" ]]; then
     echo "compline: '$compline'" > 'completely-debug.txt'
@@ -38,6 +60,9 @@
 % patterns.each do |pattern|
 % next if pattern.empty?
     <%= pattern.case_string %>)
+% if pattern.filename_action?
+      compopt -o filenames 2>/dev/null
+% end
       while read -r; do COMPREPLY+=("$REPLY"); done < <(compgen <%= pattern.compgen %> -- "$cur")
       ;;
 

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = '0.7.2'
+  VERSION = '0.7.5'
 end

data/lib/completely.rb

@@ -4,3 +4,4 @@ require 'completely/pattern'
 require 'completely/completions'
 require 'completely/tester'
 require 'completely/installer'
+require 'debug' if ENV['COMPLETELY_DEV']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.5
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -88,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Bash Completions Generator
 test_files: []