mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-27 13:45:29 +08:00
d2516cbdcd
This change centralises how user actions are defined. ### How It Works `ReviewableActionBuilder::build_user_actions_bundle` defines all of the user actions that a reviewable should need. `ReviewableActionBuilder` also now includes matching `perform_*` methods, to go with the actions defined in `build_user_actions_bundle`. There's also an overridable `target_user` method. It defaults to `target_created_by`, since that's the most common case, but it will allow different reviewable types to define a different user to target: for example, `ReviewableUser` would want to have it return `target`. ### Supporting Changes `Reviewable::build_actions` is temporarily overridden in `ReviewableActionBuilder`. Because we need `build_actions` to define both the old and new actions, I've chosen to split these into separate methods (`build_legacy_combined_actions` and `build_new_separated_actions`) that reviewables will temporarily need to define. This allows minimal code churn of the old logic, while we can build the new logic within its own method. `Reviewable::build_actions` will ultimately be moved to `ReviewableActionBuilder`. `Reviewable::create_result` has been copied to `ReviewableActionBuilder`, and expanded to include the flag-handling functionality of `ReviewablePost::successful_transition`.
104 lines
4 KiB
Ruby
Vendored
104 lines
4 KiB
Ruby
Vendored
# frozen_string_literal: true
|
|
|
|
RSpec.describe ReviewableActionBuilder do
|
|
fab!(:admin)
|
|
fab!(:guardian) { Guardian.new(admin) }
|
|
fab!(:user)
|
|
|
|
describe "#build_user_actions_bundle" do
|
|
fab!(:post) { Fabricate(:post, user: user) }
|
|
fab!(:reviewable_post) do
|
|
ReviewablePost.needs_review!(target: post, created_by: admin, potential_spam: false)
|
|
end
|
|
fab!(:post_actions) { Reviewable::Actions.new(reviewable_post, guardian) }
|
|
|
|
it "creates a user bundle with standard actions when allowed" do
|
|
bundle = reviewable_post.build_user_actions_bundle(post_actions, guardian)
|
|
|
|
# bundle id and label
|
|
expect(bundle.id).to eq("#{reviewable_post.id}-user-actions")
|
|
expect(bundle.label).to eq("reviewables.actions.user_actions.bundle_title")
|
|
|
|
# action ids are prefixed with target type (post-...)
|
|
action_ids = bundle.actions.map(&:id)
|
|
expect(action_ids).to include("post-no_action_user")
|
|
expect(action_ids).to include("post-silence_user")
|
|
expect(action_ids).to include("post-suspend_user")
|
|
expect(action_ids).to include("post-delete_user")
|
|
expect(action_ids).to include("post-delete_and_block_user")
|
|
|
|
# client_action is set for moderation actions
|
|
silence = bundle.actions.find { |a| a.id == "post-silence_user" }
|
|
suspend = bundle.actions.find { |a| a.id == "post-suspend_user" }
|
|
expect(silence.client_action).to eq("silence")
|
|
expect(suspend.client_action).to eq("suspend")
|
|
end
|
|
|
|
it "includes only the no-op action when user is nil" do
|
|
allow(reviewable_post).to receive(:target_created_by).and_return(nil)
|
|
|
|
bundle = reviewable_post.build_user_actions_bundle(post_actions, guardian)
|
|
server_actions = bundle.actions.map(&:server_action)
|
|
|
|
expect(server_actions).to include("no_action_user")
|
|
expect(server_actions - ["no_action_user"]).to be_empty
|
|
end
|
|
end
|
|
|
|
describe "#build_action" do
|
|
fab!(:reviewable_user) { ReviewableUser.create_for(user) }
|
|
|
|
it "adds an action with i18n-derived defaults" do
|
|
user_actions = Reviewable::Actions.new(reviewable_user, guardian)
|
|
|
|
reviewable_user.build_action(user_actions, :approve_user)
|
|
|
|
action = user_actions.to_a.first
|
|
expect(action).to be_present
|
|
expect(action.label).to eq("reviewables.actions.approve_user.title")
|
|
expect(action.description).to eq("reviewables.actions.approve_user.description")
|
|
expect(action.completed_message).to eq("reviewables.actions.approve_user.complete")
|
|
expect(action.confirm_message).to be_nil
|
|
expect(action.icon).to be_nil
|
|
expect(action.button_class).to be_nil
|
|
expect(action.client_action).to be_nil
|
|
expect(action.require_reject_reason).to be(false)
|
|
|
|
# It should attach to a bundle automatically matching the full action id
|
|
bundle_ids = user_actions.bundles.map(&:id)
|
|
expect(bundle_ids).to include(action.id)
|
|
end
|
|
|
|
it "sets optional fields when provided" do
|
|
user_actions = Reviewable::Actions.new(reviewable_user, guardian)
|
|
|
|
reviewable_user.build_action(
|
|
user_actions,
|
|
:approve_user,
|
|
icon: "user-plus",
|
|
button_class: "btn-primary",
|
|
client_action: "go",
|
|
confirm: true,
|
|
require_reject_reason: true,
|
|
)
|
|
|
|
action = user_actions.to_a.first
|
|
expect(action.icon).to eq("user-plus")
|
|
expect(action.button_class).to eq("btn-primary")
|
|
expect(action.client_action).to eq("go")
|
|
expect(action.confirm_message).to eq("reviewables.actions.approve_user.confirm")
|
|
expect(action.require_reject_reason).to be(true)
|
|
end
|
|
|
|
it "adds the action to the provided bundle" do
|
|
user_actions = Reviewable::Actions.new(reviewable_user, guardian)
|
|
|
|
bundle = user_actions.add_bundle("custom-bundle", icon: "x", label: "Custom")
|
|
reviewable_user.build_action(user_actions, :approve_user, bundle: bundle)
|
|
|
|
action = user_actions.to_a.first
|
|
expect(user_actions.bundles).to include(bundle)
|
|
expect(bundle.actions).to include(action)
|
|
end
|
|
end
|
|
end
|
