xref: /openbsd-src/gnu/usr.bin/perl/cpan/Test-Simple/lib/Test2/Event/Encoding.pm (revision 5486feefcc8cb79b19e014ab332cc5dfd05b3b33)
15759b3d2Safresh1package Test2::Event::Encoding;
25759b3d2Safresh1use strict;
35759b3d2Safresh1use warnings;
45759b3d2Safresh1
5*5486feefSafresh1our $VERSION = '1.302199';
65759b3d2Safresh1
75759b3d2Safresh1use Carp qw/croak/;
85759b3d2Safresh1
95759b3d2Safresh1BEGIN { require Test2::Event; our @ISA = qw(Test2::Event) }
105759b3d2Safresh1use Test2::Util::HashBase qw/encoding/;
115759b3d2Safresh1
125759b3d2Safresh1sub init {
135759b3d2Safresh1    my $self = shift;
145759b3d2Safresh1    defined $self->{+ENCODING} or croak "'encoding' is a required attribute";
155759b3d2Safresh1}
165759b3d2Safresh1
175759b3d2Safresh1sub summary { 'Encoding set to ' . $_[0]->{+ENCODING} }
185759b3d2Safresh1
195759b3d2Safresh1sub facet_data {
205759b3d2Safresh1    my $self = shift;
215759b3d2Safresh1    my $out = $self->common_facet_data;
225759b3d2Safresh1    $out->{control}->{encoding} = $self->{+ENCODING};
235759b3d2Safresh1    $out->{about}->{details} = $self->summary;
245759b3d2Safresh1    return $out;
255759b3d2Safresh1}
265759b3d2Safresh1
275759b3d2Safresh1
285759b3d2Safresh11;
295759b3d2Safresh1
305759b3d2Safresh1__END__
315759b3d2Safresh1
325759b3d2Safresh1=pod
335759b3d2Safresh1
345759b3d2Safresh1=encoding UTF-8
355759b3d2Safresh1
365759b3d2Safresh1=head1 NAME
375759b3d2Safresh1
385759b3d2Safresh1Test2::Event::Encoding - Set the encoding for the output stream
395759b3d2Safresh1
405759b3d2Safresh1=head1 DESCRIPTION
415759b3d2Safresh1
425759b3d2Safresh1The encoding event is generated when a test file wants to specify the encoding
435759b3d2Safresh1to be used when formatting its output. This event is intended to be produced
445759b3d2Safresh1by formatter classes and used for interpreting test names, message contents,
455759b3d2Safresh1etc.
465759b3d2Safresh1
475759b3d2Safresh1=head1 SYNOPSIS
485759b3d2Safresh1
495759b3d2Safresh1    use Test2::API qw/context/;
505759b3d2Safresh1    use Test2::Event::Encoding;
515759b3d2Safresh1
525759b3d2Safresh1    my $ctx = context();
535759b3d2Safresh1    my $event = $ctx->send_event('Encoding', encoding => 'UTF-8');
545759b3d2Safresh1
555759b3d2Safresh1=head1 METHODS
565759b3d2Safresh1
575759b3d2Safresh1Inherits from L<Test2::Event>. Also defines:
585759b3d2Safresh1
595759b3d2Safresh1=over 4
605759b3d2Safresh1
615759b3d2Safresh1=item $encoding = $e->encoding
625759b3d2Safresh1
635759b3d2Safresh1The encoding being specified.
645759b3d2Safresh1
655759b3d2Safresh1=back
665759b3d2Safresh1
675759b3d2Safresh1=head1 SOURCE
685759b3d2Safresh1
695759b3d2Safresh1The source code repository for Test2 can be found at
70*5486feefSafresh1L<https://github.com/Test-More/test-more/>.
715759b3d2Safresh1
725759b3d2Safresh1=head1 MAINTAINERS
735759b3d2Safresh1
745759b3d2Safresh1=over 4
755759b3d2Safresh1
765759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt>
775759b3d2Safresh1
785759b3d2Safresh1=back
795759b3d2Safresh1
805759b3d2Safresh1=head1 AUTHORS
815759b3d2Safresh1
825759b3d2Safresh1=over 4
835759b3d2Safresh1
845759b3d2Safresh1=item Chad Granum E<lt>exodist@cpan.orgE<gt>
855759b3d2Safresh1
865759b3d2Safresh1=back
875759b3d2Safresh1
885759b3d2Safresh1=head1 COPYRIGHT
895759b3d2Safresh1
90256a93a4Safresh1Copyright 2020 Chad Granum E<lt>exodist@cpan.orgE<gt>.
915759b3d2Safresh1
925759b3d2Safresh1This program is free software; you can redistribute it and/or
935759b3d2Safresh1modify it under the same terms as Perl itself.
945759b3d2Safresh1
95*5486feefSafresh1See L<https://dev.perl.org/licenses/>
965759b3d2Safresh1
975759b3d2Safresh1=cut
98