From 3c820f4fef0cfc1bacd9771ee7be42a29b7a1064 Mon Sep 17 00:00:00 2001 From: Christopher Date: Mon, 17 Feb 2020 20:43:45 -0600 Subject: [PATCH] tweaking specs for docs --- lib/wampex/roles/callee.ex | 15 ++++++++------- lib/wampex/roles/caller.ex | 7 ++++--- lib/wampex/roles/peer.ex | 4 ++-- lib/wampex/roles/publisher.ex | 7 ++++--- lib/wampex/roles/subscriber.ex | 8 ++++---- lib/wampex/session.ex | 12 ++++++------ lib/wampex/transport.ex | 2 +- test/wampex_test.exs | 8 -------- 8 files changed, 29 insertions(+), 34 deletions(-) diff --git a/lib/wampex/roles/callee.ex b/lib/wampex/roles/callee.ex index 2152e14..b834d68 100644 --- a/lib/wampex/roles/callee.ex +++ b/lib/wampex/roles/callee.ex @@ -18,27 +18,28 @@ defmodule Wampex.Role.Callee do Map.put(roles, :callee, %{}) end - @spec register(binary()) :: Wampex.message() + @spec register(procedure :: binary()) :: Wampex.message() def register(procedure) do [@register, %{}, procedure] end - @spec unregister(integer()) :: Wampex.message() - def unregister(id) do - [@unregister, id] + @spec unregister(registration_id :: integer()) :: Wampex.message() + def unregister(registration_id) do + [@unregister, registration_id] end - @spec yield(integer()) :: Wampex.message() + @spec yield(request_id :: integer()) :: Wampex.message() def yield(request_id) do [@yield, request_id, %{}] end - @spec yield(integer(), nonempty_list(any())) :: Wampex.message() + @spec yield(request_id :: integer(), arg_l :: nonempty_list(any())) :: Wampex.message() def yield(request_id, arg_l) do [@yield, request_id, %{}, arg_l] end - @spec yield(integer(), nonempty_list(any()), map()) :: Wampex.message() + @spec yield(request_id :: integer(), arg_l :: nonempty_list(any()), arg_kw :: map()) :: + Wampex.message() def yield(request_id, arg_l, arg_kw) do [@yield, request_id, %{}, arg_l, arg_kw] end diff --git a/lib/wampex/roles/caller.ex b/lib/wampex/roles/caller.ex index e8d65cc..5bd5f4d 100644 --- a/lib/wampex/roles/caller.ex +++ b/lib/wampex/roles/caller.ex @@ -14,17 +14,18 @@ defmodule Wampex.Role.Caller do Map.put(roles, :caller, %{}) end - @spec call(binary()) :: Wampex.message() + @spec call(procedure :: binary()) :: Wampex.message() def call(procedure) do [@call, %{}, procedure] end - @spec call(binary(), nonempty_list(any())) :: Wampex.message() + @spec call(procedure :: binary(), arg_l :: nonempty_list(any())) :: Wampex.message() def call(procedure, arg_l) do [@call, %{}, procedure, arg_l] end - @spec call(binary(), nonempty_list(any()), map()) :: Wampex.message() + @spec call(procedure :: binary(), arg_l :: nonempty_list(any()), arg_kw :: map()) :: + Wampex.message() def call(procedure, arg_l, arg_kw) do [@call, %{}, procedure, arg_l, arg_kw] end diff --git a/lib/wampex/roles/peer.ex b/lib/wampex/roles/peer.ex index 9622fbd..a02a4be 100644 --- a/lib/wampex/roles/peer.ex +++ b/lib/wampex/roles/peer.ex @@ -17,12 +17,12 @@ defmodule Wampex.Role.Peer do @impl true def add(roles), do: roles - @spec hello(binary(), nonempty_list(module())) :: Wampex.message() + @spec hello(realm :: binary(), roles :: nonempty_list(module())) :: Wampex.message() def hello(realm, roles) do [@hello, realm, %{roles: Enum.reduce(roles, %{}, fn r, acc -> r.add(acc) end)}] end - @spec goodbye(binary()) :: Wampex.message() + @spec goodbye(reason :: binary()) :: Wampex.message() def goodbye(reason) do [@goodbye, %{}, reason] end diff --git a/lib/wampex/roles/publisher.ex b/lib/wampex/roles/publisher.ex index 614a0a1..5e62588 100644 --- a/lib/wampex/roles/publisher.ex +++ b/lib/wampex/roles/publisher.ex @@ -14,17 +14,18 @@ defmodule Wampex.Role.Publisher do Map.put(roles, :publisher, %{}) end - @spec publish(binary()) :: Wampex.message() + @spec publish(topic :: binary()) :: Wampex.message() def publish(topic) do [@publish, %{}, topic] end - @spec publish(binary(), nonempty_list(any())) :: Wampex.message() + @spec publish(topic :: binary(), arg_l :: nonempty_list(any())) :: Wampex.message() def publish(topic, arg_l) do [@publish, %{}, topic, arg_l] end - @spec publish(binary(), nonempty_list(any()), map()) :: Wampex.message() + @spec publish(topic :: binary(), arg_l :: nonempty_list(any()), arg_kw :: map()) :: + Wampex.message() def publish(topic, arg_l, arg_kw) do [@publish, %{}, topic, arg_l, arg_kw] end diff --git a/lib/wampex/roles/subscriber.ex b/lib/wampex/roles/subscriber.ex index a34e02d..814c3de 100644 --- a/lib/wampex/roles/subscriber.ex +++ b/lib/wampex/roles/subscriber.ex @@ -17,14 +17,14 @@ defmodule Wampex.Role.Subscriber do Map.put(roles, :subscriber, %{}) end - @spec subscribe(binary()) :: Wampex.message() + @spec subscribe(topic :: binary()) :: Wampex.message() def subscribe(topic) do [@subscribe, %{}, topic] end - @spec unsubscribe(integer()) :: Wampex.message() - def unsubscribe(sub_id) do - [@unsubscribe, sub_id] + @spec unsubscribe(subscription_id :: integer()) :: Wampex.message() + def unsubscribe(subscription_id) do + [@unsubscribe, subscription_id] end @impl true diff --git a/lib/wampex/session.ex b/lib/wampex/session.ex index a002ca0..81f8d57 100644 --- a/lib/wampex/session.ex +++ b/lib/wampex/session.ex @@ -63,14 +63,14 @@ defmodule Wampex.Session do end @spec cast_send_request(name :: atom() | pid(), request :: Wampex.message()) :: :ok - def cast_send_request(p, request) do - __MODULE__.cast(p, {:send_request, request}) + def cast_send_request(name, request) do + __MODULE__.cast(name, {:send_request, request}) end @spec send_request(name :: atom() | pid(), request :: Wampex.message(), timeout :: integer()) :: term() - def send_request(p, request, timeout) do - __MODULE__.call(p, {:send_request, request}, timeout) + def send_request(name, request, timeout) do + __MODULE__.call(name, {:send_request, request}, timeout) end defp do_send(r_id, tt, t, request) do @@ -86,11 +86,11 @@ defmodule Wampex.Session do request_id end - def get_request_id(current_id) when current_id == @max_id do + defp get_request_id(current_id) when current_id == @max_id do 1 end - def get_request_id(current_id) do + defp get_request_id(current_id) do current_id + 1 end diff --git a/lib/wampex/transport.ex b/lib/wampex/transport.ex index 69175ff..4ad963a 100644 --- a/lib/wampex/transport.ex +++ b/lib/wampex/transport.ex @@ -1,6 +1,6 @@ defmodule Wampex.Transport do @moduledoc "Behaviour for Transports" - @callback send_request(atom() | pid(), Wampex.message()) :: :ok + @callback send_request(transport :: atom() | pid(), message :: Wampex.message()) :: :ok @callback start_link( url: binary(), session: Wampex.Session.t(), diff --git a/test/wampex_test.exs b/test/wampex_test.exs index 80197f8..edbcd9e 100644 --- a/test/wampex_test.exs +++ b/test/wampex_test.exs @@ -29,14 +29,6 @@ defmodule WampexTest do assert Test.Transport = Wampex.transport_name(Test) end - test "get_request_id plus one" do - assert 11 = Wampex.Session.get_request_id(10) - end - - test "get_request_id resets" do - assert 1 = Wampex.Session.get_request_id(9_007_199_254_740_992) - end - test "Callee.add" do assert %{callee: %{}} = Callee.add(%{}) end -- 2.45.3