From 91ae70b06c9cc486ea2c2cf91b94de799ceb53b2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Hoguin?= <essen@ninenines.eu>
Date: Sun, 19 Feb 2017 09:46:11 +0100
Subject: Change the order of set_resp_cookie arguments

The Opts value is put last, to be more consistent with the
rest of the cowboy_req module.

Additionally a test handler was fixed which reduced the number
of errors in http_SUITE.
---
 doc/src/guide/cookies.asciidoc                     | 27 ++++++++--------
 doc/src/manual/cowboy_req.set_resp_cookie.asciidoc | 36 +++++++++-------------
 2 files changed, 27 insertions(+), 36 deletions(-)

(limited to 'doc')

diff --git a/doc/src/guide/cookies.asciidoc b/doc/src/guide/cookies.asciidoc
index 33a1940..4825031 100644
--- a/doc/src/guide/cookies.asciidoc
+++ b/doc/src/guide/cookies.asciidoc
@@ -33,24 +33,21 @@ update the expiration time and avoid losing a cookie.
 
 === Setting cookies
 
-// @todo So I am not particularly happy about set_resp_cookie/4
-// having Opts as a *third* argument, instead of the *last* like
-// all other functions that come with an Opts argument. We will
-// probably need to change this before 2.0.
-
 By default cookies are defined for the duration of the session:
 
 [source,erlang]
+----
 SessionID = generate_session_id(),
 Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0).
+----
 
 They can also be set for a duration in seconds:
 
 [source,erlang]
 ----
 SessionID = generate_session_id(),
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
-    #{max_age => 3600}, Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
+    #{max_age => 3600}).
 ----
 
 To delete cookies, set `max_age` to 0:
@@ -58,8 +55,8 @@ To delete cookies, set `max_age` to 0:
 [source,erlang]
 ----
 SessionID = generate_session_id(),
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
-    #{max_age => 0}, Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
+    #{max_age => 0}).
 ----
 
 To restrict cookies to a specific domain and path, the options
@@ -67,8 +64,8 @@ of the same name can be used:
 
 [source,erlang]
 ----
-Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>,
-    #{domain => "my.example.org", path => "/account"}, Req0).
+Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>, Req0,
+    #{domain => "my.example.org", path => "/account"}).
 ----
 
 Cookies will be sent with requests to this domain and all
@@ -81,8 +78,8 @@ available over HTTPS):
 [source,erlang]
 ----
 SessionID = generate_session_id(),
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
-    #{secure => true}, Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
+    #{secure => true}).
 ----
 
 To prevent client-side scripts from accessing a cookie:
@@ -90,8 +87,8 @@ To prevent client-side scripts from accessing a cookie:
 [source,erlang]
 ----
 SessionID = generate_session_id(),
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
-    #{http_only => true}, Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0,
+    #{http_only => true}).
 ----
 
 Cookies may also be set client-side, for example using
diff --git a/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc b/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
index f4643ff..2831059 100644
--- a/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
+++ b/doc/src/manual/cowboy_req.set_resp_cookie.asciidoc
@@ -11,7 +11,7 @@ cowboy_req:set_resp_cookie - Set a cookie
 set_resp_cookie(Name, Value, Req :: cowboy_req:req())
     -> set_resp_cookie(Name, Value, [], Req)
 
-set_resp_cookie(Name, Value, Opts, Req :: cowboy_req:req())
+set_resp_cookie(Name, Value, Req :: cowboy_req:req(), Opts)
     -> Req
 
 Name  :: binary()                  %% case sensitive
@@ -33,14 +33,14 @@ Value::
 
 Cookie value.
 
-Opts::
-
-Optional cookie options.
-
 Req::
 
 The Req object.
 
+Opts::
+
+Cookie options.
+
 == Return value
 
 A new Req object is returned.
@@ -66,44 +66,38 @@ Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, Req0).
 .Set a cookie with an expiration time
 [source,erlang]
 ----
-Req = cowboy_req:set_resp_cookie(<<"lang">>, <<"fr-FR">>, [
-    {max_age, 3600}
-], Req0).
+Req = cowboy_req:set_resp_cookie(<<"lang">>, <<"fr-FR">>,
+    Req0, #{max_age => 3600}).
 ----
 
 .Delete a cookie
 [source,erlang]
 ----
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, <<>>, [
-    {max_age, 0}
-], Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, <<>>,
+    Req0, #{max_age => 0}).
 ----
 
 .Set a cookie for a specific domain and path
 [source,erlang]
 ----
-Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>, [
-    {domain, "my.example.org"},
-    {path, "/account"}
-], Req0).
+Req = cowboy_req:set_resp_cookie(<<"inaccount">>, <<"1">>,
+    Req0, #{domain => "my.example.org", path => "/account"}).
 ----
 
 .Restrict a cookie to HTTPS
 [source,erlang]
 ----
 SessionID = base64:encode(crypto:strong_rand_bytes(32)),
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, [
-    {secure, true}
-], Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
+    Req0, #{secure => true}).
 ----
 
 .Restrict a cookie to HTTP
 [source,erlang]
 ----
 SessionID = base64:encode(crypto:strong_rand_bytes(32)),
-Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID, [
-    {http_only, true}
-], Req0).
+Req = cowboy_req:set_resp_cookie(<<"sessionid">>, SessionID,
+    Req0, #{http_only => true}).
 ----
 
 == See also
-- 
cgit v1.2.3