- Add stdin support for installer command

Author: DannyBen

lib/completely/commands/install.rb

@@ -1,3 +1,4 @@
+require 'tempfile'
 require 'completely/commands/base'
 
 module Completely
@@ -17,9 +18,19 @@ class Install < Base
       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].'
+      param 'SCRIPT_PATH', <<~USAGE
+        Path to the source bash script [default: completely.bash].
+        Use '-' to provide the script via stdin.
+      USAGE
 
       def run
+        if script_path == '-'
+          raise InstallError, "Nothing is piped on stdin" if $stdin.tty?
+
+          @script_path = tempfile.path
+          File.write script_path, $stdin.read
+        end
+
         if args['--dry']
           puts installer.install_command_string
           return
@@ -32,6 +43,10 @@ def run
         say 'You may need to restart your session to test it'
       end
 
+      def tempfile
+        @tempfile ||= Tempfile.new('stdin-completely-')
+      end
+
     private
 
       def installer

lib/completely/installer.rb

@@ -73,15 +73,13 @@ def root_user?
     end
 
     def completions_path
-      @completions_path ||= completions_path!
-    end
+      @completions_path ||= begin
+        target_directories.each do |target|
+          return target if Dir.exist? target
+        end
 
-    def completions_path!
-      target_directories.each do |target|
-        return target if Dir.exist? target
+        nil
       end
-
-      nil
     end
   end
 end

spec/approvals/cli/install/help

@@ -25,3 +25,4 @@ Parameters:
 
   SCRIPT_PATH
     Path to the source bash script [default: completely.bash].
+    Use '-' to provide the script via stdin.

spec/approvals/cli/install/stdin-dry

@@ -0,0 +1 @@
+sudo cp <tmpfile-path> /usr/share/bash-completion/completions/completely-test

spec/approvals/cli/install/stdin-install

@@ -0,0 +1,2 @@
+Saved some-target-path
+You may need to restart your session to test it

spec/completely/commands/install_spec.rb

@@ -34,6 +34,20 @@
     end
   end
 
+  context 'with PROGRAM - (stdin)' do
+    it 'invokes the Installer using a temp file' do
+      allow(subject).to receive(:installer).and_return(mock_installer)
+      allow($stdin).to receive_messages(tty?: false, read: 'dummy data')
+
+      expect(mock_installer).to receive(:install)
+
+      expect { subject.execute %w[install completely-test -] }
+        .to output_approval('cli/install/stdin-install')
+
+      expect(File.read subject.tempfile.path).to eq 'dummy data'
+    end
+  end
+
   context 'with PROGRAM --dry' do
     it 'shows the command and does not install anything' do
       expect(mock_installer).not_to receive(:install)
@@ -43,6 +57,29 @@
     end
   end
 
+  context 'with PROGRAM - --dry (stdin)' do
+    it 'shows the command and does not install anything' do
+      allow($stdin).to receive_messages(tty?: false, read: 'dummy data')
+
+      expect(mock_installer).not_to receive(:install)
+
+      expect { subject.execute %w[install completely-test - --dry] }
+        .to output_approval('cli/install/stdin-dry')
+        .except(/[^\s]*stdin-completely-[^\s]*/, '<tmpfile-path>')
+    end
+
+    context 'when stdin is empty' do
+      it 'raises InstallError' do
+        allow($stdin).to receive_messages(tty?: true, read: nil)
+        expect(mock_installer).not_to receive(:install)
+
+        expect { subject.execute %w[install completely-test - --dry] }
+          .to raise_error(InstallError, 'Nothing is piped on stdin')
+      end
+    end
+  end
+
+
   context 'when the installer fails' do
     it 'raises an error' do
       allow(subject).to receive(:installer).and_return(mock_installer)

spec/completely/installer_spec.rb

@@ -25,6 +25,16 @@
       expect(subject.target_path)
         .to eq '/usr/share/bash-completion/completions/completely-test'
     end
+
+    # This method will not be called if there is no completions path
+    # The test is here to cover the nil fallback
+    context 'when no paths found' do
+      it 'returns nil as the base path' do
+        allow(subject).to receive(:target_directories).and_return([])
+
+        expect(subject.target_path).to eq '/completely-test'
+      end
+    end
   end
 
   describe '#install_command' do