better description for split_header function

mojolicious · Feb 10, 2015 · da8ff04 · da8ff04
1 parent f578fba
commit da8ff04
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 19 deletions.
diff --git a/lib/Mojo/URL.pm b/lib/Mojo/URL.pm
@@ -415,9 +415,10 @@ Normalized version of L</"scheme">.
   $url      = $url->query('a=1&b=2');
   $url      = $url->query(Mojo::Parameters->new);
 
-Query part of this URL, pairs in an array reference will be merged with
-L<Mojo::Parameters/"merge"> and pairs in a hash reference appended with
-L<Mojo::Parameters/"append">, defaults to a L<Mojo::Parameters> object.
+Query part of this URL, key/value pairs in an array reference will be merged
+with L<Mojo::Parameters/"merge">, and key/value pairs in a hash reference
+appended with L<Mojo::Parameters/"append">, defaults to a L<Mojo::Parameters>
+object.
 
   # "2"
   Mojo::URL->new('http://example.com?a=1&b=2')->query->param('b');

diff --git a/lib/Mojo/Util.pm b/lib/Mojo/Util.pm
@@ -48,8 +48,9 @@ my %XML = (
   '\'' => '&#39;'
 );
 
-# "Sun, 06 Nov 1994 08:49:37 GMT" or "Sunday, 06-Nov-94 08:49:37 GMT"
+# "Sun, 06 Nov 1994 08:49:37 GMT" and "Sunday, 06-Nov-94 08:49:37 GMT"
 my $EXPIRES_RE = qr/(\w+\,\s+\d+\W+\w+\D+\d+\s+\d+:\d+:\d+\s+GMT)/;
+my $VALUE_RE   = qr/("(?:\\\\|\\"|[^"])*"|[^;, ]*)/;
 
 # Encoding cache
 my %CACHE;
@@ -387,17 +388,14 @@ sub _header {
 
   my (@tree, @token);
   while ($str =~ s/^[,;\s]*([^=;, ]+)\s*//) {
-    push @token, my $name = $1, undef;
+    push @token, $1, undef;
+    my $expires = $cookie && lc $1 eq 'expires';
 
     # Special "expires" value
-    if ($cookie && lc $name eq 'expires' && $str =~ s/^=\s*$EXPIRES_RE//o) {
-      $token[-1] = $1;
-    }
+    if ($expires && $str =~ s/^=\s*$EXPIRES_RE//o) { $token[-1] = $1 }
 
     # Normal value
-    elsif ($str =~ s/^=\s*("(?:\\\\|\\"|[^"])*"|[^;, ]*)\s*//) {
-      $token[-1] = unquote $1;
-    }
+    elsif ($str =~ s/^=\s*$VALUE_RE\s*//o) { $token[-1] = unquote $1 }
 
     # Separator
     $str =~ s/^;\s*//;
@@ -681,17 +679,25 @@ L<RFC 6265|http://tools.ietf.org/html/rfc6265>.
 
    my $tree = split_header 'foo="bar baz"; test=123, yada';
 
-Split HTTP header value.
+Split HTTP header value into key/value pairs, keys without a value get
+C<undef> assigned, and each comma separated part will get its own array
+reference.
 
   # "one"
   split_header('one; two="three four", five=six')->[0][0];
 
+  # "two"
+  split_header('one; two="three four", five=six')->[0][2];
+
   # "three four"
   split_header('one; two="three four", five=six')->[0][3];
 
   # "five"
   split_header('one; two="three four", five=six')->[1][0];
 
+  # "six"
+  split_header('one; two="three four", five=six')->[1][1];
+
 =head2 spurt
 
   $bytes = spurt $bytes, '/etc/passwd';

diff --git a/lib/Mojolicious/Controller.pm b/lib/Mojolicious/Controller.pm
@@ -659,8 +659,8 @@ Prepare a C<302> redirect response, takes the same arguments as L</"url_for">.
 Render content with L<Mojolicious::Renderer/"render"> and emit hooks
 L<Mojolicious/"before_render"> as well as L<Mojolicious/"after_render">, or
 call L<Mojolicious::Plugin::DefaultHelpers/"reply-E<gt>not_found"> if no
-response could be generated, all additional pairs get merged into the
-L</"stash">.
+response could be generated, all additional key/value pairs get merged into
+the L</"stash">.
 
   # Render characters
   $c->render(text => 'I ♥ Mojolicious!');

diff --git a/lib/Mojolicious/Plugin/DefaultHelpers.pm b/lib/Mojolicious/Plugin/DefaultHelpers.pm
@@ -335,7 +335,7 @@ Dump a Perl data structure with L<Mojo::Util/"dumper">.
   % extends 'blue';
   % extends 'blue', title => 'Blue!';
 
-Set C<extends> stash value, all additional pairs get merged into the
+Set C<extends> stash value, all additional key/value pairs get merged into the
 L</"stash">.
 
 =head2 flash
@@ -381,7 +381,7 @@ response headers with L<Mojolicious::Static/"is_fresh">.
   % layout 'green';
   % layout 'green', title => 'Green!';
 
-Set C<layout> stash value, all additional pairs get merged into the
+Set C<layout> stash value, all additional key/value pairs get merged into the
 L</"stash">.
 
 =head2 param
@@ -463,8 +463,8 @@ Alias for L<Mojolicious::Controller/"stash">.
   % title 'Welcome!';
   % title 'Welcome!', foo => 'bar';
 
-Get or set C<title> stash value, all additional pairs get merged into the
-L</"stash">.
+Get or set C<title> stash value, all additional key/value pairs get merged
+into the L</"stash">.
 
 =head2 ua
 

diff --git a/lib/Mojolicious/Plugin/TagHelpers.pm b/lib/Mojolicious/Plugin/TagHelpers.pm
@@ -642,7 +642,7 @@ Alias for L</"tag">.
   <%= tag div => (id => 'foo') => begin %>test & 123<% end %>
 
 HTML tag generator, the C<data> attribute may contain a hash reference with
-pairs to generate attributes from.
+key/value pairs to generate attributes from.
 
   <br>
   <div></div>