Add -spec as appropriate, and style improvements

Author: jvoegele

src/riak_repl2_rtq.erl

@@ -88,6 +88,7 @@
            }).
 
 -type name() :: term().
+-type seq() :: non_neg_integer().
 
 %% API
 %% @doc Start linked, registered to module name.
@@ -238,13 +239,15 @@ dumpq() ->
 
 %% @doc Return summary data for the objects currently in the queue.
 %% The return value is a list of tuples of the form {SequenceNum, Key, Size}.
--spec summarize() -> [{integer(), string(), integer()}].
+-spec summarize() -> [{seq(), riak_object:key(), non_neg_integer()}].
 summarize() ->
-  gen_server:call(?SERVER, summarize, infinity).
+    gen_server:call(?SERVER, summarize, infinity).
 
 %% @doc If an object with the given Seq number is currently in the queue,
 %% evict it and return ok.
-evict(Seq) -> gen_server:call(?SERVER, {evict, Seq}, infinity).
+-spec evict(Seq :: seq()) -> 'ok'.
+evict(Seq) ->
+    gen_server:call(?SERVER, {evict, Seq}, infinity).
 
 %% @doc If an object with the given Seq number is currently in the queue and it
 %% also matches the given Key, then evict it and return ok. This is a safer
@@ -254,7 +257,10 @@ evict(Seq) -> gen_server:call(?SERVER, {evict, Seq}, infinity).
 %% given `Seq' number, then {not_found, Seq} is returned, whereas if the
 %% object with the given `Seq' number is present but does not match the
 %% provided `Key', then {wrong_key, Seq, Key} is returned.
-evict(Seq, Key) -> gen_server:call(?SERVER, {evict, Seq, Key}, infinity).
+-spec evict(Seq :: seq(), Key :: riak_object:key()) ->
+    'ok' | {'not_found', integer()} | {'wrong_key', integer(), riak_object:key()}.
+evict(Seq, Key) ->
+    gen_server:call(?SERVER, {evict, Seq, Key}, infinity).
 
 %% @doc Signal that this node is doing down, and so a proxy process needs to
 %% start to avoid dropping, or aborting unacked results.
@@ -359,9 +365,9 @@ handle_call(dumpq, _From, State = #state{qtab = QTab}) ->
 
 handle_call(summarize, _From, State = #state{qtab = QTab}) ->
     Fun = fun({Seq, _NumItems, Bin, _Meta}, Acc) ->
-      Obj = riak_repl_util:from_wire(Bin),
-      {Key, Size} = summarize_object(Obj),
-      Acc ++ [{Seq, Key, Size}]
+        Obj = riak_repl_util:from_wire(Bin),
+        {Key, Size} = summarize_object(Obj),
+        Acc ++ [{Seq, Key, Size}]
     end,
     {reply, ets:foldl(Fun, [], QTab), State};
 

test/riak_repl2_rtq_tests.erl

@@ -2,12 +2,12 @@
 -compile(export_all).
 -include_lib("eunit/include/eunit.hrl").
 
--define(set_env, application:set_env(riak_repl, rtq_max_bytes, 10*1024*1024)).
--define(unset_env, application:unset_env(riak_repl, rtq_max_bytes)).
+-define(setup_env, application:set_env(riak_repl, rtq_max_bytes, 10*1024*1024)).
+-define(clean_env, application:unset_env(riak_repl, rtq_max_bytes)).
 
 rtq_trim_test() ->
     %% make sure the queue is 10mb
-    ?set_env,
+    ?setup_env,
     {ok, Pid} = riak_repl2_rtq:start_test(),
     try
         gen_server:call(Pid, {register, rtq_test}),
@@ -22,7 +22,7 @@ rtq_trim_test() ->
         %% the queue is now empty
         ?assert(gen_server:call(Pid, {is_empty, rtq_test}))
     after
-        ?unset_env,
+        ?clean_env,
         exit(Pid, kill)
     end.
 
@@ -48,12 +48,12 @@ accumulate(Pid, Acc, C) ->
 
 status_test_() ->
     {setup, fun() ->
-        ?set_env,
+        ?setup_env,
         {ok, QPid} = riak_repl2_rtq:start_link(),
         QPid
     end,
     fun(QPid) ->
-        ?unset_env,
+        ?clean_env,
         riak_repl_test_util:kill_and_wait(QPid)
     end,
     fun(_QPid) -> [
@@ -275,15 +275,15 @@ overload_test_() ->
     ]}.
 
 start_rtq() ->
-    ?set_env,
+    ?setup_env,
     %% application:start(lager),
     %% lager:set_loglevel(lager_console_backend, debug),
     {ok, Pid} = riak_repl2_rtq:start_link(),
     gen_server:call(Pid, {register, rtq_test}),
     Pid.
 
 kill_rtq(QPid) ->
-    ?unset_env,
+    ?clean_env,
     riak_repl_test_util:kill_and_wait(QPid).
 
 object_format() -> riak_core_capability:get({riak_kv, object_format}, v0).