123456789_123456789_123456789_123456789_123456789_

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

Relationships & Source Files
Namespace Children
Classes:
Edge, Vertex
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, TSort, Enumerable
Inherits: Object
Defined in: lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb

Overview

A directed acyclic graph that is tuned to hold named dependencies

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new ⇒ DependencyGraph

Initializes an empty dependency graph

[ GitHub ] 

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 48



def initialize
  @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.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 30



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


  







Instance Attribute Details



  

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



  

    
  





  
Returns:


    
  
  • 
    ({String => Vertex})
—    
    

    the vertices of the dependency graph, keyed by Vertex#name
    

    
  
    • 





  [ GitHub ]


  

  


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



attr_reader :vertices


  







Instance Method Details



  

    #==(other)  ⇒ Boolean 
  



  

    
  





  
Returns:


    
  
  • 
    (Boolean)
—    
    

    whether the two dependency graphs are equal, determined by a recursive traversal of each #root_vertices and its Vertex#successors
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 81



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
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 95



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 DependencyGraph::Edge to the dependency graph


  





  
Parameters:


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

    the requirement that this edge represents
    

    
  
    • 



Returns:


    
  
  • 
    (Edge)
—    
    

    the added edge
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 150



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_edge_no_circular(origin, destination, requirement)   (private)
  



  

    

Adds a new DependencyGraph::Edge to the dependency graph without checking for circularity.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 161



def add_edge_no_circular(origin, destination, requirement)
  edge = Edge.new(origin, destination, requirement)
  origin.outgoing_edges << edge
  destination.incoming_edges << edge
  edge
end


  








  

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



  

    

Adds a vertex with the given name, or updates the existing one.


  





  
Parameters:


    
  
  • 
    name
    (String)
  
    • 
  
  • 
    payload
    (Object)
  
    • 



Returns:


    
  
  • 
    (Vertex)
—    
    

    the vertex that was added to self
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 112



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 DependencyGraph::Vertex from the graph, recursively removing any non-root vertices that were orphaned in the process


  





  
Parameters:


    
  
  • 
    name
    (String)
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 123



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.
    

    
  
    • 





  [ GitHub ]


  

  


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



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


  








  

    #initialize_copy(other)  
  



  

    

Initializes a copy of a DependencyGraph, ensuring that all #vertices are properly copied.


  





  
Parameters:


    
  
  • 
    other
    (DependencyGraph)
—    
    

    the graph to copy.
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 55



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:


    
  
  • 
    (String)
—    
    

    a string suitable for debugging
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 74



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


  








  

    #root_vertex_named(name)  ⇒ Vertex? 
  



  

    
  





  
Parameters:


    
  
  • 
    name
    (String)
  
    • 



Returns:


    
  
  • 
    (Vertex, nil)
—    
    

    the root vertex with the given name
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 140



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


  








  

    #tsort_each_child(vertex, &block)   (private)
  

  [ GitHub ]


  

  


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



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


  








  

    #tsort_each_node   (private)
  



  

    

Alias for #each.


  



  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 19



alias_method :tsort_each_node, :each


  








  

    #vertex_named(name)  ⇒ Vertex? 
  



  

    
  





  
Parameters:


    
  
  • 
    name
    (String)
  
    • 



Returns:


    
  
  • 
    (Vertex, nil)
—    
    

    the vertex with the given name
    

    
  
    • 





  [ GitHub ]


  

  


# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 134



def vertex_named(name)
  vertices[name]
end