Class: Requirement

Inherits:
Object
  • Object
show all
Extended by:
BuildEnvironment::DSL
Includes:
Dependable
Defined in:
Library/Homebrew/requirement.rb

Overview

A base class for non-formula requirements needed by formulae. A "fatal" requirement is one that will fail the build if it is not present. By default, Requirements are non-fatal.

Defined Under Namespace

Classes: Satisfier

Constant Summary

Constants included from Dependable

Dependable::RESERVED_TAGS

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dependable

#build?, #option_tags, #optional?, #options, #recommended?, #required?, #run?

Constructor Details

#initialize(tags = []) ⇒ Requirement

Returns a new instance of Requirement



14
15
16
17
18
19
20
21
22
23
24
25
26
27
# File 'Library/Homebrew/requirement.rb', line 14

def initialize(tags = [])
  @default_formula = self.class.default_formula
  @cask ||= self.class.cask
  @download ||= self.class.download
  @formula = nil
  tags.each do |tag|
    next unless tag.is_a? Hash
    @cask ||= tag[:cask]
    @download ||= tag[:download]
  end
  @tags = tags
  @tags << :build if self.class.build
  @name ||= infer_name
end

Class Attribute Details

.buildObject (readonly)

Returns the value of attribute build



169
170
171
# File 'Library/Homebrew/requirement.rb', line 169

def build
  @build
end

.env_procObject (readonly)

Returns the value of attribute env_proc



169
170
171
# File 'Library/Homebrew/requirement.rb', line 169

def env_proc
  @env_proc
end

Instance Attribute Details

#caskObject (readonly)

Returns the value of attribute cask



12
13
14
# File 'Library/Homebrew/requirement.rb', line 12

def cask
  @cask
end

#default_formulaObject (readonly)

Returns the value of attribute default_formula



12
13
14
# File 'Library/Homebrew/requirement.rb', line 12

def default_formula
  @default_formula
end

#downloadObject (readonly)

Returns the value of attribute download



12
13
14
# File 'Library/Homebrew/requirement.rb', line 12

def download
  @download
end

#nameObject (readonly)

Returns the value of attribute name



12
13
14
# File 'Library/Homebrew/requirement.rb', line 12

def name
  @name
end

#tagsObject (readonly)

Returns the value of attribute tags



12
13
14
# File 'Library/Homebrew/requirement.rb', line 12

def tags
  @tags
end

Class Method Details

.env(*settings, &block) ⇒ Object



177
178
179
180
181
182
183
# File 'Library/Homebrew/requirement.rb', line 177

def env(*settings, &block)
  if block_given?
    @env_proc = block
  else
    super
  end
end

.expand(dependent, &block) ⇒ Object

Expand the requirements of dependent recursively, optionally yielding [dependent, req] pairs to allow callers to apply arbitrary filters to the list. The default filter, which is applied when a block is not given, omits optionals and recommendeds based on what the dependent has asked for.



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
# File 'Library/Homebrew/requirement.rb', line 216

def expand(dependent, &block)
  reqs = Requirements.new

  formulae = dependent.recursive_dependencies.map(&:to_formula)
  formulae.unshift(dependent)

  formulae.each do |f|
    f.requirements.each do |req|
      next if prune?(f, req, &block)
      reqs << req
    end
  end

  reqs
end

.pruneObject

Used to prune requirements when calling expand with a block.



243
244
245
# File 'Library/Homebrew/requirement.rb', line 243

def prune
  throw(:prune, true)
end

.prune?(dependent, req, &_block) ⇒ Boolean

Returns:

  • (Boolean)


232
233
234
235
236
237
238
239
240
# File 'Library/Homebrew/requirement.rb', line 232

def prune?(dependent, req, &_block)
  catch(:prune) do
    if block_given?
      yield dependent, req
    elsif req.optional? || req.recommended?
      prune unless dependent.build.with?(req)
    end
  end
end

.satisfy(options = {}, &block) ⇒ Object



173
174
175
# File 'Library/Homebrew/requirement.rb', line 173

def satisfy(options = {}, &block)
  @satisfied ||= Requirement::Satisfier.new(options, &block)
end

Instance Method Details

#==(other) ⇒ Object Also known as: eql?



114
115
116
# File 'Library/Homebrew/requirement.rb', line 114

def ==(other)
  instance_of?(other.class) && name == other.name && tags == other.tags
end

#default_formula?Boolean

Returns:

  • (Boolean)


74
75
76
# File 'Library/Homebrew/requirement.rb', line 74

def default_formula?
  self.class.default_formula || false
end

#display_sObject



145
146
147
# File 'Library/Homebrew/requirement.rb', line 145

def display_s
  name
end

#envObject



106
107
108
# File 'Library/Homebrew/requirement.rb', line 106

def env
  self.class.env
end

#env_procObject



110
111
112
# File 'Library/Homebrew/requirement.rb', line 110

def env_proc
  self.class.env_proc
end

#fatal?Boolean

Overriding #fatal? is deprecated. Pass a boolean to the fatal DSL method instead.

Returns:

  • (Boolean)


70
71
72
# File 'Library/Homebrew/requirement.rb', line 70

def fatal?
  self.class.fatal || false
end

#formulaObject



127
128
129
# File 'Library/Homebrew/requirement.rb', line 127

def formula
  @formula || self.class.default_formula
end

#hashObject



119
120
121
# File 'Library/Homebrew/requirement.rb', line 119

def hash
  name.hash ^ tags.hash
end

#inspectObject



123
124
125
# File 'Library/Homebrew/requirement.rb', line 123

def inspect
  "#<#{self.class.name}: #{name.inspect} #{tags.inspect}>"
end

#messageObject

The message to show when the requirement is not met.



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'Library/Homebrew/requirement.rb', line 34

def message
  _, _, class_name = self.class.to_s.rpartition "::"
  s = "#{class_name} unsatisfied!\n"
  if cask
    s += <<~EOS
      You can install with Homebrew-Cask:
       brew cask install #{cask}
    EOS
  end

  if download
    s += <<~EOS
      You can download from:
       #{download}
    EOS
  end
  s
end

#modify_build_environmentObject

Overriding #modify_build_environment is deprecated. Pass a block to the env DSL method instead. Note: #satisfied? should be called before invoking this method as the env modifications may depend on its side effects.



91
92
93
94
95
96
97
98
99
100
101
102
103
104
# File 'Library/Homebrew/requirement.rb', line 91

def modify_build_environment
  instance_eval(&env_proc) if env_proc

  # XXX If the satisfy block returns a Pathname, then make sure that it
  # remains available on the PATH. This makes requirements like
  #   satisfy { which("executable") }
  # work, even under superenv where "executable" wouldn't normally be on the
  # PATH.
  parent = satisfied_result_parent
  return unless parent
  return if ["#{HOMEBREW_PREFIX}/bin", "#{HOMEBREW_PREFIX}/bin"].include?(parent.to_s)
  return if PATH.new(ENV["PATH"]).include?(parent.to_s)
  ENV.prepend_path("PATH", parent)
end

#option_namesObject



29
30
31
# File 'Library/Homebrew/requirement.rb', line 29

def option_names
  [name]
end

#satisfied?Boolean

Overriding #satisfied? is deprecated. Pass a block or boolean to the satisfy DSL method instead.

Returns:

  • (Boolean)


55
56
57
58
59
60
61
62
63
64
65
66
# File 'Library/Homebrew/requirement.rb', line 55

def satisfied?
  result = self.class.satisfy.yielder { |p| instance_eval(&p) }
  @satisfied_result = result
  return false unless result

  if parent = satisfied_result_parent
    parent.to_s =~ %r{(#{Regexp.escape(HOMEBREW_CELLAR)}|#{Regexp.escape(HOMEBREW_PREFIX)}/opt)/([\w+-.@]+)}
    @formula = Regexp.last_match(2)
  end

  true
end

#satisfied_by_formula?Boolean

Returns:

  • (Boolean)


131
132
133
# File 'Library/Homebrew/requirement.rb', line 131

def satisfied_by_formula?
  !@formula.nil?
end

#satisfied_result_parentObject



78
79
80
81
82
83
84
85
# File 'Library/Homebrew/requirement.rb', line 78

def satisfied_result_parent
  return unless @satisfied_result.is_a?(Pathname)
  parent = @satisfied_result.resolved_path.parent
  if parent.to_s =~ %r{^#{Regexp.escape(HOMEBREW_CELLAR)}/([\w+-.@]+)/[^/]+/(s?bin)/?$}
    parent = HOMEBREW_PREFIX/"opt/#{Regexp.last_match(1)}/#{Regexp.last_match(2)}"
  end
  parent
end

#to_dependency(use_default_formula: false) ⇒ Object



135
136
137
138
139
140
141
142
143
# File 'Library/Homebrew/requirement.rb', line 135

def to_dependency(use_default_formula: false)
  if use_default_formula && default_formula?
    Dependency.new(self.class.default_formula, tags, method(:modify_build_environment), name)
  elsif formula =~ HOMEBREW_TAP_FORMULA_REGEX
    TapDependency.new(formula, tags, method(:modify_build_environment), name)
  elsif formula
    Dependency.new(formula, tags, method(:modify_build_environment), name)
  end
end