Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce request title #54

Merged
merged 1 commit into from Nov 30, 2019

Conversation

@elvanja
Copy link
Contributor

elvanja commented Nov 28, 2019

Adds option to name test requests and show that request title in final documentation.
Usage: |> BlueBird.ConnLogger.save(title: "Without params") (also added to readme).
Defaults to response status given no title supplied.
Inspired by https://github.com/api-hogs/bureaucrat test helpers.

@@ -75,8 +75,10 @@ defmodule BlueBird.ConnLogger do
iex> save(conn)
:ok
"""
@spec save(Plug.Conn.t()) :: :ok
def save(conn) do
@type save_option :: {:title, String.t()}

This comment has been minimized.

@@ -228,6 +228,7 @@ defmodule BlueBird.Test.Writer.BlueprintTest do
%Request{
method: POST,
path: "/users/:id/pets",
title: "Add pet",

This comment has been minimized.

Copy link
@elvanja

elvanja Nov 28, 2019

Author Contributor

Maybe it could have used a separate test, but decided against it since it would be much unneeded repetition.

@@ -3,6 +3,7 @@ defmodule BlueBird.Test.FormatterTest do

alias BlueBird.Formatter

@tag :capture_log

This comment has been minimized.

Copy link
@elvanja

elvanja Nov 28, 2019

Author Contributor

Just to suppress the generated warning.

@tomekowal

This comment has been minimized.

Copy link

tomekowal commented Nov 29, 2019

That title makes HTML output much more readable!

@rhazdon

This comment has been minimized.

Copy link
Member

rhazdon commented Nov 30, 2019

Hi @elvanja, thanks a lot for this pr! :)

For me it looks well, so IMHO we can merge it.

@rhazdon rhazdon merged commit 031b2f1 into KittyHeaven:master Nov 30, 2019
2 checks passed
2 checks passed
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls First build on elvanja-introduce-request-title at 92.542%
Details
@elvanja elvanja deleted the elvanja:elvanja-introduce-request-title branch Dec 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.