discourse/app/serializers/basic_group_serializer.rb
Martin Brennan ca26099a8d
UX: Add descriptions to auto groups and auto group indicator (#28630)
This commit adds a description for all the auto groups
which will be shown in the group list and show group
pages, which will help admins understand their purpose
better.

Also adds an indicator with a tooltip to explain what
the auto groups are on the group show page.
2024-08-30 10:52:34 +10:00

121 lines
2.5 KiB
Ruby

# frozen_string_literal: true
class BasicGroupSerializer < ApplicationSerializer
attributes :id,
:automatic,
:name,
:display_name,
:user_count,
:mentionable_level,
:messageable_level,
:visibility_level,
:primary_group,
:title,
:grant_trust_level,
:incoming_email,
:has_messages,
:flair_url,
:flair_bg_color,
:flair_color,
:bio_raw,
:bio_cooked,
:bio_excerpt,
:public_admission,
:public_exit,
:allow_membership_requests,
:full_name,
:default_notification_level,
:membership_request_template,
:is_group_user,
:is_group_owner,
:members_visibility_level,
:can_see_members,
:can_admin_group,
:can_edit_group,
:publish_read_state
def include_display_name?
object.automatic
end
def display_name
if auto_group_name = Group::AUTO_GROUP_IDS[object.id]
I18n.t("groups.default_names.#{auto_group_name}")
end
end
def bio_cooked
if object.automatic
return I18n.t("groups.default_descriptions.#{Group::AUTO_GROUP_IDS[object.id]}")
end
object.bio_cooked
end
def bio_excerpt
PrettyText.excerpt(bio_cooked, 200, keep_emoji_images: true) if bio_cooked.present?
end
def include_incoming_email?
staff?
end
def include_has_messages?
staff? || scope.can_see_group_messages?(object)
end
def include_bio_raw?
staff? || (include_is_group_owner? && is_group_owner)
end
def include_is_group_user?
user_group_ids.present?
end
def is_group_user
user_group_ids.include?(object.id)
end
def include_is_group_owner?
owner_group_ids.present?
end
def can_edit_group
scope.can_edit_group?(object)
end
def include_can_edit_group?
scope.can_edit_group?(object)
end
def can_admin_group
scope.can_admin_group?(object)
end
def include_can_admin_group?
scope.can_admin_group?(object)
end
def is_group_owner
owner_group_ids.include?(object.id)
end
def can_see_members
scope.can_see_group_members?(object)
end
private
def staff?
@staff ||= scope.is_staff?
end
def user_group_ids
@options[:user_group_ids]
end
def owner_group_ids
@options[:owner_group_ids]
end
end