mirror of
https://gh.wpcy.net/https://github.com/discourse/discourse.git
synced 2026-05-04 20:35:52 +08:00
848c19ae48
## Summary - Moves scorable weight configuration and category filtering from global site settings to individual leaderboards - Each leaderboard can override any of the 15 score weight values and specify its own scorable categories - Score calculation now runs per leaderboard into a new `gamification_leaderboard_scores` table - Admin UI gains a "Scoring configuration" section on the leaderboard edit form ## Details Previously all leaderboards shared the same pre-calculated scores from global site settings. This made it impossible to have e.g. a "posts-only" leaderboard alongside a "likes-focused" one. Now each leaderboard can optionally override: - **Score weights**: Set per-action point values (empty = inherit global default, 0 = disabled) - **Scorable categories**: Restrict which categories count toward scoring (empty = inherit global setting) The old `gamification_scores` table is no longer written to — a post-deploy migration to drop it will follow separately. ## Test plan - [ ] Create a leaderboard with default scoring — scores match current behavior - [ ] Create a leaderboard with custom weights (e.g. `post_created` = 10, all others empty) — only overridden weights differ - [ ] Set a weight to 0 — that scorable is disabled for the leaderboard - [ ] Set per-leaderboard categories — only those categories count - [ ] Clear categories — inherits global `scorable_categories` setting - [ ] Existing leaderboards with no overrides behave identically after upgrade - [ ] Directory scores and user card scores work correctly (read from default leaderboard) - [ ] `bin/rspec plugins/discourse-gamification/spec/` — 120 examples, 0 failures
119 lines
4.8 KiB
Ruby
119 lines
4.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
# name: discourse-gamification
|
|
# about: Allows admins to create and customize community scoring contests for user accomplishments with leaderboards.
|
|
# meta_topic_id: 225916
|
|
# version: 0.0.1
|
|
# authors: Discourse
|
|
# url: https://github.com/discourse/discourse/tree/main/plugins/discourse-gamification
|
|
# required_version: 2.7.0
|
|
|
|
enabled_site_setting :discourse_gamification_enabled
|
|
|
|
register_asset "stylesheets/common/leaderboard.scss"
|
|
register_asset "stylesheets/desktop/leaderboard.scss", :desktop
|
|
register_asset "stylesheets/mobile/leaderboard.scss", :mobile
|
|
register_asset "stylesheets/common/leaderboard-info-modal.scss"
|
|
register_asset "stylesheets/common/leaderboard-minimal.scss"
|
|
register_asset "stylesheets/common/leaderboard-admin.scss"
|
|
register_asset "stylesheets/common/gamification-score.scss"
|
|
|
|
register_svg_icon "crown"
|
|
register_svg_icon "award"
|
|
register_svg_icon "trophy"
|
|
|
|
module ::DiscourseGamification
|
|
PLUGIN_NAME = "discourse-gamification"
|
|
end
|
|
|
|
require_relative "lib/discourse_gamification/engine"
|
|
|
|
after_initialize do
|
|
# route: /admin/plugins/discourse-gamification
|
|
add_admin_route(
|
|
"gamification.admin.title",
|
|
"discourse-gamification",
|
|
{ use_new_show_route: true },
|
|
)
|
|
|
|
require_relative "jobs/scheduled/update_scores_for_ten_days"
|
|
require_relative "jobs/scheduled/update_scores_for_today"
|
|
require_relative "jobs/regular/recalculate_scores"
|
|
require_relative "jobs/regular/recalculate_leaderboard_scores"
|
|
require_relative "jobs/regular/generate_leaderboard_positions"
|
|
require_relative "jobs/regular/refresh_leaderboard_positions"
|
|
require_relative "jobs/regular/delete_leaderboard_positions"
|
|
require_relative "jobs/regular/update_stale_leaderboard_positions"
|
|
require_relative "jobs/regular/regenerate_leaderboard_positions"
|
|
require_relative "lib/discourse_gamification/directory_integration"
|
|
require_relative "lib/discourse_gamification/guardian_extension"
|
|
require_relative "lib/discourse_gamification/scorables/scorable"
|
|
require_relative "lib/discourse_gamification/scorables/day_visited"
|
|
require_relative "lib/discourse_gamification/scorables/flag_created"
|
|
require_relative "lib/discourse_gamification/scorables/like_given"
|
|
require_relative "lib/discourse_gamification/scorables/like_received"
|
|
require_relative "lib/discourse_gamification/scorables/post_created"
|
|
require_relative "lib/discourse_gamification/scorables/post_read"
|
|
require_relative "lib/discourse_gamification/scorables/solutions"
|
|
require_relative "lib/discourse_gamification/scorables/time_read"
|
|
require_relative "lib/discourse_gamification/scorables/topic_created"
|
|
require_relative "lib/discourse_gamification/scorables/user_invited"
|
|
require_relative "lib/discourse_gamification/user_extension"
|
|
require_relative "lib/discourse_gamification/scorables/reaction_given"
|
|
require_relative "lib/discourse_gamification/scorables/reaction_received"
|
|
require_relative "lib/discourse_gamification/scorables/chat_reaction_given"
|
|
require_relative "lib/discourse_gamification/scorables/chat_reaction_received"
|
|
require_relative "lib/discourse_gamification/scorables/chat_message_created"
|
|
require_relative "lib/discourse_gamification/recalculate_scores_rate_limiter"
|
|
require_relative "lib/discourse_gamification/leaderboard_cached_view"
|
|
|
|
reloadable_patch do |plugin|
|
|
User.prepend(DiscourseGamification::UserExtension)
|
|
Guardian.include(DiscourseGamification::GuardianExtension)
|
|
end
|
|
|
|
add_directory_column(
|
|
"gamification_score",
|
|
query: DiscourseGamification::DirectoryIntegration.query,
|
|
)
|
|
|
|
add_to_serializer(
|
|
:admin_plugin,
|
|
:extras,
|
|
include_condition: -> { self.name == "discourse-gamification" },
|
|
) do
|
|
{
|
|
gamification_recalculate_scores_remaining:
|
|
DiscourseGamification::RecalculateScoresRateLimiter.remaining,
|
|
gamification_groups:
|
|
Group
|
|
.includes(:flair_upload)
|
|
.all
|
|
.map { |group| BasicGroupSerializer.new(group, root: false, scope: self.scope).as_json },
|
|
gamification_leaderboards:
|
|
DiscourseGamification::GamificationLeaderboard
|
|
.order(updated_at: :desc)
|
|
.map { |leaderboard| AdminLeaderboardSerializer.new(leaderboard, root: false).as_json },
|
|
}
|
|
end
|
|
|
|
add_to_serializer(:user_card, :gamification_score) { object.gamification_score }
|
|
add_to_serializer(:site, :default_gamification_leaderboard_id) do
|
|
DiscourseGamification::GamificationLeaderboard.first&.id
|
|
end
|
|
|
|
SeedFu.fixture_paths << Rails
|
|
.root
|
|
.join("plugins", "discourse-gamification", "db", "fixtures")
|
|
.to_s
|
|
|
|
on(:site_setting_changed) do |name|
|
|
next if name != :score_ranking_strategy
|
|
|
|
Jobs.enqueue(::Jobs::RegenerateLeaderboardPositions)
|
|
end
|
|
|
|
on(:merging_users) do |source_user, target_user|
|
|
DiscourseGamification::GamificationLeaderboardScore.merge_scores(source_user, target_user)
|
|
end
|
|
end
|
