Module: Utils::Shell

Included in:
Formula
Defined in:
Library/Homebrew/utils/shell.rb

Constant Summary collapse

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])}

Class Method Summary collapse

Class Method Details

.csh_quote(str) ⇒ Object 


66
67
68
69
70
71
72
73
74
75
76
 
# File 'Library/Homebrew/utils/shell.rb', line 66

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

.export_value(shell, key, value) ⇒ Object

quote values. quoting keys is overkill


24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'Library/Homebrew/utils/shell.rb', line 24

def export_value(shell, key, value)
  case shell
  when :bash, :ksh, :sh, :zsh
    "export #{key}=\"#{sh_quote(value)}\""
  when :fish    # fish quoting is mostly Bourne compatible except that
    # a single quote can be included in a single-quoted string via \'
    # and a literal \ can be included via \\

    "set -gx #{key} \"#{sh_quote(value)}\""
  when :csh, :tcsh
    "setenv #{key} #{csh_quote(value)};"
  end
end

.from_path(path) ⇒ Object

take a path and heuristically convert it to a shell name, return nil if there's no match


7
8
9
10
11
12
13
 
# File 'Library/Homebrew/utils/shell.rb', line 7

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

.parent ⇒ Object 


19
20
21
 
# File 'Library/Homebrew/utils/shell.rb', line 19

def parent
  from_path(`ps -p #{Process.ppid} -o ucomm=`.strip)
end

.preferred ⇒ Object 


15
16
17
 
# File 'Library/Homebrew/utils/shell.rb', line 15

def preferred
  from_path(ENV.fetch("SHELL", ""))
end

.prepend_path_in_profile(path) ⇒ Object 


43
44
45
46
47
48
49
50
51
52
 
# File 'Library/Homebrew/utils/shell.rb', line 43

def prepend_path_in_profile(path)
  case preferred
  when :bash, :ksh, :sh, :zsh, nil
    "echo 'export PATH=\"#{sh_quote(path)}:$PATH\"' >> #{profile}"
  when :csh, :tcsh
    "echo 'setenv PATH #{csh_quote(path)}:$PATH' >> #{profile}"
  when :fish
    "echo 'set -g fish_user_paths \"#{sh_quote(path)}\" $fish_user_paths' >> #{profile}"
  end
end

.profile ⇒ Object

return the shell profile file based on users' preferred shell


39
40
41
 
# File 'Library/Homebrew/utils/shell.rb', line 39

def profile
  SHELL_PROFILE_MAP.fetch(preferred, "~/.bash_profile")
end

.sh_quote(str) ⇒ Object 


78
79
80
81
82
83
84
85
86
87
 
# File 'Library/Homebrew/utils/shell.rb', line 78

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