add formatter specs

Author: DannyBen

lib/bashly/exceptions.rb

@@ -3,5 +3,4 @@ class Interrupt < Interrupt; end
   class Error < StandardError; end
   class InitError < Error; end
   class ConfigurationError < Error; end
-  class DependencyError < Error; end
 end

lib/bashly/script/formatter.rb

@@ -10,7 +10,7 @@ class Formatter
 
       def initialize(script, mode: nil)
         @script = script
-        @mode = mode
+        @mode = mode || :internal
       end
 
       def formatted_script
@@ -30,8 +30,15 @@ def shfmt_result
 
       def custom_formatter_result(command)
         command = Shellwords.split command if command.is_a? String
-        output, error, status = Open3.capture3 *command, stdin_data: script
-        raise DependencyError, "Failed running g`#{command}`:\n\n#{error}" unless status.success?
+        
+        begin
+          output, error, status = Open3.capture3(*command, stdin_data: script)
+        rescue Errno::ENOENT => e
+          raise Error, "Command not found: `#{command.join(' ')}`"
+        end
+
+        raise Error, "Failed running `#{command.join(' ')}`:\n\n#{error}" unless status.success?
+
 
         output
       end

spec/approvals/formatter/error-failure

@@ -0,0 +1 @@
+#<Bashly::Error:"Failed running `shfmt --diff`:\n\n">

spec/approvals/formatter/error-not-found

@@ -0,0 +1 @@
+#<Bashly::Error: Command not found: `my_glorious_formatter`>

spec/approvals/formatter/internal

@@ -0,0 +1,14 @@
+#!/usr/bin/env bash
+
+funk() {
+  cat <<EOF
+start multiline heredoc test
+
+end multiline heredoc test
+EOF
+
+  echo "unnecessary multiline test"
+
+  echo "unnecessary multiline test complete"
+        echo "rogue indentation"
+}

spec/approvals/formatter/shfmt

@@ -0,0 +1,16 @@
+#!/usr/bin/env bash
+
+funk() {
+  cat <<EOF
+start multiline heredoc test
+
+
+
+end multiline heredoc test
+EOF
+
+  echo "unnecessary multiline test"
+
+  echo "unnecessary multiline test complete"
+  echo "rogue indentation"
+}

spec/approvals/formatter/shfmt-custom

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+funk()
+{
+	cat <<EOF
+start multiline heredoc test
+
+
+
+end multiline heredoc test
+EOF
+
+	echo "unnecessary multiline test"
+
+	echo "unnecessary multiline test complete"
+	echo "rogue indentation"
+}

spec/bashly/script/formatter_spec.rb

@@ -0,0 +1,53 @@
+describe Script::Formatter do
+  subject { described_class.new script, mode: mode }
+
+  let(:script) { File.read "spec/fixtures/formatter/#{script_id}.sh" }
+  let(:script_id) { :simple }
+  let(:mode) { nil }
+
+  describe '#formatted_script' do
+    it 'formats the script using the internal formatter' do
+      expect(subject.formatted_script).to match_approval 'formatter/internal'
+    end
+
+    context 'with mode: :none' do
+      let(:mode) { :none }
+
+      it 'returns the original script' do
+        expect(subject.formatted_script).to eq script
+      end
+    end
+
+    context 'with mode: :shfmt' do
+      let(:mode) { :shfmt }
+
+      it 'uses shfmt to format the script' do
+        expect(subject.formatted_script).to match_approval 'formatter/shfmt'
+      end
+    end
+
+    context 'with mode: shfmt (string)' do
+      let(:mode) { 'shfmt --func-next-line' }
+
+      it 'uses the given command shfmt to format the script' do
+        expect(subject.formatted_script).to match_approval 'formatter/shfmt-custom'
+      end
+    end
+
+    context 'when the external command does not exist' do
+      let(:mode) { 'my_glorious_formatter' }
+
+      it 'raises a Bashly::Error' do
+        expect { subject.formatted_script }.to raise_approval 'formatter/error-not-found'
+      end
+    end
+
+    context 'when the external command fails' do
+      let(:mode) { 'shfmt --diff' }
+
+      it 'raises a a Bashly::Error' do
+        expect { subject.formatted_script }.to raise_approval 'formatter/error-failure'
+      end
+    end
+  end
+end

spec/fixtures/formatter/simple.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+funk() {
+  cat <<EOF
+start multiline heredoc test
+
+
+
+end multiline heredoc test
+EOF
+
+  echo "unnecessary multiline test"
+
+
+
+  echo "unnecessary multiline test complete"
+        echo "rogue indentation"
+}