Module: SiteSettings::DeprecatedSettings

Included in:
SiteSettingExtension
Defined in:
lib/site_settings/deprecated_settings.rb

Constant Summary collapse

SETTINGS = 
[
  # [<old setting>, <new_setting>, <override>, <version to drop>]
  ["search_tokenize_chinese_japanese_korean", "search_tokenize_chinese", true, "2.9"],
  ["default_categories_regular", "default_categories_normal", true, "3.0"],
]

Instance Method Summary collapse

Instance Method Details

#setup_deprecated_methods ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/site_settings/deprecated_settings.rb', line 13

def setup_deprecated_methods
  SETTINGS.each do |old_setting, new_setting, override, version|
    unless override
      SiteSetting.singleton_class.public_send(
        :alias_method,
        :"_#{old_setting}",
        :"#{old_setting}",
      )
    end

    define_singleton_method old_setting do |warn: true|
      if warn
        Discourse.deprecate(
          "`SiteSetting.#{old_setting}` has been deprecated. Please use `SiteSetting.#{new_setting}` instead.",
          drop_from: version,
        )
      end

      self.public_send(override ? new_setting : "_#{old_setting}")
    end

    unless override
      SiteSetting.singleton_class.public_send(
        :alias_method,
        :"_#{old_setting}?",
        :"#{old_setting}?",
      )
    end

    define_singleton_method "#{old_setting}?" do |warn: true|
      if warn
        Discourse.deprecate(
          "`SiteSetting.#{old_setting}?` has been deprecated. Please use `SiteSetting.#{new_setting}?` instead.",
          drop_from: version,
        )
      end

      self.public_send("#{override ? new_setting : "_" + old_setting}?")
    end

    unless override
      SiteSetting.singleton_class.public_send(
        :alias_method,
        :"_#{old_setting}=",
        :"#{old_setting}=",
      )
    end

    define_singleton_method "#{old_setting}=" do |val, warn: true|
      if warn
        Discourse.deprecate(
          "`SiteSetting.#{old_setting}=` has been deprecated. Please use `SiteSetting.#{new_setting}=` instead.",
          drop_from: version,
        )
      end

      self.public_send("#{override ? new_setting : "_" + old_setting}=", val)
    end
  end
end