discourse/app/services/update_site_setting.rb
Loïc Guitaut fc1c5f6a8d DEV: Have contract take a block in services
Currently in services, the `contract` step is only used to define where
the contract will be called in the execution flow. Then, a `Contract`
class has to be defined with validations in it.

This patch allows the `contract` step to take a block containing
validations, attributes, etc. directly. No need to then open a
`Contract` class later in the service.

It also has a nice side effect, as it’s now easy to define multiples
contracts inside the same service. Before, we had the `class_name:`
option, but it wasn’t really useful as you had to redefine a complete
new contract class.
Now, when using a name for the contract other than `default`, a new
contract will be created automatically using the provided name.

Example:
```ruby
contract(:user) do
  attribute :user_id, :integer

  validates :user_id, presence: true
end
```
This will create a `UserContract` class and use it, also putting the
resulting contract in `context[:user_contract]`.
2024-10-02 17:00:01 +09:00

60 lines
1.6 KiB
Ruby

# frozen_string_literal: true
class UpdateSiteSetting
include Service::Base
policy :current_user_is_admin
contract do
attribute :setting_name
attribute :new_value
attribute :allow_changing_hidden, :boolean, default: false
validates :setting_name, presence: true
end
step :convert_name_to_sym
policy :setting_is_visible
policy :setting_is_configurable
step :cleanup_value
step :save
private
def convert_name_to_sym(setting_name:)
context.setting_name = setting_name.to_sym
end
def current_user_is_admin(guardian:)
guardian.is_admin?
end
def setting_is_visible(setting_name:)
context.allow_changing_hidden || !SiteSetting.hidden_settings.include?(setting_name)
end
def setting_is_configurable(setting_name:)
return true if !SiteSetting.plugins[setting_name]
Discourse.plugins_by_name[SiteSetting.plugins[setting_name]].configurable?
end
def cleanup_value(setting_name:, new_value:)
new_value = new_value.strip if new_value.is_a?(String)
case SiteSetting.type_supervisor.get_type(setting_name)
when :integer
new_value = new_value.tr("^-0-9", "").to_i if new_value.is_a?(String)
when :file_size_restriction
new_value = new_value.tr("^0-9", "").to_i if new_value.is_a?(String)
when :uploaded_image_list
new_value = new_value.blank? ? "" : Upload.get_from_urls(new_value.split("|")).to_a
when :upload
new_value = Upload.get_from_url(new_value) || ""
end
context.new_value = new_value
end
def save(setting_name:, new_value:, guardian:)
SiteSetting.set_and_log(setting_name, new_value, guardian.user)
end
end