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

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

Overview

A vertex in a Gem::Resolver::Molinillo::DependencyGraph that encapsulates a #name and a #payload

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, payload) ⇒ Vertex

Returns a new instance of Vertex.

Parameters:



180
181
182
183
184
185
186
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 180

def initialize(name, payload)
  @name = name
  @payload = payload
  @explicit_requirements = []
  @outgoing_edges = []
  @incoming_edges = []
end

Instance Attribute Details

#explicit_requirements ⇒ Arrary<Object> (readonly)

Returns the explicit requirements that required this vertex.

Returns:

  • (Arrary<Object>) —

    the explicit requirements that required this vertex



172
173
174
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 172

def explicit_requirements
  @explicit_requirements
end

#incoming_edges ⇒ Array<Edge>

Returns the edges of #graph that have ‘self` as their Edge#destination.

Returns:



200
201
202
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 200

def incoming_edges
  @incoming_edges
end

#name ⇒ String

Returns the name of the vertex.

Returns:

  • (String) —

    the name of the vertex



165
166
167
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 165

def name
  @name
end

#outgoing_edges ⇒ Array<Edge>

Returns the edges of #graph that have ‘self` as their Edge#origin.

Returns:

  • (Array<Edge>) —

    the edges of #graph that have ‘self` as their Edge#origin



196
197
198
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 196

def outgoing_edges
  @outgoing_edges
end

#payload ⇒ Object

Returns the payload the vertex holds.

Returns:

  • (Object) —

    the payload the vertex holds



168
169
170
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 168

def payload
  @payload
end

#root ⇒ Boolean Also known as: root?

Returns whether the vertex is considered a root vertex.

Returns:

  • (Boolean) —

    whether the vertex is considered a root vertex



175
176
177
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 175

def root
  @root
end

Instance Method Details

#==(other) ⇒ Boolean Also known as: eql?

Returns whether the two vertices are equal, determined by a recursive traversal of each #successors.

Returns:

  • (Boolean) —

    whether the two vertices are equal, determined by a recursive traversal of each #successors



239
240
241
242
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 239

def ==(other)
  shallow_eql?(other) &&
    successors.to_set == other.successors.to_set
end

#ancestor?(other) ⇒ Boolean Also known as: is_reachable_from?

Is there a path from ‘other` to `self` following edges in the dependency graph?

Returns:

  • (Boolean) —

    true iff there is a path following edges within this #graph



271
272
273
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 271

def ancestor?(other)
  other.path_to?(self)
end

#hash ⇒ Fixnum

Returns a hash for the vertex based upon its #name.

Returns:

  • (Fixnum) —

    a hash for the vertex based upon its #name



255
256
257
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 255

def hash
  name.hash
end

#inspect ⇒ String

Returns a string suitable for debugging.

Returns:

  • (String) —

    a string suitable for debugging



233
234
235
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 233

def inspect
  "#{self.class}:#{name}(#{payload.inspect})"
end

#path_to?(other) ⇒ Boolean Also known as: descendent?

Is there a path from ‘self` to `other` following edges in the dependency graph?

Returns:

  • (Boolean) —

    true iff there is a path following edges within this #graph



262
263
264
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 262

def path_to?(other)
  equal?(other) || successors.any? { |v| v.path_to?(other) }
end

#predecessors ⇒ Array<Vertex>

Returns the vertices of #graph that have an edge with ‘self` as their Edge#destination.

Returns:



204
205
206
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 204

def predecessors
  incoming_edges.map(&:origin)
end

#recursive_predecessors ⇒ Array<Vertex>

Returns the vertices of #graph where ‘self` is a #descendent?.

Returns:



210
211
212
213
214
215
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 210

def recursive_predecessors
  vertices = predecessors
  vertices += vertices.map(&:recursive_predecessors).flatten(1)
  vertices.uniq!
  vertices
end

#recursive_successors ⇒ Array<Vertex>

Returns the vertices of #graph where ‘self` is an #ancestor?.

Returns:



225
226
227
228
229
230
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 225

def recursive_successors
  vertices = successors
  vertices += vertices.map(&:recursive_successors).flatten(1)
  vertices.uniq!
  vertices
end

#requirements ⇒ Array<Object>

Returns all of the requirements that required this vertex.

Returns:

  • (Array<Object>) —

    all of the requirements that required this vertex



190
191
192
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 190

def requirements
  incoming_edges.map(&:requirement) + explicit_requirements
end

#shallow_eql?(other) ⇒ Boolean

Returns whether the two vertices are equal, determined solely by #name and #payload equality.

Returns:

  • (Boolean) —

    whether the two vertices are equal, determined solely by #name and #payload equality



246
247
248
249
250
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 246

def shallow_eql?(other)
  other &&
    name == other.name &&
    payload == other.payload
end

#successors ⇒ Array<Vertex>

Returns the vertices of #graph that have an edge with ‘self` as their Edge#origin.

Returns:

  • (Array<Vertex>) —

    the vertices of #graph that have an edge with ‘self` as their Edge#origin



219
220
221
 
# File 'lib/rubygems/resolver/molinillo/lib/molinillo/dependency_graph.rb', line 219

def successors
  outgoing_edges.map(&:destination)
end