Class: Molinillo::DependencyGraph::Log

Inherits:

Object

• Object
• Molinillo::DependencyGraph::Log

Extended by:

Enumerable

Defined in:

lib/molinillo/dependency_graph/log.rb

Overview

A log for dependency graph actions

Instance Method Summary

• #add_edge_no_circular(graph, origin, destination, requirement) ⇒ Edge

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

• #add_vertex(graph, name, payload, root) ⇒ Vertex

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

• #detach_vertex_named(graph, name) ⇒ void

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

• #initialize ⇒ Log constructor

  Initializes an empty log.

• #pop!(graph) ⇒ Action

  Pops the most recent action from the log and undoes the action.

• #rewind_to(graph, tag) ⇒ Void

  Rewinds the graph to the state tagged as ‘tag`

• #set_payload(graph, name, payload) ⇒ Void

  Sets the payload of the vertex with the given name

• #tag(graph, tag) ⇒ Void

  Tags the current state of the dependency as the given tag

Constructor Details

#initialize ⇒ Log

Initializes an empty log

# File 'lib/molinillo/dependency_graph/log.rb', line 13

def initialize
  @current_action = @first_action = nil
end

Instance Method Details

#add_edge_no_circular(graph, origin, destination, requirement) ⇒ Edge

Parameters:

• graph (Graph) —

  the graph to perform the action on

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

  the requirement that this edge represents

Returns:

• (Edge) —

  the added edge

# File 'lib/molinillo/dependency_graph/log.rb', line 39

def add_edge_no_circular(graph, origin, destination, requirement)
  push_action(graph, AddEdgeNoCircular.new(origin, destination, requirement))
end

#add_vertex(graph, name, payload, root) ⇒ Vertex

Parameters:

• graph (Graph) —

  the graph to perform the action on

• name (String)
• payload (Object)

Returns:

• (Vertex) —

  the vertex that was added to ‘self`

# File 'lib/molinillo/dependency_graph/log.rb', line 29

def add_vertex(graph, name, payload, root)
  push_action(graph, AddVertex.new(name, payload, root))
end

#detach_vertex_named(graph, name) ⇒ void

This method returns an undefined value.

Parameters:

• graph (Graph) —

  the graph to perform the action on

• name (String)

# File 'lib/molinillo/dependency_graph/log.rb', line 34

def detach_vertex_named(graph, name)
  push_action(graph, DetachVertexNamed.new(name))
end

#pop!(graph) ⇒ Action

Pops the most recent action from the log and undoes the action

Parameters:

• graph (DependencyGraph)

Returns:

• (Action) —

  the action that was popped off the log

# File 'lib/molinillo/dependency_graph/log.rb', line 51

def pop!(graph)
  return unless action = @current_action
  unless @current_action = action.previous
    @first_action = nil
  end
  action.down(graph)
  action
end

#rewind_to(graph, tag) ⇒ Void

Parameters:

• graph (Graph) —

  the graph to perform the action on

• tag (Object) —

  the tag to rewind to

Returns:

• (Void)

# File 'lib/molinillo/dependency_graph/log.rb', line 91

def rewind_to(graph, tag)
  loop do
    action = pop!(graph)
    raise "No tag #{tag.inspect} found" unless action
    break if action.class.name == :tag && action.tag == tag
  end
end

#set_payload(graph, name, payload) ⇒ Void

Parameters:

• graph (Graph) —

  the graph to perform the action on

• name (String) —

  the name of the vertex

• payload (Object) —

  the payload

Returns:

• (Void)

# File 'lib/molinillo/dependency_graph/log.rb', line 44

def set_payload(graph, name, payload)
  push_action(graph, SetPayload.new(name, payload))
end

#tag(graph, tag) ⇒ Void

Parameters:

• graph (Graph) —

  the graph to perform the action on

• tag (Object) —

  an opaque tag for the current state of the graph

Returns:

• (Void)

# File 'lib/molinillo/dependency_graph/log.rb', line 24

def tag(graph, tag)
  push_action(graph, Tag.new(tag))
end