Module: Readall Private

Extended by:
Cachable, SystemCommand::Mixin
Defined in:
readall.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 validating syntax in taps.

Class Method Summary collapse

Methods included from Cachable

cache, clear_cache

Methods included from SystemCommand::Mixin

system_command, system_command!

Class Method Details

.valid_aliases?(alias_dir, formula_dir) ⇒ 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) 


30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'readall.rb', line 30

def self.valid_aliases?(alias_dir, formula_dir)
  return true unless alias_dir.directory?

  failed = T.let(false, T::Boolean)
  alias_dir.each_child do |f|
    if !f.symlink?
      onoe "Non-symlink alias: #{f}"
      failed = true
    elsif !f.file?
      onoe "Non-file alias: #{f}"
      failed = true
    end

    if formula_dir.glob("**/#{f.basename}.rb").any?(&:exist?)
      onoe "Formula duplicating alias: #{f}"
      failed = true
    end
  end
  !failed
end

.valid_casks?(_tap, os_name: nil, arch: nil) ⇒ 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:

  • _tap (Tap)
  • os_name (Symbol, nil) (defaults to: nil)
  • arch (Symbol, nil) (defaults to: nil)

Returns:

  • (Boolean) 


87
88
89
 
# File 'readall.rb', line 87

def self.valid_casks?(_tap, os_name: nil, arch: nil)
  true
end

.valid_formulae?(tap, bottle_tag: nil) ⇒ 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) 


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
 
# File 'readall.rb', line 52

def self.valid_formulae?(tap, bottle_tag: nil)
  cache[:valid_formulae] ||= {}

  success = T.let(true, T::Boolean)
  tap.formula_files.each do |file|
    valid = cache[:valid_formulae][file]
    next if valid == true || valid&.include?(bottle_tag)

    formula_name = file.basename(".rb").to_s
    formula_contents = file.read.force_encoding("UTF-8")

    readall_namespace = "ReadallNamespace"
    readall_formula_class = Formulary.load_formula(formula_name, file, formula_contents, readall_namespace,
                                                   flags: [], ignore_errors: false)
    readall_formula = readall_formula_class.new(formula_name, file, :stable, tap:)
    readall_formula.to_hash
    # TODO: Remove check for MACOS_MODULE_REGEX once the `MacOS` module is undefined on Linux
    cache[:valid_formulae][file] = if readall_formula.on_system_blocks_exist? ||
                                      formula_contents.match?(MACOS_MODULE_REGEX)
      [bottle_tag, *cache[:valid_formulae][file]]
    else
      true
    end
  rescue Interrupt
    raise
  # Handle all possible exceptions reading formulae.
  rescue Exception => e # rubocop:disable Lint/RescueException
    onoe "Invalid formula (#{bottle_tag}): #{file}"
    $stderr.puts e
    success = false
  end
  success
end

.valid_ruby_syntax?(ruby_files) ⇒ 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) 


20
21
22
23
24
25
26
27
 
# File 'readall.rb', line 20

def self.valid_ruby_syntax?(ruby_files)
  failed = T.let(false, T::Boolean)
  ruby_files.each do |ruby_file|
    # As a side effect, print syntax errors/warnings to `$stderr`.
    failed = true if syntax_errors_or_warnings?(ruby_file)
  end
  !failed
end

.valid_tap?(tap, aliases: false, no_simulate: false, os_arch_combinations: OnSystem::ALL_OS_ARCH_COMBINATIONS) ⇒ 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:

  • tap (Tap)
  • aliases (Boolean) (defaults to: false)
  • no_simulate (Boolean) (defaults to: false)
  • os_arch_combinations (Array<Array<String>>) (defaults to: OnSystem::ALL_OS_ARCH_COMBINATIONS)

Returns:

  • (Boolean) 


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
 
# File 'readall.rb', line 96

def self.valid_tap?(tap, aliases: false, no_simulate: false,
                    os_arch_combinations: OnSystem::ALL_OS_ARCH_COMBINATIONS)
  success = true

  if aliases
    valid_aliases = valid_aliases?(tap.alias_dir, tap.formula_dir)
    success = false unless valid_aliases
  end

  if no_simulate
    success = false unless valid_formulae?(tap)
    success = false unless valid_casks?(tap)
  else
    os_arch_combinations.each do |os, arch|
      bottle_tag = Utils::Bottles::Tag.new(system: os, arch:)
      next unless bottle_tag.valid_combination?

      Homebrew::SimulateSystem.with(os:, arch:) do
        success = false unless valid_formulae?(tap, bottle_tag:)
        success = false unless valid_casks?(tap, os_name: os, arch:)
      end
    end
  end

  success
end