Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
discourse/app/services/experiments/toggle.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

32 lines
627 B
Ruby
Raw Normal View History

FEATURE: allow admins to enable announced experimental features (#29244) Toggle the button to enable the experimental site setting from "What's new" announcement. The toggle button is displayed when: - site setting exists and is boolean; - potentially required plugin is enabled.
2024-10-21 19:56:58 -04:00
# frozen_string_literal: true
class Experiments::Toggle
include Service::Base
policy :current_user_is_admin
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 11:57:48 -04:00
params do
FEATURE: allow admins to enable announced experimental features (#29244) Toggle the button to enable the experimental site setting from "What's new" announcement. The toggle button is displayed when: - site setting exists and is boolean; - potentially required plugin is enabled.
2024-10-21 19:56:58 -04:00
attribute :setting_name, :string
validates :setting_name, presence: true
end
policy :setting_is_available
transaction { step :toggle }
private
def current_user_is_admin(guardian:)
guardian.is_admin?
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 11:57:48 -04:00
def setting_is_available(params:)
DEV: Remove hash-like access from service contracts We decided to keep only one way to access values from a contract. This patch thus removes the hash-like access from contracts.
2024-10-28 12:21:59 -04:00
SiteSetting.respond_to?(params.setting_name)
FEATURE: allow admins to enable announced experimental features (#29244) Toggle the button to enable the experimental site setting from "What's new" announcement. The toggle button is displayed when: - site setting exists and is boolean; - potentially required plugin is enabled.
2024-10-21 19:56:58 -04: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 11:57:48 -04:00
def toggle(params:, guardian:)
FEATURE: allow admins to enable announced experimental features (#29244) Toggle the button to enable the experimental site setting from "What's new" announcement. The toggle button is displayed when: - site setting exists and is boolean; - potentially required plugin is enabled.
2024-10-21 19:56:58 -04:00
SiteSetting.set_and_log(
DEV: Remove hash-like access from service contracts We decided to keep only one way to access values from a contract. This patch thus removes the hash-like access from contracts.
2024-10-28 12:21:59 -04:00
params.setting_name,
!SiteSetting.public_send(params.setting_name),
FEATURE: allow admins to enable announced experimental features (#29244) Toggle the button to enable the experimental site setting from "What's new" announcement. The toggle button is displayed when: - site setting exists and is boolean; - potentially required plugin is enabled.
2024-10-21 19:56:58 -04:00
guardian.user,
)
end
end