File Coverage

blib/lib/JMAP/Tester/Role/Result.pm

Criterion	Covered	Total	%
statement	17	33	51.5
branch	0	4	0.0
condition	0	3	0.0
subroutine	6	9	66.6
pod	3	3	100.0
total	26	52	50.0

use v5.20.0;
use warnings;
package JMAP::Tester::Role::Result 0.109;
# ABSTRACT: the kind of thing that you get back for a request

use Moo::Role;

use experimental 'signatures';

use JMAP::Tester::Abort ();

use namespace::clean;

#pod =head1 OVERVIEW
#pod
#pod This is the role consumed by the class of any object returned by JMAP::Tester's
#pod C method.  Its only guarantee, for now, is an C method,
#pod and a C method.
#pod
#pod =cut

requires 'is_success';
requires 'response_payload';

#pod =method assert_successful
#pod
#pod This method returns the result if it's a success and otherwise aborts.
#pod
#pod =cut

sub assert_successful ($self) {
  return $self if $self->is_success;

  my $str = $self->can('has_ident') && $self->has_ident
          ? $self->ident
          : "JMAP failure";

  die JMAP::Tester::Abort->new($str);
}

#pod =method assert_successful_set
#pod
#pod   $result->assert_successful_set($name);
#pod
#pod This method is equivalent to:
#pod
#pod   $result->assert_successful->sentence_named($name)->as_set->assert_no_errors;
#pod
#pod C<$name> must be provided.
#pod
#pod =cut

sub assert_successful_set ($self, $name) {
  $self->assert_successful->sentence_named($name)->as_set->assert_no_errors;
}

#pod =method assert_single_successful_set
#pod
#pod   $result->assert_single_successful_set($name);
#pod
#pod This method is equivalent to:
#pod
#pod   $result->assert_successful->single_sentence($name)->as_set->assert_no_errors;
#pod
#pod C<$name> may be omitted, in which case the sentence name is not checked.
#pod
#pod =cut

sub assert_single_successful_set ($self, $name = undef) {
  $self->assert_successful->single_sentence($name)->as_set->assert_no_errors;
}

1;

__END__