removed experimental status from Mojo::EventEmitter and merged unsubs…

…cribe_all method into unsubscribe
mojolicious · Oct 29, 2011 · 4b790dc · 4b790dc
1 parent d323417
commit 4b790dc
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 26 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,9 @@
 This file documents the revision history for Perl extension Mojolicious.
 
 2.16    2011-10-30 00:00:00
+        - Removed experimental status from Mojo::EventEmitter.
+        - Merged unsubscribe and unsubscribe_all methods in
+          Mojo::EventEmitter.
         - Improved documentation.
 
 2.15    2011-10-29 00:00:00

diff --git a/lib/Mojo/EventEmitter.pm b/lib/Mojo/EventEmitter.pm
@@ -46,6 +46,13 @@ sub subscribers { shift->{events}->{shift()} || [] }
 sub unsubscribe {
   my ($self, $name, $cb) = @_;
 
+  # All
+  unless ($cb) {
+    delete $self->{events}->{$name};
+    return $self;
+  }
+
+  # One
   my @callbacks;
   for my $subscriber (@{$self->subscribers($name)}) {
     next if $cb eq $subscriber;
@@ -56,12 +63,6 @@ sub unsubscribe {
   return $self;
 }
 
-sub unsubscribe_all {
-  my ($self, $name) = @_;
-  $self->unsubscribe($name => $_) for @{$self->subscribers($name)};
-  return $self;
-}
-
 sub _emit {
   my $self = shift;
   my $safe = shift;
@@ -117,7 +118,6 @@ Mojo::EventEmitter - Event emitter base class
 =head1 DESCRIPTION
 
 L<Mojo::EventEmitter> is a simple base class for event emitting objects.
-Note that this module is EXPERIMENTAL and might change without warning!
 
 =head1 METHODS
 
@@ -137,6 +137,7 @@ Emit event.
   $e = $e->emit_safe('foo', 123);
 
 Emit event safely and emit C<error> event on failure.
+Note that this method is EXPERIMENTAL and might change without warning!
 
 =head2 C<has_subscribers>
 
@@ -164,16 +165,11 @@ All subscribers for event.
 
 =head2 C<unsubscribe>
 
-  $e->unsubscribe(foo => $cb);
+  $e = $e->unsubscribe('foo');
+  $e = $e->unsubscribe(foo => $cb);
 
 Unsubscribe from event.
 
-=head2 C<unsubscribe_all>
-
-  $e->unsubscribe_all('foo');
-
-Remove all subscribers from event.
-
 =head1 DEBUGGING
 
 You can set the C<MOJO_EVENTEMITTER_DEBUG> environment variable to get some

diff --git a/lib/Mojo/Log.pm b/lib/Mojo/Log.pm
@@ -125,7 +125,7 @@ L<Mojo::Log> can emit the following events.
 Emitted when a new message gets logged.
 Note that this event is EXPERIMENTAL and might change without warning!
 
-  $log->unsubscribe_all('message');
+  $log->unsubscribe('message');
   $log->on(message => sub {
     my ($log, $level, @messages) = @_;
     say "$level: ", @messages;

diff --git a/lib/Mojo/Server.pm b/lib/Mojo/Server.pm
@@ -105,7 +105,7 @@ L<Mojo::Server> can emit the following events.
 
 Emitted when a request is ready and needs to be handled.
 
-  $server->unsubscribe_all('request');
+  $server->unsubscribe('request');
   $server->on(request => sub {
     my ($server, $tx) = @_;
     $tx->res->code(200);

diff --git a/lib/Mojo/Server/CGI.pm b/lib/Mojo/Server/CGI.pm
@@ -109,7 +109,7 @@ Mojo::Server::CGI - CGI server
   use Mojo::Server::CGI;
 
   my $cgi = Mojo::Server::CGI->new;
-  $cgi->unsubscribe_all('request')
+  $cgi->unsubscribe('request')
   $cgi->on(request => sub {
     my ($cgi, $tx) = @_;
 

diff --git a/lib/Mojo/Server/Daemon.pm b/lib/Mojo/Server/Daemon.pm
@@ -345,7 +345,7 @@ Mojo::Server::Daemon - Non-blocking I/O HTTP 1.1 and WebSocket server
   use Mojo::Server::Daemon;
 
   my $daemon = Mojo::Server::Daemon->new(listen => ['http://*:8080']);
-  $daemon->unsubscribe_all('request');
+  $daemon->unsubscribe('request');
   $daemon->on(request => sub {
     my ($daemon, $tx) = @_;
 

diff --git a/lib/Mojo/Server/PSGI.pm b/lib/Mojo/Server/PSGI.pm
@@ -89,7 +89,7 @@ Mojo::Server::PSGI - PSGI server
   use Mojo::Server::PSGI;
 
   my $psgi = Mojo::Server::PSGI->new;
-  $psgi->unsubscribe_all('request');
+  $psgi->unsubscribe('request');
   $psgi->on(request => sub {
     my ($psgi, $tx) = @_;
 

diff --git a/t/mojo/eventemitter.t b/t/mojo/eventemitter.t
@@ -110,23 +110,21 @@ is $once, 1, 'event was not emitted again';
 $e->emit('one_time');
 is $once, 1, 'event was not emitted again';
 
-# Unsubscribe
+# Remove subscribers
 $e = Mojo::EventEmitter->new;
 my $counter = 0;
 $cb = $e->on(foo => sub { $counter++ });
 $e->on(foo => sub { $counter++ });
 $e->on(foo => sub { $counter++ });
 $e->unsubscribe(foo => $e->once(foo => sub { $counter++ }));
 is scalar @{$e->subscribers('foo')}, 3, 'three subscribers';
-$e->emit('foo');
+$e->emit('foo')->unsubscribe(foo => $cb);
 is $counter, 3, 'event was emitted three times';
-$e->unsubscribe(foo => $cb);
 is scalar @{$e->subscribers('foo')}, 2, 'two subscribers';
 $e->emit('foo');
 is $counter, 5, 'event was emitted two times';
 ok $e->has_subscribers('foo'), 'has subscribers';
-$e->unsubscribe_all('foo');
-ok !$e->has_subscribers('foo'), 'no subscribers';
+ok !$e->unsubscribe('foo')->has_subscribers('foo'), 'no subscribers';
 is scalar @{$e->subscribers('foo')}, 0, 'no subscribers';
 $e->emit('foo');
 is $counter, 5, 'event was not emitted again';

diff --git a/t/mojo/user_agent.t b/t/mojo/user_agent.t
@@ -148,7 +148,7 @@ $ua->on(
   }
 );
 $tx = $ua->start($tx);
-$ua->unsubscribe_all('start');
+$ua->unsubscribe('start');
 ok $tx->success, 'successful';
 is $finished, 1, 'finish event has been emitted';
 is $tx->res->code, 200,     'right status';

diff --git a/t/mojo/websocket_proxy_tls.t b/t/mojo/websocket_proxy_tls.t
@@ -159,7 +159,7 @@ Mojo::IOLoop->start;
 is $result, "Hello World! / https://localhost:$port/", 'right content';
 is $works,  'it does!',                                'right header';
 is $start,  2,                                         'redirected once';
-$ua->unsubscribe_all('start');
+$ua->unsubscribe('start');
 
 # WebSocket /test (normal websocket)
 $result = undef;