The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

THALJEF / Pinto-0.14 / lib / Pinto / Result.pm 

            

              
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
—
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134

              
# ABSTRACT: The result from running an Action
package Pinto::Result;
use Moose;
use MooseX::StrictConstructor;
use MooseX::Types::Moose qw(Bool ArrayRef);
use MooseX::MarkAsMethods ( autoclean => 1 );
use Pinto::Util qw(itis);
use overload ( q{""} => 'to_string' );
#-----------------------------------------------------------------------------
our $VERSION = '0.14'; # VERSION
#------------------------------------------------------------------------------
has made_changes => (
    is      => 'ro',
    isa     => Bool,
    writer  => '_set_made_changes',
    default => 0,
);
has was_successful => (
    is      => 'ro',
    isa     => Bool,
    writer  => '_set_was_successful',
    default => 1,
);
has exceptions => (
    traits  => [qw(Array)],
    handles => { exceptions => 'elements', add_exception => 'push' },
    isa     => ArrayRef,
    default => sub { [] },
);
#-----------------------------------------------------------------------------
sub failed {
    my ( $self, %args ) = @_;
    $self->_set_was_successful(0);
    if ( my $reason = $args{because} ) {
        # HACK: Sometimes we'll get exceptions that are strings
        # instead of objects (like from Moose type constraint
        # violations).  So we have to convert them ourselves.
        # If the message already contains a full stack trace,
        # then it will be really ugly.  God I wish Perl had
        # sane native exceptions.
        require Pinto::Exception;
        $reason = Pinto::Exception->new( message => "$reason" )
            if not itis( $reason, 'Pinto::Exception' );
        $self->add_exception($reason);
    }
    return $self;
}
#-----------------------------------------------------------------------------
sub changed {
    my ($self) = @_;
    $self->_set_made_changes(1);
    return $self;
}
#-----------------------------------------------------------------------------
sub exit_status {
    my ($self) = @_;
    return $self->was_successful ? 0 : 1;
}
#-----------------------------------------------------------------------------
sub to_string {
    my ($self) = @_;
    return 'ok' if $self->was_successful;
    if ( my @exceptions = $self->exceptions ) {
        return join "\n", @exceptions;
    }
    return 'unknown error';
}
#-----------------------------------------------------------------------------
__PACKAGE__->meta->make_immutable;
#-----------------------------------------------------------------------------
1;
__END__
=pod
=encoding UTF-8
=for :stopwords Jeffrey Ryan Thalhammer
=head1 NAME
Pinto::Result - The result from running an Action
=head1 VERSION
version 0.14
=head1 AUTHOR
Jeffrey Ryan Thalhammer <jeff@stratopan.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2015 by Jeffrey Ryan Thalhammer.
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