refactor(schema): wip

Author: mydearxym

lib/groupher_server_web/schema/Helper/fields.ex

@@ -1,15 +1,18 @@
 defmodule GroupherServerWeb.Schema.Helper.Fields do
   @moduledoc """
-  common fields
+  general fields used in schema definition
   """
   import Helper.Utils, only: [get_config: 2]
+  import Absinthe.Resolution.Helpers, only: [dataloader: 2]
 
   alias GroupherServer.CMS
+  alias GroupherServerWeb.Middleware, as: M
+  alias GroupherServerWeb.Resolvers, as: R
 
   @page_size get_config(:general, :page_size)
-  @supported_emotions get_config(:article, :emotions)
-  @supported_comment_emotions get_config(:article, :comment_emotions)
 
+  @emotions get_config(:article, :emotions)
+  @comment_emotions get_config(:article, :comment_emotions)
   @article_threads get_config(:article, :threads)
 
   @doc "general article fields for grqphql resolve fields"
@@ -38,24 +41,98 @@ defmodule GroupherServerWeb.Schema.Helper.Fields do
     end
   end
 
+  @doc """
+  generate thread enum based on @article_threads
+
+  e.g:
+
+  enum :post_thread, do: value(:post)
+  enum :job_thread, do: value(:job)
+  # ..
+  """
   defmacro article_thread_enums do
     @article_threads
-    |> Enum.map(fn thread ->
-      quote do
-        enum(unquote(:"#{thread}_thread"), do: value(unquote(thread)))
+    |> Enum.map(
+      &quote do
+        enum(unquote(:"#{&1}_thread"), do: value(unquote(&1)))
       end
-    end)
+    )
   end
 
+  @doc """
+  generate thread value based on @article_threads
+
+  e.g:
+
+  value(:post)
+  value(:job)
+  # ...
+  """
   defmacro article_values do
     @article_threads
-    |> Enum.map(fn thread ->
-      quote do
-        value(unquote(thread))
+    |> Enum.map(
+      &quote do
+        value(unquote(&1))
       end
-    end)
+    )
+  end
+
+  @doc """
+  general emotion enum for articles
+  #NOTE: xxx_user_logins field is not support for gq-endpoint
+  """
+  defmacro emotion_values() do
+    @emotions
+    |> Enum.map(
+      &quote do
+        value(unquote(:"#{&1}"))
+      end
+    )
+  end
+
+  defmacro emotion_values(:comment) do
+    @emotions
+    |> Enum.map(
+      &quote do
+        value(unquote(:"#{&1}"))
+      end
+    )
+  end
+
+  @doc """
+  general emotions for articles
+
+  e.g:
+  ------
+  beer_count
+  viewer_has_beered
+  latest_bear_users
+  """
+  defmacro emotion_fields() do
+    @emotions
+    |> Enum.map(
+      &quote do
+        field(unquote(:"#{&1}_count"), :integer)
+        field(unquote(:"viewer_has_#{&1}ed"), :boolean)
+        field(unquote(:"latest_#{&1}_users"), list_of(:simple_user))
+      end
+    )
+  end
+
+  defmacro emotion_fields(:comment) do
+    @comment_emotions
+    |> Enum.map(
+      &quote do
+        field(unquote(:"#{&1}_count"), :integer)
+        field(unquote(:"viewer_has_#{&1}ed"), :boolean)
+        field(unquote(:"latest_#{&1}_users"), list_of(:simple_user))
+      end
+    )
   end
 
+  @doc """
+  general timestamp with active_at for article
+  """
   defmacro timestamp_fields(:article) do
     quote do
       field(:inserted_at, :datetime)
@@ -79,6 +156,9 @@ defmodule GroupherServerWeb.Schema.Helper.Fields do
     end
   end
 
+  @doc """
+  general pagination fields except entries
+  """
   defmacro pagination_fields do
     quote do
       field(:total_count, :integer)
@@ -98,6 +178,9 @@ defmodule GroupherServerWeb.Schema.Helper.Fields do
     end
   end
 
+  @doc """
+  general social used for user profile
+  """
   defmacro social_fields do
     quote do
       field(:qq, :string)
@@ -115,19 +198,13 @@ defmodule GroupherServerWeb.Schema.Helper.Fields do
     end
   end
 
-  import Absinthe.Resolution.Helpers, only: [dataloader: 2]
-
-  alias GroupherServer.CMS
-  alias GroupherServerWeb.Middleware, as: M
-  alias GroupherServerWeb.Resolvers, as: R
-
   defmacro threads_count_fields() do
     @article_threads
-    |> Enum.map(fn thread ->
-      quote do
-        field(unquote(:"#{thread}s_count"), :integer)
+    |> Enum.map(
+      &quote do
+        field(unquote(:"#{&1}s_count"), :integer)
       end
-    end)
+    )
   end
 
   # TODO: remove
@@ -216,62 +293,6 @@ defmodule GroupherServerWeb.Schema.Helper.Fields do
     end
   end
 
-  @doc """
-  general emotion enum for articles
-  #NOTE: xxx_user_logins field is not support for gq-endpoint
-  """
-  defmacro emotion_enum() do
-    @supported_emotions
-    |> Enum.map(fn emotion ->
-      quote do
-        value(unquote(:"#{emotion}"))
-      end
-    end)
-  end
-
-  @doc """
-  general emotion enum for comments
-  #NOTE: xxx_user_logins field is not support for gq-endpoint
-  """
-  defmacro comment_emotion_enum() do
-    @supported_comment_emotions
-    |> Enum.map(fn emotion ->
-      quote do
-        value(unquote(:"#{emotion}"))
-      end
-    end)
-  end
-
-  @doc """
-  general emotions for articles
-  #NOTE: xxx_user_logins field is not support for gq-endpoint
-  """
-  defmacro emotion_fields() do
-    @supported_emotions
-    |> Enum.map(fn emotion ->
-      quote do
-        field(unquote(:"#{emotion}_count"), :integer)
-        field(unquote(:"viewer_has_#{emotion}ed"), :boolean)
-        field(unquote(:"latest_#{emotion}_users"), list_of(:simple_user))
-      end
-    end)
-  end
-
-  @doc """
-  general emotions for comments
-  #NOTE: xxx_user_logins field is not support for gq-endpoint
-  """
-  defmacro comment_emotion_fields() do
-    @supported_comment_emotions
-    |> Enum.map(fn emotion ->
-      quote do
-        field(unquote(:"#{emotion}_count"), :integer)
-        field(unquote(:"viewer_has_#{emotion}ed"), :boolean)
-        field(unquote(:"latest_#{emotion}_users"), list_of(:simple_user))
-      end
-    end)
-  end
-
   @doc """
   general collect folder meta info
   """

lib/groupher_server_web/schema/Helper/mutations.ex

@@ -1,10 +1,31 @@
 defmodule GroupherServerWeb.Schema.Helper.Mutations do
   @moduledoc """
-  common fields
+  general mutations used for articles
+
+  e.g:
+  in schema/cms/mutation/post.ex
+
+  add following:
+  article_upvote_mutation(:post)
+
+  post will have two mutation endpoint:
+
+  upvote_post
+  unto_emotion_post
+
+  same for the job/repo .. article thread
   """
   alias GroupherServerWeb.Middleware, as: M
   alias GroupherServerWeb.Resolvers, as: R
 
+  @doc """
+  upvote mutation for article
+
+  include:
+  -----
+  upvote_[thread]
+  unto_emotion_[thread]
+  """
   defmacro article_upvote_mutation(thread) do
     quote do
       @desc unquote("upvote to #{thread}")
@@ -27,6 +48,14 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  pin mutation for article
+
+  include:
+  -----
+  pin_[thread]
+  unto_pin_[thread]
+  """
   defmacro article_pin_mutation(thread) do
     quote do
       @desc unquote("pin to #{thread}")
@@ -55,6 +84,14 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  mark delete mutation for article
+
+  include:
+  -----
+  mark_delete_[thread]
+  unto_mark_delete_[thread]
+  """
   defmacro article_mark_delete_mutation(thread) do
     quote do
       @desc unquote("mark delete a #{thread} type article, aka soft-delete")
@@ -81,6 +118,14 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  delete mutation for article
+
+  include:
+  -----
+  delete_[thread]
+  mark_delete_[thread]
+  """
   # TODO: if post belongs to multi communities, unset instead delete
   defmacro article_delete_mutation(thread) do
     quote do
@@ -97,6 +142,14 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  emotion mutation for article
+
+  include:
+  -----
+  emotion_to_[thread]
+  unto_emotion_to_[thread]
+  """
   defmacro article_emotion_mutation(thread) do
     quote do
       @desc unquote("emotion to #{thread}")
@@ -121,6 +174,14 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  report mutation for article
+
+  include:
+  -----
+  report_[thread]
+  undo_report_[thread]
+  """
   defmacro article_report_mutation(thread) do
     quote do
       @desc unquote("report a #{thread}")
@@ -145,6 +206,14 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  sink mutation for article
+
+  include:
+  -----
+  sink_[thread]
+  undo_sink_[thread]
+  """
   defmacro article_sink_mutation(thread) do
     quote do
       @desc unquote("sink a #{thread}")
@@ -173,9 +242,17 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
     end
   end
 
+  @doc """
+  lock comment of a article
+
+  include:
+  -----
+  lock_[thread]_comment
+  undo_lock_[thread]_comment
+  """
   defmacro article_lock_comment_mutation(thread) do
     quote do
-      @desc unquote("lock comment to a #{thread}")
+      @desc unquote("lock comment of a #{thread}")
       field unquote(:"lock_#{thread}_comment"), :article do
         arg(:id, non_null(:id))
         arg(:community_id, non_null(:id))