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

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. 



36
37
38
39
40
41
42
 
# File 'dependency_collector.rb', line 36

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 ⇒ Object (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. 



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

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:



33
34
35
 
# File 'dependency_collector.rb', line 33

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) 


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

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) 


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

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) 


59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'dependency_collector.rb', line 59

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

#bubblewrap_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:



106
 
# File 'dependency_collector.rb', line 106

def bubblewrap_dep_if_needed(related_formula_names); 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) 


94
95
96
97
 
# File 'dependency_collector.rb', line 94

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:



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

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) 


82
83
84
85
86
87
88
89
90
91
 
# File 'dependency_collector.rb', line 82

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:



117
118
119
 
# File 'dependency_collector.rb', line 117

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:



130
131
132
 
# File 'dependency_collector.rb', line 130

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) 


77
78
79
 
# File 'dependency_collector.rb', line 77

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.



52
53
54
55
56
 
# File 'dependency_collector.rb', line 52

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:



100
 
# File 'dependency_collector.rb', line 100

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:



109
110
111
112
113
114
 
# File 'dependency_collector.rb', line 109

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:



103
 
# File 'dependency_collector.rb', line 103

def glibc_dep_if_needed(related_formula_names); 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:



45
46
47
48
49
 
# File 'dependency_collector.rb', line 45

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:



122
123
124
125
126
127
 
# File 'dependency_collector.rb', line 122

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:



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

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:



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

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:



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

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