File Coverage

blib/lib/Sieve/Generator/Element.pm

Criterion	Covered	Total	%
statement	20	20	100.0
branch	2	2	100.0
condition			n/a
subroutine	5	5	100.0
pod	2	2	100.0
total	29	29	100.0

use v5.36.0;
package Sieve::Generator::Element 0.003;
# ABSTRACT: role for objects that render as Sieve code

use Moo::Role;

#pod =head1 DESCRIPTION
#pod
#pod This role is consumed by all objects that can render themselves as Sieve code.
#pod It requires a single method, C.
#pod
#pod =method as_sieve
#pod
#pod   my $sieve_text = $element->as_sieve;
#pod   my $sieve_text = $element->as_sieve($indent_level);
#pod
#pod This method renders the object as a string of Sieve code.  The optional
#pod C<$indent_level> argument is a non-negative integer controlling the
#pod indentation depth; each level adds two spaces.  If not given, no indenting is
#pod added.
#pod
#pod =method children
#pod
#pod   my @children = $element->children;
#pod
#pod Returns all child Elements of this node.  Leaf nodes return an empty list.
#pod Container nodes return their direct children.  This is used by
#pod C to walk the tree.
#pod
#pod =cut

sub children ($self) { () }

#pod =method find_elements
#pod
#pod   my @found = $element->find_elements(\&predicate);
#pod
#pod Walks the element tree depth-first, returning all elements (including
#pod C<$element> itself) for which the predicate returns true.  Descends into
#pod matching nodes, so all matches at any depth are returned.
#pod
#pod =cut

sub find_elements ($self, $code) {
  my @found;
  push @found, $self if $code->($self);
  push @found, $_->find_elements($code) for $self->children;
  return @found;
}

requires 'as_sieve';

no Moo::Role;
1;

__END__