2024-09-06 18:56:56 +08:00
|
|
|
# frozen_string_literal: true
|
|
|
|
|
|
|
|
|
|
class User::Suspend
|
|
|
|
|
include Service::Base
|
|
|
|
|
|
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-23 23:57:48 +08:00
|
|
|
params do
|
2024-09-06 18:56:56 +08:00
|
|
|
attribute :user_id, :integer
|
|
|
|
|
attribute :reason, :string
|
|
|
|
|
attribute :message, :string
|
|
|
|
|
attribute :suspend_until, :datetime
|
|
|
|
|
attribute :other_user_ids, :array
|
|
|
|
|
attribute :post_id, :integer
|
|
|
|
|
attribute :post_action, :string
|
|
|
|
|
attribute :post_edit, :string
|
|
|
|
|
|
|
|
|
|
validates :user_id, presence: true
|
|
|
|
|
validates :reason, presence: true, length: { maximum: 300 }
|
|
|
|
|
validates :suspend_until, presence: true
|
|
|
|
|
validates :other_user_ids, length: { maximum: User::MAX_SIMILAR_USERS }
|
|
|
|
|
validates :post_action, inclusion: { in: %w[delete delete_replies edit] }, allow_blank: true
|
|
|
|
|
end
|
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-01 23:17:14 +08:00
|
|
|
model :user
|
|
|
|
|
policy :not_suspended_already, class_name: User::Policy::NotAlreadySuspended
|
|
|
|
|
model :users
|
|
|
|
|
policy :can_suspend_all_users
|
|
|
|
|
step :suspend
|
|
|
|
|
model :post, optional: true
|
|
|
|
|
step :perform_post_action
|
2024-09-06 18:56:56 +08:00
|
|
|
|
|
|
|
|
private
|
|
|
|
|
|
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-23 23:57:48 +08:00
|
|
|
def fetch_user(params:)
|
2024-10-29 00:21:59 +08:00
|
|
|
User.find_by(id: params.user_id)
|
2024-09-06 18:56:56 +08:00
|
|
|
end
|
|
|
|
|
|
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-23 23:57:48 +08:00
|
|
|
def fetch_users(user:, params:)
|
2024-10-29 00:21:59 +08:00
|
|
|
[user, *User.where(id: params.other_user_ids.to_a.uniq).to_a]
|
2024-09-06 18:56:56 +08:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
def can_suspend_all_users(guardian:, users:)
|
|
|
|
|
users.all? { guardian.can_suspend?(_1) }
|
|
|
|
|
end
|
|
|
|
|
|
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-23 23:57:48 +08:00
|
|
|
def suspend(guardian:, users:, params:)
|
|
|
|
|
context[:full_reason] = User::Action::SuspendAll.call(users:, actor: guardian.user, params:)
|
2024-09-06 18:56:56 +08:00
|
|
|
end
|
|
|
|
|
|
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-23 23:57:48 +08:00
|
|
|
def fetch_post(params:)
|
2024-10-29 00:21:59 +08:00
|
|
|
Post.find_by(id: params.post_id)
|
2024-09-06 18:56:56 +08:00
|
|
|
end
|
|
|
|
|
|
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-23 23:57:48 +08:00
|
|
|
def perform_post_action(guardian:, post:, params:)
|
|
|
|
|
User::Action::TriggerPostAction.call(guardian:, post:, params:)
|
2024-09-06 18:56:56 +08:00
|
|
|
end
|
|
|
|
|
end
|