cpan/Test-Simple/lib/Test2/EventFacet/Render.pm

   1 package Test2::EventFacet::Render;
   2 use strict;
   3 use warnings;
   4
   5 our $VERSION = '1.302181';
   6
   7 sub is_list { 1 }
   8
   9 BEGIN { require Test2::EventFacet; our @ISA = qw(Test2::EventFacet) }
  10 use Test2::Util::HashBase qw{ -tag -facet -mode };
  11
  12 1;
  13
  14 __END__
  15
  16 =pod
  17
  18 =encoding UTF-8
  19
  20 =head1 NAME
  21
  22 Test2::EventFacet::Render - Facet that dictates how to render an event.
  23
  24 =head1 DESCRIPTION
  25
  26 This facet is used to dictate how the event should be rendered by the standard
  27 test2 rendering tools. If this facet is present then ONLY what is specified by
  28 it will be rendered. It is assumed that anything important or note-worthy will
  29 be present here, no other facets will be considered for rendering/display.
  30
  31 This facet is a list type, you can add as many items as needed.
  32
  33 =head1 FIELDS
  34
  35 =over 4
  36
  37 =item $string = $render->[#]->{details}
  38
  39 =item $string = $render->[#]->details()
  40
  41 Human readable text for display.
  42
  43 =item $string = $render->[#]->{tag}
  44
  45 =item $string = $render->[#]->tag()
  46
  47 Tag that should prefix/identify the main text.
  48
  49 =item $string = $render->[#]->{facet}
  50
  51 =item $string = $render->[#]->facet()
  52
  53 Optional, if the display text was generated from another facet this should
  54 state what facet it was.
  55
  56 =item $mode = $render->[#]->{mode}
  57
  58 =item $mode = $render->[#]->mode()
  59
  60 =over 4
  61
  62 =item calculated
  63
  64 Calculated means the facet was generated from another facet. Calculated facets
  65 may be cleared and regenerated whenever the event state changes.
  66
  67 =item replace
  68
  69 Replace means the facet is intended to replace the normal rendering of the
  70 event.
  71
  72 =back
  73
  74 =back
  75
  76 =head1 SOURCE
  77
  78 The source code repository for Test2 can be found at
  79 F<http://github.com/Test-More/test-more/>.
  80
  81 =head1 MAINTAINERS
  82
  83 =over 4
  84
  85 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  86
  87 =back
  88
  89 =head1 AUTHORS
  90
  91 =over 4
  92
  93 =item Chad Granum E<lt>exodist@cpan.orgE<gt>
  94
  95 =back
  96
  97 =head1 COPYRIGHT
  98
  99 Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
 100
 101 This program is free software; you can redistribute it and/or
 102 modify it under the same terms as Perl itself.
 103
 104 See F<http://dev.perl.org/licenses/>
 105
 106 =cut