Class: Gem::Resolver::Molinillo::DependencyGraph

Inherits:
Object
  • Object
show all
Includes:
Enumerable, TSort
Defined in:
lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb

Overview

A directed acyclic graph that is tuned to hold named dependencies

Defined Under Namespace

Classes: Edge, Vertex

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ DependencyGraph

Returns a new instance of DependencyGraph.



45
46
47
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 45

def initialize
  @vertices = {}
end

Instance Attribute Details

#vertices ⇒ {String => Vertex} (readonly)

Returns the vertices of the dependency graph, keyed by Gem::Resolver::Molinillo::DependencyGraph::Vertex#name.

Returns:



43
44
45
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 43

def vertices
  @vertices
end

Class Method Details

.tsort(vertices) ⇒ Array<Vertex>

Topologically sorts the given vertices.

Parameters:

  • vertices (Enumerable<Vertex>) —

    the vertices to be sorted, which must all belong to the same graph.

Returns:

  • (Array<Vertex>) —

    The sorted vertices.



28
29
30
31
32
33
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 28

def self.tsort(vertices)
  TSort.tsort(
    lambda { |b| vertices.each(&b) },
    lambda { |v, &b| (v.successors & vertices).each(&b) }
  )
end

Instance Method Details

#==(other) ⇒ Boolean

Returns whether the two dependency graphs are equal, determined by a recursive traversal of each #root_vertices and its Gem::Resolver::Molinillo::DependencyGraph::Vertex#successors.

Returns:



77
78
79
80
81
82
83
84
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 77

def ==(other)
  return false unless other
  vertices.each do |name, vertex|
    other_vertex = other.vertex_named(name)
    return false unless other_vertex
    return false unless other_vertex.successors.map(&:name).to_set == vertex.successors.map(&:name).to_set
  end
end

#add_child_vertex(name, payload, parent_names, requirement) ⇒ void

This method returns an undefined value.

Parameters:

  • name (String)
  • payload (Object)
  • parent_names (Array<String>)
  • requirement (Object) —

    the requirement that is requiring the child



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 91

def add_child_vertex(name, payload, parent_names, requirement)
  vertex = add_vertex(name, payload)
  parent_names.each do |parent_name|
    unless parent_name
      vertex.root = true
      next
    end
    parent_node = vertex_named(parent_name)
    add_edge(parent_node, vertex, requirement)
  end
  vertex
end

#add_edge(origin, destination, requirement) ⇒ Edge

Adds a new Edge to the dependency graph

Parameters:

  • origin (Vertex)
  • destination (Vertex)
  • requirement (Object) —

    the requirement that this edge represents

Returns:

  • (Edge) —

    the added edge



145
146
147
148
149
150
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 145

def add_edge(origin, destination, requirement)
  if destination.path_to?(origin)
    raise CircularDependencyError.new([origin, destination])
  end
  add_edge_no_circular(origin, destination, requirement)
end

#add_vertex(name, payload, root = false) ⇒ Vertex

Returns the vertex that was added to ‘self`.

Parameters:

  • name (String)
  • payload (Object)

Returns:

  • (Vertex) —

    the vertex that was added to ‘self`



107
108
109
110
111
112
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 107

def add_vertex(name, payload, root = false)
  vertex = vertices[name] ||= Vertex.new(name, payload)
  vertex.payload ||= payload
  vertex.root ||= root
  vertex
end

#detach_vertex_named(name) ⇒ void

This method returns an undefined value.

Detaches the #vertex_named ‘name` Vertex from the graph, recursively removing any non-root vertices that were orphaned in the process

Parameters:

  • name (String) 


118
119
120
121
122
123
124
125
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 118

def detach_vertex_named(name)
  return unless vertex = vertices.delete(name)
  vertex.outgoing_edges.each do |e|
    v = e.destination
    v.incoming_edges.delete(e)
    detach_vertex_named(v.name) unless v.root? || v.predecessors.any?
  end
end

#each ⇒ Array<Vertex> Also known as: tsort_each_node

Enumerates through the vertices of the graph.

Returns:

  • (Array<Vertex>) —

    The graph’s vertices.



12
13
14
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 12

def each
  vertices.values.each { |v| yield v }
end

#initialize_copy(other) ⇒ Object

Initializes a copy of a Gem::Resolver::Molinillo::DependencyGraph, ensuring that all #vertices are properly copied.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 51

def initialize_copy(other)
  super
  @vertices = {}
  traverse = lambda do |new_v, old_v|
    return if new_v.outgoing_edges.size == old_v.outgoing_edges.size
    old_v.outgoing_edges.each do |edge|
      destination = add_vertex(edge.destination.name, edge.destination.payload)
      add_edge_no_circular(new_v, destination, edge.requirement)
      traverse.call(destination, edge.destination)
    end
  end
  other.vertices.each do |name, vertex|
    new_vertex = add_vertex(name, vertex.payload, vertex.root?)
    new_vertex.explicit_requirements.replace(vertex.explicit_requirements)
    traverse.call(new_vertex, vertex)
  end
end

#inspect ⇒ String

Returns a string suitable for debugging.

Returns:

  • (String) —

    a string suitable for debugging



70
71
72
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 70

def inspect
  "#{self.class}:#{vertices.values.inspect}"
end

#root_vertex_named(name) ⇒ Vertex?

Returns the root vertex with the given name.

Parameters:

  • name (String)

Returns:

  • (Vertex, nil) —

    the root vertex with the given name



135
136
137
138
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 135

def root_vertex_named(name)
  vertex = vertex_named(name)
  vertex if vertex && vertex.root?
end

#tsort_each_child(vertex, &block) ⇒ Object 



20
21
22
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 20

def tsort_each_child(vertex, &block)
  vertex.successors.each(&block)
end

#vertex_named(name) ⇒ Vertex?

Returns the vertex with the given name.

Parameters:

  • name (String)

Returns:

  • (Vertex, nil) —

    the vertex with the given name



129
130
131
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 129

def vertex_named(name)
  vertices[name]
end