Mojo/EventEmitter.pm

filter: Statementstmt 100% 40 / 40 Branchbran 83.3% 10 / 12 Conditioncond 75.0% 3 / 4 MC/DCmcdc 50.0% 1 / 2 Subroutinesub 100% 11 / 11 Podpod 100% 7 / 7 totaltotal 94.7% 72 / 76 CC 10 SCAR 8.4
CC
10
Cov
95%
emit
4.0
unsubscribe
3.0
catch
2.1
CRAP 2.3
« Mojolicious/Plugins.pm ↑ Summary Mojolicious/Lite.pm »
1 package Mojo::EventEmitter;
2 43 ▶use Mojo::Base -base;
Subroutine BEGIN: called CC=1 SCAR=0.0
3  
4 43 ▶use Scalar::Util qw(blessed weaken);
Subroutine BEGIN: called CC=1 SCAR=0.0
5  
6 43 ▶use constant DEBUG => $ENV{MOJO_EVENTEMITTER_DEBUG} || 0;
Subroutine BEGIN: called CC=2 SCAR=7.1
Condition50%1/2
$ENV{'MOJO_EVENTEMITTER_DEBUG'} || 0
l!l
043
MC/DC0%0/1
$ENV{'MOJO_EVENTEMITTER_DEBUG'} || 0
$ENV{'MOJO_EVENTEMITTER_DEBUG'}
Truth table50%1/2
A
A= $ENV{'MOJO_EVENTEMITTER_DEBUG'}
Aresult
11
00
7  
8 52 ▶sub catch { $_[0]->on(error => $_[1]) and return $_[0] }
Subroutine catch: called CC=2 SCAR=7.6
Pod documented
Branch: 1 branch
BranchTrueFalseTotal
$_[0]->on("error", $_[1]) and return $_[0] 52 0 52
9  
10 31309 ▶sub emit {
Subroutine emit: called CC=4 SCAR=13.9
Pod documented
11 31309 my ($self, $name) = (shift, shift);
12  
13 31309 ▶ if (my $s = $self->{events}{$name}) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $s = $self->{'events'}{$name}) { } 16763 14546 31309
14 16763 warn "-- Emit $name in @{[blessed $self]} (@{[scalar @$s]})\n" if DEBUG;
15 16763 for my $cb (@$s) { $self->$cb(@_) }
16 }
17 else {
18 14546 warn "-- Emit $name in @{[blessed $self]} (0)\n" if DEBUG;
19 14546 ▶ die "@{[blessed $self]}: $_[0]" if $name eq 'error';
Branch: 1 branch
BranchTrueFalseTotal
if $name eq "error" 1 14545 14546
20 }
21  
22 31305 return $self;
23 }
24  
25 469 ▶sub has_subscribers { !!shift->{events}{shift()} }
Subroutine has_subscribers: called CC=1 SCAR=0.0
Pod documented
26  
27 12511 ▶sub on { push @{$_[0]{events}{$_[1]}}, $_[2] and return $_[2] }
Subroutine on: called CC=2 SCAR=7.2
Pod documented
Branch: 1 branch
BranchTrueFalseTotal
push @{$_[0]{"events"}{$_[1]};}, $_[2] and return $_[2] 12511 0 12511
28  
29 9672 ▶sub once {
Subroutine once: called CC=1 SCAR=0.0
Pod documented
30 9672 my ($self, $name, $cb) = @_;
31  
32 9672 weaken $self;
33 9663 ▶ my $wrapper = sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
34 9663 $self->unsubscribe($name => __SUB__);
35 9663 $cb->(@_);
36 9672 };
37 9672 $self->on($name => $wrapper);
38  
39 9672 return $wrapper;
40 }
41  
42 1424 ▶sub subscribers { shift->{events}{shift()} //= [] }
Subroutine subscribers: called CC=2 SCAR=6.9
Pod documented
Condition100%2/2
+(shift())->{"events"}{shift()} //= []
l!l
1262162
MC/DC100%1/1
+(shift())->{"events"}{shift()} //= []
+(shift())->{"events"}{shift()}
Truth table100%2/2
A
A= +(shift())->{"events"}{shift()}
Aresult
11
00
43  
44 9738 ▶sub unsubscribe {
Subroutine unsubscribe: called CC=3 SCAR=11.0
Pod documented
45 9738 my ($self, $name, $cb) = @_;
46  
47 # One
48 9738 ▶ if ($cb) {
Branch: 1 branch
BranchTrueFalseTotal
if ($cb) { } 9694 44 9738
49 9694 $self->{events}{$name} = [grep { $cb ne $_ } @{$self->{events}{$name}}];
50 9694 ▶ delete $self->{events}{$name} unless @{$self->{events}{$name}};
Branch: 1 branch
BranchTrueFalseTotal
unless @{$self->{"events"}{$name};} 9687 7 9694
51 }
52  
53 # All
54 44 else { delete $self->{events}{$name} }
55  
56 9738 return $self;
57 }
58  
59 43 1;
60  
61 =encoding utf8
62  
63 =head1 NAME
64  
65 Mojo::EventEmitter - Event emitter base class
66  
67 =head1 SYNOPSIS
68  
69 package Cat;
70 use Mojo::Base 'Mojo::EventEmitter', -signatures;
71  
72 # Emit events
73 sub poke ($self) { $self->emit(roar => 3) }
74  
75 package main;
76  
77 # Subscribe to events
78 my $tiger = Cat->new;
79 $tiger->on(roar => sub ($tiger, $times) { say 'RAWR!' for 1 .. $times });
80 $tiger->poke;
81  
82 =head1 DESCRIPTION
83  
84 L<Mojo::EventEmitter> is a simple base class for event emitting objects.
85  
86 =head1 EVENTS
87  
88 L<Mojo::EventEmitter> can emit the following events.
89  
90 =head2 error
91  
92 $e->on(error => sub ($e, $err) {...});
93  
94 This is a special event for errors, it will not be emitted directly by this class, but is fatal if unhandled.
95 Subclasses may choose to emit it, but are not required to do so.
96  
97 $e->on(error => sub ($e, $err) { say "This looks bad: $err" });
98  
99 =head1 METHODS
100  
101 L<Mojo::EventEmitter> inherits all methods from L<Mojo::Base> and implements the following new ones.
102  
103 =head2 catch
104  
105 $e = $e->catch(sub {...});
106  
107 Subscribe to L</"error"> event.
108  
109 # Longer version
110 $e->on(error => sub {...});
111  
112 =head2 emit
113  
114 $e = $e->emit('foo');
115 $e = $e->emit('foo', 123);
116  
117 Emit event.
118  
119 =head2 has_subscribers
120  
121 my $bool = $e->has_subscribers('foo');
122  
123 Check if event has subscribers.
124  
125 =head2 on
126  
127 my $cb = $e->on(foo => sub {...});
128  
129 Subscribe to event.
130  
131 $e->on(foo => sub ($e, @args) {...});
132  
133 =head2 once
134  
135 my $cb = $e->once(foo => sub {...});
136  
137 Subscribe to event and unsubscribe again after it has been emitted once.
138  
139 $e->once(foo => sub ($e, @args) {...});
140  
141 =head2 subscribers
142  
143 my $subscribers = $e->subscribers('foo');
144  
145 All subscribers for event.
146  
147 # Unsubscribe last subscriber
148 $e->unsubscribe(foo => $e->subscribers('foo')->[-1]);
149  
150 # Change order of subscribers
151 @{$e->subscribers('foo')} = reverse @{$e->subscribers('foo')};
152  
153 =head2 unsubscribe
154  
155 $e = $e->unsubscribe('foo');
156 $e = $e->unsubscribe(foo => $cb);
157  
158 Unsubscribe from event.
159  
160 =head1 DEBUGGING
161  
162 You can set the C<MOJO_EVENTEMITTER_DEBUG> environment variable to get some advanced diagnostics information printed to
163 C<STDERR>.
164  
165 MOJO_EVENTEMITTER_DEBUG=1
166  
167 =head1 SEE ALSO
168  
169 L<Mojolicious>, L<Mojolicious::Guides>, L<https://mojolicious.org>.
170  
171 =cut
« Mojolicious/Plugins.pm ↑ Summary Mojolicious/Lite.pm »