More deprecations.

Deprecate more methods. Internal APIs have been verified to be unused
elsewhere and removed. External APIs have had deprecation methods added.
Existing deprecations have been either upgraded to produce warnings or
no longer deprecated and the reasoning documented.

1 files changed, 52 insertions, 54 deletions

diff --git a/Library/Homebrew/utils/shell.rb b/Library/Homebrew/utils/shell.rb
index 302167d47..5327f6ecf 100644
--- a/Library/Homebrew/utils/shell.rb
+++ b/Library/Homebrew/utils/shell.rb
@@ -1,62 +1,24 @@
 module Utils
-  SHELL_PROFILE_MAP = {
-    bash: "~/.bash_profile",
-    csh: "~/.cshrc",
-    fish: "~/.config/fish/config.fish",
-    ksh: "~/.kshrc",
-    sh: "~/.bash_profile",
-    tcsh: "~/.tcshrc",
-    zsh: "~/.zshrc",
-  }.freeze
-
   module Shell
-    UNSAFE_SHELL_CHAR = %r{([^A-Za-z0-9_\-.,:/@\n])}
+    module_function
 
     # take a path and heuristically convert it
     # to a shell name, return nil if there's no match
-    def path_to_shell(path)
+    def from_path(path)
       # we only care about the basename
       shell_name = File.basename(path)
       # handle possible version suffix like `zsh-5.2`
       shell_name.sub!(/-.*\z/m, "")
       shell_name.to_sym if %w[bash csh fish ksh sh tcsh zsh].include?(shell_name)
     end
-    module_function :path_to_shell
-
-    def preferred_shell
-      path_to_shell(ENV.fetch("SHELL", ""))
-    end
-    module_function :preferred_shell
 
-    def parent_shell
-      path_to_shell(`ps -p #{Process.ppid} -o ucomm=`.strip)
+    def preferred
+      from_path(ENV.fetch("SHELL", ""))
     end
-    module_function :parent_shell
 
-    def csh_quote(str)
-      # ruby's implementation of shell_escape
-      str = str.to_s
-      return "''" if str.empty?
-      str = str.dup
-      # anything that isn't a known safe character is padded
-      str.gsub!(UNSAFE_SHELL_CHAR, "\\\\" + "\\1")
-      # newlines have to be specially quoted in csh
-      str.gsub!(/\n/, "'\\\n'")
-      str
+    def parent
+      from_path(`ps -p #{Process.ppid} -o ucomm=`.strip)
     end
-    module_function :csh_quote
-
-    def sh_quote(str)
-      # ruby's implementation of shell_escape
-      str = str.to_s
-      return "''" if str.empty?
-      str = str.dup
-      # anything that isn't a known safe character is padded
-      str.gsub!(UNSAFE_SHELL_CHAR, "\\\\" + "\\1")
-      str.gsub!(/\n/, "'\n'")
-      str
-    end
-    module_function :sh_quote
 
     # quote values. quoting keys is overkill
     def export_value(shell, key, value)
@@ -72,24 +34,60 @@ module Utils
         "setenv #{key} #{csh_quote(value)};"
       end
     end
-    module_function :export_value
 
     # return the shell profile file based on users' preferred shell
-    def shell_profile
-      SHELL_PROFILE_MAP.fetch(preferred_shell, "~/.bash_profile")
+    def profile
+      SHELL_PROFILE_MAP.fetch(preferred, "~/.bash_profile")
     end
-    module_function :shell_profile
 
-    def prepend_path_in_shell_profile(path)
-      case preferred_shell
+    def prepend_path_in_profile(path)
+      case preferred
       when :bash, :ksh, :sh, :zsh, nil
-        "echo 'export PATH=\"#{sh_quote(path)}:$PATH\"' >> #{shell_profile}"
+        "echo 'export PATH=\"#{sh_quote(path)}:$PATH\"' >> #{profile}"
       when :csh, :tcsh
-        "echo 'setenv PATH #{csh_quote(path)}:$PATH' >> #{shell_profile}"
+        "echo 'setenv PATH #{csh_quote(path)}:$PATH' >> #{profile}"
       when :fish
-        "echo 'set -g fish_user_paths \"#{sh_quote(path)}\" $fish_user_paths' >> #{shell_profile}"
+        "echo 'set -g fish_user_paths \"#{sh_quote(path)}\" $fish_user_paths' >> #{profile}"
       end
     end
-    module_function :prepend_path_in_shell_profile
+
+    private
+
+    SHELL_PROFILE_MAP = {
+      bash: "~/.bash_profile",
+      csh: "~/.cshrc",
+      fish: "~/.config/fish/config.fish",
+      ksh: "~/.kshrc",
+      sh: "~/.bash_profile",
+      tcsh: "~/.tcshrc",
+      zsh: "~/.zshrc",
+    }.freeze
+
+    UNSAFE_SHELL_CHAR = %r{([^A-Za-z0-9_\-.,:/@\n])}
+
+    module_function
+
+    def csh_quote(str)
+      # ruby's implementation of shell_escape
+      str = str.to_s
+      return "''" if str.empty?
+      str = str.dup
+      # anything that isn't a known safe character is padded
+      str.gsub!(UNSAFE_SHELL_CHAR, "\\\\" + "\\1")
+      # newlines have to be specially quoted in csh
+      str.gsub!(/\n/, "'\\\n'")
+      str
+    end
+
+    def sh_quote(str)
+      # ruby's implementation of shell_escape
+      str = str.to_s
+      return "''" if str.empty?
+      str = str.dup
+      # anything that isn't a known safe character is padded
+      str.gsub!(UNSAFE_SHELL_CHAR, "\\\\" + "\\1")
+      str.gsub!(/\n/, "'\n'")
+      str
+    end
   end
 end