class Bundler::PubGrub::Incompatibility

Constants

CircularDependency
ConflictCause
InvalidDependency
NoVersions

Attributes

cause[R]
terms[R]

Public Class Methods

new(terms, cause:, custom_explanation: nil) click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 19
def initialize(terms, cause:, custom_explanation: nil)
  @cause = cause
  @terms = cleanup_terms(terms)
  @custom_explanation = custom_explanation

  if cause == :dependency && @terms.length != 2
    raise ArgumentError, "a dependency Incompatibility must have exactly two terms. Got #{@terms.inspect}"
  end
end

Public Instance Methods

conflict?() click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 42
def conflict?
  ConflictCause === cause
end
eql?(other) click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 33
def eql?(other)
  cause.eql?(other.cause) &&
    terms.eql?(other.terms)
end
external_incompatibilities() click to toggle source

Returns all external incompatibilities in this incompatibility’s derivation graph

# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 48
def external_incompatibilities
  if conflict?
    [
      cause.conflict,
      cause.other
    ].flat_map(&:external_incompatibilities)
  else
    [this]
  end
end
failure?() click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 38
def failure?
  terms.empty? || (terms.length == 1 && Package.root?(terms[0].package) && terms[0].positive?)
end
hash() click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 29
def hash
  cause.hash ^ terms.hash
end
inspect() click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 112
def inspect
  "#<#{self.class} #{to_s}>"
end
pretty_print(q) click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 116
def pretty_print(q)
  q.group 2, "#<#{self.class}", ">" do
    q.breakable
    q.text to_s

    q.breakable
    q.text " caused by "
    q.pp @cause
  end
end
to_s() click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 59
def to_s
  return @custom_explanation if @custom_explanation

  case cause
  when :root
    "(root dependency)"
  when :dependency
    "#{terms[0].to_s(allow_every: true)} depends on #{terms[1].invert}"
  when Bundler::PubGrub::Incompatibility::InvalidDependency
    "#{terms[0].to_s(allow_every: true)} depends on unknown package #{cause.package}"
  when Bundler::PubGrub::Incompatibility::CircularDependency
    "#{terms[0].to_s(allow_every: true)} depends on itself"
  when Bundler::PubGrub::Incompatibility::NoVersions
    "no versions satisfy #{cause.constraint}"
  when Bundler::PubGrub::Incompatibility::ConflictCause
    if failure?
      "version solving has failed"
    elsif terms.length == 1
      term = terms[0]
      if term.positive?
        "#{terms[0].to_s(allow_every: true)} is forbidden"
      else
        "#{terms[0].invert} is required"
      end
    else
      if terms.all?(&:positive?)
        if terms.length == 2
          "#{terms[0].to_s(allow_every: true)} is incompatible with #{terms[1]}"
        else
          "one of #{terms.map(&:to_s).join(" or ")} must be false"
        end
      elsif terms.all?(&:negative?)
        if terms.length == 2
          "either #{terms[0].invert} or #{terms[1].invert}"
        else
          "one of #{terms.map(&:invert).join(" or ")} must be true";
        end
      else
        positive = terms.select(&:positive?)
        negative = terms.select(&:negative?).map(&:invert)

        if positive.length == 1
          "#{positive[0].to_s(allow_every: true)} requires #{negative.join(" or ")}"
        else
          "if #{positive.join(" and ")} then #{negative.join(" or ")}"
        end
      end
    end
  else
    raise "unhandled cause: #{cause.inspect}"
  end
end

Private Instance Methods

cleanup_terms(terms) click to toggle source
# File bundler/vendor/pub_grub/lib/pub_grub/incompatibility.rb, line 129
def cleanup_terms(terms)
  terms.each do |term|
    raise "#{term.inspect} must be a term" unless term.is_a?(Term)
  end

  if terms.length != 1 && ConflictCause === cause
    terms = terms.reject do |term|
      term.positive? && Package.root?(term.package)
    end
  end

  # Optimized simple cases
  return terms if terms.length <= 1
  return terms if terms.length == 2 && terms[0].package != terms[1].package

  terms.group_by(&:package).map do |package, common_terms|
    common_terms.inject do |acc, term|
      acc.intersect(term)
    end
  end
end