add --dry

Author: DannyBen

lib/completely/commands/install.rb

@@ -19,20 +19,28 @@ class Install < Base
         The target filename will be the program name, and sudo will be used if necessary.
       HELP
 
-      usage 'completely install PROGRAM [SCRIPT_PATH --force]'
+      usage 'completely install PROGRAM [SCRIPT_PATH --force --dry]'
       usage 'completely install (-h|--help)'
 
       option '-f --force', 'Overwrite target file if it exists'
+      option '-d --dry', 'Show the installation command but do not run it'
 
       param 'PROGRAM', 'Name of the program the completions are for.'
       param 'SCRIPT_PATH', 'Path to the source bash script [default: completely.bash].'
 
       def run
         bounce
+
+        if args['--dry']
+          puts command.join ' '
+          return
+        end
+
         success = system(*command)
         raise "Failed running command:\nnb`#{command.join ' '}`" unless success
 
         say "Saved m`#{target_path}`"
+        say 'You may need to restart your session to test it'
       end
 
     private

spec/approvals/cli/install/dry

@@ -0,0 +1 @@
+sudo cp README.md /usr/share/bash-completion/completions/completely-test

spec/approvals/cli/install/help

@@ -10,13 +10,16 @@ The target filename will be the program name, and sudo will be used if
 necessary.
 
 Usage:
-  completely install PROGRAM [SCRIPT_PATH --force]
+  completely install PROGRAM [SCRIPT_PATH --force --dry]
   completely install (-h|--help)
 
 Options:
   -f --force
     Overwrite target file if it exists
 
+  -d --dry
+    Show the installation command but do not run it
+
   -h --help
     Show this help
 

spec/approvals/cli/install/install-default

@@ -1 +1,2 @@
 Saved /usr/share/bash-completion/completions/completely-test
+You may need to restart your session to test it

spec/approvals/cli/install/install-specified

@@ -1 +1,2 @@
 Saved /usr/share/bash-completion/completions/completely-test
+You may need to restart your session to test it

spec/approvals/cli/install/no-args

@@ -1,3 +1,3 @@
 Usage:
-  completely install PROGRAM [SCRIPT_PATH --force]
+  completely install PROGRAM [SCRIPT_PATH --force --dry]
   completely install (-h|--help)

spec/completely/commands/install_spec.rb

@@ -5,32 +5,35 @@
 
   context 'with --help' do
     it 'shows long usage' do
-      expect { subject.execute %w[install --help] }.to output_approval('cli/install/help').diff(10)
+      expect { subject.execute %w[install --help] }
+        .to output_approval('cli/install/help').diff(10)
     end
   end
 
   context 'without arguments' do
     it 'shows short usage' do
-      expect { subject.execute %w[install] }.to output_approval('cli/install/no-args')
+      expect { subject.execute %w[install] }
+        .to output_approval('cli/install/no-args')
     end
   end
 
   context 'with only the program name argument' do
     context 'when the default script is not found' do
       it 'raises an error' do
-        expect { subject.execute %w[install completely-test] }.to raise_approval('cli/install/missing-script')
+        expect { subject.execute %w[install completely-test] }
+          .to raise_approval('cli/install/missing-script')
       end
     end
 
     context 'when the default script is found' do
-      let(:expected_args) {
+      let(:expected_args) do
         %w[
           sudo
           cp
           completely.bash
           /usr/share/bash-completion/completions/completely-test
         ]
-      }
+      end
 
       before do
         reset_tmp_dir
@@ -39,40 +42,51 @@
 
       it 'copies the script' do
         Dir.chdir 'spec/tmp' do
-          expect(subject).to receive(:system).with(*expected_args).and_return true
-          expect { subject.execute %W[install completely-test] }.to output_approval('cli/install/install-default')
+          allow(subject).to receive(:system).with(*expected_args).and_return true
+          expect { subject.execute %w[install completely-test] }
+            .to output_approval('cli/install/install-default')
         end
       end
     end
   end
 
   context 'with the program name argument and a script argument' do
-    let(:expected_args) {
+    let(:expected_args) do
       %w[
         sudo
         cp
         README.md
         /usr/share/bash-completion/completions/completely-test
       ]
-    }
+    end
 
     it 'copies the script' do
-      expect(subject).to receive(:system).with(*expected_args).and_return true
-      expect { subject.execute %W[install completely-test README.md] }.to output_approval('cli/install/install-specified')
+      allow(subject).to receive(:system).with(*expected_args).and_return true
+      expect { subject.execute %w[install completely-test README.md] }
+        .to output_approval('cli/install/install-specified')
+    end
+  end
+
+  context 'with --dry' do
+    it 'shows the command' do
+      expect { subject.execute %w[install completely-test README.md --dry] }
+        .to output_approval('cli/install/dry')
     end
   end
 
   context 'when none of the target directories is found' do
     it 'raises an error' do
-      expect(subject).to receive(:completions_path).and_return nil
-      expect { subject.execute %W[install completely-test README.md] }.to raise_approval('cli/install/no-completion-targets')
+      allow(subject).to receive(:completions_path).and_return nil
+      expect { subject.execute %w[install completely-test README.md] }
+        .to raise_approval('cli/install/no-completion-targets')
     end
   end
 
   context 'when the target file exists' do
     it 'raises an error' do
-      expect(subject).to receive(:target_exist?).and_return true
-      expect { subject.execute %W[install completely-test README.md] }.to raise_approval('cli/install/target-exists')
+      allow(subject).to receive(:target_exist?).and_return true
+      expect { subject.execute %w[install completely-test README.md] }
+        .to raise_approval('cli/install/target-exists')
     end
   end
 end