completely 0.5.4 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4fbe4bb19567637239bac887b5e785caeac6c0dbf38f82e7d775a994db58a29
-  data.tar.gz: d7449fd83d8e1b6e5ce723deb457e6e8eab4254a92818f739fd6002b939385c8
+  metadata.gz: 96373b5a76365d9d8dd59e017dec1c32159520ac92f4d2abaed7dd807843a847
+  data.tar.gz: fea9ce43a598c7f52ddb59971f895ebdb8eb9bb4f9a1d6918e5c15c52eb583e9
 SHA512:
-  metadata.gz: e5e3c3985ac71d2db26ce7f321e1717af80ef760def41820b86e505ee884a3921d43618093c94ee41b3f9ed2291d35f9eac49fd6c4c6d4a376e1e981198d3ce9
-  data.tar.gz: 19719cecb29e21e1a226fd45d815a02baf9579c75e0f88ed0876a4ece8c3dee587feb88e71657d9d362cf9a2de5d0222b1423ecff4af759d32906daee0ba42a7
+  metadata.gz: c2b06ef048b16ddc565534b7934c421bc9dde18bf7706071972f64d406563be6044308cd4a38497f96f78208ba5916bc29d5aa4c1228f30fdfb0e6cad638f61b
+  data.tar.gz: ae92c96a9d51cf4574868257432f348494e16c8bbcfa10a3a6703ae6ca3de110a008c443bc1da25807a815792e7e9d7e3cc6df5530a32ee21c5653524662b93d

data/README.md

@@ -109,7 +109,7 @@ $ completely generate
 $ completely preview
 ```
 
-For more options (like setting input/output path), run
+For more options (like setting input/output path), run:
 
 ```bash
 $ completely --help
@@ -215,9 +215,15 @@ In order to enable the completions, simply source the generated script:
 $ source completely.bash
 ```
 
-In order to load these completions on startup, you may want to place them in 
-the completions directory of your operating system, which can be either of
-these (whichever exists):
+If you are satisfied with the result, and wish to copy the script to your bash
+completions directory, simply run:
+
+```bash
+$ completely install
+```
+
+Alternatively, you can copy the script manually to one of these directories
+(whichever exists):
 
 - `/usr/share/bash-completion/completions`
 - `/usr/local/etc/bash_completion.d`

data/lib/completely/cli.rb

@@ -1,10 +1,11 @@
 require 'mister_bin'
-require 'completely/version'
 require 'completely/commands/generate'
 require 'completely/commands/init'
 require 'completely/commands/install'
 require 'completely/commands/preview'
 require 'completely/commands/test'
+require 'completely/commands/uninstall'
+require 'completely/version'
 
 module Completely
   class CLI
@@ -18,6 +19,7 @@ module Completely
       runner.route 'generate',  to: Commands::Generate
       runner.route 'test',      to: Commands::Test
       runner.route 'install',   to: Commands::Install
+      runner.route 'uninstall', to: Commands::Uninstall
 
       runner
     end

data/lib/completely/commands/init.rb

@@ -12,7 +12,7 @@ module Completely
       environment_config_path
 
       def run
-        raise "File already exists: #{config_path}" if File.exist? config_path
+        raise Error, "File already exists: #{config_path}" if File.exist? config_path
 
         File.write config_path, sample
         say "Saved m`#{config_path}`"

data/lib/completely/commands/install.rb

@@ -3,19 +3,10 @@ require 'completely/commands/base'
 module Completely
   module Commands
     class Install < Base
-      TARGETS = %W[
-        /usr/share/bash-completion/completions
-        /usr/local/etc/bash_completion.d
-        #{Dir.home}/.bash_completion.d
-      ]
-
       summary 'Install a bash completion script'
 
       help <<~HELP
-        This command will copy the specified file to one of the following directories:
-
-        #{TARGETS.map { |c| "  - #{c}" }.join "\n"}
-
+        This command will copy the specified file to one of the bash completion directories.
         The target filename will be the program name, and sudo will be used if necessary.
       HELP
 
@@ -29,68 +20,27 @@ module Completely
       param 'SCRIPT_PATH', 'Path to the source bash script [default: completely.bash].'
 
       def run
-        bounce
-
         if args['--dry']
-          puts command.join ' '
+          puts installer.install_command_string
           return
         end
 
-        success = system(*command)
-        raise "Failed running command:\nnb`#{command.join ' '}`" unless success
+        success = installer.install force: args['--force']
+        raise InstallError, "Failed running command:\nnb`#{installer.install_command_string}`" unless success
 
-        say "Saved m`#{target_path}`"
+        say "Saved m`#{installer.target_path}`"
         say 'You may need to restart your session to test it'
       end
 
     private
 
-      def bounce
-        unless completions_path
-          raise 'Cannot determine system completions directory'
-        end
-
-        unless File.exist? script_path
-          raise "Cannot find script: m`#{script_path}`"
-        end
-
-        if target_exist? && !args['--force']
-          raise "File exists: m`#{target_path}`\nUse nb`--force` to overwrite"
-        end
-      end
-
-      def target_exist?
-        File.exist? target_path
-      end
-
-      def command
-        result = root? ? [] : %w[sudo]
-        result + %W[cp #{script_path} #{target_path}]
+      def installer
+        Installer.new program: args['PROGRAM'], script_path: script_path
       end
 
       def script_path
         args['SCRIPT_PATH'] || 'completely.bash'
       end
-
-      def target_path
-        "#{completions_path}/#{args['PROGRAM']}"
-      end
-
-      def root?
-        Process.uid.zero?
-      end
-
-      def completions_path
-        @completions_path ||= completions_path!
-      end
-
-      def completions_path!
-        TARGETS.each do |tarnet|
-          return tarnet if Dir.exist? tarnet
-        end
-
-        nil
-      end
     end
   end
 end

data/lib/completely/commands/uninstall.rb

@@ -0,0 +1,39 @@
+require 'completely/commands/base'
+
+module Completely
+  module Commands
+    class Uninstall < Base
+      summary 'Uninstall a bash completion script'
+
+      help <<~HELP
+        This command will remove the completion script for the specified program from all the bash completion directories.
+      HELP
+
+      usage 'completely uninstall PROGRAM [--dry]'
+      usage 'completely uninstall (-h|--help)'
+
+      option '-d --dry', 'Show the uninstallation command but do not run it'
+
+      param 'PROGRAM', 'Name of the program the completions are for.'
+
+      def run
+        if args['--dry']
+          puts installer.uninstall_command_string
+          return
+        end
+
+        success = installer.uninstall
+        raise InstallError, "Failed running command:\nnb`#{installer.uninstall_command_string}`" unless success
+
+        say 'Done'
+        say 'You may need to restart your session to test it'
+      end
+
+    private
+
+      def installer
+        Installer.new program: args['PROGRAM']
+      end
+    end
+  end
+end

data/lib/completely/exceptions.rb

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

data/lib/completely/installer.rb

@@ -0,0 +1,86 @@
+module Completely
+  class Installer
+    attr_reader :program, :script_path
+
+    def initialize(program:, script_path: nil)
+      @program = program
+      @script_path = script_path
+    end
+
+    def target_directories
+      @target_directories ||= %W[
+        /usr/share/bash-completion/completions
+        /usr/local/etc/bash_completion.d
+        #{Dir.home}/.bash_completion.d
+      ]
+    end
+
+    def install_command
+      result = root_user? ? [] : %w[sudo]
+      result + %W[cp #{script_path} #{target_path}]
+    end
+
+    def install_command_string
+      install_command.join ' '
+    end
+
+    def uninstall_command
+      result = root_user? ? [] : %w[sudo]
+      result + %w[rm -f] + target_directories.map { |dir| "#{dir}/#{program}" }
+    end
+
+    def uninstall_command_string
+      uninstall_command.join ' '
+    end
+
+    def target_path
+      "#{completions_path}/#{program}"
+    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
+
+      if target_exist? && !force
+        raise InstallError, "File exists: m`#{target_path}`"
+      end
+
+      system(*install_command)
+    end
+
+    def uninstall
+      system(*uninstall_command)
+    end
+
+  private
+
+    def target_exist?
+      File.exist? target_path
+    end
+
+    def script_exist?
+      File.exist? script_path
+    end
+
+    def root_user?
+      Process.uid.zero?
+    end
+
+    def completions_path
+      @completions_path ||= completions_path!
+    end
+
+    def completions_path!
+      target_directories.each do |target|
+        return target if Dir.exist? target
+      end
+
+      nil
+    end
+  end
+end

data/lib/completely/templates/template.erb

@@ -33,7 +33,7 @@
     echo "cur:      '$cur'" >> 'completely-debug.txt'
   fi
 
-%end
+% end
   case "$compline" in
 % patterns.each do |pattern|
 % next if pattern.empty?

data/lib/completely/version.rb

@@ -1,3 +1,3 @@
 module Completely
-  VERSION = '0.5.4'
+  VERSION = '0.6.1'
 end

data/lib/completely.rb

@@ -3,6 +3,8 @@ if ENV['BYEBUG']
   require 'lp'
 end
 
+require 'completely/exceptions'
 require 'completely/pattern'
 require 'completely/completions'
 require 'completely/tester'
+require 'completely/installer'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: completely
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.1
 platform: ruby
 authors:
 - Danny Ben Shitrit
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-21 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colsole
@@ -61,17 +61,23 @@ files:
 - lib/completely/commands/install.rb
 - lib/completely/commands/preview.rb
 - lib/completely/commands/test.rb
+- lib/completely/commands/uninstall.rb
 - lib/completely/completions.rb
+- lib/completely/exceptions.rb
+- lib/completely/installer.rb
 - lib/completely/pattern.rb
 - lib/completely/templates/sample.yaml
 - lib/completely/templates/template.erb
 - lib/completely/templates/tester-template.erb
 - lib/completely/tester.rb
 - lib/completely/version.rb
-homepage: https://github.com/dannyben/completely
+homepage: https://github.com/DannyBen/completely
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/DannyBen/completely/issues
+  changelog_uri: https://github.com/DannyBen/completely/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/DannyBen/completely
   rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
@@ -81,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.4.14
 signing_key: 
 specification_version: 4
 summary: Bash Completions Generator