Add support for using heredoc (#496)

- Add support for using heredoc

Author: DannyBen

lib/bashly/extensions/array.rb

@@ -3,7 +3,17 @@ def indent(offset)
     return self unless offset.positive?
 
     indentation = ' ' * offset
-    map { |line| "#{indentation}#{line}" }
+    heredoc_marker = nil
+
+    map do |line|
+      if heredoc_marker
+        heredoc_marker = nil if /^#{heredoc_marker}\n?$/.match?(line)
+        line
+      else
+        heredoc_marker = $1 if line =~ /<<-?(\w+)\n?$/
+        "#{indentation}#{line}"
+      end
+    end
   end
 
   def nonuniq

spec/approvals/fixtures/heredoc

@@ -0,0 +1,16 @@
++ bundle exec bashly generate
+creating user files in src
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli
+unindented
+multiline
+heredoc text
+also unindented
+  1 indentation
+    2 indentations
+      3 indentations
+
+      3 indentations with empty line above
+also unindented

spec/bashly/extensions/array_spec.rb

@@ -11,6 +11,40 @@
         expect(subject.indent(0)).to eq subject
       end
     end
+
+    context 'when the string contains heredoc block' do
+      subject do
+        result = <<~SUBJECT
+          function() {
+            cat <<-SOME_EOF_MARKER
+          not-indented
+            indented-once
+              indented-twice
+          SOME_EOF_MARKER
+          } # indented with function() start
+        SUBJECT
+
+        result.lines
+      end
+
+      let(:expected) do
+        result = <<~SUBJECT
+            function() {
+              cat <<-SOME_EOF_MARKER
+          not-indented
+            indented-once
+              indented-twice
+          SOME_EOF_MARKER
+            } # indented with function() start
+        SUBJECT
+
+        result.lines
+      end
+
+      it 'does not indent it but indents everything else' do
+        expect(subject.indent 2).to eq expected
+      end
+    end
   end
 
   describe '#nonuniq' do

spec/fixtures/workspaces/heredoc/.gitignore

@@ -0,0 +1 @@
+cli

spec/fixtures/workspaces/heredoc/README.md

@@ -0,0 +1 @@
+This fixture tests that heredoc blocks are kept unindented

spec/fixtures/workspaces/heredoc/src/bashly.yml

@@ -0,0 +1,3 @@
+name: cli
+help: Sample application to test heredoc
+version: 0.1.0

spec/fixtures/workspaces/heredoc/src/root_command.sh

@@ -0,0 +1,18 @@
+echo unindented
+
+cat <<-FIRST_BLOCK
+multiline
+heredoc text
+FIRST_BLOCK
+
+echo also unindented
+
+cat <<-SECOND_BLOCK
+  1 indentation
+    2 indentations
+      3 indentations
+
+      3 indentations with empty line above
+SECOND_BLOCK
+
+echo also unindented

spec/fixtures/workspaces/heredoc/test.sh

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -x
+
+bundle exec bashly generate
+
+./cli
+