タグ履歴 (#309) (#319)

#309

#309

#309

#309

#309

Merge remote-tracking branch 'origin/main' into feature/309

#309

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

backend/app/controllers/nico_tags_controller.rb

@@ -30,15 +30,21 @@ class NicoTagsController < ApplicationController
     id = params[:id].to_i
 
     tag = Tag.find(id)
-    return head :bad_request if tag.category != 'nico'
+    return head :bad_request unless tag.nico?
 
-    linked_tag_names = params[:tags].to_s.split(' ')
+    linked_tag_names = params[:tags].to_s.split
     linked_tags = Tag.normalise_tags(linked_tag_names, with_tagme: false,
                                                        with_no_deerjikist: false)
-    return head :bad_request if linked_tags.any? { |t| t.category == 'nico' }
+    return head :bad_request if linked_tags.any? { |t| t.nico? }
 
-    tag.linked_tags = linked_tags
-    tag.save!
+    ApplicationRecord.transaction do
+      TagVersioning.record_tag_snapshots!(linked_tags, created_by_user: current_user)
+
+      tag.linked_tags = linked_tags
+      tag.save!
+
+      NicoTagVersionRecorder.record!(tag:, event_type: :update, created_by_user: current_user)
+    end
 
     render json: tag.linked_tags.map { |t| TagRepr.base(t) }, status: :ok
   end

backend/app/controllers/posts_controller.rb

@@ -128,9 +128,11 @@ class PostsController < ApplicationController
                     original_created_from:, original_created_before:)
     post.thumbnail.attach(thumbnail)
 
-    ActiveRecord::Base.transaction do
+    ApplicationRecord.transaction do
       post.save!
       tags = Tag.normalise_tags(tag_names)
+      TagVersioning.record_tag_snapshots!(tags, created_by_user: current_user)
+
       tags = Tag.expand_parent_tags(tags)
       sync_post_tags!(post, tags)
       post.resized_thumbnail!
@@ -170,10 +172,15 @@ class PostsController < ApplicationController
 
     post = Post.find(params[:id].to_i)
 
-    ActiveRecord::Base.transaction do
+    ApplicationRecord.transaction do
+      PostVersionRecorder.ensure_snapshot!(post, created_by_user: current_user)
+
       post.update!(title:, original_created_from:, original_created_before:)
-      tags = post.tags.where(category: 'nico').to_a +
-             Tag.normalise_tags(tag_names, with_tagme: false)
+
+      normalised_tags = Tag.normalise_tags(tag_names, with_tagme: false)
+      TagVersioning.record_tag_snapshots!(normalised_tags, created_by_user: current_user)
+
+      tags = post.tags.nico.to_a + normalised_tags
       tags = Tag.expand_parent_tags(tags)
       sync_post_tags!(post, tags)
       PostVersionRecorder.record!(post:, event_type: :update, created_by_user: current_user)

backend/app/controllers/tag_children_controller.rb

@@ -7,7 +7,16 @@ class TagChildrenController < ApplicationController
     child_id = params[:child_id]
     return head :bad_request if parent_id.blank? || child_id.blank?
 
-    Tag.find(parent_id).children << Tag.find(child_id) rescue nil
+    parent = Tag.find(parent_id)
+    child = Tag.find(child_id)
+    return head :bad_request if parent.nico? || child.nico?
+
+    ApplicationRecord.transaction do
+      TagVersioning.ensure_snapshot!(child, created_by_user: current_user)
+
+      TagImplication.find_or_create_by!(parent_tag: parent, tag: child)
+      TagVersionRecorder.record!(tag: child, event_type: :update, created_by_user: current_user)
+    end
 
     head :no_content
   end
@@ -20,7 +29,16 @@ class TagChildrenController < ApplicationController
     child_id = params[:child_id]
     return head :bad_request if parent_id.blank? || child_id.blank?
 
-    Tag.find(parent_id).children.delete(Tag.find(child_id)) rescue nil
+    parent = Tag.find(parent_id)
+    child = Tag.find(child_id)
+    return head :bad_request if parent.nico? || child.nico?
+
+    ApplicationRecord.transaction do
+      TagVersioning.ensure_snapshot!(child, created_by_user: current_user)
+
+      TagImplication.find_by(parent_tag: parent, tag: child)&.destroy!
+      TagVersionRecorder.record!(tag: child, event_type: :update, created_by_user: current_user)
+    end
 
     head :no_content
   end

backend/app/controllers/tags_controller.rb

@@ -218,15 +218,21 @@ class TagsController < ApplicationController
 
     tag = Tag.find(params[:id])
 
-    if name.present?
-      tag.tag_name.update!(name:)
+    if category.present? && tag.nico? != (category == 'nico')
+      return render json: { error: 'ニコタグのカテゴリ変更はできません．' },
+                    status: :unprocessable_entity
     end
 
-    if category.present?
-      tag.update!(category:)
+    ApplicationRecord.transaction do
+      TagVersioning.ensure_snapshot!(tag, created_by_user: current_user)
+
+      tag.tag_name.update!(name:) if name.present?
+      tag.update!(category:) if category.present?
+
+      record_tag_version!(tag, event_type: :update, created_by_user: current_user)
     end
 
-    render json: TagRepr.base(tag)
+    render json: TagRepr.base(tag.reload)
   end
 
   private
@@ -244,4 +250,12 @@ class TagsController < ApplicationController
         children: tag.children.sort_by { _1.name }.map { build_tag_children(_1) },
         material: material.as_json&.merge(file:, content_type:))
   end
+
+  def record_tag_version!(tag, event_type:, created_by_user:)
+    if tag.nico?
+      NicoTagVersionRecorder.record!(tag:, event_type:, created_by_user:)
+    else
+      TagVersionRecorder.record!(tag:, event_type:, created_by_user:)
+    end
+  end
 end

backend/app/models/my_discard.rb

@@ -1,7 +1,11 @@
 module MyDiscard
   extend ActiveSupport::Concern
 
-  included { include Discard::Model }
+  included do
+    include Discard::Model
+
+    default_scope -> { kept }
+  end
 
   class_methods do
     def find_undiscard_or_create_by! attrs, &block

backend/app/models/nico_tag_version.rb

@@ -0,0 +1,7 @@
+class NicoTagVersion < ApplicationRecord
+  include VersionRecord
+
+  belongs_to :tag
+
+  validates :name, presence: true
+end

backend/app/models/post_version.rb

@@ -1,29 +1,13 @@
 class PostVersion < ApplicationRecord
-  before_update do
-    raise ActiveRecord::ReadOnlyRecord, '版は更新できません．'
-  end
-
-  before_destroy do
-    raise ActiveRecord::ReadOnlyRecord, '版は削除できません．'
-  end
+  include VersionRecord
 
   belongs_to :post
   belongs_to :parent, class_name: 'Post', optional: true
-  belongs_to :created_by_user, class_name: 'User', optional: true
 
-  enum :event_type, { create: 'create',
-                      update: 'update',
-                      discard: 'discard',
-                      restore: 'restore' }, prefix: true, validate: true
-
-  validates :version_no, presence: true, numericality: { only_integer: true, greater_than: 0 }
-  validates :event_type, presence: true, inclusion: { in: event_types.keys }
   validates :url, presence: true
 
   validate :validate_original_created_range
 
-  scope :chronological, -> { order(:version_no, :id) }
-
   private
 
   def validate_original_created_range

backend/app/models/tag.rb

@@ -8,8 +8,6 @@ class Tag < ApplicationRecord
     ;
   end
 
-  default_scope -> { kept }
-
   has_many :post_tags, inverse_of: :tag
   has_many :active_post_tags, -> { kept }, class_name: 'PostTag', inverse_of: :tag
   has_many :post_tags_with_discarded, -> { with_discarded }, class_name: 'PostTag'
@@ -36,6 +34,9 @@ class Tag < ApplicationRecord
   has_many :deerjikists, dependent: :delete_all
   has_many :materials
 
+  has_many :tag_versions
+  has_many :nico_tag_versions
+
   belongs_to :tag_name
   delegate :wiki_page, to: :tag_name
 
@@ -78,25 +79,11 @@ class Tag < ApplicationRecord
 
   def material_id = materials.first&.id
 
-  def self.tagme
-    @tagme ||= find_or_create_by_tag_name!('タグ希望', category: :meta)
-  end
-
-  def self.bot
-    @bot ||= find_or_create_by_tag_name!('bot操作', category: :meta)
-  end
-
-  def self.no_deerjikist
-    @no_deerjikist ||= find_or_create_by_tag_name!('ニジラー情報不詳', category: :meta)
-  end
-
-  def self.video
-    @video ||= find_or_create_by_tag_name!('動画', category: :meta)
-  end
-
-  def self.niconico
-    @niconico ||= find_or_create_by_tag_name!('ニコニコ', category: :meta)
-  end
+  def self.tagme = find_or_create_by_tag_name!('タグ希望', category: :meta)
+  def self.bot = find_or_create_by_tag_name!('bot操作', category: :meta)
+  def self.no_deerjikist = find_or_create_by_tag_name!('ニジラー情報不詳', category: :meta)
+  def self.video = find_or_create_by_tag_name!('動画', category: :meta)
+  def self.niconico = find_or_create_by_tag_name!('ニコニコ', category: :meta)
 
   def self.normalise_tags tag_names, with_tagme: true,
                                      with_no_deerjikist: true,
@@ -152,21 +139,25 @@ class Tag < ApplicationRecord
     retry
   end
 
-  def self.merge_tags! target_tag, source_tags
+  def self.merge_tags! target_tag, source_tags, created_by_user: nil
     target_tag => Tag
 
     affected_post_ids = Set.new
 
     Tag.transaction do
+      TagVersioning.ensure_snapshot!(target_tag, created_by_user:)
+
       Array(source_tags).compact.uniq.each do |source_tag|
         source_tag => Tag
 
         next if source_tag == target_tag
 
+        TagVersioning.ensure_snapshot!(source_tag, created_by_user:)
+
         source_tag.post_tags.kept.find_each do |source_pt|
           post_id = source_pt.post_id
           affected_post_ids << post_id
-          source_pt.discard_by!(nil)
+          source_pt.discard_by!(created_by_user)
           unless PostTag.kept.exists?(post_id:, tag: target_tag)
             PostTag.create!(post_id:, tag: target_tag)
           end
@@ -178,6 +169,7 @@ class Tag < ApplicationRecord
           raise ActiveRecord::RecordInvalid.new(source_tag_name)
         end
 
+        TagVersioning.record!(source_tag, event_type: :discard, created_by_user:)
         source_tag.discard!
 
         if source_tag.nico?
@@ -186,10 +178,13 @@ class Tag < ApplicationRecord
           source_tag_name.update_columns(canonical_id: target_tag.tag_name_id,
                                          updated_at: Time.current)
         end
+
+        TagVersioning.record!(target_tag, event_type: :update, created_by_user:)
       end
 
       Post.where(id: affected_post_ids.to_a).find_each do |post|
-        PostVersionRecorder.record!(post:, event_type: :update, created_by_user: nil)
+        PostVersionRecorder.ensure_snapshot!(post, created_by_user:)
+        PostVersionRecorder.record!(post:, event_type: :update, created_by_user:)
       end
 
       # 投稿件数を再集計
@@ -199,6 +194,14 @@ class Tag < ApplicationRecord
     target_tag.reload
   end
 
+  def snapshot_aliases = tag_name.aliases.kept.order(:name).pluck(:name)
+
+  def snapshot_parent_tag_ids = parents.order(:id).pluck(:id)
+
+  def snapshot_linked_tag_names
+    linked_tags.joins(:tag_name).order('tag_names.name').pluck('tag_names.name')
+  end
+
   private
 
   def nico_tag_name_must_start_with_nico

backend/app/models/tag_name.rb

@@ -1,8 +1,6 @@
 class TagName < ApplicationRecord
   include MyDiscard
 
-  default_scope -> { kept }
-
   has_one :tag
   has_one :wiki_page
 

backend/app/models/tag_version.rb

@@ -0,0 +1,15 @@
+class TagVersion < ApplicationRecord
+  include VersionRecord
+
+  belongs_to :tag
+
+  enum :category, { deerjikist: 'deerjikist',
+                    meme: 'meme',
+                    character: 'character',
+                    general: 'general',
+                    material: 'material',
+                    meta: 'meta' }, validate: true
+
+  validates :name, presence: true
+  validates :category, presence: true
+end

backend/app/models/version_record.rb

@@ -0,0 +1,19 @@
+module VersionRecord
+  extend ActiveSupport::Concern
+
+  def readonly? = persisted?
+
+  included do
+    belongs_to :created_by_user, class_name: 'User', optional: true
+
+    enum :event_type, { create: 'create',
+                        update: 'update',
+                        discard: 'discard',
+                        restore: 'restore' }, prefix: true, validate: true
+
+    validates :version_no, presence: true, numericality: { only_integer: true, greater_than: 0 }
+    validates :event_type, presence: true
+
+    scope :chronological, -> { order(:version_no, :id) }
+  end
+end

backend/app/models/wiki_page.rb

@@ -4,8 +4,6 @@ require 'set'
 class WikiPage < ApplicationRecord
   include MyDiscard
 
-  default_scope -> { kept }
-
   has_many :wiki_revisions, dependent: :destroy
   belongs_to :created_user, class_name: 'User'
   belongs_to :updated_user, class_name: 'User'

backend/app/services/nico_tag_version_recorder.rb

@@ -0,0 +1,19 @@
+class NicoTagVersionRecorder < VersionRecorder
+  def self.record! tag:, event_type:, created_by_user:
+    new(tag:, event_type:, created_by_user:).record!
+  end
+
+  def initialize tag:, event_type:, created_by_user:
+    super(record: tag, event_type:, created_by_user:)
+  end
+
+  private
+
+  def version_class = NicoTagVersion
+  def version_association = :nico_tag_versions
+  def record_key = :tag
+
+  def snapshot_attributes
+    { name: @record.name, linked_tags: @record.snapshot_linked_tag_names.join(' ') }
+  end
+end

backend/app/services/post_version_recorder.rb

@@ -1,57 +1,31 @@
-class PostVersionRecorder
+class PostVersionRecorder < VersionRecorder
   def self.record! post:, event_type:, created_by_user:
     new(post:, event_type:, created_by_user:).record!
   end
 
   def initialize post:, event_type:, created_by_user:
-    @post = post
-    @event_type = event_type
-    @created_by_user = created_by_user
+    super(record: post, event_type:, created_by_user:)
   end
 
-  def record!
-    @post.with_lock do
-      latest = @post.post_versions.order(version_no: :desc).first
-      attrs = snapshot_attributes
+  def self.ensure_snapshot! post, created_by_user:
+    return if post.post_versions.exists?
 
-      return latest if @event_type == :update && latest && same_snapshot?(latest, attrs)
-
-      PostVersion.create!(
-          post: @post,
-          version_no: (latest&.version_no || 0) + 1,
-          event_type: @event_type,
-          title: attrs[:title],
-          url: attrs[:url],
-          thumbnail_base: attrs[:thumbnail_base],
-          tags: attrs[:tags],
-          parent: attrs[:parent],
-          original_created_from: attrs[:original_created_from],
-          original_created_before: attrs[:original_created_before],
-          created_at: Time.current,
-          created_by_user: @created_by_user)
-    end
+    record!(post:, event_type: :create, created_by_user:)
   end
 
   private
 
-  def snapshot_attributes
-    { title: @post.title,
-      url: @post.url,
-      thumbnail_base: @post.thumbnail_base,
-      tags: @post.snapshot_tag_names.join(' '),
-      parent: @post.parent,
-      original_created_from: @post.original_created_from,
-      original_created_before: @post.original_created_before }
-  end
+  def version_class = PostVersion
+  def version_association = :post_versions
+  def record_key = :post
 
-  def same_snapshot? version, attrs
-    true &&
-        version.title == attrs[:title] &&
-        version.url == attrs[:url] &&
-        version.thumbnail_base == attrs[:thumbnail_base] &&
-        version.tags == attrs[:tags] &&
-        version.parent_id == attrs[:parent]&.id &&
-        version.original_created_from == attrs[:original_created_from] &&
-        version.original_created_before == attrs[:original_created_before]
+  def snapshot_attributes
+    { title: @record.title,
+      url: @record.url,
+      thumbnail_base: @record.thumbnail_base,
+      tags: @record.snapshot_tag_names.join(' '),
+      parent_id: @record.parent_id,
+      original_created_from: @record.original_created_from,
+      original_created_before: @record.original_created_before }
   end
 end

backend/app/services/tag_version_recorder.rb

@@ -0,0 +1,22 @@
+class TagVersionRecorder < VersionRecorder
+  def self.record! tag:, event_type:, created_by_user:
+    new(tag:, event_type:, created_by_user:).record!
+  end
+
+  def initialize tag:, event_type:, created_by_user:
+    super(record: tag, event_type:, created_by_user:)
+  end
+
+  private
+
+  def version_class = TagVersion
+  def version_association = :tag_versions
+  def record_key = :tag
+
+  def snapshot_attributes
+    { name: @record.name,
+      category: @record.category,
+      aliases: @record.snapshot_aliases.join(' '),
+      parent_tag_ids: @record.snapshot_parent_tag_ids.join(' ') }
+  end
+end

backend/app/services/tag_versioning.rb

@@ -0,0 +1,38 @@
+class TagVersioning
+  def self.record! tag, event_type:, created_by_user:
+    if tag.nico?
+      NicoTagVersionRecorder.record!(tag:, event_type:, created_by_user:)
+    else
+      TagVersionRecorder.record!(tag:, event_type:, created_by_user:)
+    end
+  end
+
+  def self.ensure_snapshot! tag, created_by_user:
+    if tag.nico?
+      return if tag.nico_tag_versions.exists?
+
+      NicoTagVersionRecorder.record!(tag:, event_type: :create, created_by_user:)
+    else
+      return if tag.tag_versions.exists?
+
+      TagVersionRecorder.record!(tag:, event_type: :create, created_by_user:)
+    end
+  end
+
+  def self.record_tag_snapshot! tag, created_by_user:
+    event_type =
+        if tag.nico?
+          tag.nico_tag_versions.exists? ? :update : :create
+        else
+          tag.tag_versions.exists? ? :update : :create
+        end
+
+    record!(tag, event_type:, created_by_user:)
+  end
+
+  def self.record_tag_snapshots! tags, created_by_user:
+    tags.each do |tag|
+      record_tag_snapshot!(tag, created_by_user:)
+    end
+  end
+end

backend/app/services/version_recorder.rb

@@ -0,0 +1,62 @@
+class VersionRecorder
+  EVENT_TYPES = ['create', 'update', 'discard', 'restore'].freeze
+
+  def initialize record:, event_type:, created_by_user:
+    @record = record
+    @event_type = event_type.to_s
+    @created_by_user = created_by_user
+
+    validate_event_type!
+  end
+
+  def record!
+    raise "#{ record_class.name } must be persisted" unless @record.persisted?
+
+    ApplicationRecord.transaction do
+      @record = record_class.unscoped.lock.find(@record.id)
+      latest = latest_version
+
+      if !(latest) && @event_type != 'create'
+        raise "#{ version_class.name } first event must be create"
+      end
+
+      if @event_type == 'create' && latest
+        raise "#{ version_class.name } create event already exists"
+      end
+
+      attrs = snapshot_attributes
+
+      return latest if @event_type == 'update' && latest && same_snapshot?(latest, attrs)
+
+      version_class.create!(base_attributes(latest).merge(record_key => @record).merge(attrs))
+    end
+  end
+
+  private
+
+  def latest_version = versions.order(version_no: :desc).first
+
+  def versions = @record.public_send(version_association)
+
+  def base_attributes latest
+    { version_no: (latest&.version_no || 0) + 1,
+      event_type: @event_type,
+      created_at: Time.current,
+      created_by_user: @created_by_user }
+  end
+
+  def same_snapshot?(version, attrs) = attrs.all? { |k, v| version.public_send(k) == v }
+
+  def validate_event_type!
+    return if EVENT_TYPES.include?(@event_type)
+
+    raise ArgumentError, "Invalid event_type: #{ @event_type }"
+  end
+
+  def version_class = raise NotImplementedError
+  def version_association = raise NotImplementedError
+  def record_key = raise NotImplementedError
+  def snapshot_attributes = raise NotImplementedError
+
+  def record_class = @record.class
+end