Module: Cask::Utils Private
- Defined in:
- cask/utils.rb
Overview
This module is part of a private API. This module may only be used in the Homebrew/brew repository. Third parties should avoid using this module if possible, as it may be removed or changed without warning.
Helper functions for various cask operations.
Class Method Summary collapse
-
.error_message_with_suggestions ⇒ String
private
-
.gain_permissions(path, command_args, command) ⇒ Object
private
-
.gain_permissions_mkpath(path, command: SystemCommand) ⇒ Object
private
-
.gain_permissions_remove(path, command: SystemCommand) ⇒ Object
private
-
.gain_permissions_rmdir(path, command: SystemCommand) ⇒ Object
private
-
.method_missing_message(method, token, section = nil) ⇒ Object
private
-
.path_occupied?(path) ⇒ Boolean
private
-
.token_from(name) ⇒ String
private
Class Method Details
.error_message_with_suggestions ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
121 122 123 124 125 126 |
# File 'cask/utils.rb', line 121 def self. <<~EOS Follow the instructions here: #{Formatter.url(BUG_REPORTS_URL)} EOS end |
.gain_permissions(path, command_args, command) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 |
# File 'cask/utils.rb', line 63 def self.(path, command_args, command) = false tried_ownership = false begin yield path rescue # in case of permissions problems unless # TODO: Better handling for the case where path is a symlink. # The -h and -R flags cannot be combined, and behavior is # dependent on whether the file argument has a trailing # slash. This should do the right thing, but is fragile. command.run("/usr/bin/chflags", args: command_args + ["--", "000", path]) command.run("/bin/chmod", args: command_args + ["--", "u+rwx", path]) command.run("/bin/chmod", args: command_args + ["-N", path]) = true retry # rmtree end unless tried_ownership # in case of ownership problems # TODO: Further examine files to see if ownership is the problem # before using sudo+chown ohai "Using sudo to gain ownership of path '#{path}'" command.run("/usr/sbin/chown", args: command_args + ["--", User.current, path], sudo: true) tried_ownership = true # retry chflags/chmod after chown = false retry # rmtree end raise end end |
.gain_permissions_mkpath(path, command: SystemCommand) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
14 15 16 17 18 19 20 21 22 23 |
# File 'cask/utils.rb', line 14 def self.(path, command: SystemCommand) dir = path.ascend.find(&:directory?) return if path == dir if dir.writable? path.mkpath else command.run!("/bin/mkdir", args: ["-p", "--", path], sudo: true, print_stderr: false) end end |
.gain_permissions_remove(path, command: SystemCommand) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
# File 'cask/utils.rb', line 35 def self.(path, command: SystemCommand) directory = false = if path.symlink? ["-h"] elsif path.directory? directory = true ["-R"] elsif path.exist? [] else # Nothing to remove. return end (path, , command) do |p| if p.parent.writable? if directory p.rmtree else FileUtils.rm_f p end else recursive_flag = directory ? ["-R"] : [] command.run!("/bin/rm", args: recursive_flag + ["-f", "--", p], sudo: true, print_stderr: false) end end end |
.gain_permissions_rmdir(path, command: SystemCommand) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
25 26 27 28 29 30 31 32 33 |
# File 'cask/utils.rb', line 25 def self.(path, command: SystemCommand) (path, [], command) do |p| if p.parent.writable? FileUtils.rmdir p else command.run!("/bin/rmdir", args: ["--", p], sudo: true, print_stderr: false) end end end |
.method_missing_message(method, token, section = nil) ⇒ Object
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
128 129 130 131 132 133 134 |
# File 'cask/utils.rb', line 128 def self.(method, token, section = nil) = +"Unexpected method '#{method}' called " << "during #{section} " if section << "on Cask #{token}." ofail "#{}\n#{}" end |
.path_occupied?(path) ⇒ Boolean
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
104 105 106 |
# File 'cask/utils.rb', line 104 def self.path_occupied?(path) path.exist? || path.symlink? end |
.token_from(name) ⇒ String
This method is part of a private API. This method may only be used in the Homebrew/brew repository. Third parties should avoid using this method if possible, as it may be removed or changed without warning.
109 110 111 112 113 114 115 116 117 118 |
# File 'cask/utils.rb', line 109 def self.token_from(name) name.downcase .gsub("+", "-plus-") .gsub("@", "-at-") .gsub(/[ _·•]/, "-") .gsub(/[^\w-]/, "") .gsub(/--+/, "-") .delete_prefix("-") .delete_suffix("-") end |