feat: Guide thread (#416)

* chore(guide): basic migration & model setup

* chore(guide): tests

* chore(guide): typo

* chore(guide): fix migration schema

Author: mydearxym

config/config.exs

@@ -69,7 +69,7 @@ config :groupher_server, :article,
   min_length: 10,
   max_length: 20_000,
   # NOTE: do not change unless you know what you are doing
-  threads: [:post, :job, :repo, :blog, :works, :radar],
+  threads: [:post, :job, :repo, :blog, :works, :radar, :guide],
   # in this period, paged articles will sort front if non-article-author commented
   # 在此时间段内，一旦有非文章作者的用户评论，该文章就会排到前面
   active_period_days: %{
@@ -78,7 +78,8 @@ config :groupher_server, :article,
     repo: 10,
     blog: 10,
     works: 10,
-    radar: 10
+    radar: 10,
+    guide: 10
   },
 
   # NOTE: if you want to add/remove emotion, just edit the list below

lib/groupher_server/cms/models/guide.ex

@@ -0,0 +1,48 @@
+defmodule GroupherServer.CMS.Model.Guide do
+  @moduledoc false
+  alias __MODULE__
+
+  use Ecto.Schema
+  use Accessible
+
+  import Ecto.Changeset
+  import GroupherServer.CMS.Helper.Macros
+
+  alias GroupherServer.CMS
+  alias CMS.Model.Embeds
+
+  @timestamps_opts [type: :utc_datetime_usec]
+
+  @required_fields ~w(title digest)a
+  @article_cast_fields general_article_cast_fields()
+  @optional_fields @article_cast_fields
+
+  @type t :: %Guide{}
+  schema "cms_guides" do
+    article_tags_field(:guide)
+    article_communities_field(:guide)
+    general_article_fields(:guide)
+  end
+
+  @doc false
+  def changeset(%Guide{} = guide, attrs) do
+    guide
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> validate_required(@required_fields)
+    |> cast_embed(:meta, required: false, with: &Embeds.ArticleMeta.changeset/2)
+    |> generl_changeset
+  end
+
+  @doc false
+  def update_changeset(%Guide{} = guide, attrs) do
+    guide
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> generl_changeset
+  end
+
+  defp generl_changeset(changeset) do
+    changeset
+    |> validate_length(:title, min: 3, max: 50)
+    |> cast_embed(:emotions, with: &Embeds.ArticleEmotion.changeset/2)
+  end
+end

lib/groupher_server/cms/models/guide_document.ex

@@ -0,0 +1,47 @@
+defmodule GroupherServer.CMS.Model.GuideDocument do
+  @moduledoc """
+  mainly for full-text search
+  """
+  alias __MODULE__
+
+  use Ecto.Schema
+  use Accessible
+
+  import Ecto.Changeset
+  import Helper.Utils, only: [get_config: 2]
+
+  alias GroupherServer.CMS
+  alias CMS.Model.Guide
+
+  @timestamps_opts [type: :utc_datetime_usec]
+
+  @max_body_length get_config(:article, :max_length)
+  @min_body_length get_config(:article, :min_length)
+
+  @required_fields ~w(body body_html guide_id)a
+  @optional_fields []
+
+  @type t :: %GuideDocument{}
+  schema "guide_documents" do
+    belongs_to(:guide, Guide, foreign_key: :guide_id)
+
+    field(:body, :string)
+    field(:body_html, :string)
+    field(:toc, :map)
+  end
+
+  @doc false
+  def changeset(%GuideDocument{} = guide, attrs) do
+    guide
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> validate_required(@required_fields)
+    |> validate_length(:body, min: @min_body_length, max: @max_body_length)
+  end
+
+  @doc false
+  def update_changeset(%GuideDocument{} = guide, attrs) do
+    guide
+    |> cast(attrs, @optional_fields ++ @required_fields)
+    |> validate_length(:body, min: @min_body_length, max: @max_body_length)
+  end
+end

lib/groupher_server_web/schema/cms/cms_metrics.ex

@@ -212,6 +212,13 @@ defmodule GroupherServerWeb.Schema.CMS.Metrics do
     field(:sort, :sort_enum)
   end
 
+  @desc "guide_filter doc"
+  input_object :paged_guides_filter do
+    pagination_args()
+    article_filter_fields()
+    field(:sort, :sort_enum)
+  end
+
   @desc "article_filter doc"
   input_object :paged_repos_filter do
     @desc "limit of records (default 20), if first > 30, only return 30 at most"

lib/groupher_server_web/schema/cms/cms_types.ex

@@ -117,6 +117,18 @@ defmodule GroupherServerWeb.Schema.CMS.Types do
     timestamp_fields(:article)
   end
 
+  object :guide do
+    interface(:article)
+
+    general_article_fields()
+    comments_fields()
+
+    field(:length, :integer)
+    field(:link_addr, :string)
+
+    timestamp_fields(:article)
+  end
+
   object :repo do
     interface(:article)
 

lib/groupher_server_web/schema/cms/mutations/guide.ex

@@ -0,0 +1,52 @@
+defmodule GroupherServerWeb.Schema.CMS.Mutations.Guide do
+  @moduledoc """
+  CMS mutations for guide
+  """
+  use Helper.GqlSchemaSuite
+  import GroupherServerWeb.Schema.Helper.Mutations
+
+  object :cms_guide_mutations do
+    @desc "create a guide"
+    field :create_guide, :guide do
+      arg(:title, non_null(:string))
+      arg(:body, non_null(:string))
+      arg(:digest, non_null(:string))
+      arg(:community_id, non_null(:id))
+      arg(:thread, :thread, default_value: :guide)
+      arg(:article_tags, list_of(:id))
+
+      middleware(M.Authorize, :login)
+      middleware(M.PublishThrottle)
+      resolve(&R.CMS.create_article/3)
+      middleware(M.Statistics.MakeContribute, for: [:user, :community])
+    end
+
+    @desc "update a cms/guide"
+    field :update_guide, :guide do
+      arg(:id, non_null(:id))
+      arg(:title, :string)
+      arg(:body, :string)
+      arg(:digest, :string)
+
+      arg(:article_tags, list_of(:id))
+      # ...
+
+      middleware(M.Authorize, :login)
+      middleware(M.PassportLoader, source: :guide)
+      middleware(M.Passport, claim: "owner;cms->c?->guide.edit")
+
+      resolve(&R.CMS.update_article/3)
+    end
+
+    article_react_mutations(:guide, [
+      :upvote,
+      :pin,
+      :mark_delete,
+      :delete,
+      :emotion,
+      :report,
+      :sink,
+      :lock_comment
+    ])
+  end
+end

priv/repo/migrations/20210626054252_create_guide.exs

@@ -0,0 +1,32 @@
+defmodule GroupherServer.Repo.Migrations.CreateGuide do
+  use Ecto.Migration
+
+  def change do
+    create table(:cms_guides) do
+      add(:thread, :string)
+      add(:title, :string)
+      add(:digest, :string)
+      add(:views, :integer, default: 0)
+      add(:mark_delete, :boolean, default: false)
+      add(:meta, :map)
+      add(:emotions, :map)
+      add(:original_community_id, references(:communities, on_delete: :delete_all))
+      add(:author_id, references(:cms_authors, on_delete: :delete_all), null: false)
+
+      add(:active_at, :utc_datetime)
+
+      # reaction
+      add(:upvotes_count, :integer, default: 0)
+      add(:collects_count, :integer, default: 0)
+
+      # comments
+      add(:comments_participants_count, :integer, default: 0)
+      add(:comments_count, :integer, default: 0)
+      add(:comments_participants, :map)
+
+      timestamps()
+    end
+
+    create(index(:cms_guides, [:author_id]))
+  end
+end

priv/repo/migrations/20210626054616_create_guide_document.exs

@@ -0,0 +1,13 @@
+defmodule GroupherServer.Repo.Migrations.CreateGuideDocument do
+  use Ecto.Migration
+
+  def change do
+    create table(:guide_documents) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all), null: false)
+      add(:body, :text)
+      add(:body_html, :text)
+      add(:markdown, :text)
+      add(:toc, :map)
+    end
+  end
+end

priv/repo/migrations/20210626054717_create_communities_join_guides.exs

@@ -0,0 +1,12 @@
+defmodule GroupherServer.Repo.Migrations.CreateCommunitiesJoinGuides do
+  use Ecto.Migration
+
+  def change do
+    create table(:communities_join_guides) do
+      add(:community_id, references(:communities, on_delete: :delete_all), null: false)
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all), null: false)
+    end
+
+    create(unique_index(:communities_join_guides, [:community_id, :guide_id]))
+  end
+end

priv/repo/migrations/20210626054903_add_guide_id_to_others.exs

@@ -0,0 +1,41 @@
+defmodule GroupherServer.Repo.Migrations.AddGuideIdToOthers do
+  use Ecto.Migration
+
+  def change do
+    alter table(:articles_join_tags) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:abuse_reports) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:article_collects) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:article_upvotes) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:comments) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:pinned_comments) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:articles_users_emotions) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:pinned_articles) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+
+    alter table(:cited_artiments) do
+      add(:guide_id, references(:cms_guides, on_delete: :delete_all))
+    end
+  end
+end