deprecated all is_done methods in favor of is_finished

mojolicious · Oct 20, 2011 · aff2ff2 · aff2ff2
1 parent 0376afa
commit aff2ff2
Show file tree

Hide file tree

Showing 37 changed files with 540 additions and 501 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,8 @@
 This file documents the revision history for Perl extension Mojolicious.
 
 2.03    2011-10-20 00:00:00
+        - Deprecated all is_done methods in favor of is_finished.
+        - Renamed done event in Mojo::IOLoop::Trigger to finish.
         - Added EXPERIMETNAL support for new HTTP status codes from
           draft-nottingham-http-new-status.
         - Improved documentation.

diff --git a/lib/Mojo/Content.pm b/lib/Mojo/Content.pm
@@ -126,9 +126,12 @@ sub is_chunked {
   return $encoding =~ /chunked/i ? 1 : 0;
 }
 
+# DEPRECATED in Leaf Fluttering In Wind!
 sub is_done {
-  return 1 if (shift->{state} || '') eq 'done';
-  return;
+  warn <<EOF;
+Mojo::Content->is_done is DEPRECATED in favor of Mojo::Content->is_finished!
+EOF
+  shift->is_finished;
 }
 
 sub is_dynamic {
@@ -137,6 +140,11 @@ sub is_dynamic {
   return;
 }
 
+sub is_finished {
+  return 1 if (shift->{state} || '') eq 'finished';
+  return;
+}
+
 sub is_multipart {undef}
 
 sub is_parsing_body {
@@ -158,7 +166,7 @@ sub leftovers {
 # DEPRECATED in Smiling Face With Sunglasses!
 sub on_read {
   warn <<EOF;
-Mojo::Content->on_read is DEPRECATED in favor of using Mojo::Content->on!!!
+Mojo::Content->on_read is DEPRECATED in favor of using Mojo::Content->on!
 EOF
   shift->on(read => shift);
 }
@@ -186,7 +194,7 @@ sub parse {
   $self->{real_size} = 0 unless exists $self->{real_size};
   if ($self->is_chunked && ($self->{state} || '') ne 'headers') {
     $self->_parse_chunked;
-    $self->{state} = 'done' if ($self->{chunked} || '') eq 'done';
+    $self->{state} = 'finished' if ($self->{chunked} || '') eq 'finished';
   }
 
   # Not chunked, pass through to second buffer
@@ -220,8 +228,8 @@ sub parse {
         $self->emit(read => $chunk);
       }
 
-      # Done
-      $self->{state} = 'done' if $len <= $self->progress;
+      # Finished
+      $self->{state} = 'finished' if $len <= $self->progress;
     }
   }
 
@@ -237,7 +245,7 @@ sub parse_body {
 sub parse_body_once {
   my $self = shift;
   $self->parse_body(@_);
-  $self->{state} = 'done';
+  $self->{state} = 'finished';
   return $self;
 }
 
@@ -384,8 +392,8 @@ sub _parse_chunked_trailing_headers {
   $headers->parse($self->{pre_buffer});
   $self->{pre_buffer} = '';
 
-  # Done
-  if ($headers->is_done) {
+  # Finished
+  if ($headers->is_finished) {
 
     # Remove Transfer-Encoding
     my $headers  = $self->headers;
@@ -396,7 +404,7 @@ sub _parse_chunked_trailing_headers {
       : $headers->remove('Transfer-Encoding');
     $headers->content_length($self->{real_size});
 
-    $self->{chunked} = 'done';
+    $self->{chunked} = 'finished';
   }
 }
 
@@ -408,8 +416,8 @@ sub _parse_headers {
   $headers->parse($self->{pre_buffer});
   $self->{pre_buffer} = '';
 
-  # Done
-  if ($headers->is_done) {
+  # Finished
+  if ($headers->is_finished) {
     my $leftovers = $headers->leftovers;
     $self->{header_size} = $self->{raw_size} - length $leftovers;
     $self->{pre_buffer}  = $leftovers;
@@ -570,19 +578,19 @@ Size of headers in bytes.
 
 Check if content is chunked.
 
-=head2 C<is_done>
-
-  my $success = $content->is_done;
-
-Check if parser is done.
-
 =head2 C<is_dynamic>
 
   my $success = $content->is_dynamic;
 
 Check if content will be dynamic.
 Note that this method is EXPERIMENTAL and might change without warning!
 
+=head2 C<is_finished>
+
+  my $success = $content->is_finished;
+
+Check if parser is finished.
+
 =head2 C<is_multipart>
 
   my $false = $content->is_multipart;

diff --git a/lib/Mojo/Content/MultiPart.pm b/lib/Mojo/Content/MultiPart.pm
@@ -146,7 +146,7 @@ sub _parse_multipart {
   # Parse
   $self->{multi_state} ||= 'multipart_preamble';
   my $boundary = $self->boundary;
-  while (!$self->is_done) {
+  while (!$self->is_finished) {
 
     # Preamble
     if (($self->{multi_state} || '') eq 'multipart_preamble') {
@@ -206,8 +206,8 @@ sub _parse_multipart_boundary {
   if ((index $self->{buffer}, $end) == 0) {
     substr $self->{buffer}, 0, length $end, '';
 
-    # Done
-    $self->{state} = $self->{multi_state} = 'done';
+    # Finished
+    $self->{state} = $self->{multi_state} = 'finished';
   }
 
   return;

diff --git a/lib/Mojo/Content/Single.pm b/lib/Mojo/Content/Single.pm
@@ -70,8 +70,8 @@ sub parse {
     my $need = $len - $asset->size;
     $asset->add_chunk(substr $self->{buffer}, 0, $need, '') if $need > 0;
 
-    # Done
-    $self->{state} = 'done' if $len <= $self->progress;
+    # Finished
+    $self->{state} = 'finished' if $len <= $self->progress;
   }
 
   return $self;

diff --git a/lib/Mojo/DOM.pm b/lib/Mojo/DOM.pm
@@ -53,17 +53,14 @@ sub new {
 
 # DEPRECATED in Smiling Face With Sunglasses!
 sub add_after {
-  warn <<EOF;
-Mojo::DOM->add_after is DEPRECATED in favor of Mojo::DOM->append!!!
-EOF
+  warn "Mojo::DOM->add_after is DEPRECATED in favor of Mojo::DOM->append!\n";
   shift->append(@_);
 }
 
 # DEPRECATED in Smiling Face With Sunglasses!
 sub add_before {
-  warn <<EOF;
-Mojo::DOM->add_before is DEPRECATED in favor of Mojo::DOM->prepend!!!
-EOF
+  warn
+    "Mojo::DOM->add_before is DEPRECATED in favor of Mojo::DOM->prepend!\n";
   shift->prepend(@_);
 }
 
@@ -171,7 +168,7 @@ sub find {
 # DEPRECATED in Smiling Face With Sunglasses!
 sub inner_xml {
   warn <<EOF;
-Mojo::DOM->inner_xml is DEPRECATED in favor of Mojo::DOM->content_xml!!!
+Mojo::DOM->inner_xml is DEPRECATED in favor of Mojo::DOM->content_xml!
 EOF
   shift->content_xml(@_);
 }
@@ -284,7 +281,7 @@ sub replace_content {
 sub replace_inner {
   warn <<EOF;
 Mojo::DOM->replace_inner is DEPRECATED in favor of
-Mojo::DOM->replace_content!!!
+Mojo::DOM->replace_content!
 EOF
   shift->content_xml(@_);
 }

diff --git a/lib/Mojo/Headers.pm b/lib/Mojo/Headers.pm
@@ -166,7 +166,15 @@ sub header {
 sub host { scalar shift->header(Host => @_) }
 sub if_modified_since { scalar shift->header('If-Modified-Since' => @_) }
 
-sub is_done { (shift->{state} || '') eq 'done' }
+# DEPRECATED in Leaf Fluttering In Wind!
+sub is_done {
+  warn <<EOF;
+Mojo::Headers->is_done is DEPRECATED in favor of Mojo::Headers->is_finished!
+EOF
+  shift->is_finished;
+}
+
+sub is_finished { (shift->{state} || '') eq 'finished' }
 
 sub is_limit_exceeded { shift->{limit} }
 
@@ -195,7 +203,7 @@ sub parse {
 
     # Check line size limit
     if (length $line > $max) {
-      $self->{state} = 'done';
+      $self->{state} = 'finished';
       $self->{limit} = 1;
       return $self;
     }
@@ -209,14 +217,14 @@ sub parse {
     # Empty line
     else {
       $self->add(splice @$headers, 0, 2) while @$headers;
-      $self->{state} = 'done';
+      $self->{state} = 'finished';
       return $self;
     }
   }
 
   # Check line size limit
   if (length $self->{buffer} > $max) {
-    $self->{state} = 'done';
+    $self->{state} = 'finished';
     $self->{limit} = 1;
   }
 
@@ -504,11 +512,11 @@ Shortcut for the C<Host> header.
 
 Shortcut for the C<If-Modified-Since> header.
 
-=head2 C<is_done>
+=head2 C<is_finished>
 
-  my $success = $headers->is_done;
+  my $success = $headers->is_finished;
 
-Check if header parser is done.
+Check if header parser is finished.
 
 =head2 C<is_limit_exceeded>
 

diff --git a/lib/Mojo/IOLoop.pm b/lib/Mojo/IOLoop.pm
@@ -305,7 +305,7 @@ sub trigger {
   my $t = Mojo::IOLoop::Trigger->new;
   $t->ioloop($self);
   weaken $t->{ioloop};
-  $t->once(done => $cb) if $cb;
+  $t->once(finish => $cb) if $cb;
 
   return $t;
 }
@@ -933,7 +933,7 @@ Note that this method is EXPERIMENTAL and might change without warning!
     });
   }
 
-  # Stop automatically when done
+  # Stop automatically when finished
   $t->start;
 
 =head2 C<write>

diff --git a/lib/Mojo/IOLoop/Trigger.pm b/lib/Mojo/IOLoop/Trigger.pm
@@ -15,12 +15,12 @@ sub begin {
 sub end {
   my $self = shift;
   push @{$self->{args} ||= []}, @_;
-  $self->emit_safe('done', @{$self->{args}}) if --$self->{counter} <= 0;
+  $self->emit_safe('finish', @{$self->{args}}) if --$self->{counter} <= 0;
 }
 
 sub start {
   my $self = shift;
-  $self->once(done => sub { shift->ioloop->stop });
+  $self->once(finish => sub { shift->ioloop->stop });
   $self->ioloop->start;
   return @{$self->{args}};
 }
@@ -38,7 +38,7 @@ Mojo::IOLoop::Trigger - IOLoop trigger
 
   # Synchronize multiple events
   my $t = Mojo::IOLoop::Trigger->new;
-  $t->on(done => sub { say 'BOOM!' });
+  $t->on(finish => sub { say 'BOOM!' });
   for my $i (1 .. 10) {
     $t->begin;
     Mojo::IOLoop->timer($i => sub {
@@ -47,7 +47,7 @@ Mojo::IOLoop::Trigger - IOLoop trigger
     });
   }
 
-  # Stop automatically when done
+  # Stop automatically when finished
   $t->start;
 
 =head1 DESCRIPTION
@@ -59,9 +59,9 @@ Note that this module is EXPERIMENTAL and might change without warning!
 
 L<Mojo::IOLoop::Trigger> can emit the following events.
 
-=head2 C<done>
+=head2 C<finish>
 
-  $trigger->on(done => sub {
+  $trigger->on(finish => sub {
     my $trigger = shift;
   });
 
@@ -105,7 +105,7 @@ Decrement active event counter.
 
   my @args = $t->start;
 
-Start C<ioloop> and register C<done> event that stops it again once the
+Start C<ioloop> and register C<finish> event that stops it again once the
 active event counter reaches zero.
 
 =head1 SEE ALSO