completely 0.7.3 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d6353c59bdf0d9ea55a2618a06f40b14d844ad7d40827d50f3bb38949b5263f
-  data.tar.gz: bbdcddef491b55bc6554fdcdf804b48bfddddbe744360bff99a19e9e105f2b2b
+  metadata.gz: bc1feb2ea4f84471fa2e014aed467122163556f6f92c0ec5ad536065f3789438
+  data.tar.gz: 747d77ca9ce9f351bd914656423f92d8501aa2e0b19789f227bbcd1130de7cb2
 SHA512:
-  metadata.gz: 5fab1170310c441fded2bdac3770edbaab6ce20100be7b005971371361513926b5492016e4abacf0bceb528824c1f80b30d1874d4bd6d8bb566e4f3ebaebd23e
-  data.tar.gz: 01cdc71f95b09bc73492c2d65fd70e272505e1d5145d5aabe69a58cdab1a924316f9919951dbbf64243a24c0c435d60ca4e2f559d843716c82e27352f5f4bf1c
+  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/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

@@ -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

@@ -60,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.3'
+  VERSION = '0.7.5'
 end

metadata

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