Merge pull request #395 from DannyBen/add/completions-uninstaller

Add `bashly completions --uninstall` command

Author: DannyBen

bashly.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 3.0'
 
   s.add_runtime_dependency 'colsole', '>= 0.8.1', '< 2'
-  s.add_runtime_dependency 'completely', '~> 0.6'
+  s.add_runtime_dependency 'completely', '~> 0.6.1'
   s.add_runtime_dependency 'filewatcher', '~> 2.0'
   s.add_runtime_dependency 'gtx', '~> 0.1'
   s.add_runtime_dependency 'lp', '~> 0.2'

lib/bashly/commands/completions.rb

@@ -4,14 +4,17 @@ class Completions < Base
       summary 'Install bash completions for bashly itself'
       help 'Display the bash completions script or install it directly to your bash completions directory'
 
-      usage 'bashly completions [--install]'
+      usage 'bashly completions [--install --uninstall]'
       usage 'bashly completions (-h|--help)'
 
       option '-i --install', 'Install the completions script to your bash completions directory'
+      option '-u --uninstall', 'Uninstall the completions script from your bash completions directory'
 
       def run
         if args['--install']
           install_completions
+        elsif args['--uninstall']
+          uninstall_completions
         else
           puts script
         end
@@ -25,14 +28,22 @@ def installer
 
       def install_completions
         success = installer.install force: true
-        raise Error, "Failed running command:\nnb`#{installer.command_string}`" unless success
+        raise Error, "Failed running command:\nnb`#{installer.install_command_string}`" unless success
 
-        say 'Completions installed.'
+        say 'Completions installed'
         say "Source: m`#{installer.script_path}`"
         say "Target: m`#{installer.target_path}`"
         say 'Restart your session for the changes to take effect'
       end
 
+      def uninstall_completions
+        success = installer.uninstall
+        raise Error, "Failed running command:\nnb`#{installer.uninstall_command_string}`" unless success
+
+        say 'Completions uninstalled'
+        say 'Restart your session for the changes to take effect'
+      end
+
       def script_path
         @script_path ||= asset('completions/bashly-completions.bash')
       end

spec/approvals/cli/completions/help

@@ -4,12 +4,15 @@ Display the bash completions script or install it directly to your bash
 completions directory
 
 Usage:
-  bashly completions [--install]
+  bashly completions [--install --uninstall]
   bashly completions (-h|--help)
 
 Options:
   -i --install
     Install the completions script to your bash completions directory
 
+  -u --uninstall
+    Uninstall the completions script from your bash completions directory
+
   -h --help
     Show this help

spec/approvals/cli/completions/install

@@ -1,4 +1,4 @@
-Completions installed.
+Completions installed
 Source: some-script-path
 Target: some-target-path
 Restart your session for the changes to take effect

spec/approvals/cli/completions/uninstall

@@ -0,0 +1,2 @@
+Completions uninstalled
+Restart your session for the changes to take effect

spec/approvals/cli/completions/uninstall-error

@@ -0,0 +1,2 @@
+#<Bashly::Error: Failed running command:
+nb`rm -f some files`>

spec/bashly/commands/completions_spec.rb

@@ -8,10 +8,12 @@
   let(:completions_script) { File.read completions_path }
   let :mock_installer do
     instance_double Completely::Installer,
-      install:        true,
-      target_path:    'some-target-path',
-      script_path:    'some-script-path',
-      command_string: 'cp source target'
+      install:                  true,
+      uninstall:                true,
+      target_path:              'some-target-path',
+      script_path:              'some-script-path',
+      install_command_string:   'cp source target',
+      uninstall_command_string: 'rm -f some files'
   end
 
   describe '#installer' do
@@ -55,4 +57,24 @@
       end
     end
   end
+
+  context 'with --uninstall' do
+    it 'uninstalls the completions script from all completions directories' do
+      allow(subject).to receive(:installer).and_return mock_installer
+
+      expect { subject.execute %w[completions --uninstall] }
+        .to output_approval('cli/completions/uninstall')
+    end
+
+    context 'when the installer fails' do
+      it 'raises an error' do
+        allow(subject).to receive(:installer).and_return mock_installer
+        allow(mock_installer).to receive(:uninstall).and_return(false)
+
+        expect { subject.execute %w[completions --uninstall] }
+          .to raise_approval('cli/completions/uninstall-error')
+          .diff(leeway)
+      end
+    end
+  end
 end