discourse/app/services/flags/update_flag.rb
Loïc Guitaut 584424594e DEV: Replace params by the contract object in services
This patch replaces the parameters provided to a service through
`params` by the contract object.

That way, it allows better consistency when accessing input params. For
example, if you have a service without a contract, to access a
parameter, you need to use `params[:my_parameter]`. But with a contract,
you do this through `contract.my_parameter`. Now, with this patch,
you’ll be able to access it through `params.my_parameter` or
`params[:my_parameter]`.

Some methods have been added to the contract object to better mimic a
Hash. That way, when accessing/using `params`, you don’t have to think
too much about it:
- `params.my_key` is also accessible through `params[:my_key]`.
- `params.my_key = value` can also be done through `params[:my_key] =
  value`.
- `#slice` and `#merge` are available.
- `#to_hash` has been implemented, so the contract object will be
  automatically cast as a hash by Ruby depending on the context. For
  example, with an AR model, you can do this: `user.update(**params)`.
2024-10-25 14:48:34 +02:00

65 lines
1.4 KiB
Ruby

# frozen_string_literal: true
class Flags::UpdateFlag
include Service::Base
params do
attribute :id, :integer
attribute :name, :string
attribute :description, :string
attribute :require_message, :boolean
attribute :enabled, :boolean
attribute :applies_to
attribute :auto_action_type, :boolean
validates :id, presence: true
validates :name, presence: true
validates :description, presence: true
validates :name, length: { maximum: Flag::MAX_NAME_LENGTH }
validates :description, length: { maximum: Flag::MAX_DESCRIPTION_LENGTH }
validates :applies_to, inclusion: { in: -> { Flag.valid_applies_to_types } }, allow_nil: false
end
model :flag
policy :not_system
policy :not_used
policy :invalid_access
policy :unique_name
transaction do
step :update
step :log
end
private
def fetch_flag(params:)
Flag.find_by(id: params[:id])
end
def not_system(flag:)
!flag.system?
end
def not_used(flag:)
!flag.used?
end
def invalid_access(guardian:, flag:)
guardian.can_edit_flag?(flag)
end
def unique_name(params:)
!Flag.custom.where(name: params[:name]).where.not(id: params[:id]).exists?
end
def update(flag:, params:)
flag.update!(**params)
end
def log(guardian:, flag:)
StaffActionLogger.new(guardian.user).log_custom(
"update_flag",
flag.slice(:name, :description, :applies_to, :require_message, :enabled),
)
end
end