shims/super: add pod2man shim

Author: alebcay

Diff for: Library/Homebrew/shims/linux/super/pod2man

@@ -0,0 +1 @@
+../../super/pod2man

Diff for: Library/Homebrew/shims/mac/super/pod2man

@@ -0,0 +1 @@
+../../super/pod2man

Diff for: Library/Homebrew/shims/super/pod2man

@@ -0,0 +1,89 @@
+#!/bin/bash
+# vim: ft=ruby
+# Make sure this shim uses the same Ruby interpreter that is used by Homebrew.
+if [[ -z "${HOMEBREW_RUBY_PATH}" ]]
+then
+  echo "${0##*/}: The build tool has reset ENV; --env=std required." >&2
+  exit 1
+fi
+unset RUBYLIB
+exec "${HOMEBREW_RUBY_PATH}" --enable-frozen-string-literal --disable=gems,did_you_mean,rubyopt -x "$0" "$@"
+#!/usr/bin/env ruby -W0
+
+require "open3"
+require "pathname"
+
+def split_args(args)
+  options = []
+  positional_args = []
+  args.each do |arg|
+    # `-` is stdin, so treat it as a positional argument
+    if arg.start_with?("-") && arg != "-"
+      options << arg
+    else
+      positional_args << arg
+    end
+  end
+  [options, positional_args]
+end
+
+def remove_superbin_from_path(paths)
+  superbin = Pathname.new(__FILE__).dirname.realpath
+  paths.reject do |x|
+    path = Pathname.new(x)
+    path.directory? && path.realpath == superbin
+  end
+end
+
+if __FILE__ == $PROGRAM_NAME
+  dirname, tool = File.split($PROGRAM_NAME)
+  separated_args = split_args(ARGV)
+  options = separated_args[0]
+  positional_args = separated_args[1]
+
+  # pod2man will not accept an empty string for --release, so use a space instead.
+  # Set this to avoid the perl version from being included in the generated docs.
+  # By prepending, the caller may choose to override this value to something else (later
+  # args take precedence).
+  options.prepend "--release= "
+
+  # pod2man accepts any provided positional arguments as input and output pairs. The first
+  # argument is always assumed to be input. If there is an odd number of positional arguments,
+  # the output of the last input will be emitted to stdout.
+  outputs = []
+  positional_args.each_slice(2) { |_, output| outputs << output unless output.nil? }
+
+  paths = ENV["PATH"].split(":")
+  paths = remove_superbin_from_path(paths)
+  paths.unshift "#{ENV["HOMEBREW_PREFIX"]}/bin"
+  ENV["PATH"] = paths.join(":")
+
+  # Wrap the execution of the real pod2man. Don't use exec, because we need to
+  # clean non-deterministic contents from the output files afterwards.
+  Open3.popen3(tool, *options, *positional_args) do |stdin, stdout, stderr, wait_thr|
+    # Clean any non-deterministic contents from output emitted via stdout
+    Thread.new do
+      stdout.each do |line|
+        $stdout.puts line.gsub(/^\.\\"\s*Automatically generated by .*\n/, "")
+      end
+    end
+
+    Thread.new do
+      stderr.each { |line| $stderr.puts line }
+    end
+
+    while !$stdin.tty? && $stdin.gets
+      stdin.puts $_
+    end
+
+    stdin.close
+    wait_thr.value
+  end
+
+  outputs.each do |output|
+    next if output == "-"
+
+    str = File.binread(output).gsub(/^\.\\"\s*Automatically generated by .*\n/, "")
+    File.write(output, str)
+  end
+end

Diff for: Library/Homebrew/style.rb

@@ -302,6 +302,8 @@ def self.json_result!(result)
       JSON.parse(result.stdout)
     end
 
+    NON_SHELL_SHIMS = %w[cc pod2man].freeze
+
     def self.shell_scripts
       [
         HOMEBREW_ORIGINAL_BREW_FILE,
@@ -312,7 +314,7 @@ def self.shell_scripts
         *HOMEBREW_LIBRARY.glob("Homebrew/**/*.sh").reject { |path| path.to_s.include?("/vendor/") },
         *HOMEBREW_LIBRARY.glob("Homebrew/shims/**/*").map(&:realpath).uniq
                          .reject(&:directory?)
-                         .reject { |path| path.basename.to_s == "cc" }
+                         .reject { |path| NON_SHELL_SHIMS.include? path.basename.to_s }
                          .select do |path|
                            %r{^#! ?/bin/(?:ba)?sh( |$)}.match?(path.read(13))
                          end,

Diff for: Library/Homebrew/test/bash_spec.rb

@@ -42,12 +42,13 @@
 
   describe "every shim script" do
     it "has valid Bash syntax" do
+      shims_to_skip = %w[cc pod2man].freeze # `bash -n` tries to parse the Ruby part
       # These have no file extension, but can be identified by their shebang.
       (HOMEBREW_LIBRARY_PATH/"shims").find do |path|
         next if path.directory?
         next if path.symlink?
         next unless path.executable?
-        next if path.basename.to_s == "cc" # `bash -n` tries to parse the Ruby part
+        next if shims_to_skip.include? path.basename.to_s
         next if path.read(12) != "#!/bin/bash\n"
 
         expect(path).to have_valid_bash_syntax