Merge pull request #53 from DannyBen/add/uninstall

DannyBen · web-flow · commit f7ed6937d752 · 2023-06-23T13:31:18.000+03:00
Add ability to uninstall a completion script
diff --git a/lib/completely/cli.rb b/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 @@ def self.runner
       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
diff --git a/lib/completely/commands/install.rb b/lib/completely/commands/install.rb
@@ -21,12 +21,12 @@ class Install < Base
 
       def run
         if args['--dry']
-          puts installer.command_string
+          puts installer.install_command_string
           return
         end
 
         success = installer.install force: args['--force']
-        raise InstallError, "Failed running command:\nnb`#{installer.command_string}`" unless success
+        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'
diff --git a/lib/completely/commands/uninstall.rb b/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
diff --git a/lib/completely/installer.rb b/lib/completely/installer.rb
@@ -15,13 +15,22 @@ def target_directories
       ]
     end
 
-    def command
+    def install_command
       result = root_user? ? [] : %w[sudo]
       result + %W[cp #{script_path} #{target_path}]
     end
 
-    def command_string
-      command.join ' '
+    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
@@ -41,7 +50,11 @@ def install(force: false)
         raise InstallError, "File exists: m`#{target_path}`"
       end
 
-      system(*command)
+      system(*install_command)
+    end
+
+    def uninstall
+      system(*uninstall_command)
     end
 
   private
diff --git a/spec/approvals/cli/commands b/spec/approvals/cli/commands
@@ -1,10 +1,11 @@
 Completely - Bash Completions Generator
 
 Commands:
-  init      Create a new sample YAML configuration file
-  preview   Generate the bash completion script to STDOUT
-  generate  Generate the bash completion script to a file
-  test      Test completions
-  install   Install a bash completion script
+  init       Create a new sample YAML configuration file
+  preview    Generate the bash completion script to STDOUT
+  generate   Generate the bash completion script to a file
+  test       Test completions
+  install    Install a bash completion script
+  uninstall  Uninstall a bash completion script
 
 Run completely COMMAND --help for more information
diff --git a/spec/approvals/cli/uninstall/dry b/spec/approvals/cli/uninstall/dry
@@ -0,0 +1 @@
+sudo rm -f /usr/share/bash-completion/completions/completely-test /usr/local/etc/bash_completion.d/completely-test /home/vagrant/.bash_completion.d/completely-test
diff --git a/spec/approvals/cli/uninstall/help b/spec/approvals/cli/uninstall/help
@@ -0,0 +1,19 @@
+Uninstall a bash completion script
+
+This command will remove the completion script for the specified program from
+all the bash completion directories.
+
+Usage:
+  completely uninstall PROGRAM [--dry]
+  completely uninstall (-h|--help)
+
+Options:
+  -d --dry
+    Show the uninstallation command but do not run it
+
+  -h --help
+    Show this help
+
+Parameters:
+  PROGRAM
+    Name of the program the completions are for.
diff --git a/spec/approvals/cli/uninstall/no-args b/spec/approvals/cli/uninstall/no-args
@@ -0,0 +1,3 @@
+Usage:
+  completely uninstall PROGRAM [--dry]
+  completely uninstall (-h|--help)
diff --git a/spec/approvals/cli/uninstall/uninstall b/spec/approvals/cli/uninstall/uninstall
@@ -0,0 +1,2 @@
+Done
+You may need to restart your session to test it
diff --git a/spec/approvals/cli/uninstall/uninstall-error b/spec/approvals/cli/uninstall/uninstall-error
@@ -0,0 +1,2 @@
+#<Completely::InstallError: Failed running command:
+nb`rm -f some paths`>
diff --git a/spec/completely/commands/install_spec.rb b/spec/completely/commands/install_spec.rb
@@ -1,12 +1,12 @@
 describe Commands::Install do
   subject { described_class.new }
 
-  let(:leeway) { RUBY_VERSION < "3.2.0" ? 0 : 5 }
+  let(:leeway) { RUBY_VERSION < '3.2.0' ? 0 : 5 }
   let :mock_installer do
     instance_double Installer,
-      install:        true,
-      target_path:    'some-target-path',
-      command_string: 'sudo cp source target'
+      install:                true,
+      target_path:            'some-target-path',
+      install_command_string: 'sudo cp source target'
   end
 
   context 'with --help' do
diff --git a/spec/completely/commands/uninstall_spec.rb b/spec/completely/commands/uninstall_spec.rb
@@ -0,0 +1,54 @@
+describe Commands::Uninstall do
+  subject { described_class.new }
+
+  let(:leeway) { RUBY_VERSION < '3.2.0' ? 0 : 5 }
+  let :mock_installer do
+    instance_double Installer,
+      uninstall:                true,
+      uninstall_command_string: 'rm -f some paths'
+  end
+
+  context 'with --help' do
+    it 'shows long usage' do
+      expect { subject.execute %w[uninstall --help] }
+        .to output_approval('cli/uninstall/help')
+    end
+  end
+
+  context 'without arguments' do
+    it 'shows short usage' do
+      expect { subject.execute %w[uninstall] }
+        .to output_approval('cli/uninstall/no-args')
+    end
+  end
+
+  context 'with PROGRAM' do
+    it 'invokes the Installer' do
+      allow(subject).to receive(:installer).and_return(mock_installer)
+
+      expect(mock_installer).to receive(:uninstall)
+
+      expect { subject.execute %w[uninstall completely-test] }
+        .to output_approval('cli/uninstall/uninstall')
+    end
+  end
+
+  context 'with PROGRAM --dry' do
+    it 'shows the command and does not install anything' do
+      expect(mock_installer).not_to receive(:uninstall)
+
+      expect { subject.execute %w[uninstall completely-test --dry] }
+        .to output_approval('cli/uninstall/dry').diff(20)
+    end
+  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[uninstall completely-test] }
+        .to raise_approval('cli/uninstall/uninstall-error').diff(leeway)
+    end
+  end
+end
diff --git a/spec/completely/installer_spec.rb b/spec/completely/installer_spec.rb
@@ -1,46 +1,71 @@
 describe Installer do
   subject { described_class.new program: program, script_path: script_path }
 
-  let(:leeway) { RUBY_VERSION < "3.2.0" ? 0 : 3 }
+  let(:leeway) { RUBY_VERSION < '3.2.0' ? 0 : 3 }
   let(:program) { 'completely-test' }
   let(:script_path) { 'completions.bash' }
-  let(:expected_command) do
+  let(:targets) { subject.target_directories.map { |dir| "#{dir}/#{program}" } }
+  let(:install_command) do
     %W[sudo cp #{subject.script_path} #{subject.target_path}]
   end
 
+  let(:uninstall_command) do
+    %w[sudo rm -f] + targets
+  end
+
   describe '#target_directories' do
     it 'returns an array of potential completion directories' do
       expect(subject.target_directories).to be_an Array
       expect(subject.target_directories.size).to eq 3
     end
   end
 
-  describe '#command' do
+  describe '#target_path' do
+    it 'returns the first matching path' do
+      expect(subject.target_path)
+        .to eq '/usr/share/bash-completion/completions/completely-test'
+    end
+  end
+
+  describe '#install_command' do
     it 'returns a copy command as an array' do
-      expect(subject.command)
+      expect(subject.install_command)
         .to eq %w[sudo cp completions.bash /usr/share/bash-completion/completions/completely-test]
     end
 
     context 'when the user is root' do
       it 'returns the command without sudo' do
         allow(subject).to receive(:root_user?).and_return true
 
-        expect(subject.command)
+        expect(subject.install_command)
           .to eq %w[cp completions.bash /usr/share/bash-completion/completions/completely-test]
       end
     end
   end
 
-  describe '#command_string' do
-    it 'returns the command as a string' do
-      expect(subject.command_string).to eq subject.command.join(' ')
+  describe '#install_command_string' do
+    it 'returns the install command as a string' do
+      expect(subject.install_command_string).to eq subject.install_command.join(' ')
     end
   end
 
-  describe '#target_path' do
-    it 'returns the first matching path' do
-      expect(subject.target_path)
-        .to eq '/usr/share/bash-completion/completions/completely-test'
+  describe '#uninstall_command' do
+    it 'returns an rm command as an array' do
+      expect(subject.uninstall_command).to eq %w[sudo rm -f] + targets
+    end
+
+    context 'when the user is root' do
+      it 'returns the command without sudo' do
+        allow(subject).to receive(:root_user?).and_return true
+
+        expect(subject.uninstall_command).to eq %w[rm -f] + targets
+      end
+    end
+  end
+
+  describe '#uninstall_command_string' do
+    it 'returns the uninstall command as a string' do
+      expect(subject.uninstall_command_string).to eq subject.uninstall_command.join(' ')
     end
   end
 
@@ -84,7 +109,7 @@
       it 'proceeds to install' do
         allow(subject).to receive(:target_path).and_return existing_file
 
-        expect(subject).to receive(:system).with(*expected_command)
+        expect(subject).to receive(:system).with(*install_command)
 
         subject.install force: true
       end
@@ -94,10 +119,18 @@
       it 'proceeds to install' do
         allow(subject).to receive(:target_path).and_return missing_file
 
-        expect(subject).to receive(:system).with(*expected_command)
+        expect(subject).to receive(:system).with(*install_command)
 
         subject.install
       end
     end
   end
+
+  describe '#uninstall' do
+    it 'removes the completions script' do
+      expect(subject).to receive(:system).with(*uninstall_command)
+
+      subject.uninstall
+    end
+  end
 end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+sudo rm -f /usr/share/bash-completion/completions/completely-test /usr/local/etc/bash_completion.d/completely-test /home/vagrant/.bash_completion.d/completely-test`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Usage:`
	`2`	`+ completely uninstall PROGRAM [--dry]`
	`3`	`+ completely uninstall (-h\|--help)`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+Done`
	`2`	`+You may need to restart your session to test it`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+#<Completely::InstallError: Failed running command:`
	`2`	+nb`rm -f some paths`>