gems.sass-3.2.8.lib.sass.tree.visitors.base.rb Maven / Gradle / Ivy
# Visitors are used to traverse the Sass parse tree.
# Visitors should extend {Visitors::Base},
# which provides a small amount of scaffolding for traversal.
module Sass::Tree::Visitors
# The abstract base class for Sass visitors.
# Visitors should extend this class,
# then implement `visit_*` methods for each node they care about
# (e.g. `visit_rule` for {RuleNode} or `visit_for` for {ForNode}).
# These methods take the node in question as argument.
# They may `yield` to visit the child nodes of the current node.
#
# *Note*: due to the unusual nature of {Sass::Tree::IfNode},
# special care must be taken to ensure that it is properly handled.
# In particular, there is no built-in scaffolding
# for dealing with the return value of `@else` nodes.
#
# @abstract
class Base
# Runs the visitor on a tree.
#
# @param root [Tree::Node] The root node of the Sass tree.
# @return [Object] The return value of \{#visit} for the root node.
def self.visit(root)
new.send(:visit, root)
end
protected
# Runs the visitor on the given node.
# This can be overridden by subclasses that need to do something for each node.
#
# @param node [Tree::Node] The node to visit.
# @return [Object] The return value of the `visit_*` method for this node.
def visit(node)
method = "visit_#{node_name node}"
if self.respond_to?(method, true)
self.send(method, node) {visit_children(node)}
else
visit_children(node)
end
end
# Visit the child nodes for a given node.
# This can be overridden by subclasses that need to do something
# with the child nodes' return values.
#
# This method is run when `visit_*` methods `yield`,
# and its return value is returned from the `yield`.
#
# @param parent [Tree::Node] The parent node of the children to visit.
# @return [Array