chore(comments): article comments naming (#412)

* refactor(naming): paged_folded_comments

* refactor(naming): drop article prefix in comments action

Author: mydearxym

lib/groupher_server/cms/cms.ex

@@ -137,8 +137,8 @@ defmodule GroupherServer.CMS do
   defdelegate paged_published_comments(user, thread, filters), to: CommentCurd
   defdelegate paged_published_comments(user, filters), to: CommentCurd
 
-  defdelegate paged_folded_article_comments(thread, article_id, filters), to: CommentCurd
-  defdelegate paged_folded_article_comments(thread, article_id, filters, user), to: CommentCurd
+  defdelegate paged_folded_comments(thread, article_id, filters), to: CommentCurd
+  defdelegate paged_folded_comments(thread, article_id, filters, user), to: CommentCurd
 
   defdelegate paged_comment_replies(comment_id, filters), to: CommentCurd
   defdelegate paged_comment_replies(comment_id, filters, user), to: CommentCurd
@@ -154,14 +154,14 @@ defmodule GroupherServer.CMS do
   defdelegate upvote_comment(comment_id, user), to: CommentAction
   defdelegate undo_upvote_comment(comment_id, user), to: CommentAction
   defdelegate reply_comment(comment_id, args, user), to: CommentAction
-  defdelegate lock_article_comment(thread, article_id), to: CommentAction
-  defdelegate undo_lock_article_comment(thread, article_id), to: CommentAction
+  defdelegate lock_article_comments(thread, article_id), to: CommentAction
+  defdelegate undo_lock_article_comments(thread, article_id), to: CommentAction
 
   defdelegate pin_comment(comment_id), to: CommentAction
   defdelegate undo_pin_comment(comment_id), to: CommentAction
 
-  defdelegate fold_article_comment(comment_id, user), to: CommentAction
-  defdelegate unfold_article_comment(comment_id, user), to: CommentAction
+  defdelegate fold_comment(comment_id, user), to: CommentAction
+  defdelegate unfold_comment(comment_id, user), to: CommentAction
 
   defdelegate emotion_to_comment(comment_id, args, user), to: CommentEmotion
   defdelegate undo_emotion_to_comment(comment_id, args, user), to: CommentEmotion
@@ -172,12 +172,12 @@ defmodule GroupherServer.CMS do
 
   # TODO: move report to abuse report module
   defdelegate report_article(thread, article_id, reason, attr, user), to: AbuseReport
-  defdelegate report_article_comment(comment_id, reason, attr, user), to: AbuseReport
+  defdelegate report_comment(comment_id, reason, attr, user), to: AbuseReport
   defdelegate report_account(account_id, reason, attr, user), to: AbuseReport
   defdelegate undo_report_account(account_id, user), to: AbuseReport
   defdelegate undo_report_article(thread, article_id, user), to: AbuseReport
   defdelegate paged_reports(filter), to: AbuseReport
-  defdelegate undo_report_article_comment(comment_id, user), to: AbuseReport
+  defdelegate undo_report_comment(comment_id, user), to: AbuseReport
 
   # Passport CURD
   defdelegate stamp_passport(rules, user), to: PassportCURD

lib/groupher_server/cms/delegates/abuse_report.ex

@@ -172,7 +172,7 @@ defmodule GroupherServer.CMS.Delegate.AbuseReport do
   end
 
   @doc "report a comment"
-  def report_article_comment(comment_id, reason, attr, %User{} = user) do
+  def report_comment(comment_id, reason, attr, %User{} = user) do
     with {:ok, comment} <- ORM.find(Comment, comment_id) do
       Multi.new()
       |> Multi.run(:create_abuse_report, fn _, _ ->
@@ -184,15 +184,15 @@ defmodule GroupherServer.CMS.Delegate.AbuseReport do
       end)
       |> Multi.run(:fold_comment_report_too_many, fn _, %{create_abuse_report: abuse_report} ->
         if abuse_report.report_cases_count >= @report_threshold_for_fold,
-          do: CMS.fold_article_comment(comment, user),
+          do: CMS.fold_comment(comment, user),
           else: {:ok, comment}
       end)
       |> Repo.transaction()
       |> result()
     end
   end
 
-  def undo_report_article_comment(comment_id, %User{} = user) do
+  def undo_report_comment(comment_id, %User{} = user) do
     undo_report_article(:comment, comment_id, user)
   end
 

lib/groupher_server/cms/delegates/comment_action.ex

@@ -81,19 +81,19 @@ defmodule GroupherServer.CMS.Delegate.CommentAction do
   end
 
   @doc "fold a comment"
-  def fold_article_comment(%Comment{} = comment, %User{} = _user) do
+  def fold_comment(%Comment{} = comment, %User{} = _user) do
     comment |> ORM.update(%{is_folded: true})
   end
 
   @doc "fold a comment"
-  def fold_article_comment(comment_id, %User{} = _user) do
+  def fold_comment(comment_id, %User{} = _user) do
     with {:ok, comment} <- ORM.find(Comment, comment_id) do
       comment |> ORM.update(%{is_folded: true})
     end
   end
 
   @doc "unfold a comment"
-  def unfold_article_comment(comment_id, %User{} = _user) do
+  def unfold_comment(comment_id, %User{} = _user) do
     with {:ok, comment} <- ORM.find(Comment, comment_id) do
       comment |> ORM.update(%{is_folded: false})
     end
@@ -145,7 +145,7 @@ defmodule GroupherServer.CMS.Delegate.CommentAction do
       |> Repo.transaction()
       |> result()
     else
-      false -> raise_error(:article_comment_locked, "this article is forbid comment")
+      false -> raise_error(:article_comments_locked, "this article is forbid comment")
       {:error, error} -> {:error, error}
     end
   end
@@ -228,7 +228,7 @@ defmodule GroupherServer.CMS.Delegate.CommentAction do
   end
 
   @doc "lock comment of a article"
-  def lock_article_comment(thread, id) do
+  def lock_article_comments(thread, id) do
     with {:ok, info} <- match(thread),
          {:ok, article} <- ORM.find(info.model, id) do
       article_meta = ensure(article.meta, @default_article_meta)
@@ -239,7 +239,7 @@ defmodule GroupherServer.CMS.Delegate.CommentAction do
   end
 
   @doc "undo lock comment of a article"
-  def undo_lock_article_comment(thread, id) do
+  def undo_lock_article_comments(thread, id) do
     with {:ok, info} <- match(thread),
          {:ok, article} <- ORM.find(info.model, id) do
       article_meta = ensure(article.meta, @default_article_meta)

lib/groupher_server/cms/delegates/comment_curd.ex

@@ -83,12 +83,12 @@ defmodule GroupherServer.CMS.Delegate.CommentCurd do
     |> done()
   end
 
-  def paged_folded_article_comments(thread, article_id, filters) do
+  def paged_folded_comments(thread, article_id, filters) do
     where_query = dynamic([c], c.is_folded and not c.is_pinned)
     do_paged_comment(thread, article_id, filters, where_query, nil)
   end
 
-  def paged_folded_article_comments(thread, article_id, filters, user) do
+  def paged_folded_comments(thread, article_id, filters, user) do
     where_query = dynamic([c], c.is_folded and not c.is_pinned)
     do_paged_comment(thread, article_id, filters, where_query, user)
   end
@@ -153,7 +153,7 @@ defmodule GroupherServer.CMS.Delegate.CommentCurd do
       |> Repo.transaction()
       |> result()
     else
-      false -> raise_error(:article_comment_locked, "this article is forbid comment")
+      false -> raise_error(:article_comments_locked, "this article is forbid comment")
       {:error, error} -> {:error, error}
     end
   end

lib/groupher_server/cms/delegates/hooks/cite.ex

@@ -20,7 +20,7 @@ defmodule GroupherServer.CMS.Delegate.Hooks.Cite do
 
   cited_type: thread or comment
   artiment: article or comment
-  # cited_article_comment_id, [xxx_article]_id, [block_id, block2_id, ...],
+  # cited_comment_id, [xxx_article]_id, [block_id, block2_id, ...],
 
   注意 cited_by_type 不能命名为 cited_by_thread
 

lib/groupher_server/cms/models/comment.ex

@@ -35,7 +35,7 @@ defmodule GroupherServer.CMS.Model.Comment do
   # 每篇文章最多含有置顶评论的条数
   @pinned_comment_limit 10
 
-  @doc "latest participants stores in article article_comment_participants field"
+  @doc "latest participants stores in article comment_participants field"
   def max_participator_count(), do: @max_participator_count
   @doc "latest replies stores in comment replies field, used for frontend display"
   def max_parent_replies_count(), do: @max_parent_replies_count

lib/groupher_server/cms/models/comment_upvote.ex

@@ -21,8 +21,8 @@ defmodule GroupherServer.CMS.Model.CommentUpvote do
   end
 
   @doc false
-  def changeset(%CommentUpvote{} = article_comment_upvote, attrs) do
-    article_comment_upvote
+  def changeset(%CommentUpvote{} = comment_upvote, attrs) do
+    comment_upvote
     |> cast(attrs, @required_fields)
     |> validate_required(@required_fields)
     |> foreign_key_constraint(:comment_id)

lib/groupher_server_web/resolvers/cms_resolver.ex

@@ -111,10 +111,11 @@ defmodule GroupherServerWeb.Resolvers.CMS do
   # #######################
   # thread reaction ..
   # #######################
-  def lock_article_comment(_root, ~m(id thread)a, _info), do: CMS.lock_article_comment(thread, id)
+  def lock_article_comments(_root, ~m(id thread)a, _info),
+    do: CMS.lock_article_comments(thread, id)
 
-  def undo_lock_article_comment(_root, ~m(id thread)a, _info) do
-    CMS.undo_lock_article_comment(thread, id)
+  def undo_lock_article_comments(_root, ~m(id thread)a, _info) do
+    CMS.undo_lock_article_comments(thread, id)
   end
 
   def sink_article(_root, ~m(id thread)a, _info), do: CMS.sink_article(thread, id)

lib/groupher_server_web/schema/Helper/mutations.ex

@@ -261,7 +261,7 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
         middleware(M.Authorize, :login)
         middleware(M.PassportLoader, source: :community)
         middleware(M.Passport, claim: unquote("cms->c?->#{to_string(thread)}.lock_comment"))
-        resolve(&R.CMS.lock_article_comment/3)
+        resolve(&R.CMS.lock_article_comments/3)
       end
 
       @desc unquote("undo lock to a #{thread}")
@@ -273,7 +273,7 @@ defmodule GroupherServerWeb.Schema.Helper.Mutations do
         middleware(M.Authorize, :login)
         middleware(M.PassportLoader, source: :community)
         middleware(M.Passport, claim: unquote("cms->c?->#{to_string(thread)}.undo_lock_comment"))
-        resolve(&R.CMS.undo_lock_article_comment/3)
+        resolve(&R.CMS.undo_lock_article_comments/3)
       end
     end
   end

lib/groupher_server_web/schema/cms/cms_types.ex

@@ -246,7 +246,7 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
     emotion_fields()
   end
 
-  object :article_comment_meta do
+  object :comment_meta do
     field(:is_article_author_upvoted, :boolean)
     field(:is_reply_to_others, :boolean)
 
@@ -263,7 +263,7 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
     field(:upvotes_count, :integer)
     field(:is_article_author, :boolean)
     field(:emotions, :comment_emotions)
-    field(:meta, :article_comment_meta)
+    field(:meta, :comment_meta)
     field(:replies_count, :integer)
     field(:reply_to, :comment_reply)
     field(:viewer_has_upvoted, :boolean)
@@ -281,7 +281,7 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
     field(:upvotes_count, :integer)
     field(:emotions, :comment_emotions)
     field(:is_article_author, :boolean)
-    field(:meta, :article_comment_meta)
+    field(:meta, :comment_meta)
     field(:reply_to, :comment_reply)
     field(:replies, list_of(:comment_reply))
     field(:replies_count, :integer)