refactor: add more spec

mydearxym · mydearxym · commit 6f0ee7693239 · 2019-08-11T15:58:12.000+08:00
diff --git a/lib/groupher_server/cms/delegates/community_sync.ex b/lib/groupher_server/cms/delegates/community_sync.ex
@@ -4,12 +4,14 @@ defmodule GroupherServer.CMS.Delegate.CommunitySync do
   """
   import Ecto.Query, warn: false
   import Helper.ErrorCode
-  import Helper.CommonTypes
   # import ShortMaps
 
+  alias GroupherServer.CMS
+
   alias Helper.ORM
+  alias Helper.SpecType, as: T
 
-  alias GroupherServer.CMS.{
+  alias CMS.{
     Community,
     CommunityWiki,
     CommunityCheatsheet
@@ -46,7 +48,7 @@ defmodule GroupherServer.CMS.Delegate.CommunitySync do
   @doc """
   sync wiki
   """
-  @spec sync_github_content(Community.t(), atom) :: {:ok, CommunityWiki.t()}
+  @spec sync_github_content(Community.t(), atom(), any()) :: {:ok, CommunityWiki.t()}
   def sync_github_content(%Community{id: id}, :wiki, attrs) do
     with {:ok, community} <- ORM.find(Community, id) do
       attrs = Map.merge(attrs, %{community_id: community.id})
@@ -58,7 +60,7 @@ defmodule GroupherServer.CMS.Delegate.CommunitySync do
   @doc """
   sync cheatsheet
   """
-  @spec sync_github_content(Community.t(), atom()) :: {:ok, CommunityCheatsheet.t()}
+  @spec sync_github_content(Community.t(), atom(), any()) :: {:ok, CommunityCheatsheet.t()}
   def sync_github_content(%Community{id: id}, :cheatsheet, attrs) do
     with {:ok, community} <- ORM.find(Community, id) do
       attrs = Map.merge(attrs, %{community_id: community.id})
@@ -70,17 +72,17 @@ defmodule GroupherServer.CMS.Delegate.CommunitySync do
   @doc """
   add contributor to exsit wiki contributors list
   """
-  @spec add_contributor(Community.t(), github_contributor()) ::
-          {:ok, CommunityWiki} | custom_error()
+  @spec add_contributor(Community.t(), T.github_contributor()) ::
+          {:ok, CommunityWiki} | T.gq_error()
   def add_contributor(%CommunityWiki{id: id}, contributor_attrs) do
     do_add_contributor(CommunityWiki, id, contributor_attrs)
   end
 
   @doc """
   add contributor to exsit cheatsheet contributors list
   """
-  @spec add_contributor(Community.t(), github_contributor()) ::
-          {:ok, CommunityCheatsheet} | custom_error()
+  @spec add_contributor(Community.t(), T.github_contributor()) ::
+          {:ok, CommunityCheatsheet} | T.gq_error()
   def add_contributor(%CommunityCheatsheet{id: id}, contributor_attrs) do
     do_add_contributor(CommunityCheatsheet, id, contributor_attrs)
   end
diff --git a/lib/helper/common_types.ex b/lib/helper/common_types.ex
diff --git a/lib/helper/spec_type.ex b/lib/helper/spec_type.ex
@@ -14,4 +14,17 @@ defmodule Helper.SpecType do
   @type done :: {:ok, map} | {:error, map}
 
   @type id :: non_neg_integer() | String.t()
+
+  @typedoc """
+  general contribute type for wiki and cheatshet
+  """
+  @type github_contributor2 :: %{
+          github_id: String.t(),
+          avatar: String.t(),
+          html_url: String.t(),
+          nickname: String.t(),
+          bio: nil | String.t(),
+          location: nil | String.t(),
+          company: nil | String.t()
+        }
 end
