Packages

xcribe

0.1.1
0.7.12 0.7.11 0.7.10 0.7.9 0.7.8 0.7.7 0.7.6 0.7.5 0.7.4 0.7.3 0.7.2 0.7.1 0.7.0 0.6.1 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.1 0.1.0 0.0.2 0.0.1

A lib to generate API documentation from test specs

HexDocs

Current section

Files

Jump to
Readme
23 Versions
0 Dependencies
Dependants
Files
Activity
xcribe lib helpers document.ex
Raw

lib/helpers/document.ex 

defmodule Xcribe.Helpers.Document do

  alias Xcribe.{Config, ConnParser, Recorder}



  defmacro document(conn, opts \\ []) do

    "test " <> test_name = __CALLER__.function |> elem(0) |> to_string



    quote bind_quoted: [conn: conn, test_name: test_name, opts: opts] do

      options = Keyword.merge([as: test_name], opts)



      if Config.active?() do

        conn

        |> ConnParser.execute(request_description(options))

        |> Recorder.save()

      end



      conn

    end

  end



  def request_description(options), do: Keyword.fetch!(options, :as)

end