allow appending a footer in the mandoc renderer

Author: DannyBen

.rubocop.yml

@@ -28,7 +28,7 @@ RSpec/FilePath:
     - 'spec/bashly/concerns/completions_command_spec.rb'
     - 'spec/bashly/concerns/completions_flag_spec.rb'
 
-# FIXME: This test is ugly and long
+# Allow longer integration examples as they are more complex by nature
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/bashly/integration/rendering_spec.rb'
+    - 'spec/bashly/integration/**/*'

lib/bashly/libraries/render/mandoc/README.md

@@ -21,3 +21,8 @@ $ PREVIEW="cli download" bashly render :mandoc docs
 # .. and also watch for changes
 $ PREVIEW="cli download" bashly render :mandoc docs --watch
 ```
+
+## Appending a footer
+
+In case you wish to append additional sections to your generated man pages,
+you can place a file named `_footer.md` in your target directory.

lib/bashly/libraries/render/mandoc/mandoc.gtx

@@ -166,6 +166,7 @@ if examples
     >
   end
   > ~~~
+  >
 end
 
 if public_commands.any?
@@ -175,3 +176,5 @@ if public_commands.any?
   = public_commands.map { |x| "**#{x.full_name.to_hyphen}**(1)" }.join ', '
   >
 end
+
+>

lib/bashly/libraries/render/mandoc/render.rb

@@ -11,8 +11,14 @@
   manfile = "#{target}/#{command.full_name.tr(' ', '-')}.1"
   save mdfile, gtx.parse(command)
 
-  cmd = %[pandoc -f markdown-smart -s --to man "#{mdfile}" > "#{manfile}"]
+  # Append the footer file if it exists
+  footer_file = "#{target}/_footer.md"
+  if File.exist? footer_file
+    File.append mdfile, File.read(footer_file)
+  end
 
+  # The pandoc command that creates a manpage from markdown
+  cmd = %[pandoc -f markdown-smart -s --to man "#{mdfile}" > "#{manfile}"]
   success = system cmd
   raise "Failed running pandoc\nMake sure the following command succeeds and try again:\n\n  #{cmd}" unless success
 

spec/approvals/rendering/mandoc/catch-all-advanced/cli-download.md

@@ -51,3 +51,4 @@ cli download example.com
 cli download example.com ./output -f
 
 ~~~
+

spec/approvals/rendering/mandoc/minimal/download.md

@@ -46,3 +46,4 @@ download example.com
 download example.com ./output -f
 
 ~~~
+

spec/bashly/integration/rendering_spec.rb renamed to spec/bashly/integration/rendering_mandoc_spec.rb

@@ -1,6 +1,6 @@
 # This spec tests that the rendering using the libraries/render templates
 # is generating the expected output.
-describe 'rendering templates' do
+describe 'rendering mandoc' do
   subject { Commands::Render.new }
 
   target = 'spec/tmp'
@@ -22,19 +22,7 @@
         reset_tmp_dir
       end
 
-      it 'renders markdown properly' do
-        expect { subject.execute %W[render :markdown #{target}] }
-          .to output_approval("rendering/markdown/#{example}/stdout")
-
-        Dir["#{target}/*.md"].each do |file|
-          puts "    => #{file}"
-          basename = File.basename file
-          expect(File.read file).to match_approval("rendering/markdown/#{example}/#{basename}")
-            .diff(leeway)
-        end
-      end
-
-      it 'renders mandoc properly' do
+      it 'renders properly' do
         expect { subject.execute %W[render :mandoc #{target}] }
           .to output_approval("rendering/mandoc/#{example}/stdout")
 

spec/bashly/integration/rendering_markdown_spec.rb

@@ -0,0 +1,38 @@
+# This spec tests that the rendering using the libraries/render templates
+# is generating the expected output.
+describe 'rendering markdown' do
+  subject { Commands::Render.new }
+
+  target = 'spec/tmp'
+  examples = %w[
+    catch-all-advanced
+    dependencies-alt
+    docker-like
+    extensible-delegate
+    minimal
+  ]
+
+  # Allow up to a certain string distance from the approval text in CI
+  leeway = ENV['CI'] ? 20 : 0
+
+  examples.each do |example|
+    describe example do
+      before do
+        Settings.config_path = "examples/#{example}/src/bashly.yml"
+        reset_tmp_dir
+      end
+
+      it 'renders properly' do
+        expect { subject.execute %W[render :markdown #{target}] }
+          .to output_approval("rendering/markdown/#{example}/stdout")
+
+        Dir["#{target}/*.md"].each do |file|
+          puts "    => #{file}"
+          basename = File.basename file
+          expect(File.read file).to match_approval("rendering/markdown/#{example}/#{basename}")
+            .diff(leeway)
+        end
+      end
+    end
+  end
+end