completely 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6353c59bdf0d9ea55a2618a06f40b14d844ad7d40827d50f3bb38949b5263f
-  data.tar.gz: bbdcddef491b55bc6554fdcdf804b48bfddddbe744360bff99a19e9e105f2b2b
+  metadata.gz: e03a96457b69bced5091cb3a335f60da59ed7629d836f985f6bef54e89f8d827
+  data.tar.gz: fb9fdf6333328841bb45fd65a6428571934602f13d5c7f1b555bc6dc7120c224
 SHA512:
-  metadata.gz: 5fab1170310c441fded2bdac3770edbaab6ce20100be7b005971371361513926b5492016e4abacf0bceb528824c1f80b30d1874d4bd6d8bb566e4f3ebaebd23e
-  data.tar.gz: 01cdc71f95b09bc73492c2d65fd70e272505e1d5145d5aabe69a58cdab1a924316f9919951dbbf64243a24c0c435d60ca4e2f559d843716c82e27352f5f4bf1c
+  metadata.gz: b085523a2bb092c928fd6ff908baef5e5e1c0c68775688ea5e1a31ba77e19c09acfd17c19395f513a44eae88c9ab36cb28784e6ddae1afda46053d8de3f79981
+  data.tar.gz: '0835d18cf9bf62f98c794368d39173263890856fe15ee601455b272ac5944a311a7bfee3e9eb6b8aa9ea215c2cd4713b7b5eb5e9c2c8cfb89764149064b41273'

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.
 

data/lib/completely/commands/generate.rb

@@ -60,7 +60,7 @@ module Completely
       end
 
       def show(content) = puts content
-      
+
       def save(content)
         File.write output_path, content
         say "Saved m`#{output_path}`"

data/lib/completely/installer.rb

@@ -1,3 +1,5 @@
+require 'fileutils'
+
 module Completely
   class Installer
     class << self
@@ -38,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
@@ -57,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
@@ -70,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
@@ -99,22 +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 ||= begin
-        result = nil
-        target_directories.each do |target|
-          if Dir.exist? target
-            result = target
-            break
-          end
-        end
+    def user_completions_base_dir
+      @user_completions_base_dir ||= bash_completion_user_dir || "#{data_home}/bash-completion"
+    end
 
-        result
-      end
+    def bash_completion_user_dir
+      ENV['BASH_COMPLETION_USER_DIR']&.split(':')&.find { |entry| !entry.empty? }
+    end
+
+    def data_home
+      ENV['XDG_DATA_HOME'] || "#{Dir.home}/.local/share"
     end
   end
 end

data/lib/completely/pattern.rb

@@ -54,8 +54,16 @@ module Completely
     def compgen!
       result = []
       result << actions.join(' ').to_s if actions.any?
-      result << %[-W "$(#{function_name} "#{words.join ' '}")"] if words.any?
+      result << %[-W "$(#{function_name} #{quoted_words.join ' '})"] if words.any?
       result.any? ? result.join(' ') : nil
     end
+
+    def quoted_words
+      @quoted_words ||= words.map { |word| %("#{escape_for_double_quotes word}") }
+    end
+
+    def escape_for_double_quotes(word)
+      word.gsub(/["\\]/, '\\\\\&')
+    end
   end
 end

data/lib/completely/templates/template.erb

@@ -5,9 +5,10 @@
 # Modifying it manually is not recommended
 
 <%= function_name %>_filter() {
-  local words="$1"
+  local words=("$@")
   local cur=${COMP_WORDS[COMP_CWORD]}
   local result=()
+  local want_options=0
 
   # words the user already typed (excluding the command itself)
   local used=()
@@ -15,28 +16,26 @@
     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
+  # Completing an option: offer everything.
+  # Completing a non-option: drop options and already-used words.
+  [[ "${cur:0:1}" == "-" ]] && want_options=1
+  for word in "${words[@]}"; do
+    if ((!want_options)); then
       [[ "${word:0:1}" == "-" ]] && continue
 
-      local seen=0
       for u in "${used[@]}"; do
         if [[ "$u" == "$word" ]]; then
-          seen=1
-          break
+          continue 2
         fi
       done
-      ((!seen)) && result+=("$word")
-    done
+    fi
 
-    echo "${result[*]}"
-  fi
+    # compgen -W expects shell-escaped words in one space-delimited string.
+    printf -v word '%q' "$word"
+    result+=("$word")
+  done
+
+  echo "${result[*]}"
 }
 
 <%= function_name %>() {

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = '0.7.3'
+  VERSION = '0.7.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 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: []