Cleaned up type specs for dialyzer #4

Author: etrepum

.travis.yml

@@ -2,6 +2,5 @@ language: erlang
 notifications:
   email: false
 otp_release:
-  - R14B03
-  - R14B02
-  - R14B01
+  - R15B03
+  - R16B01

CHANGES.md

@@ -1,3 +1,8 @@
+Version 0.2.3 released 2013-09-15
+
+* Cleaned up type specs for dialyzer
+  https://github.com/mochi/statebox/issues/4
+
 Version 0.2.2 released 2011-06-14
 
 * Updated README

src/statebox.app.src

@@ -1,7 +1,7 @@
 {application, statebox,
  [
   {description, "Erlang state \"monad\" with merge/conflict-resolution capabilities. Useful for Riak."},
-  {vsn, "0.2.2"},
+  {vsn, "0.2.3"},
   {registered, []},
   {applications, [
                   kernel,

src/statebox.erl

@@ -22,11 +22,12 @@
           last_modified :: timestamp()}).
 -opaque statebox() :: #statebox{}.
 -type event() :: {timestamp(), op()}.
--type timestamp() :: integer().
+-type timestamp() :: statebox_clock:timestamp().
 -type timedelta() :: integer().
 -type basic_op() :: {module(), atom(), [term()]} |
                     {fun((...) -> statebox()), [term()]}.
 -type op() :: basic_op() | [op()].
+-export_type([statebox/0, event/0, timestamp/0, timedelta/0, basic_op/0, op/0]).
 
 %% Used in a test, must be done before function definitions.
 -ifdef(TEST).
@@ -35,7 +36,7 @@
 
 %% @doc Return <code>true</code> if the argument is a statebox, <code>false</code>
 %%      otherwise.
--spec is_statebox(term()) -> boolean().
+-spec is_statebox(statebox() | term()) -> boolean().
 is_statebox(#statebox{}) ->
     true;
 is_statebox(_T) ->
@@ -46,6 +47,7 @@ is_statebox(_T) ->
 %%      return an "empty" object of the desired type, such as
 %%      <code>fun gb_trees:empty/0</code>.
 %% @equiv new(timestamp(), Constructor)
+-spec new(fun(() -> term())) -> statebox().
 new(Constructor) ->
     new(statebox_clock:timestamp(), Constructor).
 

src/statebox_clock.erl

@@ -4,21 +4,25 @@
 -module(statebox_clock).
 -export([timestamp/0, now_to_msec/1, now/0]).
 
+-type t_now() :: {integer(), integer(), integer()}.
+-type timestamp() :: integer().
+-export_type([t_now/0, timestamp/0]).
+
 -define(KILO, 1000).
 -define(MEGA, 1000000).
 
 %% @doc Current UNIX epoch timestamp in integer milliseconds.
 %%      Equivalient to <code>now_to_msec(os:timestamp())</code>.
--spec timestamp() -> integer().
+-spec timestamp() -> timestamp().
 timestamp() ->
     now_to_msec(os:timestamp()).
 
 %% @doc Converts given time of now() format to UNIX epoch timestamp in
 %%      integer milliseconds.
--spec now_to_msec(calendar:t_now()) -> integer().
+-spec now_to_msec(t_now()) -> timestamp().
 now_to_msec({MegaSecs, Secs, MicroSecs}) ->
     trunc(((MegaSecs * ?MEGA) + Secs + (MicroSecs / ?MEGA)) * ?KILO).
 
--spec now() -> calendar:t_now().
+-spec now() -> t_now().
 now() ->
     erlang:now().

src/statebox_identity.erl

@@ -4,6 +4,7 @@
 -export([entropy/2, entropy/0]).
 
 -type entropy() :: 1..4294967296.
+-export_type([entropy/0]).
 
 %% @equiv entropy(node(), statebox_clock:now())
 -spec entropy() -> entropy().
@@ -12,6 +13,6 @@ entropy() ->
 
 %% @doc Return an integer that can be expected to be reasonably unique
 %%      at a given msec timestamp.
--spec entropy(node(), calendar:t_now()) -> entropy().
+-spec entropy(node(), statebox_clock:t_now()) -> entropy().
 entropy(Node, Now) ->
     erlang:phash2({Node, Now}).