Class: DependencyCollector Private

Inherits:
Object show all
Extended by:
Cachable, T::Generic
Includes:
OS::Linux::DependencyCollector, OS::Mac::DependencyCollector
Defined in:
dependency_collector.rb

Overview

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

This class is used by depends_on in the formula DSL to turn dependency specifications into the proper kinds of dependencies and requirements.

Constant Summary collapse

Cache =

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. 

type_template { { fixed: T::Hash[T.untyped, T.untyped] } }

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Cachable

cache, clear_cache

Methods included from OS::Linux::DependencyCollector

#global_dep_tree

Constructor Details

#initialize ⇒ void

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. 



33
34
35
36
37
38
39
 
# File 'dependency_collector.rb', line 33

def initialize
  # Ensure this is synced with `initialize_dup` and `freeze` (excluding simple objects like integers and booleans)
  @deps = T.let(Dependencies.new, Dependencies)
  @requirements = T.let(Requirements.new, Requirements)

  init_global_dep_tree_if_needed!
end

Instance Attribute Details

#deps ⇒ Dependencies (readonly)

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:



27
28
29
 
# File 'dependency_collector.rb', line 27

def deps
  @deps
end

#requirements ⇒ Requirements (readonly)

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:



30
31
32
 
# File 'dependency_collector.rb', line 30

def requirements
  @requirements
end

Class Method Details

.tar_needs_bzip2_dependency? ⇒ 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.

Returns:

  • (Boolean) 


164
165
166
 
# File 'dependency_collector.rb', line 164

def self.tar_needs_bzip2_dependency?
  !new.bzip2_dep_if_needed([]).nil?
end

.tar_needs_xz_dependency? ⇒ 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.

Returns:

  • (Boolean) 


159
160
161
 
# File 'dependency_collector.rb', line 159

def self.tar_needs_xz_dependency?
  !new.xz_dep_if_needed([]).nil?
end

Instance Method Details

#add(spec) ⇒ 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:

  • spec (T.untyped)

Returns:

  • (T.untyped) 


56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'dependency_collector.rb', line 56

def add(spec)
  case dep = fetch(spec)
  when Array
    dep.compact.each { |dep| @deps << dep }
  when Dependency
    @deps << dep
  when Requirement
    @requirements << dep
  when nil
    # no-op when we have a nil value
    nil
  else
    raise ArgumentError, "DependencyCollector#add passed something that isn't a Dependency or Requirement!"
  end
  dep
end

#build(spec) ⇒ 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:

  • spec (T.untyped)

Returns:

  • (T.untyped) 


91
92
93
94
 
# File 'dependency_collector.rb', line 91

def build(spec)
  spec, tags = spec.is_a?(Hash) ? spec.first : spec
  parse_spec(spec, Array(tags))
end

#bzip2_dep_if_needed(tags) ⇒ Dependency?

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:



154
155
156
 
# File 'dependency_collector.rb', line 154

def bzip2_dep_if_needed(tags)
  Dependency.new("bzip2", [*tags, :implicit]) unless which("bzip2")
end

#cache_key(spec) ⇒ 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:

  • spec (T.untyped)

Returns:

  • (T.untyped) 


79
80
81
82
83
84
85
86
87
88
 
# File 'dependency_collector.rb', line 79

def cache_key(spec)
  if spec.is_a?(Resource)
    if spec.download_strategy <= CurlDownloadStrategy
      return "#{spec.download_strategy}#{File.extname(T.must(spec.url)).split("?").first}"
    end

    return spec.download_strategy
  end
  spec
end

#curl_dep_if_needed(tags) ⇒ Dependency

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:



121
122
123
 
# File 'dependency_collector.rb', line 121

def curl_dep_if_needed(tags)
  Dependency.new("curl", [*tags, :implicit])
end

#cvs_dep_if_needed(tags) ⇒ Dependency?

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:



134
135
136
 
# File 'dependency_collector.rb', line 134

def cvs_dep_if_needed(tags)
  Dependency.new("cvs", [*tags, :implicit]) unless which("cvs")
end

#fetch(spec) ⇒ 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:

  • spec (T.untyped)

Returns:

  • (T.untyped) 


74
75
76
 
# File 'dependency_collector.rb', line 74

def fetch(spec)
  self.class.cache.fetch(cache_key(spec)) { |key| self.class.cache[key] = build(spec) }
end

#freeze ⇒ void

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.

This method returns an undefined value.



49
50
51
52
53
 
# File 'dependency_collector.rb', line 49

def freeze
  @deps.freeze
  @requirements.freeze
  super
end

#gcc_dep_if_needed(related_formula_names) ⇒ Dependency?

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:

  • related_formula_names (Set<String>)

Returns:



97
 
# File 'dependency_collector.rb', line 97

def gcc_dep_if_needed(related_formula_names); end

#git_dep_if_needed(tags) ⇒ Dependency?

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:



113
114
115
116
117
118
 
# File 'dependency_collector.rb', line 113

def git_dep_if_needed(tags)
  require "utils/git"
  return if Utils::Git.available?

  Dependency.new("git", [*tags, :implicit])
end

#glibc_dep_if_needed(related_formula_names) ⇒ Dependency?

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:

  • related_formula_names (Set<String>)

Returns:



100
 
# File 'dependency_collector.rb', line 100

def glibc_dep_if_needed(related_formula_names); end

#implicit_dependency_names ⇒ Set<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.

Names implicitly added to any formula's deps right now, reusing the same checks Formula#add_global_deps_to_spec uses to inject them onto a real formula.

Returns:



105
106
107
108
109
110
 
# File 'dependency_collector.rb', line 105

def implicit_dependency_names
  [
    gcc_dep_if_needed(Set.new),
    glibc_dep_if_needed(Set.new),
  ].compact.to_set(&:name)
end

#initialize_dup(other) ⇒ void

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.

This method returns an undefined value.

Parameters:



42
43
44
45
46
 
# File 'dependency_collector.rb', line 42

def initialize_dup(other)
  super
  @deps = @deps.dup
  @requirements = @requirements.dup
end

#subversion_dep_if_needed(tags) ⇒ Dependency?

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:



126
127
128
129
130
131
 
# File 'dependency_collector.rb', line 126

def subversion_dep_if_needed(tags)
  require "utils/svn"
  return if Utils::Svn.available?

  Dependency.new("subversion", [*tags, :implicit])
end

#unzip_dep_if_needed(tags) ⇒ Dependency?

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:



149
150
151
 
# File 'dependency_collector.rb', line 149

def unzip_dep_if_needed(tags)
  Dependency.new("unzip", [*tags, :implicit]) unless which("unzip")
end

#xz_dep_if_needed(tags) ⇒ Dependency?

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:



139
140
141
 
# File 'dependency_collector.rb', line 139

def xz_dep_if_needed(tags)
  Dependency.new("xz", [*tags, :implicit]) unless which("xz")
end

#zstd_dep_if_needed(tags) ⇒ Dependency?

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:



144
145
146
 
# File 'dependency_collector.rb', line 144

def zstd_dep_if_needed(tags)
  Dependency.new("zstd", [*tags, :implicit]) unless which("zstd")
end