Merge pull request #1246 from code-corps/add-processor-typespecs

Add typespecs for processor

Author: joshsmith

lib/code_corps/accounts/accounts.ex

@@ -123,6 +123,7 @@ defmodule CodeCorps.Accounts do
     |> Repo.update()
   end
 
+  @spec upload_github_photo_async(User.t) :: User.t | Processor.result
   defp upload_github_photo_async(%User{cloudinary_public_id: nil} = user) do
     Processor.process(fn -> upload_github_photo(user) end)
   end

lib/code_corps/processor/async.ex

@@ -1,6 +1,7 @@
 defmodule CodeCorps.Processor.Async do
   @behaviour CodeCorps.Processor
 
+  @spec process((() -> any)) :: {:ok, pid}
   def process(fun) do
     Task.Supervisor.start_child(:background_processor, fn ->
       apply(fun, [])

lib/code_corps/processor/processor.ex

@@ -1,8 +1,11 @@
 defmodule CodeCorps.Processor do
   @processor Application.get_env(:code_corps, :processor)
 
-  @callback process(fun :: (() -> any)) :: any
+  @type result :: {:ok, pid} | any
 
+  @callback process(fun :: (() -> any)) :: result
+
+  @spec process((() -> any)) :: result
   def process(fun) do
     @processor.process(fun)
   end

lib/code_corps/processor/sync.ex

@@ -1,6 +1,7 @@
 defmodule CodeCorps.Processor.Sync do
   @behaviour CodeCorps.Processor
 
+  @spec process((() -> any)) :: any
   def process(fun) do
     apply(fun, [])
   end