discourse/lib/validators/quality_title_validator.rb

# frozen_string_literal: true

require "text_sentinel"
require "text_cleaner"

class QualityTitleValidator < ActiveModel::EachValidator
  def validate_each(record, attribute, value)
    return if Discourse.static_doc_topic_ids.include?(record.id) && record.acting_user&.admin?

    sentinel = TextSentinel.title_sentinel(value)

    if !sentinel.valid?
      if !sentinel.seems_meaningful?
        record.errors.add(attribute, :is_invalid_meaningful)
      elsif !sentinel.seems_unpretentious?
        record.errors.add(attribute, :is_invalid_unpretentious)
      elsif !sentinel.seems_quiet?
        record.errors.add(attribute, :is_invalid_quiet)
      else
        record.errors.add(attribute, :is_invalid)
      end
    end
  end
end
DEV: enable frozen string literal on all files This reduces chances of errors where consumers of strings mutate inputs and reduces memory usage of the app. Test suite passes now, but there may be some stuff left, so we will run a few sites on a branch prior to merging 2019-05-03 06:17:27 +08:00			`# frozen_string_literal: true`

refactor Topic validation introduce a couple of custom validators fix minor discrepancies in tests copy I18n error message keys to default location clean up validation invocation move some responsibilities out of validator into class 2013-05-23 12:52:12 +08:00			`require "text_sentinel"`
			`require "text_cleaner"`

			`class QualityTitleValidator < ActiveModel::EachValidator`
			`def validate_each(record, attribute, value)`
FIX: Skip quality title validations for static topics when edited by admin (#18468) Static topics are the seeded topics that are automatically created for every Discourse instance to hold the content for the FAQ, ToS and Privacy pages. These topics are allowed to bypass the minimum title length checks when they're edited by admins: https://github.com/discourse/discourse/blob/ba27ee16376c961c93a4e3854b038a42f9577613/app/assets/javascripts/discourse/app/models/composer.js#L487-L496 However, on the server-side, the "quality title" validations aren't skipped for static topics and that can cause confusion for admins when they change the title of a static topic to something that's short enough to fail the quality title validations. This commit ignores all quality title validations on static topics when they're edited by admins. Internal topic: t/75745. 2022-10-05 02:55:21 +08:00			`return if Discourse.static_doc_topic_ids.include?(record.id) && record.acting_user&.admin?`

refactor Topic validation introduce a couple of custom validators fix minor discrepancies in tests copy I18n error message keys to default location clean up validation invocation move some responsibilities out of validator into class 2013-05-23 12:52:12 +08:00			`sentinel = TextSentinel.title_sentinel(value)`
FEATURE: Improve errors when title is invalid (#11149) It used to simply say "title is invalid" without giving any hint what the problem could be. This commit adds different errors messages for all caps titles, low entropy titles or titles with very long words. 2020-11-11 21:11:36 +08:00
			`if !sentinel.valid?`
			`if !sentinel.seems_meaningful?`
			`record.errors.add(attribute, :is_invalid_meaningful)`
			`elsif !sentinel.seems_unpretentious?`
			`record.errors.add(attribute, :is_invalid_unpretentious)`
			`elsif !sentinel.seems_quiet?`
			`record.errors.add(attribute, :is_invalid_quiet)`
			`else`
			`record.errors.add(attribute, :is_invalid)`
			`end`
			`end`
refactor Topic validation introduce a couple of custom validators fix minor discrepancies in tests copy I18n error message keys to default location clean up validation invocation move some responsibilities out of validator into class 2013-05-23 12:52:12 +08:00			`end`
			`end`