Class: Homebrew::FormulaAuditor

Inherits:
Object
  • Object
show all
Includes:
FormulaCellarChecks
Defined in:
brew/Library/Homebrew/dev-cmd/audit.rb

Constant Summary collapse

USES_FROM_MACOS_ALLOWLIST =
%w[
  apr
  apr-util
  openblas
  openssl@1.1
].freeze
VERSIONED_KEG_ONLY_ALLOWLIST =
%w[
  autoconf@2.13
  bash-completion@2
  gnupg@1.4
  libsigc++@2
  lua@5.1
  numpy@1.16
  python@3.8
].freeze
VERSIONED_HEAD_SPEC_ALLOWLIST =
%w[
  bash-completion@2
  imagemagick@6
].freeze
THROTTLED_FORMULAE =
{
  "aws-sdk-cpp" => 10,
  "awscli@1"    => 10,
  "balena-cli"  => 10,
  "gatsby-cli"  => 10,
  "quicktype"   => 10,
  "vim"         => 50,
}.freeze
UNSTABLE_ALLOWLIST =
{
  "aalib"           => "1.4rc",
  "automysqlbackup" => "3.0-rc",
  "aview"           => "1.3.0rc",
  "elm-format"      => "0.6.0-alpha",
  "ftgl"            => "2.1.3-rc",
  "hidapi"          => "0.8.0-rc",
  "libcaca"         => "0.99b",
  "premake"         => "4.4-beta",
  "pwnat"           => "0.3-beta",
  "recode"          => "3.7-beta",
  "speexdsp"        => "1.2rc",
  "sqoop"           => "1.4.",
  "tcptraceroute"   => "1.5beta",
  "tiny-fugue"      => "5.0b",
  "vbindiff"        => "3.0_beta",
}.freeze
GNOME_DEVEL_ALLOWLIST =
{
  "libart"              => "2.3",
  "gtk-mac-integration" => "2.1",
  "gtk-doc"             => "1.31",
  "gcab"                => "1.3",
  "libepoxy"            => "1.5",
}.freeze
GITHUB_PRERELEASE_ALLOWLIST =
%w[cake].freeze

Constants included from FormulaCellarChecks

FormulaCellarChecks::VALID_LIBRARY_EXTENSIONS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from FormulaCellarChecks

#audit_installed, #check_easy_install_pth, #check_elisp_dirname, #check_elisp_root, #check_env_path, #check_generic_executables, #check_infopages, #check_jars, #check_linkage, #check_manpages, #check_non_executables, #check_non_libraries, #check_openssl_links, #check_plist, #check_python_framework_links, #check_python_packages, #check_shadowed_headers, #check_shim_references, #generic_audit_installed, #generic_valid_library_extension?, #valid_library_extension?

Constructor Details

#initialize(formula, options = {}) ⇒ FormulaAuditor

Returns a new instance of FormulaAuditor.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 203

def initialize(formula, options = {})
  @formula = formula
  @versioned_formula = formula.versioned_formula?
  @new_formula_inclusive = options[:new_formula]
  @new_formula = options[:new_formula] && !@versioned_formula
  @strict = options[:strict]
  @online = options[:online]
  @git = options[:git]
  @display_cop_names = options[:display_cop_names]
  @only = options[:only]
  @except = options[:except]
  # Accept precomputed style offense results, for efficiency
  @style_offenses = options[:style_offenses]
  # Allow the formula tap to be set as homebrew/core, for testing purposes
  @core_tap = formula.tap&.core_tap? || options[:core_tap]
  @problems = []
  @new_formula_problems = []
  @text = FormulaText.new(formula.path)
  @specs = %w[stable devel head].map { |s| formula.send(s) }.compact
  @spdx_data = options[:spdx_data]
end

Instance Attribute Details

#formulaObject (readonly)

Returns the value of attribute formula.



201
202
203
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 201

def formula
  @formula
end

#new_formula_problemsObject (readonly)

Returns the value of attribute new_formula_problems.



201
202
203
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 201

def new_formula_problems
  @new_formula_problems
end

#problemsObject (readonly)

Returns the value of attribute problems.



201
202
203
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 201

def problems
  @problems
end

#textObject (readonly)

Returns the value of attribute text.



201
202
203
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 201

def text
  @text
end

Class Method Details

.aliasesObject



294
295
296
297
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 294

def self.aliases
  # core aliases + tap alias names + tap alias full name
  @aliases ||= Formula.aliases + Formula.tap_aliases
end

Instance Method Details

#auditObject



857
858
859
860
861
862
863
864
865
866
867
868
869
870
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 857

def audit
  only_audits = @only
  except_audits = @except

  methods.map(&:to_s).grep(/^audit_/).each do |audit_method_name|
    name = audit_method_name.delete_prefix("audit_")
    if only_audits
      next unless only_audits.include?(name)
    elsif except_audits
      next if except_audits.include?(name)
    end
    send(audit_method_name)
  end
end

#audit_bitbucket_repositoryObject



546
547
548
549
550
551
552
553
554
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 546

def audit_bitbucket_repository
  user, repo = get_repo_data(%r{https?://bitbucket\.org/([^/]+)/([^/]+)/?.*}) if @new_formula
  return if user.blank?

  warning = SharedAudits.bitbucket(user, repo)
  return if warning.nil?

  new_formula_problem warning
end

#audit_bottle_disabledObject



514
515
516
517
518
519
520
521
522
523
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 514

def audit_bottle_disabled
  return unless formula.bottle_disabled?
  return if formula.bottle_unneeded?

  problem "Unrecognized bottle modifier" unless formula.bottle_disable_reason.valid?

  return unless @core_tap

  problem "Formulae in homebrew/core should not use `bottle :disabled`"
end

#audit_bottle_specObject



502
503
504
505
506
507
508
509
510
511
512
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 502

def audit_bottle_spec
  # special case: new versioned formulae should be audited
  return unless @new_formula_inclusive
  return unless @core_tap

  return if formula.bottle_disabled?

  return unless formula.bottle_defined?

  new_formula_problem "New formulae in homebrew/core should not have a `bottle do` block"
end

#audit_conflictsObject



426
427
428
429
430
431
432
433
434
435
436
437
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 426

def audit_conflicts
  formula.conflicts.each do |c|
    Formulary.factory(c.name)
  rescue TapFormulaUnavailableError
    # Don't complain about missing cross-tap conflicts.
    next
  rescue FormulaUnavailableError
    problem "Can't find conflicting formula #{c.name.inspect}."
  rescue TapFormulaAmbiguityError, TapFormulaWithOldnameAmbiguityError
    problem "Ambiguous conflicting formula #{c.name.inspect}."
  end
end

#audit_depsObject



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 351

def audit_deps
  @specs.each do |spec|
    # Check for things we don't like to depend on.
    # We allow non-Homebrew installs whenever possible.
    spec.deps.each do |dep|
      begin
        dep_f = dep.to_formula
      rescue TapFormulaUnavailableError
        # Don't complain about missing cross-tap dependencies
        next
      rescue FormulaUnavailableError
        problem "Can't find dependency #{dep.name.inspect}."
        next
      rescue TapFormulaAmbiguityError
        problem "Ambiguous dependency #{dep.name.inspect}."
        next
      rescue TapFormulaWithOldnameAmbiguityError
        problem "Ambiguous oldname dependency #{dep.name.inspect}."
        next
      end

      if dep_f.oldname && dep.name.split("/").last == dep_f.oldname
        problem "Dependency '#{dep.name}' was renamed; use new name '#{dep_f.name}'."
      end

      if self.class.aliases.include?(dep.name) &&
         (dep_f.core_formula? || !dep_f.versioned_formula?)
        problem "Dependency '#{dep.name}' from homebrew/core is an alias; " \
        "use the canonical name '#{dep.to_formula.full_name}'."
      end

      if @new_formula &&
         dep_f.keg_only? &&
         dep_f.keg_only_reason.provided_by_macos? &&
         dep_f.keg_only_reason.applicable? &&
         !USES_FROM_MACOS_ALLOWLIST.include?(dep.name)
        new_formula_problem(
          "Dependency '#{dep.name}' is provided by macOS; " \
          "please replace 'depends_on' with 'uses_from_macos'.",
        )
      end

      dep.options.each do |opt|
        next if @core_tap
        next if dep_f.option_defined?(opt)
        next if dep_f.requirements.find do |r|
          if r.recommended?
            opt.name == "with-#{r.name}"
          elsif r.optional?
            opt.name == "without-#{r.name}"
          end
        end

        problem "Dependency #{dep} does not define option #{opt.name.inspect}"
      end

      problem "Don't use git as a dependency (it's always available)" if @new_formula && dep.name == "git"

      problem "Dependency '#{dep.name}' is marked as :run. Remove :run; it is a no-op." if dep.tags.include?(:run)

      next unless @core_tap

      if dep.tags.include?(:recommended) || dep.tags.include?(:optional)
        problem "Formulae in homebrew/core should not have optional or recommended dependencies"
      end
    end

    next unless @core_tap

    if spec.requirements.map(&:recommended?).any? || spec.requirements.map(&:optional?).any?
      problem "Formulae in homebrew/core should not have optional or recommended requirements"
    end
  end
end

#audit_fileObject



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 233

def audit_file
  if formula.core_formula? && @versioned_formula
    unversioned_formula = begin
      # build this ourselves as we want e.g. homebrew/core to be present
      full_name = if formula.tap
        "#{formula.tap}/#{formula.name}"
      else
        formula.name
      end
      Formulary.factory(full_name.gsub(/@.*$/, "")).path
    rescue FormulaUnavailableError, TapFormulaAmbiguityError,
           TapFormulaWithOldnameAmbiguityError
      Pathname.new formula.path.to_s.gsub(/@.*\.rb$/, ".rb")
    end
    unless unversioned_formula.exist?
      unversioned_name = unversioned_formula.basename(".rb")
      problem "#{formula} is versioned but no #{unversioned_name} formula exists"
    end
  elsif Homebrew.args.build_stable? && formula.stable? &&
        !(versioned_formulae = formula.versioned_formulae).empty?
    versioned_aliases = formula.aliases.grep(/.@\d/)
    _, last_alias_version = versioned_formulae.map(&:name).last.split("@")
    major, minor, = formula.version.to_s.split(".")
    alias_name_major = "#{formula.name}@#{major}"
    alias_name_major_minor = "#{alias_name_major}.#{minor}"
    alias_name = if last_alias_version.split(".").length == 1
      alias_name_major
    else
      alias_name_major_minor
    end
    valid_alias_names = [alias_name_major, alias_name_major_minor]

    unless @core_tap
      versioned_aliases.map! { |a| "#{formula.tap}/#{a}" }
      valid_alias_names.map! { |a| "#{formula.tap}/#{a}" }
    end

    valid_versioned_aliases = versioned_aliases & valid_alias_names
    invalid_versioned_aliases = versioned_aliases - valid_alias_names

    if valid_versioned_aliases.empty?
      if formula.tap
        problem <<~EOS
          Formula has other versions so create a versioned alias:
            cd #{formula.tap.alias_dir}
            ln -s #{formula.path.to_s.gsub(formula.tap.path, "..")} #{alias_name}
        EOS
      else
        problem "Formula has other versions so create an alias named #{alias_name}."
      end
    end

    unless invalid_versioned_aliases.empty?
      problem <<~EOS
        Formula has invalid versioned aliases:
          #{invalid_versioned_aliases.join("\n  ")}
      EOS
    end
  end
end

#audit_formula_nameObject



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 299

def audit_formula_name
  return unless @strict
  return unless @core_tap

  name = formula.name

  problem "'#{name}' is not allowed in homebrew/core." if MissingFormula.disallowed_reason(name)

  if Formula.aliases.include? name
    problem "Formula name conflicts with existing aliases in homebrew/core."
    return
  end

  if oldname = CoreTap.instance.formula_renames[name]
    problem "'#{name}' is reserved as the old name of #{oldname} in homebrew/core."
    return
  end

  return if formula.core_formula?
  return unless Formula.core_names.include?(name)

  problem "Formula name conflicts with existing core formula."
end

#audit_github_repositoryObject



525
526
527
528
529
530
531
532
533
534
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 525

def audit_github_repository
  user, repo = get_repo_data(%r{https?://github\.com/([^/]+)/([^/]+)/?.*}) if @new_formula

  return if user.blank?

  warning = SharedAudits.github(user, repo)
  return if warning.nil?

  new_formula_problem warning
end

#audit_gitlab_repositoryObject



536
537
538
539
540
541
542
543
544
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 536

def audit_gitlab_repository
  user, repo = get_repo_data(%r{https?://gitlab\.com/([^/]+)/([^/]+)/?.*}) if @new_formula
  return if user.blank?

  warning = SharedAudits.gitlab(user, repo)
  return if warning.nil?

  new_formula_problem warning
end

#audit_homepageObject



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 485

def audit_homepage
  homepage = formula.homepage

  return if homepage.nil? || homepage.empty?

  return unless @online

  return unless DevelopmentTools.curl_handles_most_https_certificates?

  if http_content_problem = curl_check_http_content(homepage,
                                                    user_agents:   [:browser, :default],
                                                    check_content: true,
                                                    strict:        @strict)
    problem http_content_problem
  end
end

#audit_licenseObject



330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 330

def audit_license
  if formula.license.present?
    if @spdx_data["licenses"].any? { |lic| lic["licenseId"] == formula.license }
      return unless @online

      user, repo = get_repo_data(%r{https?://github\.com/([^/]+)/([^/]+)/?.*}) if @new_formula
      return if user.blank?

      github_license = GitHub.get_repo_license(user, repo)
      return if github_license && [formula.license, "NOASSERTION"].include?(github_license)

      problem "License mismatch - GitHub license is: #{github_license}, "\
              "but Formulae license states: #{formula.license}."
    else
      problem "#{formula.license} is not a standard SPDX license."
    end
  elsif @new_formula
    problem "No license specified for package."
  end
end

#audit_postgresqlObject



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 439

def audit_postgresql
  return unless formula.name == "postgresql"
  return unless @core_tap

  major_version = formula.version
                         .to_s
                         .split(".")
                         .first
                         .to_i
  previous_major_version = major_version - 1
  previous_formula_name = "postgresql@#{previous_major_version}"
  begin
    Formula[previous_formula_name]
  rescue FormulaUnavailableError
    problem "Versioned #{previous_formula_name} in homebrew/core must be created for " \
            "`brew-postgresql-upgrade-database` and `pg_upgrade` to work."
  end
end

#audit_prefix_has_contentsObject



838
839
840
841
842
843
844
845
846
847
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 838

def audit_prefix_has_contents
  return unless formula.prefix.directory?
  return unless Keg.new(formula.prefix).empty_installation?

  problem <<~EOS
    The installation seems to be empty. Please ensure the prefix
    is set correctly and expected files are installed.
    The prefix configure/make argument may be case-sensitive.
  EOS
end

#audit_reverse_migrationObject



825
826
827
828
829
830
831
832
833
834
835
836
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 825

def audit_reverse_migration
  # Only enforce for new formula being re-added to core
  return unless @strict
  return unless @core_tap
  return unless formula.tap.tap_migrations.key?(formula.name)

  problem <<~EOS
    #{formula.name} seems to be listed in tap_migrations.json!
    Please remove #{formula.name} from present tap & tap_migrations.json
    before submitting it to Homebrew/homebrew-#{formula.tap.repo}.
  EOS
end

#audit_revision_and_version_schemeObject



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 729

def audit_revision_and_version_scheme
  return unless @git
  return unless formula.tap # skip formula not from core or any taps
  return unless formula.tap.git? # git log is required
  return if formula.stable.blank?

  fv = FormulaVersions.new(formula)

  current_version = formula.stable.version
  current_checksum = formula.stable.checksum
  current_version_scheme = formula.version_scheme
  current_revision = formula.revision

  previous_version = nil
  previous_version_scheme = nil
  previous_revision = nil

  newest_committed_version = nil
  newest_committed_checksum = nil
  newest_committed_revision = nil

  fv.rev_list("origin/master") do |rev|
    fv.formula_at_revision(rev) do |f|
      stable = f.stable
      next if stable.blank?

      previous_version = stable.version
      previous_checksum = stable.checksum
      previous_version_scheme = f.version_scheme
      previous_revision = f.revision

      newest_committed_version ||= previous_version
      newest_committed_checksum ||= previous_checksum
      newest_committed_revision ||= previous_revision
    end

    break if previous_version && current_version != previous_version
  end

  if current_version == previous_version &&
     current_checksum != newest_committed_checksum
    problem(
      "stable sha256 changed without the version also changing; " \
      "please create an issue upstream to rule out malicious " \
      "circumstances and to find out why the file changed.",
    )
  end

  if !newest_committed_version.nil? &&
     current_version < newest_committed_version &&
     current_version_scheme == previous_version_scheme
    problem "stable version should not decrease (from #{newest_committed_version} to #{current_version})"
  end

  unless previous_version_scheme.nil?
    if current_version_scheme < previous_version_scheme
      problem "version_scheme should not decrease (from #{previous_version_scheme} " \
              "to #{current_version_scheme})"
    elsif current_version_scheme > (previous_version_scheme + 1)
      problem "version_schemes should only increment by 1"
    end
  end

  if previous_version != newest_committed_version &&
     !current_revision.zero? &&
     current_revision == newest_committed_revision &&
     current_revision == previous_revision
    problem "'revision #{current_revision}' should be removed"
  elsif current_version == previous_version &&
        !previous_revision.nil? &&
        current_revision < previous_revision
    problem "revision should not decrease (from #{previous_revision} to #{current_revision})"
  elsif newest_committed_revision &&
        current_revision > (newest_committed_revision + 1)
    problem "revisions should only increment by 1"
  end
end

#audit_specsObject

version_prefix = stable_version_string.sub(/\d+$/, “”) version_prefix = stable_version_string.split(“.”)[0..1].join(“.”)



614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 614

def audit_specs
  problem "Head-only (no stable download)" if head_only?(formula)
  problem "Devel-only (no stable download)" if devel_only?(formula)

  %w[Stable Devel HEAD].each do |name|
    spec_name = name.downcase.to_sym
    next unless spec = formula.send(spec_name)

    ra = ResourceAuditor.new(spec, spec_name, online: @online, strict: @strict).audit
    problems.concat ra.problems.map { |problem| "#{name}: #{problem}" }

    spec.resources.each_value do |resource|
      problem "Resource name should be different from the formula name" if resource.name == formula.name

      ra = ResourceAuditor.new(resource, spec_name, online: @online, strict: @strict).audit
      problems.concat ra.problems.map { |problem|
        "#{name} resource #{resource.name.inspect}: #{problem}"
      }
    end

    next if spec.patches.empty?
    next unless @new_formula

    new_formula_problem(
      "Formulae should not require patches to build. " \
      "Patches should be submitted and accepted upstream first.",
    )
  end

  %w[Stable Devel].each do |name|
    next unless spec = formula.send(name.downcase)

    version = spec.version
    problem "#{name}: version (#{version}) is set to a string without a digit" if version.to_s !~ /\d/
    if version.to_s.start_with?("HEAD")
      problem "#{name}: non-HEAD version name (#{version}) should not begin with HEAD"
    end
  end

  if formula.stable && formula.devel
    if formula.devel.version < formula.stable.version
      problem "devel version #{formula.devel.version} is older than stable version #{formula.stable.version}"
    elsif formula.devel.version == formula.stable.version
      problem "stable and devel versions are identical"
    end
  end

  return unless @core_tap

  problem "Formulae in homebrew/core should not have a `devel` spec" if formula.devel

  if formula.head && @versioned_formula
    head_spec_message = "Versioned formulae should not have a `HEAD` spec"
    problem head_spec_message unless VERSIONED_HEAD_SPEC_ALLOWLIST.include?(formula.name)
  end

  stable = formula.stable
  return unless stable
  return unless stable.url

  stable_version_string = stable.version.to_s
  stable_url_version = Version.parse(stable.url)
  _, stable_url_minor_version, = stable_url_version.to_s
                                                   .split(".", 3)
                                                   .map(&:to_i)

  formula_suffix = stable_version_string.split(".").last.to_i
  throttled_rate = THROTTLED_FORMULAE[formula.name]
  if throttled_rate && formula_suffix.modulo(throttled_rate).nonzero?
    problem "should only be updated every #{throttled_rate} releases on multiples of #{throttled_rate}"
  end

  case (url = stable.url)
  when /[\d._-](alpha|beta|rc\d)/
    matched = Regexp.last_match(1)
    version_prefix = stable_version_string.sub(/\d+$/, "")
    return if UNSTABLE_ALLOWLIST[formula.name] == version_prefix

    problem "Stable version URLs should not contain #{matched}"
  when %r{download\.gnome\.org/sources}, %r{ftp\.gnome\.org/pub/GNOME/sources}i
    version_prefix = stable_version_string.split(".")[0..1].join(".")
    return if GNOME_DEVEL_ALLOWLIST[formula.name] == version_prefix
    return if stable_url_version < Version.create("1.0")
    return if stable_url_minor_version.even?

    problem "#{stable.version} is a development release"
  when %r{isc.org/isc/bind\d*/}i
    return if stable_url_minor_version.even?

    problem "#{stable.version} is a development release"
  when %r{^https://github.com/([\w-]+)/([\w-]+)/}
    owner = Regexp.last_match(1)
    repo = Regexp.last_match(2)
    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

    begin
      if @online && (release = GitHub.open_api("#{GitHub::API_URL}/repos/#{owner}/#{repo}/releases/tags/#{tag}"))
        if release["prerelease"] && !GITHUB_PRERELEASE_ALLOWLIST.include?(formula.name)
          problem "#{tag} is a GitHub prerelease"
        elsif release["draft"]
          problem "#{tag} is a GitHub draft"
        end
      end
    rescue GitHub::HTTPNotFoundError
      # No-op if we can't find the release.
      nil
    end
  end
end

#audit_styleObject



225
226
227
228
229
230
231
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 225

def audit_style
  return unless @style_offenses

  @style_offenses.each do |offense|
    problem offense.to_s(display_cop_name: @display_cop_names)
  end
end

#audit_textObject



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 807

def audit_text
  bin_names = Set.new
  bin_names << formula.name
  bin_names += formula.aliases
  [formula.bin, formula.sbin].each do |dir|
    next unless dir.exist?

    bin_names += dir.children.map(&:basename).map(&:to_s)
  end
  bin_names.each do |name|
    ["system", "shell_output", "pipe_output"].each do |cmd|
      if text.to_s.match?(/test do.*#{cmd}[(\s]+['"]#{Regexp.escape(name)}[\s'"]/m)
        problem %Q(fully scope test #{cmd} calls, e.g. #{cmd} "\#{bin}/#{name}")
      end
    end
  end
end

#audit_versioned_keg_onlyObject



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 468

def audit_versioned_keg_only
  return unless @versioned_formula
  return unless @core_tap

  if formula.keg_only?
    return if formula.keg_only_reason.versioned_formula?
    if formula.name.start_with?("openssl", "libressl") &&
       formula.keg_only_reason.by_macos?
      return
    end
  end

  return if VERSIONED_KEG_ONLY_ALLOWLIST.include?(formula.name) || formula.name.start_with?("gcc@")

  problem "Versioned formulae in homebrew/core should use `keg_only :versioned_formula`"
end

#get_repo_data(regex) ⇒ Object



556
557
558
559
560
561
562
563
564
565
566
567
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 556

def get_repo_data(regex)
  return unless @core_tap
  return unless @online

  _, user, repo = *regex.match(formula.stable.url) if formula.stable
  _, user, repo = *regex.match(formula.homepage) unless user
  return if !user || !repo

  repo.delete_suffix!(".git")

  [user, repo]
end

#problem_if_output(output) ⇒ Object



853
854
855
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 853

def problem_if_output(output)
  problem(output) if output
end

#quote_dep(dep) ⇒ Object



849
850
851
# File 'brew/Library/Homebrew/dev-cmd/audit.rb', line 849

def quote_dep(dep)
  dep.is_a?(Symbol) ? dep.inspect : "'#{dep}'"
end