Module: SharedAudits Private

Extended by:
Utils::Curl
Includes:
Utils::Curl
Defined in:
Library/Homebrew/utils/shared_audits.rb

Overview

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Auditing functions for rules common to both casks and formulae.

Constant Summary collapse

GITHUB_PRERELEASE_ALLOWLIST =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{
  "amd-power-gadget" => :all,
  "elm-format"       => "0.8.3",
  "extraterm"        => :all,
  "freetube"         => :all,
  "gitless"          => "0.8.8",
  "home-assistant"   => :all,
  "lidarr"           => :all,
  "nuclear"          => :all,
  "pock"             => :all,
  "riff"             => "0.5.0",
  "syntax-highlight" => :all,
  "telegram-cli"     => "1.3.1",
  "toggl-track"      => :all,
  "volta"            => "0.8.6",
}.freeze
GITLAB_PRERELEASE_ALLOWLIST =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

{}.freeze
GITHUB_FORK_ALLOWLIST =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

%w[
  variar/klogg
].freeze

Class Method Summary collapse

Methods included from Utils::Curl

curl, curl_args, curl_check_http_content, curl_download, curl_executable, curl_http_content_headers_and_checksum, curl_output, curl_with_workarounds, http_status_ok?, url_protected_by_cloudflare?, url_protected_by_incapsula?

Class Method Details

.bitbucket(user, repo) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 147

def bitbucket(user, repo)
  api_url = "https://api.bitbucket.org/2.0/repositories/#{user}/#{repo}"
  out, _, status= curl_output("--request", "GET", api_url)
  return unless status.success?

  metadata = JSON.parse(out)
  return if metadata.nil?

  return "Uses deprecated mercurial support in Bitbucket" if metadata["scm"] == "hg"

  return "Bitbucket fork (not canonical repository)" unless metadata["parent"].nil?

  return "Bitbucket repository too new (<30 days old)" if Date.parse(metadata["created_on"]) >= (Date.today - 30)

  forks_out, _, forks_status= curl_output("--request", "GET", "#{api_url}/forks")
  return unless forks_status.success?

  watcher_out, _, watcher_status= curl_output("--request", "GET", "#{api_url}/watchers")
  return unless watcher_status.success?

  forks_metadata = JSON.parse(forks_out)
  return if forks_metadata.nil?

  watcher_metadata = JSON.parse(watcher_out)
  return if watcher_metadata.nil?

  return if forks_metadata["size"] >= 30 || watcher_metadata["size"] >= 75

  "Bitbucket repository not notable enough (<30 forks and <75 watchers)"
end

.github(user, repo) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 113

def github(user, repo)
  metadata = github_repo_data(user, repo)

  return if metadata.nil?

  if metadata["fork"] && !GITHUB_FORK_ALLOWLIST.include?("#{user}/#{repo}")
    return "GitHub fork (not canonical repository)"
  end

  if (metadata["forks_count"] < 30) && (metadata["subscribers_count"] < 30) &&
     (metadata["stargazers_count"] < 75)
    return "GitHub repository not notable enough (<30 forks, <30 watchers and <75 stars)"
  end

  return if Date.parse(metadata["created_at"]) <= (Date.today - 30)

  "GitHub repository too new (<30 days old)"
end

.github_release(user, repo, tag, formula: nil, cask: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 51

def github_release(user, repo, tag, formula: nil, cask: nil)
  release = github_release_data(user, repo, tag)
  return unless release

  if cask && GITHUB_PRERELEASE_ALLOWLIST[cask.token] == :all
    return if release["prerelease"]

    return "#{tag} is not a GitHub pre-release but cask '#{cask.token}' is in GITHUB_PRERELEASE_ALLOWLIST."
  end

  if release["prerelease"]
    return if formula && GITHUB_PRERELEASE_ALLOWLIST[formula.name] == formula.version

    return "#{tag} is a GitHub pre-release."
  end

  return "#{tag} is a GitHub draft." if release["draft"]
end

.github_release_data(user, repo, tag) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


24
25
26
27
28
29
30
31
32
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 24

def github_release_data(user, repo, tag)
  id = "#{user}/#{repo}/#{tag}"
  @github_release_data ||= {}
  @github_release_data[id] ||= GitHub.open_api("#{GitHub::API_URL}/repos/#{user}/#{repo}/releases/tags/#{tag}")

  @github_release_data[id]
rescue GitHub::HTTPNotFoundError
  nil
end

.github_repo_data(user, repo) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


15
16
17
18
19
20
21
22
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 15

def github_repo_data(user, repo)
  @github_repo_data ||= {}
  @github_repo_data["#{user}/#{repo}"] ||= GitHub.repository(user, repo)

  @github_repo_data["#{user}/#{repo}"]
rescue GitHub::HTTPNotFoundError
  nil
end

.github_tag_from_url(url) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


178
179
180
181
182
183
184
185
186
187
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 178

def github_tag_from_url(url)
  url = url.to_s
  tag = url.match(%r{^https://github\.com/[\w-]+/[\w-]+/archive/([^/]+)\.(tar\.gz|zip)$})
           .to_a
           .second
  tag ||= url.match(%r{^https://github\.com/[\w-]+/[\w-]+/releases/download/([^/]+)/})
             .to_a
             .second
  tag
end

.gitlab(user, repo) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 132

def gitlab(user, repo)
  metadata = gitlab_repo_data(user, repo)

  return if metadata.nil?

  return "GitLab fork (not canonical repository)" if metadata["fork"]
  if (metadata["forks_count"] < 30) && (metadata["star_count"] < 75)
    return "GitLab repository not notable enough (<30 forks and <75 stars)"
  end

  return if Date.parse(metadata["created_at"]) <= (Date.today - 30)

  "GitLab repository too new (<30 days old)"
end

.gitlab_release(user, repo, tag, formula: nil) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


99
100
101
102
103
104
105
106
107
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 99

def gitlab_release(user, repo, tag, formula: nil)
  release = gitlab_release_data(user, repo, tag)
  return unless release

  return if Date.parse(release["released_at"]) <= Date.today
  return if formula && GITLAB_PRERELEASE_ALLOWLIST[formula.name] == formula.version

  "#{tag} is a GitLab pre-release."
end

.gitlab_release_data(user, repo, tag) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 82

def gitlab_release_data(user, repo, tag)
  id = "#{user}/#{repo}/#{tag}"
  @gitlab_release_data ||= {}
  @gitlab_release_data[id] ||= begin
    out, _, status= curl_output(
      "https://gitlab.com/api/v4/projects/#{user}%2F#{repo}/releases/#{tag}", "--fail"
    )
    return unless status.success?

    JSON.parse(out)
  end

  @gitlab_release_data[id]
end

.gitlab_repo_data(user, repo) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


70
71
72
73
74
75
76
77
78
79
80
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 70

def gitlab_repo_data(user, repo)
  @gitlab_repo_data ||= {}
  @gitlab_repo_data["#{user}/#{repo}"] ||= begin
    out, _, status= curl_output("--request", "GET", "https://gitlab.com/api/v4/projects/#{user}%2F#{repo}")
    return unless status.success?

    JSON.parse(out)
  end

  @gitlab_repo_data["#{user}/#{repo}"]
end

.gitlab_tag_from_url(url) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 


189
190
191
192
193
194
 
# File 'Library/Homebrew/utils/shared_audits.rb', line 189

def gitlab_tag_from_url(url)
  url = url.to_s
  url.match(%r{^https://gitlab\.com/[\w-]+/[\w-]+/-/archive/([^/]+)/})
     .to_a
     .second
end