added experimental current_route helper (closes #300)

mojolicious · Mar 12, 2012 · 10118ae · 10118ae
1 parent dbdbad9
commit 10118ae
Show file tree

Hide file tree

Showing 7 changed files with 79 additions and 15 deletions.
diff --git a/Changes b/Changes
@@ -1,6 +1,8 @@
 This file documents the revision history for Perl extension Mojolicious.
 
 2.60    2012-03-12 00:00:00
+        - Added EXPERIMENTAL current_route helper to
+          Mojolicious::Plugin::DefaultHelpers.
         - Made text_area helper a little smarter. (sshaw, sri)
         - Improved inactivity timeout logging for WebSockets.
         - Fixed escaping bug in select_field and text_area helpers.
@@ -2309,8 +2311,7 @@ This file documents the revision history for Perl extension Mojolicious.
 
 0.9001  2009-01-28 00:00:00
         - Added proper home detection to Mojo itself. (charsbar)
-        - Fixed a bug where errors got cached in the routes dispatcher.
-          (charsbar)
+        - Fixed a bug where errors got cached in the router. (charsbar)
         - Updated error handling in MojoX::Dispatcher::Static.
         - Fixed Mojo::Message::Request::cookies() to always return a
           arrayref.

diff --git a/lib/Mojolicious.pm b/lib/Mojolicious.pm
@@ -310,8 +310,8 @@ contain more information.
   my $routes = $app->routes;
   $app       = $app->routes(Mojolicious::Routes->new);
 
-The routes dispatcher, defaults to a L<Mojolicious::Routes> object. You use
-this in your startup method to define the url endpoints for your application.
+The router, defaults to a L<Mojolicious::Routes> object. You use this in your
+startup method to define the url endpoints for your application.
 
   sub startup {
     my $self = shift;
@@ -460,7 +460,7 @@ application object)
 
 =item B<before_dispatch>
 
-Emitted right before the static and routes dispatchers start their work.
+Emitted right before the static dispatcher and router start their work.
 
   $app->hook(before_dispatch => sub {
     my $c = shift;
@@ -473,7 +473,7 @@ Very useful for rewriting incoming requests and other preprocessing tasks.
 =item B<after_static_dispatch>
 
 Emitted in reverse order after the static dispatcher determined if a static
-file should be served and before the routes dispatcher starts its work.
+file should be served and before the router starts its work.
 
   $app->hook(after_static_dispatch => sub {
     my $c = shift;

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -661,7 +661,7 @@ controller, defaults to a L<Mojolicious> object.
   my $m = $c->match;
   $c    = $c->match(Mojolicious::Routes::Match->new);
 
-Routes dispatcher results for the current request, defaults to a
+Router results for the current request, defaults to a
 L<Mojolicious::Routes::Match> object.
 
   my $name = $c->match->endpoint->name;

diff --git a/lib/Mojolicious/Guides/Rendering.pod b/lib/Mojolicious/Guides/Rendering.pod
@@ -146,8 +146,8 @@ Most commonly used features every L<Mojolicious> developer should know about.
 The renderer can be manually started by calling the method
 L<Mojolicious::Controller/"render">, but that's usually not necessary,
 because it will get automatically called if nothing has been rendered after
-the routes dispatcher finished its work. This also means you can have routes
-pointing only to templates without actual actions.
+the router finished its work. This also means you can have routes pointing
+only to templates without actual actions.
 
   $self->render;
 

diff --git a/lib/Mojolicious/Guides/Routing.pod b/lib/Mojolicious/Guides/Routing.pod
@@ -425,8 +425,9 @@ Or you can just disable format detection.
 
 =head2 Named routes
 
-Naming your routes will allow backreferencing in many kinds of helpers
-throughout the whole framework.
+Naming your routes will allow backreferencing in many methods and helpers
+throughout the whole framework, most of them internally rely on
+L<Mojolicious::Controller/"url_for"> for this.
 
   # /foo/abc -> {controller => 'foo', action => 'bar', name => 'abc'}
   $r->route('/foo/:name')->name('test')
@@ -454,6 +455,12 @@ name at all.
   $self->url_for('current');
   $self->url_for;
 
+To check or get the actual name of the currently active route you can also
+use the helper L<Mojolicious::Plugin::DefaultHelpers/"current_route">.
+
+  # Get name for current route
+  my $name = $self->current_route;
+
 =head2 HTTP methods
 
 The method L<Mojolicious::Routes/"via"> allows only specific HTTP methods to

diff --git a/lib/Mojolicious/Plugin/DefaultHelpers.pm b/lib/Mojolicious/Plugin/DefaultHelpers.pm
@@ -40,6 +40,16 @@ sub register {
     }
   );
 
+  # Add "current_route" helper
+  $app->helper(
+    current_route => sub {
+      my $self = shift;
+      return '' unless my $endpoint = $self->match->endpoint;
+      return $endpoint->name unless @_;
+      return $endpoint->name eq shift;
+    }
+  );
+
   # Add "dumper" helper
   $app->helper(
     dumper => sub {
@@ -171,6 +181,16 @@ Append content to named buffer and retrieve it.
   % end
   %= content_for 'message'
 
+=head2 C<current_route>
+
+  % if (current_route 'hello') {
+    Hello World!
+  % }
+  %= current_route
+
+Check or return name of current route. Note that this helper is EXPERIMENTAL
+and might change without warning!
+
 =head2 C<dumper>
 
   %= dumper $foo

diff --git a/t/mojolicious/rebased_lite_app.t b/t/mojolicious/rebased_lite_app.t
@@ -6,7 +6,7 @@ BEGIN {
   $ENV{MOJO_IOWATCHER} = 'Mojo::IOWatcher';
 }
 
-use Test::More tests => 9;
+use Test::More tests => 19;
 
 # "For example, if you killed your grandfather, you'd cease to exist!
 #  But existing is basically all I do!"
@@ -21,6 +21,14 @@ app->hook(
   }
 );
 
+# Current route hook
+app->hook(
+  after_dispatch => sub {
+    my $self = shift;
+    $self->res->headers->header('X-Route' => $self->current_route);
+  }
+);
+
 # GET /
 get '/' => 'root';
 
@@ -33,32 +41,55 @@ get '/bar' => sub {
   $self->redirect_to($self->url_for('foo'));
 };
 
+# GET /baz
+get '/baz' => sub { shift->render('root') };
+
 my $t = Test::Mojo->new;
 
 # GET /
-$t->get_ok('/')->status_is(200)->content_is(<<EOF);
+$t->get_ok('/')->status_is(200)->header_is('X-Route' => 'root')
+  ->content_is(<<EOF);
 <base href="http://kraih.com/rebased/" />
 <script src="/rebased/js/jquery.js" type="text/javascript"></script>
 <img src="/rebased/images/test.png" />
 http://kraih.com/rebased/foo
 /rebased/foo
 http://kraih.com/
+root
+  Welcome to the root!
 EOF
 
 # GET /foo
-$t->get_ok('/foo')->status_is(200)->content_is(<<EOF);
+$t->get_ok('/foo')->status_is(200)->header_is('X-Route' => 'foo')
+  ->content_is(<<EOF);
 <base href="http://kraih.com/rebased/" />
 <link href="/rebased/b.css" media="test" rel="stylesheet" type="text/css" />
 <img alt="Test" src="/rebased/images/test.png" />
 http://kraih.com/rebased
 /rebased
 http://kraih.com/
+foo
 EOF
 
 # GET /bar
-$t->get_ok('/bar')->status_is(302)
+$t->get_ok('/bar')->status_is(302)->header_is('X-Route' => 'bar')
   ->header_is(Location => 'http://kraih.com/rebased/foo');
 
+# GET /baz
+$t->get_ok('/baz')->status_is(200)->header_is('X-Route' => 'baz')
+  ->content_is(<<EOF);
+<base href="http://kraih.com/rebased/" />
+<script src="/rebased/js/jquery.js" type="text/javascript"></script>
+<img src="/rebased/images/test.png" />
+http://kraih.com/rebased/foo
+/rebased/foo
+http://kraih.com/
+baz
+EOF
+
+# GET /yada (does not exist)
+$t->get_ok('/yada')->status_is(404)->header_is('X-Route' => '');
+
 __DATA__
 @@ root.html.ep
 %= base_tag
@@ -67,6 +98,10 @@ __DATA__
 %= url_for('foo')->to_abs
 %= url_for 'foo'
 %= url_for('foo')->base
+%= current_route
+% if (current_route 'root') {
+  Welcome to the root!
+% }
 
 @@ foo.html.ep
 %= base_tag
@@ -75,3 +110,4 @@ __DATA__
 %= url_for('root')->to_abs
 %= url_for 'root'
 %= url_for('root')->base
+%= current_route