Module: Homebrew::MissingFormula Private

Extended by:
Utils::Output::Mixin
Defined in:
missing_formula.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 module for checking if there is a reason a formula is missing.

Class Method Summary collapse

Methods included from Utils::Output::Mixin

odebug, odeprecated, odie, odisabled, ofail, oh1, oh1_title, ohai, ohai_title, onoe, opoo, opoo_outside_github_actions, pretty_deprecated, pretty_disabled, pretty_duration, pretty_installed, pretty_outdated, pretty_uninstalled

Class Method Details

.cask_reason(name, silent: false, show_info: false) ⇒ 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.

Parameters:

  • name (String)
  • silent (Boolean) (defaults to: false)
  • show_info (Boolean) (defaults to: false)

Returns:



220
 
# File 'missing_formula.rb', line 220

def cask_reason(name, silent: false, show_info: false); end

.deleted_reason(name, silent: false) ⇒ 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.

Parameters:

  • name (String)
  • silent (Boolean) (defaults to: false)

Returns:



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'missing_formula.rb', line 155

def deleted_reason(name, silent: false)
  path = Formulary.path name
  return if File.exist? path

  tap = Tap.from_path(path)
  return if tap.nil? || !File.exist?(tap.path)

  relative_path = path.relative_path_from tap.path

  tap.path.cd do
    unless silent
      ohai "Searching for a previously deleted formula (in the last month)..."
      if (tap.path/".git/shallow").exist?
        opoo <<~EOS
          #{tap} is shallow clone. To get its complete history, run:
            git -C "$(brew --repo #{tap})" fetch --unshallow

        EOS
      end
    end

    # Optimization for the core tap which has many monthly commits
    if tap.core_tap?
      # Check if the formula has been deleted in the last month.
      diff_command = ["git", "diff", "--diff-filter=D", "--name-only",
                      "@{'1 month ago'}", "--", relative_path]
      deleted_formula = Utils.popen_read(*diff_command)

      if deleted_formula.blank?
        ofail "No previously deleted formula found." unless silent
        return
      end
    end

    # Find commit where formula was deleted in the last month.
    log_command = "git log --since='1 month ago' --diff-filter=D " \
                  "--name-only --max-count=1 " \
                  "--format=%H\\\\n%h\\\\n%B -- #{relative_path}"
    hash, short_hash, *commit_message, relative_path_string =
      Utils.popen_read(log_command).gsub("\\n", "\n").lines.map(&:chomp)

    if hash.blank? || short_hash.blank? || relative_path_string.blank?
      ofail "No previously deleted formula found." unless silent
      return
    end

    commit_message = commit_message.reject(&:empty?).join("\n  ")

    commit_message.sub!(/ \(#(\d+)\)$/, " (#{tap.issues_url}/\\1)")
    commit_message.gsub!(/(Closes|Fixes) #(\d+)/, "\\1 #{tap.issues_url}/\\2")

    <<~EOS
      #{name} was deleted from #{tap.name} in commit #{short_hash}:
        #{commit_message}

      To show the formula before removal, run:
        git -C "$(brew --repo #{tap})" show #{short_hash}^:#{relative_path_string}

      If you still use this formula, consider creating your own tap:
        #{Formatter.url("https://docs.brew.sh/How-to-Create-and-Maintain-a-Tap")}
    EOS
  end
end

.disallowed_reason(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.

Parameters:

Returns:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
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
62
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
 
# File 'missing_formula.rb', line 21

def disallowed_reason(name)
  case name.downcase
  when "gem", /^rubygems?$/ then <<~EOS
    macOS provides gem as part of Ruby. To install a newer version:
      brew install ruby
  EOS
  when "pip" then <<~EOS
    pip is part of the python formula:
      brew install python
  EOS
  when "pil" then <<~EOS
    Instead of PIL, consider pillow:
      brew install pillow
  EOS
  when "macruby" then <<~EOS
    MacRuby has been discontinued. Consider RubyMotion:
      brew install --cask rubymotion
  EOS
  when /(lib)?lzma/ then <<~EOS
    lzma is now part of the xz formula:
      brew install xz
  EOS
  when "gsutil" then <<~EOS
    gsutil is available through pip:
      pip3 install gsutil
  EOS
  when "gfortran" then <<~EOS
    GNU Fortran is part of the GCC formula:
      brew install gcc
  EOS
  when "play" then <<~EOS
    Play 2.3 replaces the play command with activator:
      brew install typesafe-activator

    You can read more about this change at:
      #{Formatter.url("https://www.playframework.com/documentation/2.3.x/Migration23")}
      #{Formatter.url("https://www.playframework.com/documentation/2.3.x/Highlights23")}
  EOS
  when "haskell-platform" then <<~EOS
    The components of the Haskell Platform are available separately.

    Glasgow Haskell Compiler:
      brew install ghc

    Cabal build system:
      brew install cabal-install

    Haskell Stack tool:
      brew install haskell-stack
  EOS
  when "mysqldump-secure" then <<~EOS
    The creator of mysqldump-secure tried to game our popularity metrics.
  EOS
  when "ngrok" then <<~EOS
    Upstream sunsetted 1.x in March 2016 and 2.x is not open-source.

    If you wish to use the 2.x release you can install it with:
      brew install --cask ngrok
  EOS
  when "cargo" then <<~EOS
    cargo is part of the rust formula:
      brew install rust
  EOS
  when "cargo-completion" then <<~EOS
    cargo-completion is part of the rust formula:
      brew install rust
  EOS
  when "uconv" then <<~EOS
    uconv is part of the icu4c formula:
      brew install icu4c
  EOS
  when "postgresql", "postgres" then <<~EOS
    postgresql breaks existing databases on upgrade without human intervention.

    See a more specific version to install with:
      brew formulae | grep postgresql@
  EOS
  end
end

.reason(name, silent: false, show_info: false) ⇒ 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.

Parameters:

  • name (String)
  • silent (Boolean) (defaults to: false)
  • show_info (Boolean) (defaults to: false)

Returns:



15
16
17
18
 
# File 'missing_formula.rb', line 15

def reason(name, silent: false, show_info: false)
  cask_reason(name, silent:, show_info:) || disallowed_reason(name) ||
    tap_migration_reason(name) || deleted_reason(name, silent:)
end

.suggest_command(name, command) ⇒ 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.

Parameters:

Returns:



223
 
# File 'missing_formula.rb', line 223

def suggest_command(name, command); end

.tap_migration_reason(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.

Parameters:

Returns:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'missing_formula.rb', line 102

def tap_migration_reason(name)
  message = T.let(nil, T.nilable(String))

  Tap.each do |old_tap|
    new_tap = old_tap.tap_migrations[name]
    next unless new_tap

    same_tap = new_tap == name
    migrated_tap_name = Utils.tap_from_full_name(new_tap)
    same_tap_new_name = !same_tap && migrated_tap_name.nil? && new_tap.exclude?("/")
    new_tap_name = if migrated_tap_name
      migrated_tap_name
    elsif new_tap.include?("/")
      new_tap
    elsif same_tap_new_name
      old_tap.name
    end
    new_tap_new_name = if migrated_tap_name
      Utils.name_from_full_name(new_tap)
    elsif same_tap_new_name
      new_tap
    end

    message = if same_tap
      "It was migrated from a formula to a cask.\n"
    else
      "It was migrated from #{old_tap} to #{new_tap}.\n"
    end

    install_cmd = if new_tap_name&.start_with?("homebrew/cask") || same_tap
      "install --cask"
    else
      "install"
    end
    new_tap_new_name ||= name

    message += if same_tap || same_tap_new_name || new_tap_name == CoreTap.instance.name
      "You can install it by running:\n"
    else
      <<~EOS
        You can access it again by running:
          brew tap #{T.must(new_tap_name)}
        And then you can install it by running:
      EOS
    end
    message += "  brew #{install_cmd} #{new_tap_new_name}\n"
    break
  end

  message
end