add specs for completions command

Author: DannyBen

lib/bashly/commands/completions.rb

@@ -20,12 +20,12 @@ def run
     private
 
       def install_completions
-        raise Error, "Cannot find completions directory" unless compdir
+        raise Error, 'Cannot find completions directory' unless compdir
 
         target = "#{compdir}/bashly"
 
         say "Installing completions to m`#{target}`"
-        command = %Q[cp "#{completions_path}" "#{target}"]
+        command = %[cp "#{completions_path}" "#{target}"]
         command = "sudo #{command}" unless root_user?
         system command
 
@@ -45,21 +45,24 @@ def completions_script
       end
 
       def compdir
-        @compdir ||= begin
-          candidates = [
-            '/usr/share/bash-completion/completions',
-            '/usr/local/etc/bash_completion.d'
-          ]
-        
-          candidates.each { |dir| return dir if Dir.exist? dir }
-          nil
-        end
+        @compdir ||= compdir!
+      end
+
+      def compdir!
+        compdir_candidates.each { |dir| return dir if Dir.exist? dir }
+        nil
+      end
+
+      def compdir_candidates
+        @compdir_candidates ||= [
+          '/usr/share/bash-completion/completions',
+          '/usr/local/etc/bash_completion.d',
+        ]
       end
 
       def root_user?
-        Process.uid == 0
+        Process.uid.zero?
       end
     end
-
   end
 end

lib/bashly/completions/completely.yaml.gtx

@@ -61,7 +61,6 @@ end
 libs.each do |lib|
   = "- #{lib}"
 end
-
 > 
 > bashly a: *add
 > 
@@ -72,15 +71,15 @@ end
 docs.each do |doc|
   = "- #{doc}"
 end
-
+>
 > bashly completions: &completions
 = help_flags
 > - --install
 > - -i
 > 
 > bashly c: *completions
-
+>
 > bashly shell: &shell
 = help_flags
 > 
-> bashly s: *shell
+> bashly s: *shell

spec/approvals/cli/commands

@@ -1,13 +1,14 @@
 Bashly - Bash CLI Generator
 
 Commands:
-  init      Initialize a new workspace
-  preview   Generate the bash script to STDOUT
-  validate  Scan the configuration file for errors
-  generate  Generate the bash script and required files
-  add       Add extra features and customization to your script
-  doc       Show bashly reference documentation
-  shell     Start an interactive bashly shell
+  init         Initialize a new workspace
+  preview      Generate the bash script to STDOUT
+  validate     Scan the configuration file for errors
+  generate     Generate the bash script and required files
+  add          Add extra features and customization to your script
+  doc          Show bashly reference documentation
+  completions  Install bash completions for bashly itself
+  shell        Start an interactive bashly shell
 
 Help: bashly COMMAND --help
 Docs: https://bashly.dannyb.co

spec/approvals/cli/completions/help

@@ -0,0 +1,15 @@
+Install bash completions for bashly itself
+
+Display the bash completions script or install it directly to your bash
+completions directory
+
+Usage:
+  bashly completions [--install]
+  bashly completions (-h|--help)
+
+Options:
+  -i --install
+    Install the completions script to your bash completions directory
+
+  -h --help
+    Show this help

spec/approvals/cli/completions/install

@@ -0,0 +1,2 @@
+Installing completions to /tmp/bashly
+Restart your session for the changes to take effect.

spec/approvals/cli/completions/install-error

@@ -0,0 +1 @@
+#<Bashly::Error: Cannot find completions directory>

spec/approvals/cli/completions/install-root

@@ -0,0 +1,2 @@
+Installing completions to /tmp/bashly
+Restart your session for the changes to take effect.

spec/approvals/cli/shell/boot

@@ -1,12 +1,13 @@
 Bashly - Bash CLI Generator
 
 Commands:
-  init      Initialize a new workspace
-  preview   Generate the bash script to STDOUT
-  validate  Scan the configuration file for errors
-  generate  Generate the bash script and required files
-  add       Add extra features and customization to your script
-  doc       Show bashly reference documentation
+  init         Initialize a new workspace
+  preview      Generate the bash script to STDOUT
+  validate     Scan the configuration file for errors
+  generate     Generate the bash script and required files
+  add          Add extra features and customization to your script
+  doc          Show bashly reference documentation
+  completions  Install bash completions for bashly itself
 
 Help: bashly COMMAND --help
 Docs: https://bashly.dannyb.co

spec/bashly/commands/completions_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe Commands::Completions do
+  subject { described_class.new }
+
+  let(:completions_path) { File.expand_path 'lib/bashly/completions/bashly-completions.bash' }
+  let(:completions_script) { File.read completions_path }
+
+  context 'with --help' do
+    it 'shows long usage' do
+      expect { subject.execute %w[completions --help] }.to output_approval('cli/completions/help')
+    end
+  end
+
+  context 'without arguments' do
+    it 'shows the completions script' do
+      expect { subject.execute %w[completions] }.to output(completions_script).to_stdout
+    end
+  end
+
+  context 'with --install' do
+    it 'installs the completions script to the completions directory' do
+      allow(subject).to receive(:compdir_candidates).and_return ['/tmp']
+      expect(subject).to receive(:system).with(%Q[sudo cp "#{completions_path}" "/tmp/bashly"])
+      expect { subject.execute %w[completions --install] }.to output_approval('cli/completions/install')
+    end
+
+    context 'when the completions directory is not found' do
+      it 'raises an error' do
+        allow(Dir).to receive(:exist?).twice.and_return(false)
+        expect { subject.execute %w[completions --install] }.to raise_approval('cli/completions/install-error')
+      end
+    end
+
+    context 'when running as root' do
+      it 'installs the completions script to the completions directory without sudo' do
+        allow(subject).to receive(:compdir_candidates).and_return ['/tmp']
+        allow(subject).to receive(:root_user?).and_return true
+        expect(subject).to receive(:system).with(%Q[cp "#{completions_path}" "/tmp/bashly"])
+        expect { subject.execute %w[completions --install] }.to output_approval('cli/completions/install-root')
+      end
+    end
+  end
+end