improve renderer not to require a return value from handlers

mojolicious · Nov 21, 2015 · c7a22d7 · KES777 · Feb 28, 2016 · c7a22d7
1 parent d040ec4
commit c7a22d7
Show file tree

Hide file tree

Showing 7 changed files with 21 additions and 30 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,7 @@
 
-6.33  2015-11-20
+6.33  2015-11-22
   - Updated IO::Socket::IP requirement to 0.37 for certain bug fixes.
+  - Improved renderer not to require a return value from handlers.
   - Improved helper method in Mojolicious to replace already existing helpers
     silently.
 

diff --git a/lib/Mojolicious/Guides/Rendering.pod b/lib/Mojolicious/Guides/Rendering.pod
@@ -1399,14 +1399,11 @@ called.
       # This part is up to you and your template system :)
       ...
 
-      # Just die if an error occurs
-      die 'Something went wrong with the template';
-
-      # Or pass the rendered result back to the renderer
+      # Pass the rendered result back to the renderer
       $$output = 'Hello World!';
 
-      # And return true if something has been rendered or false otherwise
-      return 1;
+      # Or just die if an error occurs
+      die 'Something went wrong with the template';
     });
   }
 
@@ -1445,8 +1442,6 @@ generating bytes instead.
 
     # Encode data from stash value
     $$output = nfreeze delete $c->stash->{storable};
-
-    return 1;
   });
 
   # Set "handler" value automatically if "storable" value is set already

diff --git a/lib/Mojolicious/Plugin/EPLRenderer.pm b/lib/Mojolicious/Plugin/EPLRenderer.pm
@@ -21,7 +21,7 @@ sub _epl {
   else {
     my $inline = $options->{inline};
     my $name = defined $inline ? md5_sum encode('UTF-8', $inline) : undef;
-    return undef unless defined($name //= $renderer->template_name($options));
+    return unless defined($name //= $renderer->template_name($options));
 
     # Inline
     if (defined $inline) {
@@ -47,12 +47,12 @@ sub _epl {
       }
 
       # No template
-      else { $log->debug(qq{Template "$name" not found}) and return undef }
+      else { $log->debug(qq{Template "$name" not found}) }
     }
   }
 
-  # Exception or success
-  return ref $$output ? die $$output : 1;
+  # Exception
+  die $$output if ref $$output;
 }
 
 1;

diff --git a/lib/Mojolicious/Plugin/EPRenderer.pm b/lib/Mojolicious/Plugin/EPRenderer.pm
@@ -20,7 +20,7 @@ sub register {
       my ($renderer, $c, $output, $options) = @_;
 
       my $name = $options->{inline} // $renderer->template_name($options);
-      return undef unless defined $name;
+      return unless defined $name;
       my @keys = sort grep {/^\w+$/} keys %{$c->stash};
       my $key = md5_sum encode 'UTF-8', join(',', $name, @keys);
 
@@ -47,7 +47,7 @@ sub register {
       local *{"${ns}::_C"} = sub {$c};
 
       # Render with "epl" handler
-      return $renderer->handlers->{epl}($renderer, $c, $output, $options);
+      $renderer->handlers->{epl}($renderer, $c, $output, $options);
     }
   );
 }

diff --git a/lib/Mojolicious/Plugin/PODRenderer.pm b/lib/Mojolicious/Plugin/PODRenderer.pm
@@ -16,12 +16,8 @@ sub register {
   $app->renderer->add_handler(
     $conf->{name} || 'pod' => sub {
       my ($renderer, $c, $output, $options) = @_;
-
-      # Preprocess and render
-      my $handler = $renderer->handlers->{$preprocess};
-      return undef unless $handler->($renderer, $c, $output, $options);
-      $$output = _pod_to_html($$output);
-      return 1;
+      $renderer->handlers->{$preprocess}($renderer, $c, $output, $options);
+      $$output = _pod_to_html($$output) if defined $$output;
     }
   );
 

diff --git a/lib/Mojolicious/Renderer.pm b/lib/Mojolicious/Renderer.pm
@@ -138,7 +138,8 @@ sub render {
   while ((my $next = _next($stash)) && !defined $inline) {
     @$options{qw(handler template)} = ($stash->{handler}, $next);
     $options->{format} = $stash->{format} || $self->default_format;
-    $self->_render_template($c, \$output, $options);
+    my $layout;
+    $output = $layout if $self->_render_template($c, \$layout, $options);
     $content->{content} = $output
       if $content->{content} !~ /\S/ && $output =~ /\S/;
   }
@@ -234,16 +235,13 @@ sub _next {
 sub _render_template {
   my ($self, $c, $output, $options) = @_;
 
-  # Find handler and render
   my $handler = $options->{handler} ||= $self->template_handler($options);
   return undef unless $handler;
-  if (my $renderer = $self->handlers->{$handler}) {
-    return 1 if $renderer->($self, $c, $output, $options);
-  }
+  $c->app->log->error(qq{No handler for "$handler" available}) and return undef
+    unless my $renderer = $self->handlers->{$handler};
 
-  # No handler
-  else { $c->app->log->error(qq{No handler for "$handler" available}) }
-  return undef;
+  $renderer->($self, $c, $output, $options);
+  return 1 if defined $$output;
 }
 
 1;

diff --git a/t/mojolicious/renderer.t b/t/mojolicious/renderer.t
@@ -15,7 +15,8 @@ my $renderer = $c->app->renderer->default_format('test');
 $renderer->add_handler(
   debug => sub {
     my ($renderer, $c, $output) = @_;
-    $$output .= 'Hello Mojo!';
+    my $content = $c->content // '';
+    $$output = "Hello Mojo!$content";
   }
 );
 $c->stash->{template} = 'something';