タグ・グループを Wiki から分離 (#425) (#429)

Reviewed-on: #429
Co-authored-by: miteruzo <miteruzo@naver.com>

backend/app/controllers/tag_groups_controller.rb

@@ -0,0 +1,39 @@
+class TagGroupsController < ApplicationController
+  def index
+    groups = TagGroup.includes(:created_by_user, :updated_by_user).order(:id)
+    render json: TagGroupRepr.many(groups.to_a)
+  end
+
+  def show
+    group = TagGroup.includes(:created_by_user, :updated_by_user).find_by(id: params[:id])
+    return head :not_found unless group
+
+    render json: TagGroupRepr.one(group)
+  end
+
+  def create
+    return head :unauthorized unless current_user
+    return head :forbidden unless current_user.gte_member?
+
+    group = TagGroupOperation.create!(**write_attributes, actor: current_user)
+    render json: TagGroupRepr.one(group), status: :created
+  end
+
+  def update
+    return head :unauthorized unless current_user
+    return head :forbidden unless current_user.gte_member?
+
+    group = TagGroup.find_by(id: params[:id])
+    return head :not_found unless group
+
+    TagGroupOperation.update!(group:, **write_attributes, actor: current_user)
+    render json: TagGroupRepr.one(group.reload)
+  end
+
+  private
+
+  def write_attributes
+    { name: params[:name], description: params[:description],
+      members: params[:members], placements: params[:placements] }
+  end
+end

backend/app/controllers/wiki_pages_controller.rb

@@ -3,23 +3,27 @@ class WikiPagesController < ApplicationController
 
   def index
     # 互換性のための化石リソース
-    # TODO: ヘルプおよびタグ・グループ追加後に，
-    # TODO: タグ説明とヘルプ、タグ・グループから取得する作りに変更する．
-    #
+
     title = params[:title].to_s.strip
-    descriptions = TagDescription.where(language_code: 'ja')
+    descriptions =
+        TagDescription.where(language_code: 'ja')
         .includes(tag: :tag_names)
     pages = unmigrated_wiki_pages.includes(tag_name: :tag)
 
+    tag_groups = TagGroup.all
     if title.present?
       pattern = "%#{ ApplicationRecord.sanitize_sql_like(title) }%"
-      descriptions = descriptions.joins(tag: :tag_names)
+      descriptions =
+          descriptions.joins(tag: :tag_names)
           .where(tag_names: { language_code: 'ja', primary_flg: true })
           .where('tag_names.name LIKE ?', pattern).limit(20)
+      tag_groups = tag_groups.where(
+          'CONCAT(?, name) LIKE ?', TagGroupRepr::PREFIX, pattern).limit(20)
       pages = pages.where('tag_names.name LIKE ?', pattern).limit(20)
     end
 
     json = descriptions.map { |description| WikiPageRepr.tag_description(description) }
+    json.concat(tag_groups.map { WikiPageRepr.tag_group(_1) })
     json.concat(WikiPageRepr.base(pages))
     json = json.first(20) if title.present?
     render json:
@@ -30,6 +34,9 @@ class WikiPagesController < ApplicationController
 
     return render_wiki_page_by_tag_description tag_description if tag_description
 
+    tag_group = TagGroup.find_by(id: params[:id])
+    return render_tag_group tag_group if tag_group
+
     page = WikiPage.joins(:tag_name)
                    .includes(tag_name: :tag)
                    .find_by(id: params[:id])
@@ -40,25 +47,39 @@ class WikiPagesController < ApplicationController
   def show_by_title
     title = params[:title].to_s.strip
 
+    if title.start_with?(TagGroupRepr::PREFIX)
+      name = title.delete_prefix(TagGroupRepr::PREFIX)
+      tag_group = TagGroup.find_by(name:)
+      return render_tag_group tag_group if tag_group
+      return head :not_found
+    end
+
     tag_description = tag_description_by_title(title)
 
     return render_wiki_page_by_tag_description tag_description if tag_description
 
-    page = WikiPage.joins(:tag_name)
-                   .includes(tag_name: :tag)
-                   .find_by(tag_name: { name: title })
+    page =
+        WikiPage
+        .joins(:tag_name)
+        .includes(tag_name: :tag)
+        .find_by(tag_name: { name: title })
 
     render_wiki_page_or_404 page
   end
 
   def exists
     return head :no_content if TagDescription.exists?(id: params[:id])
+    return head :no_content if TagGroup.exists?(id: params[:id])
 
     head WikiPage.exists?(id: params[:id]) ? :no_content : :not_found
   end
 
   def exists_by_title
     title = params[:title].to_s.strip
+    if title.start_with?(TagGroupRepr::PREFIX)
+      exists = TagGroup.exists?(name: title.delete_prefix(TagGroupRepr::PREFIX))
+      return head exists ? :no_content : :not_found
+    end
     return head :no_content if tag_description_by_title(title)
 
     exists = WikiPage.joins(:tag_name).exists?(tag_names: { name: title })
@@ -79,29 +100,33 @@ class WikiPagesController < ApplicationController
       to_rev = to ? versions.find(to) : versions.find_by!(version_no: description.version_no)
       resource = WikiPageRepr.tag_description(description)
     else
-      page = WikiPage.joins(:tag_name).includes(tag_name: :tag).find(id)
-      from_rev = from && page.wiki_revisions.find(from)
-      to_rev = to ? page.wiki_revisions.find(to) : page.current_revision
-      if ((from_rev && !from_rev.content?) || !to_rev&.content?)
-        return render_unprocessable_entity('差分を表示できない版です．')
+      tag_group = TagGroup.find_by(id:)
+      if tag_group
+        from_rev = from && group_version(tag_group, from)
+        to_rev = to ? group_version(tag_group, to) : current_group_version(tag_group)
+        return head :not_found if (from && !from_rev) || !to_rev
+
+        from_body = from_rev && render_group_version(from_rev)
+        to_body = render_group_version(to_rev)
+        resource = { 'id' => tag_group.id,
+                     'title' => "#{ TagGroupRepr::PREFIX }#{ tag_group.name }",
+                     'deprecated_at' => nil }
+      else
+        page = WikiPage.joins(:tag_name).includes(tag_name: :tag).find(id)
+        from_rev = from && page.wiki_revisions.find(from)
+        to_rev = to ? page.wiki_revisions.find(to) : page.current_revision
+        if ((from_rev && !from_rev.content?) || !to_rev&.content?)
+          return render_unprocessable_entity('差分を表示できない版です．')
+        end
+        from_body = from_rev&.body
+        to_body = to_rev.body
+        resource = WikiPageRepr.base(page)
       end
-      resource = WikiPageRepr.base(page)
     end
 
-    diffs = Diff::LCS.sdiff(from_rev&.body&.lines || [], to_rev.body.lines)
-    diff_json = diffs.map { |change|
-      case change.action
-      when ?=
-        { type: 'context', content: change.old_element }
-      when ?!
-        [{ type: 'removed', content: change.old_element },
-         { type: 'added', content: change.new_element }]
-      when ?+
-        { type: 'added', content: change.new_element }
-      when ?-
-        { type: 'removed', content: change.old_element }
-      end
-    }.flatten.compact
+    from_body ||= from_rev&.body
+    to_body ||= to_rev.body
+    diff_json = wiki_diff(from_body, to_body)
 
     render json: { wiki_page_id:      resource.fetch('id'),
                    title:             resource.fetch('title'),
@@ -109,6 +134,8 @@ class WikiPagesController < ApplicationController
                    older_revision_id: from_rev&.id,
                    newer_revision_id: to_rev.id,
                    diff:              diff_json }
+  rescue TagGroupMarkdownRenderer::UnsupportedStructure => error
+    render_unprocessable_entity(error.message)
   end
 
   def create
@@ -122,6 +149,17 @@ class WikiPagesController < ApplicationController
     return render_unprocessable_entity('タイトルは必須です．', field: :title) if title.blank?
     return render_unprocessable_entity('本文は必須です．', field: :body) if body.blank?
 
+    if title.start_with?(TagGroupRepr::PREFIX)
+      name = title.delete_prefix(TagGroupRepr::PREFIX)
+      parsed = TagGroupMarkdownParser.parse(body:, group: nil)
+      group = TagGroupOperation.create!(name:, **parsed, actor: current_user,
+                                         require_compatibility: true)
+      version = current_group_version(group)
+      return render_group_representation(TagGroupRepr.one(group), version,
+                                         body: parsed.fetch(:compatibility_body),
+                                         status: :created)
+    end
+
     page = if title.include?(':')
       ApplicationRecord.transaction do
         tag_name = TagName.find_or_create_by!(language_code: 'ja', name: title) do |name|
@@ -146,6 +184,8 @@ class WikiPagesController < ApplicationController
     render_validation_error e.record
   rescue ActiveRecord::RecordNotUnique
     render_record_not_unique
+  rescue TagGroupMarkdownParser::InvalidDocument => error
+    render_unprocessable_entity(error.message)
   end
 
   def update
@@ -158,7 +198,26 @@ class WikiPagesController < ApplicationController
     return render_unprocessable_entity('タイトルは必須です．', field: :title) if title.blank?
     return render_unprocessable_entity('本文は必須です．', field: :body) if body.blank?
 
-    page = WikiPage.find(params[:id])
+    group = TagGroup.find_by(id: params[:id])
+    if title.start_with?(TagGroupRepr::PREFIX)
+      return head :not_found unless group
+
+      name = title.delete_prefix(TagGroupRepr::PREFIX)
+      parsed = TagGroupMarkdownParser.parse(body:, group:)
+      TagGroupOperation.update!(group:, name:, **parsed, actor: current_user,
+                                require_compatibility: true)
+      return head :ok
+    end
+
+    page = WikiPage.find_by(id: params[:id])
+    if legacy_group_page?(page)
+      return render_unprocessable_entity field: :title
+    end
+    if group && !legacy_update_identified?(page, title, group)
+      return render_unprocessable_entity field: :title
+    end
+    return head :not_found unless page
+
     base_revision_id = params[:base_revision_id].presence
 
     ApplicationRecord.transaction do
@@ -175,11 +234,17 @@ class WikiPagesController < ApplicationController
       page.tag_name.update!(name: title) if title != old_title
 
       message = params[:message].presence
-      Wiki::Commit.content!(page:,
-                            body:,
-                            created_user: current_user,
-                            message:,
-                            base_revision_id:)
+      description = TagDescription.find_by(id: page.id)
+      description_page = description && (
+          tag&.id == description.tag_id ||
+          (tag.nil? && !old_title.include?(':')))
+      if description && !description_page
+        Wiki::Commit.legacy_content!(page:, body:, created_user: current_user,
+                                     message:, base_revision_id:)
+      else
+        Wiki::Commit.content!(page:, body:, created_user: current_user,
+                              message:, base_revision_id:)
+      end
 
       if tag && title != old_title
         tag.reload
@@ -188,6 +253,12 @@ class WikiPagesController < ApplicationController
     end
 
     head :ok
+  rescue ActiveRecord::RecordInvalid => e
+    render_validation_error e.record
+  rescue ActiveRecord::RecordNotUnique
+    render_record_not_unique
+  rescue TagGroupMarkdownParser::InvalidDocument => error
+    render_unprocessable_entity(error.message)
   end
 
   def changes
@@ -197,6 +268,11 @@ class WikiPagesController < ApplicationController
       return render json: description_changes(TagDescription.where(id: description.id))
     end
 
+    tag_group = id && TagGroup.find_by(id:)
+    if tag_group
+      return render json: tag_group_changes(TagGroupVersion.where(tag_group_id: tag_group.id))
+    end
+
     pages = id ? WikiPage.where(id:) : unmigrated_wiki_pages
     revisions = WikiRevision.joins(wiki_page: :tag_name)
         .where(wiki_page_id: pages.select(:id))
@@ -215,14 +291,122 @@ class WikiPagesController < ApplicationController
         timestamp: rev.created_at }
     }
     unless id
+      json.concat(tag_group_changes(TagGroupVersion.all))
       json.concat(description_changes(TagDescription.where(language_code: 'ja')))
-      json.sort_by! { |row| -row[:revision_id] }
+      json = json.each_with_index.sort_by do |row, index|
+        [-row.fetch(:timestamp).to_f, index]
+      end.map(&:first)
     end
     render json: json.first(200)
   end
 
   private
 
+  def legacy_group_page? page
+    return false unless page
+    return true if page.title.start_with?(TagGroupRepr::PREFIX)
+
+    prefix = ApplicationRecord.sanitize_sql_like(TagGroupRepr::PREFIX)
+    page.wiki_versions.where('title LIKE ?', "#{ prefix }%").exists?
+  end
+
+  def legacy_update_identified? page, title, group
+    return false unless page
+    return true if page.title == title
+    return false if title == group.name
+
+    namespace = page.title.split(':', 2)
+    return true if namespace.size == 2 && title.start_with?("#{ namespace.first }:")
+
+    base = params[:base_revision_id].presence
+    base && page.wiki_revisions.exists?(id: base)
+  end
+
+  def render_tag_group group
+    version = if params[:version].present?
+      group_version(group, params[:version])
+    else
+      current_group_version(group)
+    end
+    return head :not_found unless version
+
+    representation = if params[:version].present?
+      TagGroupRepr.historical(version)
+    else
+      TagGroupRepr.one(group)
+    end
+    render_group_representation(representation, version)
+  end
+
+  def render_group_version version
+    representation = TagGroupRepr.historical(version)
+    TagGroupMarkdownRenderer.render(representation)
+  end
+
+  def render_group_representation representation, version, body: nil, status: :ok
+    body ||= TagGroupMarkdownRenderer.render(representation)
+    versions = TagGroupVersion.where(tag_group_id: version.tag_group_id)
+    pred = versions.find_by(version_no: version.version_no - 1)&.id
+    succ = versions.find_by(version_no: version.version_no + 1)&.id
+    updated_at = version.created_at
+    render json: {
+        'id' => version.tag_group_id,
+        'title' => "#{ TagGroupRepr::PREFIX }#{ representation.fetch('name') }",
+        'deprecated_at' => nil,
+        'body' => body,
+        'revision_id' => version.id,
+        'pred' => pred,
+        'succ' => succ,
+        'updated_at' => updated_at }, status:
+  rescue TagGroupMarkdownRenderer::UnsupportedStructure => error
+    render_unprocessable_entity(error.message)
+  end
+
+  def current_group_version group
+    TagGroupVersion.find_by(tag_group_id: group.id, version_no: group.version_no)
+  end
+
+  def group_version group, version_id
+    TagGroupVersion.find_by(tag_group_id: group.id, id: version_id)
+  end
+
+  def wiki_diff from_body, to_body
+    diffs = Diff::LCS.sdiff(from_body.to_s.lines, to_body.to_s.lines)
+    diffs.map { |change|
+      case change.action
+      when ?=
+        { type: 'context', content: change.old_element }
+      when ?!
+        [{ type: 'removed', content: change.old_element },
+         { type: 'added', content: change.new_element }]
+      when ?+
+        { type: 'added', content: change.new_element }
+      when ?-
+        { type: 'removed', content: change.old_element }
+      end
+    }.flatten.compact
+  end
+
+  def tag_group_changes versions
+    rows = versions.includes(:created_by_user).order(id: :desc).limit(200).to_a
+    groups = TagGroup.where(id: rows.map(&:tag_group_id).uniq).index_by(&:id)
+    predecessors = TagGroupVersion.where(tag_group_id: groups.keys,
+                                         version_no: rows.map { _1.version_no - 1 })
+        .pluck(:tag_group_id, :version_no, :id)
+        .to_h { |group_id, number, version_id| [[group_id, number], version_id] }
+    rows.map do |version|
+      group = groups.fetch(version.tag_group_id)
+      user = version.created_by_user
+      { revision_id: version.id,
+        pred: predecessors[[group.id, version.version_no - 1]],
+        succ: nil,
+        wiki_page: { id: group.id, title: "#{ TagGroupRepr::PREFIX }#{ version.name }",
+                     deprecated_at: nil },
+        user: user && { id: user.id, name: user.name },
+        kind: 'content', message: nil, timestamp: version.created_at }
+    end
+  end
+
   def render_wiki_page_or_404 page
     return head :not_found unless page
 
@@ -271,7 +455,10 @@ class WikiPagesController < ApplicationController
 
   def unmigrated_wiki_pages
     descriptions = TagDescription.where(language_code: 'ja')
-    WikiPage.joins(:tag_name).where.not(id: descriptions.select(:id))
+
+    WikiPage
+        .joins(:tag_name)
+        .where.not('tag_names.name LIKE ?', "#{ TagGroupRepr::PREFIX }%")
         .where('tag_names.tag_id IS NULL OR tag_names.tag_id NOT IN (?)',
                descriptions.select(:tag_id))
   end