File Coverage

blib/lib/Mail/BIMI/Role/HasError.pm

Criterion	Covered	Total	%
statement	61	66	92.4
branch	8	8	100.0
condition			n/a
subroutine	13	14	92.8
pod	7	7	100.0
total	89	95	93.6

package Mail::BIMI::Role::HasError;
# ABSTRACT: Class to model an error
our $VERSION = '3.20210225'; # VERSION
use 5.20.0;
use Moose::Role;
use Mail::BIMI::Prelude;
use Mail::BIMI::Trait::Cacheable;
use Mail::BIMI::Trait::CacheSerial;
use Mail::BIMI::Error;
use Sub::Install;

has errors => ( is => 'rw', isa => 'ArrayRef', lazy => 1, default => sub{return []}, traits => ['Cacheable','CacheSerial'] );
has warnings => ( is => 'rw', isa => 'ArrayRef', lazy => 1, default => sub{return []}, traits => ['Cacheable'] );



sub serialize_errors($self) {
  my @data = map {{
    code => $_->code,
    detail => $_->detail,
  }} $self->errors->@*;
  return \@data;
}


sub deserialize_errors($self,$value) {
  foreach my $error ($value->@*) {
    my $error_object = Mail::BIMI::Error->new(
      code => $error->{code},
      ( $error->{detail} ? ( detail => $error->{detail} ) : () ),
    );
    $self->add_error_object($error_object);
  }
}


sub add_error($self,$code,$detail=undef) {
  my $error = Mail::BIMI::Error->new(
    code=>$code,
    ($detail?(detail=>$detail):()),
  );
  $self->add_error_object($error);
}


sub add_warning($self,$detail) {
  push $self->warnings->@*, $detail;
}


sub add_error_object($self,$error) {
  if ( ref $error eq 'ARRAY' ) {
    foreach my $suberror ( $error->@* ){
        $self->add_error_object($suberror);
    }
  }
  else {
    $self->log_verbose(join(' : ',
      'Error',
      $error->code,
      $error->description,
      ( $error->detail ? $error->detail : () ),
    ));
    push $self->errors->@*, $error;
  }
}


sub error_codes($self) {
  my @error_codes = map { $_->code } $self->errors->@*;
  return \@error_codes;
}


sub filter_errors($self,$error) {
  return grep { $_->code eq $error } $self->errors->@*;
}

1;

__END__

=pod

=encoding UTF-8

=head1 NAME

Mail::BIMI::Role::HasError - Class to model an error

=head1 VERSION

version 3.20210225

=head1 DESCRIPTION

Role for handling validation errors and warnings

=head1 METHODS

=head2 I<serialize_errors()>

Serialize the errors property for cache storage

=head2 I<deserialize_errors($value)>

De-serialize the errors property for cache storage

=head2 I<add_error($code,$detail)>

Add an error with the given code and optional detail to the current operation.

=head2 I<add_warning($detail)>

Add a warning which may be returned to a validator.

=head2 I<add_error_object($error)>

Add an existing error object, or objects, to the current operation

=head2 I<error_codes>

Return an ArrayRef of current error codes

=head2 I<filter_errors($error)>

Return error(s) matching the given error code

=head1 REQUIRES

=over 4

=item * L<Mail::BIMI::Error|Mail::BIMI::Error>

=item * L<Mail::BIMI::Prelude|Mail::BIMI::Prelude>

=item * L<Mail::BIMI::Trait::CacheSerial|Mail::BIMI::Trait::CacheSerial>

=item * L<Mail::BIMI::Trait::Cacheable|Mail::BIMI::Trait::Cacheable>

=item * L<Moose::Role|Moose::Role>

=item * L<Sub::Install|Sub::Install>

=back

=head1 AUTHOR

Marc Bradshaw <[e-mail]>

=head1 COPYRIGHT AND LICENSE

This software is copyright (c) 2020 by Marc Bradshaw.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.

=cut