Class: Requirement

Inherits:
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



164
165
166
# File 'Library/Homebrew/requirement.rb', line 164

def build
  @build
end

.env_procObject (readonly)

Returns the value of attribute env_proc



164
165
166
# File 'Library/Homebrew/requirement.rb', line 164

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



172
173
174
175
176
177
178
# File 'Library/Homebrew/requirement.rb', line 172

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.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
# File 'Library/Homebrew/requirement.rb', line 211

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.



238
239
240
# File 'Library/Homebrew/requirement.rb', line 238

def prune
  throw(:prune, true)
end

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

Returns:

  • (Boolean)


227
228
229
230
231
232
233
234
235
# File 'Library/Homebrew/requirement.rb', line 227

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



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

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

Instance Method Details

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



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

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

#default_formula?Boolean

Returns:

  • (Boolean)


76
77
78
# File 'Library/Homebrew/requirement.rb', line 76

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

#display_sObject



140
141
142
# File 'Library/Homebrew/requirement.rb', line 140

def display_s
  name
end

#envObject



103
104
105
# File 'Library/Homebrew/requirement.rb', line 103

def env
  self.class.env
end

#env_procObject



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

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)


72
73
74
# File 'Library/Homebrew/requirement.rb', line 72

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

#formulaObject



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

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

#hashObject



116
117
118
# File 'Library/Homebrew/requirement.rb', line 116

def hash
  name.hash ^ tags.hash
end

#inspectObject



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

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
52
53
# 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.undent

      You can install with Homebrew-Cask:
        brew cask install #{cask}
    EOS
  end

  if download
    s += <<-EOS.undent

      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.



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

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 PATH.new(ENV["PATH"]).include?(parent.to_s)
  ENV.append_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)


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

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 = $2
  end

  true
end

#satisfied_by_formula?Boolean

Returns:

  • (Boolean)


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

def satisfied_by_formula?
  !@formula.nil?
end

#satisfied_result_parentObject



80
81
82
83
# File 'Library/Homebrew/requirement.rb', line 80

def satisfied_result_parent
  return unless @satisfied_result.is_a?(Pathname)
  @satisfied_result.resolved_path.parent
end

#to_dependencyObject



132
133
134
135
136
137
138
# File 'Library/Homebrew/requirement.rb', line 132

def to_dependency
  if 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