aboutsummaryrefslogtreecommitdiffstats
path: root/Library/Homebrew/requirement.rb
blob: 42e4467bc51874542ab0c3c5681409e1d61a611d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
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
85
86
87
88
89
90
91
92
93
94
95
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
require 'dependable'
require 'build_environment'

# 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.
class Requirement
  include Dependable
  extend BuildEnvironmentDSL

  attr_reader :tags, :name

  def initialize(*tags)
    @tags = tags.flatten.compact
    @tags << :build if self.class.build
    @name ||= infer_name
  end

  # The message to show when the requirement is not met.
  def message; "" end

  # Overriding #satisfied? is deprecated.
  # Pass a block or boolean to the satisfied DSL method instead.
  def satisfied?
    result = self.class.satisfy.yielder do |proc|
      instance_eval(&proc)
    end

    infer_env_modification(result)
    !!result
  end

  # Overriding #fatal? is deprecated.
  # Pass a boolean to the fatal DSL method instead.
  def fatal?
    self.class.fatal || false
  end

  # Overriding #modify_build_environment is deprecated.
  # Pass a block to the the env DSL method instead.
  def modify_build_environment
    satisfied? and env.modify_build_environment(self)
  end

  def env
    @env ||= self.class.env
  end

  def eql?(other)
    instance_of?(other.class) && hash == other.hash
  end

  def hash
    [name, *tags].hash
  end

  private

  def infer_name
    klass = self.class.to_s
    klass.sub!(/(Dependency|Requirement)$/, '')
    klass.sub!(/^(\w+::)*/, '')
    klass.downcase
  end

  def infer_env_modification(o)
    case o
    when Pathname
      self.class.env do
        unless ENV["PATH"].split(":").include?(o.parent.to_s)
          ENV.append("PATH", o.parent, ":")
        end
      end
    end
  end

  class << self
    def fatal(val=nil)
      val.nil? ? @fatal : @fatal = val
    end

    def build(val=nil)
      val.nil? ? @build : @build = val
    end

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

  class Satisfier
    def initialize(options={}, &block)
      case options
      when Hash
        @options = { :build_env => true }
        @options.merge!(options)
      else
        @satisfied = options
      end
      @proc = block
    end

    def yielder
      if instance_variable_defined?(:@satisfied)
        @satisfied
      elsif @options[:build_env]
        require 'superenv'
        ENV.with_build_environment do
          ENV.userpaths!
          yield @proc
        end
      else
        yield @proc
      end
    end
  end

  # 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.
  def self.expand(dependent, &block)
    reqs = ComparableSet.new

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

    formulae.map(&:requirements).each do |requirements|
      requirements.each do |req|
        prune = catch(:prune) do
          if block_given?
            yield dependent, req
          elsif req.optional? || req.recommended?
            Requirement.prune unless dependent.build.with?(req.name)
          end
        end

        next if prune

        reqs << req
      end
    end

    # We special case handling of X11Dependency and its subclasses to
    # ensure the correct dependencies are present in the final list.
    # If an X11Dependency is present after filtering, we eliminate
    # all X11Dependency::Proxy objects from the list. If there aren't
    # any X11Dependency objects, then we eliminate all but one of the
    # proxy objects.
    proxy = unless reqs.any? { |r| r.instance_of?(X11Dependency) }
      reqs.find { |r| r.kind_of?(X11Dependency::Proxy) }
    end

    reqs.reject! do |r|
      r.kind_of?(X11Dependency::Proxy)
    end

    reqs << proxy unless proxy.nil?
    reqs
  end

  # Used to prune requirements when calling expand with a block.
  def self.prune
    throw(:prune, true)
  end
end