123456789_123456789_123456789_123456789_123456789_

Class: Bundler::SpecSet

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, TSort, Enumerable
Inherits: Object
Defined in: lib/bundler/spec_set.rb

Constant Summary

TSort - Included

VERSION

Class Method Summary

Instance Attribute Summary

Instance Method Summary

TSort - Included

#each_strongly_connected_component

The iterator version of the #strongly_connected_components method.

#each_strongly_connected_component_from

Iterates over strongly connected component in the subgraph reachable from node.

#strongly_connected_components

Returns strongly connected components as an array of arrays of nodes.

#tsort

Returns a topologically sorted array of nodes.

#tsort_each

The iterator version of the #tsort method.

#tsort_each_child

Should be implemented by a extended class.

#tsort_each_node

Should be implemented by a extended class.

Constructor Details

.new(specs, incomplete_specs = []) ⇒ SpecSet

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 12

def initialize(specs, incomplete_specs = [])
  @specs = specs
  @incomplete_specs = incomplete_specs
end

Instance Attribute Details

#empty?Boolean (readonly)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 186

def empty?
  @specs.empty?
end

#incomplete_specs (readonly)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 10

attr_reader :incomplete_specs

Instance Method Details

#-(other)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 153

def -(other)
  SpecSet.new(to_a - other.to_a)
end

#<<(spec)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 174

def <<(spec)
  @specs << spec
end

#[](key)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 91

def [](key)
  key = key.name if key.respond_to?(:name)
  lookup[key]&.reverse || []
end

#[]=(key, value)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 96

def []=(key, value)
  @specs << value

  reset!
end

#add_extra_platforms!(platforms)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 55

def add_extra_platforms!(platforms)
  return platforms.concat([Gem::Platform::RUBY]).uniq if @specs.empty?

  new_platforms = all_platforms.select do |platform|
    next if platforms.include?(platform)
    next unless GemHelpers.generic(platform) == Gem::Platform::RUBY

    complete_platform(platform)
  end
  return platforms if new_platforms.empty?

  platforms.concat(new_platforms)

  less_specific_platform = new_platforms.find {|platform| platform != Gem::Platform::RUBY && Bundler.local_platform === platform && platform === Bundler.local_platform }
  platforms.delete(Bundler.local_platform) if less_specific_platform

  platforms
end

#all_platforms (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 232

def all_platforms
  @specs.flat_map {|spec| spec.source.specs.search([spec.name, spec.version]).map(&:platform) }.uniq
end

#complete_platform(platform) (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 205

def complete_platform(platform)
  new_specs = []

  valid_platform = lookup.all? do |_, specs|
    spec = specs.first
    matching_specs = spec.source.specs.search([spec.name, spec.version])
    platform_spec = GemHelpers.select_best_platform_match(matching_specs, platform).find do |s|
      s.matches_current_metadata? && valid_dependencies?(s)
    end

    if platform_spec
      new_specs << LazySpecification.from_spec(platform_spec) unless specs.include?(platform_spec)
      true
    else
      false
    end
  end

  if valid_platform && new_specs.any?
    @specs.concat(new_specs)

    reset!
  end

  valid_platform
end

#complete_platforms!(platforms)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 74

def complete_platforms!(platforms)
  platforms.each do |platform|
    complete_platform(platform)
  end
end

#delete(specs)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 102

def delete(specs)
  specs.each {|spec| @specs.delete(spec) }

  reset!
end

#delete_by_name(name)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 161

def delete_by_name(name)
  @specs.reject! {|spec| spec.name == name }

  reset!
end

#each(&b)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 190

def each(&b)
  sorted.each(&b)
end

#extract_circular_gems(error) (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 252

def extract_circular_gems(error)
  error.message.scan(/@name="(.*?)"/).flatten
end

#find_by_name_and_platform(name, platform)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 157

def find_by_name_and_platform(name, platform)
  @specs.detect {|spec| spec.name == name && spec.match_platform(platform) }
end

#for(dependencies, check = false, platforms = [nil])

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 17

def for(dependencies, check = false, platforms = [nil])
  handled = ["bundler"].product(platforms).map {|k| [k, true] }.to_h
  deps = dependencies.product(platforms)
  specs = []

  loop do
    break unless dep = deps.shift

    name = dep[0].name
    platform = dep[1]
    incomplete = false

    key = [name, platform]
    next if handled.key?(key)

    handled[key] = true

    specs_for_dep = specs_for_dependency(*dep)
    if specs_for_dep.any?
      specs.concat(specs_for_dep)

      specs_for_dep.first.dependencies.each do |d|
        next if d.type == :development
        incomplete = true if d.name != "bundler" && lookup[d.name].nil?
        deps << [d, dep[1]]
      end
    else
      incomplete = true
    end

    if incomplete && check
      @incomplete_specs += lookup[name] || [LazySpecification.new(name, nil, nil)]
    end
  end

  specs.uniq
end

#incomplete_for_platform?(deps, platform) ⇒ Boolean

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 139

def incomplete_for_platform?(deps, platform)
  return false if @specs.empty?

  @incomplete_specs = []

  self.for(deps, true, [platform])

  @incomplete_specs.any?
end

#length

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 178

def length
  @specs.length
end

#lookup (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 256

def lookup
  @lookup ||= begin
    lookup = {}
    @specs.each do |s|
      lookup[s.name] ||= []
      lookup[s.name] << s
    end
    lookup
  end
end

#materialize(deps)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 120

def materialize(deps)
  materialized = self.for(deps, true)

  SpecSet.new(materialized, incomplete_specs)
end

#materialized_for_all_platformsArray<Gem::Specification>

Materialize for all the specs in the spec set, regardless of what platform they’re for This is in contrast to how for does platform filtering (and specifically different from how #materialize calls #for only for the current platform)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 129

def materialized_for_all_platforms
  @specs.map do |s|
    next s unless s.is_a?(LazySpecification)
    s.source.remote!
    spec = s.materialize_for_installation
    raise GemNotFound, "Could not find #{s.full_name} in any of the sources" unless spec
    spec
  end
end

#missing_specs

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 149

def missing_specs
  @specs.select {|s| s.is_a?(LazySpecification) }
end

#names

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 194

def names
  lookup.keys
end

#reset! (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 200

def reset!
  @sorted = nil
  @lookup = nil
end

#size

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 182

def size
  @specs.size
end

#sort!

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 108

def sort!
  self
end

#sorted (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 240

def sorted
  rake = @specs.find {|s| s.name == "rake" }
  begin
    @sorted ||= ([rake] + tsort).compact.uniq
  rescue TSort::Cyclic => error
    cgems = extract_circular_gems(error)
    raise CyclicDependencyError, "Your bundle requires gems that depend" \
      " on each other, creating an infinite loop. Please remove either" \
      " gem '#{cgems[0]}' or gem '#{cgems[1]}' and try again."
  end
end

#specs_for_dependency(dep, platform) (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 272

def specs_for_dependency(dep, platform)
  specs_for_name = lookup[dep.name]
  return [] unless specs_for_name

  matching_specs = if dep.force_ruby_platform
    GemHelpers.force_ruby_platform(specs_for_name)
  else
    GemHelpers.select_best_platform_match(specs_for_name, platform || Bundler.local_platform)
  end
  matching_specs.map!(&:materialize_for_installation).compact! if platform.nil?
  matching_specs
end

#to_a

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 112

def to_a
  sorted.dup
end

#to_hash

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 116

def to_hash
  lookup.dup
end

#tsort_each_child(s) (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 285

def tsort_each_child(s)
  s.dependencies.sort_by(&:name).each do |d|
    next if d.type == :development

    specs_for_name = lookup[d.name]
    next unless specs_for_name

    specs_for_name.each {|s2| yield s2 }
  end
end

#tsort_each_node (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 267

def tsort_each_node
  # MUST sort by name for backwards compatibility
  @specs.sort_by(&:name).each {|s| yield s }
end

#valid_dependencies?(s) ⇒ Boolean (private)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 236

def valid_dependencies?(s)
  validate_deps(s) == :valid
end

#validate_deps(s)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 80

def validate_deps(s)
  s.runtime_dependencies.each do |dep|
    next if dep.name == "bundler"

    return :missing unless names.include?(dep.name)
    return :invalid if none? {|spec| dep.matches_spec?(spec) }
  end

  :valid
end

#what_required(spec)

[ GitHub ]

  
# File 'lib/bundler/spec_set.rb', line 167

def what_required(spec)
  unless req = find {|s| s.runtime_dependencies.any? {|d| d.name == spec.name } }
    return [spec]
  end
  what_required(req) << spec
end