Module: SharedAudits Private

Defined in:
utils/shared_audits.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.

Auditing functions for rules common to both casks and formulae.

Constant Summary collapse

URL_TYPE_HOMEPAGE =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

"homepage URL"
SELF_SUBMISSION_THRESHOLD_MULTIPLIER =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

3
GITHUB_NOTABILITY_THRESHOLDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let({ forks: 30, watchers: 30, stars: 75 }.freeze, T::Hash[Symbol, Integer])
GITLAB_NOTABILITY_THRESHOLDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let({ forks: 30, stars: 75 }.freeze, T::Hash[Symbol, Integer])
BITBUCKET_NOTABILITY_THRESHOLDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let({ forks: 30, watchers: 75 }.freeze, T::Hash[Symbol, Integer])
FORGEJO_NOTABILITY_THRESHOLDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let({ forks: 30, watchers: 30, stars: 75 }.freeze, T::Hash[Symbol, Integer])
NOTABILITY_REPOSITORY_REGEXES =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.let({
  github:    %r{\Ahttps?://github\.com/([^/]+)/([^/]+)/?.*},
  gitlab:    %r{\Ahttps?://gitlab\.com/([^/]+)/([^/]+)/?.*},
  bitbucket: %r{\Ahttps?://bitbucket\.org/([^/]+)/([^/]+)/?.*},
  forgejo:   %r{\Ahttps?://codeberg\.org/([^/]+)/([^/]+)/?.*},
}.freeze, T::Hash[Symbol, Regexp])
NEW_DOMAIN_THRESHOLD_DAYS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

30
GIT_FORGE_DOMAINS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

%w[
  bitbucket.org
  codeberg.org
  github.com
  github.io
  gitlab.com
  gitlab.io
  sr.ht
].freeze
WHOIS_TIMEOUT_SECONDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

5
WHOIS_CREATION_DATE_REGEX =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

/^\s*(?:creation\s+date|created(?:\s+on)?|registered(?:\s+on)?|
registration\s+(?:date|time))\s*:\s*(.+)/ix
RDAP_BOOTSTRAP_URL =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning.

RDAP is the IETF successor to WHOIS: ICANN requires every gTLD registry to serve it and IANA's bootstrap file lists the server for each TLD (gTLD or ccTLD) that does.

"https://data.iana.org/rdap/dns.json"
RDAP_TIMEOUT_SECONDS =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

10
RdapServices =

This constant is part of a private API. This constant may only be used in the Homebrew/brew repository. Third parties should avoid using this constant if possible, as it may be removed or changed without warning. 

T.type_alias { T::Array[[T::Array[String], T::Array[String]]] }

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.pull_request_commit_email_domains ⇒ Array<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.

Returns:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'utils/shared_audits.rb', line 159

def self.pull_request_commit_email_domains
  @pull_request_commit_email_domains ||= begin
    commits_url = github_event_pull_request_value("commits_url")
    commits = []
    if commits_url.present?
      GitHub::API.paginate_rest(commits_url) do |page_commits, _page|
        commits.concat(page_commits)
      end
    end
    commits.filter_map { |commit| commit.dig("commit", "author", "email").to_s.split("@").last&.downcase }
  rescue GitHub::API::Error
    []
  end
end

.rdap_services=(value) ⇒ RdapServices? (writeonly)

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.

Returns:



55
56
57
 
# File 'utils/shared_audits.rb', line 55

def rdap_services=(value)
  @rdap_services = value
end

Class Method Details

.bitbucket(user, repo, self_submission: 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:

  • user (String)
  • repo (String)
  • self_submission (Boolean) (defaults to: false)

Returns:



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'utils/shared_audits.rb', line 475

def self.bitbucket(user, repo, self_submission: false)
  api_url = "https://api.bitbucket.org/2.0/repositories/#{user}/#{repo}"
  result = Utils::Curl.curl_output("--request", "GET", api_url)
  return unless result.status.success?

  metadata = JSON.parse(result.stdout)
  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?

  age_days = (Date.today - Date.parse(metadata["created_on"])).to_i
  return "Bitbucket repository too new (#{age_days} days old, 30 days required)" if age_days < 30

  forks_result = Utils::Curl.curl_output("--request", "GET", "#{api_url}/forks")
  return unless forks_result.status.success?

  watcher_result = Utils::Curl.curl_output("--request", "GET", "#{api_url}/watchers")
  return unless watcher_result.status.success?

  forks_metadata = JSON.parse(forks_result.stdout)
  return if forks_metadata.nil?

  watcher_metadata = JSON.parse(watcher_result.stdout)
  return if watcher_metadata.nil?

  notability_thresholds = notability_thresholds_for(BITBUCKET_NOTABILITY_THRESHOLDS, self_submission)
  return if forks_metadata["size"] >= notability_thresholds.fetch(:forks) ||
            watcher_metadata["size"] >= notability_thresholds.fetch(:watchers)

  notability_prefix = if self_submission
    "Self-submitted Bitbucket repository not notable enough"
  else
    "Bitbucket repository not notable enough"
  end
  "#{notability_prefix} (<#{notability_thresholds.fetch(:forks)} forks and " \
    "<#{notability_thresholds.fetch(:watchers)} watchers)"
end

.check_deprecate_disable_reason(formula_or_cask) ⇒ 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:



574
575
576
577
578
579
580
581
582
583
584
585
586
587
 
# File 'utils/shared_audits.rb', line 574

def self.check_deprecate_disable_reason(formula_or_cask)
  return if !formula_or_cask.deprecated? && !formula_or_cask.disabled?

  reason = formula_or_cask.deprecated? ? formula_or_cask.deprecation_reason : formula_or_cask.disable_reason
  return unless reason.is_a?(Symbol)

  reasons = if formula_or_cask.is_a?(Formula)
    DeprecateDisable::FORMULA_DEPRECATE_DISABLE_REASONS
  else
    DeprecateDisable::CASK_DEPRECATE_DISABLE_REASONS
  end

  "#{reason} is not a valid deprecate! or disable! reason" unless reasons.include?(reason)
end

.commit_email_domain_match(urls) ⇒ Array<(Symbol, 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:



175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'utils/shared_audits.rb', line 175

def self.commit_email_domain_match(urls)
  urls.each do |stanza, url|
    next unless url

    domain = url_domain(url)
    next if domain.nil? || git_forge_domain?(domain)
    next if pull_request_commit_email_domains.none? { |email_domain| domain_or_subdomain?(domain, email_domain) }

    return [stanza, domain]
  end
  nil
end

.eol_data(product, cycle) ⇒ Hash{String => T.untyped}?

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:



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'utils/shared_audits.rb', line 260

def self.eol_data(product, cycle)
  @eol_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  key = "#{product}/#{cycle}"
  return @eol_data[key] if @eol_data.key?(key)

  result = Utils::Curl.curl_output(
    "--location",
    "https://endoflife.date/api/v1/products/#{product}/releases/#{cycle}",
  )
  return unless result.status.success?

  @eol_data[key] = begin
    JSON.parse(result.stdout)
  rescue JSON::ParserError
    nil
  end
end

.forgejo(user, repo, self_submission: 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:

  • user (String)
  • repo (String)
  • self_submission (Boolean) (defaults to: false)

Returns:



516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
 
# File 'utils/shared_audits.rb', line 516

def self.forgejo(user, repo, self_submission: false)
  metadata = forgejo_repo_data(user, repo)
  return if metadata.nil?

  return "Forgejo fork (not canonical repository)" if metadata["fork"]

  notability_thresholds = notability_thresholds_for(FORGEJO_NOTABILITY_THRESHOLDS, self_submission)
  notability_prefix = if self_submission
    "Self-submitted Forgejo repository not notable enough"
  else
    "Forgejo repository not notable enough"
  end
  if (metadata["forks_count"] < notability_thresholds.fetch(:forks)) &&
     (metadata["watchers_count"] < notability_thresholds.fetch(:watchers)) &&
     (metadata["stars_count"] < notability_thresholds.fetch(:stars))
    return "#{notability_prefix} (<#{notability_thresholds.fetch(:forks)} forks, " \
           "<#{notability_thresholds.fetch(:watchers)} watchers and " \
           "<#{notability_thresholds.fetch(:stars)} stars)"
  end

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

  "Forgejo repository too new (#{age_days} days old, 30 days required)"
end

.forgejo_release(user, repo, tag, formula: nil, cask: nil) ⇒ 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:



405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'utils/shared_audits.rb', line 405

def self.forgejo_release(user, repo, tag, formula: nil, cask: nil)
  release = forgejo_release_data(user, repo, tag)
  return unless release
  return unless release["prerelease"]

  exception, version = if formula
    [formula.tap&.audit_exception(:forgejo_prerelease_allowlist, formula.name), formula.version]
  elsif cask
    [cask.tap&.audit_exception(:forgejo_prerelease_allowlist, cask.token), cask.version]
  end
  return if [version, "all"].include?(exception)

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

.forgejo_repo_data(user, repo) ⇒ Hash{String => T.untyped}?

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:



342
343
344
345
346
347
348
349
 
# File 'utils/shared_audits.rb', line 342

def self.forgejo_repo_data(user, repo)
  @forgejo_repo_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  @forgejo_repo_data["#{user}/#{repo}"] ||= begin
    result = Utils::Curl.curl_output("https://codeberg.org/api/v1/repos/#{user}/#{repo}", "--fail")

    JSON.parse(result.stdout) if result.status.success?
  end
end

.forgejo_tag_from_url(url) ⇒ 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:



554
555
556
 
# File 'utils/shared_audits.rb', line 554

def self.forgejo_tag_from_url(url)
  url[%r{^https://codeberg\.org/[\w-]+/[\w.-]+/archive/(.+)\.(?:tar\.gz|zip)$}, 1]
end

.github(user, repo, self_submission: 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:

  • user (String)
  • repo (String)
  • self_submission (Boolean) (defaults to: false)

Returns:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'utils/shared_audits.rb', line 421

def self.github(user, repo, self_submission: false)
  metadata = github_repo_data(user, repo)

  return if metadata.nil?

  return "GitHub fork (not canonical repository)" if metadata["fork"]

  notability_thresholds = notability_thresholds_for(GITHUB_NOTABILITY_THRESHOLDS, self_submission)
  notability_prefix = if self_submission
    "Self-submitted GitHub repository not notable enough"
  else
    "GitHub repository not notable enough"
  end
  if (metadata["forks_count"] < notability_thresholds.fetch(:forks)) &&
     (metadata["subscribers_count"] < notability_thresholds.fetch(:watchers)) &&
     (metadata["stargazers_count"] < notability_thresholds.fetch(:stars))
    return "#{notability_prefix} (<#{notability_thresholds.fetch(:forks)} forks, " \
           "<#{notability_thresholds.fetch(:watchers)} watchers and " \
           "<#{notability_thresholds.fetch(:stars)} stars)"
  end

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

  "GitHub repository too new (#{age_days} days old, 30 days required)"
end

.github_release(user, repo, tag, formula: nil, cask: nil) ⇒ 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:



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'utils/shared_audits.rb', line 311

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

  exception, name, version = if formula
    [formula.tap&.audit_exception(:github_prerelease_allowlist, formula.name), formula.name, formula.version]
  elsif cask
    [cask.tap&.audit_exception(:github_prerelease_allowlist, cask.token), cask.token, cask.version]
  end

  return "#{tag} is a GitHub pre-release." if release["prerelease"] && [version, "all", "any"].exclude?(exception)

  if !release["prerelease"] && exception && [version, "any"].exclude?(exception)
    return "#{tag} is not a GitHub pre-release but '#{name}' is in the GitHub prerelease allowlist."
  end

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

.github_repo_data(user, repo) ⇒ Hash{String => T.untyped}?

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:



279
280
281
282
283
284
285
286
287
288
 
# File 'utils/shared_audits.rb', line 279

def self.github_repo_data(user, repo)
  @github_repo_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  @github_repo_data["#{user}/#{repo}"] ||= GitHub.repository(user, repo)

  @github_repo_data["#{user}/#{repo}"]
rescue GitHub::API::HTTPNotFoundError
  nil
rescue GitHub::API::AuthenticationFailedError => e
  raise unless e.message.match?(GitHub::API::GITHUB_IP_ALLOWLIST_ERROR)
end

.github_tag_from_url(url) ⇒ 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:



543
544
545
546
 
# File 'utils/shared_audits.rb', line 543

def self.github_tag_from_url(url)
  tag = url[%r{^https://github\.com/[\w-]+/[\w.-]+/archive/refs/tags/(.+)\.(?:tar\.gz|zip)$}, 1]
  tag || url[%r{^https://github\.com/[\w-]+/[\w.-]+/releases/download/([^/]+)/}, 1]
end

.gitlab(user, repo, self_submission: 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:

  • user (String)
  • repo (String)
  • self_submission (Boolean) (defaults to: false)

Returns:



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'utils/shared_audits.rb', line 449

def self.gitlab(user, repo, self_submission: false)
  metadata = gitlab_repo_data(user, repo)

  return if metadata.nil?

  return "GitLab fork (not canonical repository)" if metadata["fork"]

  notability_thresholds = notability_thresholds_for(GITLAB_NOTABILITY_THRESHOLDS, self_submission)
  notability_prefix = if self_submission
    "Self-submitted GitLab repository not notable enough"
  else
    "GitLab repository not notable enough"
  end
  if (metadata["forks_count"] < notability_thresholds.fetch(:forks)) &&
     (metadata["star_count"] < notability_thresholds.fetch(:stars))
    return "#{notability_prefix} (<#{notability_thresholds.fetch(:forks)} forks and " \
           "<#{notability_thresholds.fetch(:stars)} stars)"
  end

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

  "GitLab repository too new (#{age_days} days old, 30 days required)"
end

.gitlab_release(user, repo, tag, formula: nil, cask: nil) ⇒ 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:



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'utils/shared_audits.rb', line 370

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

  return if DateTime.parse(release["released_at"]) <= DateTime.now

  exception, version = if formula
    [formula.tap&.audit_exception(:gitlab_prerelease_allowlist, formula.name), formula.version]
  elsif cask
    [cask.tap&.audit_exception(:gitlab_prerelease_allowlist, cask.token), cask.version]
  end
  return if [version, "all"].include?(exception)

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

.gitlab_repo_data(user, repo) ⇒ Hash{String => T.untyped}?

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:



331
332
333
334
335
336
337
338
339
 
# File 'utils/shared_audits.rb', line 331

def self.gitlab_repo_data(user, repo)
  @gitlab_repo_data ||= T.let({}, T.nilable(T::Hash[String, T.untyped]))
  @gitlab_repo_data["#{user}/#{repo}"] ||= begin
    result = Utils::Curl.curl_output("https://gitlab.com/api/v4/projects/#{user}%2F#{repo}")
    json = JSON.parse(result.stdout) if result.status.success?
    json = nil if json&.dig("message")&.include?("404 Project Not Found")
    json
  end
end

.gitlab_tag_from_url(url) ⇒ 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:



549
550
551
 
# File 'utils/shared_audits.rb', line 549

def self.gitlab_tag_from_url(url)
  url[%r{^https://gitlab\.com/(?:\w[\w.-]*/){2,}-/archive/([^/]+)/}, 1]
end

.homepage_browsed_recently?(browsed) ⇒ 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.

Parameters:

  • browsed (Date, nil)

Returns:

  • (Boolean) 


59
60
61
62
63
64
 
# File 'utils/shared_audits.rb', line 59

def self.homepage_browsed_recently?(browsed)
  return false unless browsed

  today = Date.today
  browsed <= today && browsed.next_year > today
end

.livecheck_required_problem(formula_or_cask) ⇒ 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:



559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'utils/shared_audits.rb', line 559

def self.livecheck_required_problem(formula_or_cask)
  reason = if formula_or_cask.livecheck.skip?
    "uses `skip` in its `livecheck` block"
  elsif !formula_or_cask.livecheck_defined? &&
        Homebrew::Livecheck.checkable_urls(formula_or_cask).none? { |url| Homebrew::Livecheck::Strategy.from_url(url).any? }
    "has no URL that `livecheck` can check without a `livecheck` block"
  end
  return if reason.nil?

  noun, nouns = formula_or_cask.is_a?(Formula) ? %w[formula formulae] : %w[cask casks]
  "New #{nouns} must have a working `livecheck` block but this #{noun} #{reason}. " \
    "See #{Formatter.url("https://docs.brew.sh/Brew-Livecheck")}"
end

.new_domain_problem(homepage) ⇒ 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:



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
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
 
# File 'utils/shared_audits.rb', line 67

def self.new_domain_problem(homepage)
  domain = url_domain(homepage)
  return if domain.nil? || git_forge_domain?(domain)

  @rdap_services ||= begin
    result = Utils::Curl.curl_output(RDAP_BOOTSTRAP_URL, max_time: RDAP_TIMEOUT_SECONDS)
    (JSON.parse(result.stdout).fetch("services") if result.status.success?) || []
  rescue JSON::ParserError, KeyError, TypeError
    []
  end

  registered_domain = domain
  registered_on = T.let(nil, T.nilable(Date))
  tld = domain.split(".").last
  rdap_urls = @rdap_services.find { |tlds, _| tlds.include?(tld) }&.fetch(1)
  if rdap_urls.present?
    rdap_base_url = (rdap_urls.find { |url| url.start_with?("https://") } || rdap_urls.fetch(0)).delete_suffix("/")
    # Registries answer 4xx for subdomains, so walk up to the registered domain.
    labels = domain.split(".")
    while labels.length >= 2
      candidate = labels.join(".")
      result = Utils::Curl.curl_output(
        "--include", "--location", "#{rdap_base_url}/domain/#{candidate}",
        header: "Accept: application/rdap+json", max_time: RDAP_TIMEOUT_SECONDS
      )
      break unless result.status.success?

      parsed = Utils::Curl.parse_curl_output(result.stdout)
      case parsed.fetch(:responses).last&.fetch(:status_code).to_i
      when 200
        registered_on = begin
          events = JSON.parse(parsed.fetch(:body)).fetch("events", [])
          registration = events.find { |event| event["eventAction"] == "registration" }
          Date.parse(registration.fetch("eventDate")) unless registration.nil?
        rescue JSON::ParserError, KeyError, TypeError, Date::Error
          nil
        end
        registered_domain = candidate unless registered_on.nil?
        break
      when 400..499
        labels.shift
      else
        break
      end
    end
  end

  if registered_on.nil? && which("whois")
    whois = begin
      SystemCommand.run("whois", args: [domain], print_stderr: false, timeout: WHOIS_TIMEOUT_SECONDS)
    rescue Timeout::Error
      nil
    end
    lines = if whois.nil? || !whois.status.success?
      []
    else
      whois.stdout.scrub.lines
    end
    # `whois` may print the IANA record for the TLD (whose creation date is always ancient)
    # before following its referral to the registry, so only look after the referral marker:
    # `# whois.nic.sh` on macOS, `Found a referral to whois.nic.sh.` on Linux.
    if lines.first&.start_with?("% IANA WHOIS server")
      referral_index = lines.index { |line| line.start_with?("# whois.", "Found a referral to ") }
      lines = referral_index ? lines.drop(referral_index + 1) : []
    end

    lines.each do |line|
      value = line[WHOIS_CREATION_DATE_REGEX, 1]
      next if value.nil?

      registered_on = Date.parse(value)
      break
    rescue Date::Error
      nil
    end
  end
  return if registered_on.nil?
  return if (Date.today - registered_on) >= NEW_DOMAIN_THRESHOLD_DAYS

  "`homepage` domain `#{registered_domain}` was registered on #{registered_on}: " \
    "homepages should exist for at least #{NEW_DOMAIN_THRESHOLD_DAYS} days before inclusion"
end

.notability_thresholds_for(thresholds, self_submission) ⇒ Hash{Symbol => Integer}

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
224
225
226
227
 
# File 'utils/shared_audits.rb', line 223

def self.notability_thresholds_for(thresholds, self_submission)
  return thresholds unless self_submission

  thresholds.transform_values { |value| value * SELF_SUBMISSION_THRESHOLD_MULTIPLIER }
end

.pull_request_author ⇒ 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.

Returns:



151
152
153
154
155
156
 
# File 'utils/shared_audits.rb', line 151

def self.pull_request_author
  return @pull_request_author if @pull_request_author_computed

  @pull_request_author_computed = true
  @pull_request_author = github_event_pull_request_value("user", "login")
end

.self_submission?(submitter, repo_owner) ⇒ 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.

Parameters:

Returns:

  • (Boolean) 


202
203
204
205
206
207
 
# File 'utils/shared_audits.rb', line 202

def self.self_submission?(submitter, repo_owner)
  return false if submitter.blank?
  return false if repo_owner.empty?

  submitter.casecmp?(repo_owner)
end

.self_submission_for_repo_owner?(repo_owner) ⇒ 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.

Parameters:

Returns:

  • (Boolean) 


210
211
212
213
214
215
216
217
218
219
220
 
# File 'utils/shared_audits.rb', line 210

def self.self_submission_for_repo_owner?(repo_owner)
  return false if repo_owner.blank?

  submitter = pull_request_author
  return false if submitter.blank?

  key = repo_owner.downcase
  return @self_submission_cache.fetch(key) if @self_submission_cache.key?(key)

  @self_submission_cache[key] = self_submission?(submitter, repo_owner)
end

.self_submission_problem(urls) ⇒ 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:



189
190
191
192
193
194
195
196
197
198
199
 
# File 'utils/shared_audits.rb', line 189

def self.self_submission_problem(urls)
  return if urls.values.compact.grep(Regexp.union(NOTABILITY_REPOSITORY_REGEXES.values)).any?

  match = commit_email_domain_match(urls)
  return if match.nil?

  stanza, domain = match
  "Self-submitted (a commit author's email address matches the `#{stanza}` domain `#{domain}`) " \
    "without a GitHub, GitLab, Bitbucket or Codeberg repository to assess its notability. " \
    "This is not an automatic rejection, but the pull request author must provide evidence that it is notable."
end