do not use $self for event examples

mojolicious · Oct 17, 2011 · 93ba1b1 · 93ba1b1
1 parent 7321e4c
commit 93ba1b1
Show file tree

Hide file tree

Showing 14 changed files with 37 additions and 34 deletions.
diff --git a/Changes b/Changes
@@ -1,5 +1,8 @@
 This file documents the revision history for Perl extension Mojolicious.
 
+2.01    2011-10-18 00:00:00
+        - Improved documentation.
+
 2.0     2011-10-17 00:00:00
         - Code name "Leaf Fluttering In Wind", this is a major release.
         - Increased Perl version requirement to 5.10.1.

diff --git a/lib/Mojo/EventEmitter.pm b/lib/Mojo/EventEmitter.pm
@@ -112,7 +112,7 @@ Mojo::EventEmitter - Event emitter base class
   # Subscribe to events
   my $tiger = Cat->new;
   $tiger->on(roar => sub {
-    my ($self, $times) = @_;
+    my ($tiger, $times) = @_;
     say 'RAWR!' for 1 .. $times;
   });
   $tiger->poke;

diff --git a/lib/Mojo/IOLoop.pm b/lib/Mojo/IOLoop.pm
@@ -428,13 +428,13 @@ Mojo::IOLoop - Minimalistic reactor for non-blocking TCP clients and servers
   Mojo::IOLoop->listen(
     port => 3000,
     on_read => sub {
-      my ($self, $id, $chunk) = @_;
+      my ($loop, $id, $chunk) = @_;
 
       # Process input
       say $chunk;
 
       # Got some data, time to write
-      $self->write($id, 'HTTP/1.1 200 OK');
+      $loop->write($id, 'HTTP/1.1 200 OK');
     }
   );
 
@@ -444,13 +444,13 @@ Mojo::IOLoop - Minimalistic reactor for non-blocking TCP clients and servers
     port => 3000,
     tls => 1,
     on_connect => sub {
-      my ($self, $id) = @_;
+      my ($loop, $id) = @_;
 
       # Write request
-      $self->write($id, "GET / HTTP/1.1\r\n\r\n");
+      $loop->write($id, "GET / HTTP/1.1\r\n\r\n");
     },
     on_read => sub {
-      my ($self, $id, $chunk) = @_;
+      my ($loop, $id, $chunk) = @_;
 
       # Process input
       say $chunk;
@@ -459,8 +459,8 @@ Mojo::IOLoop - Minimalistic reactor for non-blocking TCP clients and servers
 
   # Add a timer
   Mojo::IOLoop->timer(5 => sub {
-    my $self = shift;
-    $self->drop($id);
+    my $loop = shift;
+    $loop->drop($id);
   });
 
   # Start and stop loop

diff --git a/lib/Mojo/IOLoop/Client.pm b/lib/Mojo/IOLoop/Client.pm
@@ -167,11 +167,11 @@ Mojo::IOLoop::Client - IOLoop socket client
   # Create socket connection
   my $client = Mojo::IOLoop::Client->new;
   $client->on(connect => sub {
-    my ($self, $handle) = @_;
+    my ($client, $handle) = @_;
     ...
   });
   $client->on(error => sub {
-    my ($self, $error) = @_;
+    my ($client, $error) = @_;
     ...
   });
   $client->connect(address => 'mojolicio.us', port => 80);

diff --git a/lib/Mojo/IOLoop/Resolver.pm b/lib/Mojo/IOLoop/Resolver.pm
@@ -361,13 +361,13 @@ Mojo::IOLoop::Resolver - IOLoop DNS stub resolver
   # Lookup address
   my $resolver = Mojo::IOLoop::Resolver->new;
   $resolver->lookup('mojolicio.us' => sub {
-    my ($self, $address) = @_;
+    my ($resolver, $address) = @_;
     ...
   });
 
   # Resolve "MX" records
   $resolver->resolve('mojolicio.us', 'MX', sub {
-    my ($self, $records) = @_;
+    my ($resolver, $records) = @_;
     ...
   });
 

diff --git a/lib/Mojo/IOLoop/Server.pm b/lib/Mojo/IOLoop/Server.pm
@@ -268,7 +268,7 @@ Mojo::IOLoop::Server - IOLoop socket server
   # Create listen socket
   my $server = Mojo::IOLoop::Server->new;
   $server->on(accept => sub {
-    my ($self, $handle) = @_;
+    my ($server, $handle) = @_;
     ...
   });
   $server->listen(port => 3000);

diff --git a/lib/Mojo/IOLoop/Stream.pm b/lib/Mojo/IOLoop/Stream.pm
@@ -149,15 +149,15 @@ Mojo::IOLoop::Stream - IOLoop stream
   # Create stream
   my $stream = Mojo::IOLoop::Stream->new($handle);
   $stream->on(read => sub {
-    my ($self, $chunk) = @_;
+    my ($stream, $chunk) = @_;
     ...
   });
   $stream->on(close => sub {
-    my $self = shift;
+    my $stream = shift;
     ...
   });
   $stream->on(error => sub {
-    my ($self, $error) = @_;
+    my ($stream, $error) = @_;
     ...
   });
 

diff --git a/lib/Mojo/Server/CGI.pm b/lib/Mojo/Server/CGI.pm
@@ -111,7 +111,7 @@ Mojo::Server::CGI - CGI server
   my $cgi = Mojo::Server::CGI->new;
   $cgi->unsubscribe_all('request')
   $cgi->on(request => sub {
-    my ($self, $tx) = @_;
+    my ($cgi, $tx) = @_;
 
     # Request
     my $method = $tx->req->method;

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

diff --git a/lib/Mojo/Server/PSGI.pm b/lib/Mojo/Server/PSGI.pm
@@ -91,7 +91,7 @@ Mojo::Server::PSGI - PSGI server
   my $psgi = Mojo::Server::PSGI->new;
   $psgi->unsubscribe_all('request');
   $psgi->on(request => sub {
-    my ($self, $tx) = @_;
+    my ($psgi, $tx) = @_;
 
     # Request
     my $method = $tx->req->method;

diff --git a/lib/Mojo/UserAgent.pm b/lib/Mojo/UserAgent.pm
@@ -604,7 +604,7 @@ Mojo::UserAgent - Non-blocking I/O HTTP 1.1 and WebSocket user agent
   for my $url ('mojolicio.us', 'cpan.org') {
     $t->begin;
     $ua->get($url => sub {
-      my ($self, $tx) = @_;
+      my ($ua, $tx) = @_;
       $t->end($tx->res->dom->at('title')->text);
     });
   }
@@ -615,7 +615,7 @@ Mojo::UserAgent - Non-blocking I/O HTTP 1.1 and WebSocket user agent
 
   # WebSocket request
   $ua->websocket('ws://websockets.org:8787' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     $tx->on(finish  => sub { Mojo::IOLoop->stop });
     $tx->on(message => sub {
       my ($tx, $message) = @_;
@@ -812,7 +812,7 @@ L<Mojo::UserAgent::Transactor/"tx"> (except for the method).
 You can also append a callback to perform requests non-blocking.
 
   $ua->delete('http://kraih.com' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -835,7 +835,7 @@ L<Mojo::UserAgent::Transactor/"tx"> (except for the method).
 You can also append a callback to perform requests non-blocking.
 
   $ua->get('http://kraih.com' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -851,7 +851,7 @@ L<Mojo::UserAgent::Transactor/"tx"> (except for the method).
 You can also append a callback to perform requests non-blocking.
 
   $ua->head('http://kraih.com' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -874,7 +874,7 @@ L<Mojo::UserAgent::Transactor/"tx"> (except for the method).
 You can also append a callback to perform requests non-blocking.
 
   $ua->post('http://kraih.com' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -890,7 +890,7 @@ L<Mojo::UserAgent::Transactor/"form">.
 You can also append a callback to perform requests non-blocking.
 
   $ua->post_form('http://kraih.com' => {q => 'test'} => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -906,7 +906,7 @@ L<Mojo::UserAgent::Transactor/"tx"> (except for the method).
 You can also append a callback to perform requests non-blocking.
 
   $ua->put('http://kraih.com' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -920,7 +920,7 @@ Process blocking transaction.
 You can also append a callback to perform transactions non-blocking.
 
   $ua->start($tx => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     say $tx->res->body;
     Mojo::IOLoop->stop;
   });
@@ -945,7 +945,7 @@ the exact same arguments as L<Mojo::UserAgent::Transactor/"websocket">.
 Note that this method is EXPERIMENTAL and might change without warning!
 
   $ua->websocket('ws://localhost:3000/echo' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     $tx->on(finish  => sub { Mojo::IOLoop->stop });
     $tx->on(message => sub {
       my ($tx, $message) = @_;

diff --git a/lib/Mojolicious.pm b/lib/Mojolicious.pm
@@ -35,7 +35,7 @@ has static   => sub { Mojolicious::Static->new };
 has types    => sub { Mojolicious::Types->new };
 
 our $CODENAME = 'Leaf Fluttering In Wind';
-our $VERSION  = '2.0';
+our $VERSION  = '2.01';
 
 # "These old doomsday devices are dangerously unstable.
 #  I'll rest easier not knowing where they are."

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -1000,7 +1000,7 @@ A L<Mojo::UserAgent> prepared for the current environment.
 
   # Non-blocking
   $c->ua->get('http://mojolicio.us' => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     $c->render_data($tx->res->body);
   });
 
@@ -1012,7 +1012,7 @@ A L<Mojo::UserAgent> prepared for the current environment.
   for my $url ('http://mojolicio.us', 'https://metacpan.org') {
     $t->begin;
     $c->ua->get($url => sub {
-      my ($self, $tx) = @_;
+      my ($ua, $tx) = @_;
       $t->end($tx->res->dom->html->head->title->text);
     });
   }

diff --git a/lib/Mojolicious/Guides/Cookbook.pod b/lib/Mojolicious/Guides/Cookbook.pod
@@ -297,7 +297,7 @@ been initialized and before a connection gets associated with them.
 
   # Add a witty header to every request
   $ua->on(start => sub {
-    my ($self, $tx) = @_;
+    my ($ua, $tx) = @_;
     $tx->req->headers->header('X-Bender' => 'Bite my shiny metal ass!');
     say 'Request: ', $tx->req->url->clone->to_abs;
   });
@@ -403,7 +403,7 @@ time.
 
     # Fetch non-blocking just by adding a callback
     $ua->get($url => sub {
-      my ($self, $tx) = @_;
+      my ($ua, $tx) = @_;
 
       # Extract URLs
       say "[$id] $url";