Class: TreeStand::BreadthFirstVisitor

Inherits:

Object

• Object
• TreeStand::BreadthFirstVisitor

Extended by:

T::Sig

Defined in:

lib/tree_stand/breadth_first_visitor.rb

Overview

Breadth-first traversal through the tree, calling hooks at each stop.

Instance Method Summary

• #around(node, &block) ⇒ void abstract
• #initialize(node) ⇒ void constructor
• #on(node) ⇒ void abstract
• #visit ⇒ T.self_type

  Run the visitor on the document and return self.

Constructor Details

#initialize(node) ⇒ void

Parameters:

• node (TreeStand::Node)

# File 'lib/tree_stand/breadth_first_visitor.rb', line 10

def initialize(node)
  @node = node
end

Instance Method Details

#around(node, &block) ⇒ void

This method is abstract.

The default implementation yields to visit all children.

This method returns an undefined value.

Parameters:

• node (TreeStand::Node)
• block (T.proc.void)

# File 'lib/tree_stand/breadth_first_visitor.rb', line 32

def around(node, &block) = yield

#on(node) ⇒ void

This method is abstract.

The default implementation does nothing.

This method returns an undefined value.

Parameters:

• node (TreeStand::Node)

# File 'lib/tree_stand/breadth_first_visitor.rb', line 28

def on(node) = nil

#visit ⇒ T.self_type

Run the visitor on the document and return self. Allows chaining create and visit.

Examples:

visitor = CountingVisitor.new(node, :predicate).visit

Returns:

• (T.self_type)

# File 'lib/tree_stand/breadth_first_visitor.rb', line 18

def visit
  queue = [@node]
  while queue.any?
    visit_node(queue)
  end
  self
end