Fix -spec(_).s (#9)

arizona-framework · Jun 28, 2024 · c4d1590 · c4d1590
1 parent a59dfe0
commit c4d1590
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 39 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -29,25 +29,14 @@ jobs:
           version-type: strict
           version-file: .tool-versions
 
-      - name: Restore _build
-        uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
-        with:
-          path: _build
-          key: "_build-cache-for\
-                -os-${{runner.os}}\
-                -otp-${{steps.setup-beam.outputs.otp-version}}\
-                -rebar3-${{steps.setup-beam.outputs.rebar3-version}}\
-                -hash-${{hashFiles('rebar.lock')}}"
-
       - name: Restore rebar3's cache
         uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4.0.2
         with:
           path: ~/.cache/rebar3
           key: "rebar3-cache-for\
                 -os-${{runner.os}}\
                 -otp-${{steps.setup-beam.outputs.otp-version}}\
-                -rebar3-${{steps.setup-beam.outputs.rebar3-version}}\
-                -hash-${{hashFiles('rebar.lock')}}"
+                -rebar3-${{steps.setup-beam.outputs.rebar3-version}}"
 
       - name: Continuous Integration
         run: |

diff --git a/rebar.config b/rebar.config
@@ -2,8 +2,8 @@
 
 {erl_opts, [
     debug_info,
-    warnings_as_errors%,
-%    warn_missing_spec
+    warnings_as_errors,
+    warn_missing_spec
 ]}.
 
 {deps, [

diff --git a/src/arizona_example_app.erl b/src/arizona_example_app.erl
@@ -10,9 +10,16 @@
 -export([start/2]).
 -export([stop/1]).
 
+-spec start(StartType, StartArgs) -> Started
+    when StartType :: normal,
+         StartArgs :: [],
+         Started :: supervisor:startlink_ret().
 start(_StartType, _StartArgs) ->
     arizona_example_sup:start_link().
 
+-spec stop(State) -> Stopped
+    when State :: [],
+         Stopped :: ok.
 stop(_State) ->
     ok.
 

diff --git a/src/arizona_example_live_counter.erl b/src/arizona_example_live_counter.erl
@@ -17,15 +17,20 @@
 %% arizona_live_view callbacks.
 %% --------------------------------------------------------------------
 
-mount(#{assigns := Assigns} = Socket) ->
-    Count = maps:get(count, Assigns, 0),
-    {ok, arizona_socket:assign(count, Count, Socket)}.
+-spec mount(Socket) -> Mounted
+    when Socket :: arizona_socket:t(),
+         Mounted :: {ok, arizona_socket:t()}.
+mount(Socket) ->
+    Count = arizona_socket:get_assign(count, Socket, 0),
+    {ok, arizona_socket:put_assign(count, Count, Socket)}.
 
+-spec render(Macros) -> Tree
+    when Macros :: arizona_live_view:macros(),
+         Tree :: arizona_live_view:tree().
 render(Macros0) ->
-    Macros = Macros0#{
-        title => maps:get(title, Macros0, ~"Arizona")
-    },
-    ?ARIZONA_LIVEVIEW(~"""
+    Title = arizona_live_view:get_macro(title, Macros0, ~"Arizona"),
+    Macros = arizona_live_view:put_macro(title, Title, Macros0),
+    ?ARIZONA_LIVEVIEW(Macros, ~"""
     <!DOCTYPE html>
     <html lang="en">
     <head>
@@ -50,31 +55,41 @@ render(Macros0) ->
     </html>
     """).
 
-handle_event(<<"incr">>, #{}, #{assigns := Assigns} = Socket) ->
-    Count = maps:get(count, Assigns) + 1,
-    {noreply, arizona_socket:assign(count, Count, Socket)};
-handle_event(<<"decr">>, #{}, #{assigns := Assigns} = Socket) ->
-    Count = maps:get(count, Assigns) - 1,
-    {noreply, arizona_socket:assign(count, Count, Socket)}.
+-spec handle_event(EventName, Payload, Socket) -> Handled
+    when EventName :: binary(),
+         Payload :: arizona:payload(),
+         Socket :: arizona_socket:t(),
+         Handled :: {noreply, arizona_socket:t()}.
+handle_event(<<"incr">>, _Payload, Socket) ->
+    Count = arizona_socket:get_assign(count, Socket) + 1,
+    {noreply, arizona_socket:put_assign(count, Count, Socket)};
+handle_event(<<"decr">>, _Payload, Socket) ->
+    Count = arizona_socket:get_assign(count, Socket) - 1,
+    {noreply, arizona_socket:put_assign(count, Count, Socket)}.
 
 %% --------------------------------------------------------------------
 %% Component functions.
 %% --------------------------------------------------------------------
 
+-spec counter(Macros) -> Tree
+    when Macros :: arizona_live_view:macros(),
+         Tree :: arizona_live_view:tree().
 counter(Macros) ->
-    ?ARIZONA_LIVEVIEW(~s"""
+    ?ARIZONA_LIVEVIEW(Macros, ~s"""
     <div :stateful>
         <div>Count: {_@count}</div>
         <.button event={_@event} text={_@btn_text} />
     </div>
     """).
 
+-spec button(Macros) -> Tree
+    when Macros :: arizona_live_view:macros(),
+         Tree :: arizona_live_view:tree().
 button(Macros) ->
-    ?ARIZONA_LIVEVIEW(~s"""
+    ?ARIZONA_LIVEVIEW(Macros, ~s"""
     {% NOTE: On this example, :onclick is and expression to be }
     {%       dynamic. It could be just, e.g., :onclick="incr". }
     <button type="button" :onclick={arizona_js:send(_@event)}>
         {_@text}
     </button>
     """).
-
diff --git a/src/arizona_example_sup.erl b/src/arizona_example_sup.erl
@@ -13,18 +13,16 @@
 
 -define(SERVER, ?MODULE).
 
+-spec start_link() -> Ret
+    when Ret :: supervisor:startlink_ret().
 start_link() ->
     supervisor:start_link({local, ?SERVER}, ?MODULE, []).
 
-%% sup_flags() = #{strategy => strategy(),         % optional
-%%                 intensity => non_neg_integer(), % optional
-%%                 period => pos_integer()}        % optional
-%% child_spec() = #{id => child_id(),       % mandatory
-%%                  start => mfargs(),      % mandatory
-%%                  restart => restart(),   % optional
-%%                  shutdown => shutdown(), % optional
-%%                  type => worker(),       % optional
-%%                  modules => modules()}   % optional
+-spec init(Args) -> Init
+    when Args :: [],
+         Init :: {ok, {SupFlags, [ChildSpec]}},
+         SupFlags :: supervisor:sup_flags(),
+         ChildSpec :: supervisor:child_spec().
 init([]) ->
     SupFlags = #{
         strategy => one_for_all,