Project

General

Profile

Feature #42630 » 0001-Adds-reaction-feature-to-issues-news-and-forums.patch

Katsuya HIDAKA, 2025-04-25 08:40

View differences:

app/assets/images/icons.svg
<path d="M19 15v6h3"/>
<path d="M11 21v-6l2.5 3l2.5 -3v6"/>
</symbol>
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--thumb-up">
<path d="M7 11v8a1 1 0 0 1 -1 1h-2a1 1 0 0 1 -1 -1v-7a1 1 0 0 1 1 -1h3a4 4 0 0 0 4 -4v-1a2 2 0 0 1 4 0v5h3a2 2 0 0 1 2 2l-1 5a2 3 0 0 1 -2 2h-7a3 3 0 0 1 -3 -3"/>
</symbol>
<symbol viewBox="0 0 24 24" id="icon--thumb-up-filled">
<path d="M13 3a3 3 0 0 1 2.995 2.824l.005 .176v4h2a3 3 0 0 1 2.98 2.65l.015 .174l.005 .176l-.02 .196l-1.006 5.032c-.381 1.626 -1.502 2.796 -2.81 2.78l-.164 -.008h-8a1 1 0 0 1 -.993 -.883l-.007 -.117l.001 -9.536a1 1 0 0 1 .5 -.865a2.998 2.998 0 0 0 1.492 -2.397l.007 -.202v-1a3 3 0 0 1 3 -3z"/>
<path d="M5 10a1 1 0 0 1 .993 .883l.007 .117v9a1 1 0 0 1 -.883 .993l-.117 .007h-1a2 2 0 0 1 -1.995 -1.85l-.005 -.15v-7a2 2 0 0 1 1.85 -1.995l.15 -.005h1z"/>
</symbol>
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--time">
<path d="M3 12a9 9 0 1 0 18 0a9 9 0 0 0 -18 0"/>
<path d="M12 7v5l3 3"/>
app/assets/javascripts/application-legacy.js
});
}
function setupHoverTooltips() {
$("[title]:not(.no-tooltip)").tooltip({
function setupHoverTooltips(container) {
$(container || 'body').find("[title]:not(.no-tooltip)").tooltip({
show: {
delay: 400
},
......
}
});
}
function removeHoverTooltips(container) {
$(container || 'body').find("[title]:not(.no-tooltip)").tooltip('destroy')
}
$(function() { setupHoverTooltips(); });
function inlineAutoComplete(element) {
app/assets/stylesheets/application.css
img.filecontent.image {background-image: url(/transparent.png);}
/* Reaction styles */
.reaction-button.reacted .icon-svg {
fill: #126fa7;
stroke: none;
}
.reaction-button.reacted:hover .icon-svg {
fill: #c61a1a;
}
.reaction-button .icon-label {
margin-left: 3px;
margin-bottom: -1px;
}
div.issue.details .reaction {
float: right;
font-size: 0.9em;
margin-top: 0.5em;
}
div.message .reaction {
float: right;
font-size: 0.9em;
}
div.news .reaction {
float: right;
font-size: 0.9em;
}
/* Custom JQuery styles */
.ui-autocomplete, .ui-menu {
border-radius: 2px;
app/controllers/messages_controller.rb
reorder("#{Message.table_name}.created_on ASC, #{Message.table_name}.id ASC").
limit(@reply_pages.per_page).
offset(@reply_pages.offset).
to_a
load_with_reactions
@reply = Message.new(:subject => "RE: #{@message.subject}")
render :action => "show", :layout => false if request.xhr?
app/controllers/news_controller.rb
end
def show
@comments = @news.comments.to_a
@comments = @news.comments.load_with_reactions
@comments.reverse! if User.current.wants_comments_in_reverse_order?
end
app/controllers/reactions_controller.rb
# frozen_string_literal: true
# Redmine - project management software
# Copyright (C) 2006- Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
class ReactionsController < ApplicationController
before_action :check_enabled
before_action :require_login
before_action :set_object, :authorize_reactable
def create
@reaction = @object.reactions.find_or_create_by!(user: User.current)
end
def destroy
@reaction = @object.reactions.by(User.current).find_by(id: params[:id])
@reaction&.destroy
end
private
def check_enabled
render_403 unless Setting.reactions_enabled?
end
def set_object
object_type = params[:object_type]
unless Redmine::Reaction::REACTABLE_TYPES.include?(object_type)
render_403
return
end
@object = object_type.constantize.find(params[:object_id])
end
def authorize_reactable
render_403 unless @object.visible?(User.current)
end
end
app/helpers/issues_helper.rb
include Redmine::Export::PDF::IssuesPdfHelper
include IssueStatusesHelper
include QueriesHelper
include ReactionsHelper
def issue_list(issues, &)
ancestors = []
app/helpers/journals_helper.rb
module JournalsHelper
include Redmine::QuoteReply::Helper
include ReactionsHelper
# Returns the attachments of a journal that are displayed as thumbnails
def journal_thumbnail_attachments(journal)
......
end
if journal.notes.present?
links << reaction_button(journal)
if options[:reply_links]
url = quoted_issue_path(issue, :journal_id => journal, :journal_indice => indice)
links << quote_reply(url, "#journal-#{journal.id}-notes", icon_only: true)
app/helpers/messages_helper.rb
module MessagesHelper
include Redmine::QuoteReply::Helper
include ReactionsHelper
end
app/helpers/news_helper.rb
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
module NewsHelper
include ReactionsHelper
end
app/helpers/reactions_helper.rb
# frozen_string_literal: true
# Redmine - project management software
# Copyright (C) 2006- Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
module ReactionsHelper
def reaction_button(object, reaction = nil)
return unless Setting.reactions_enabled? && object.visible?(User.current)
reaction ||= object.reaction_by(User.current)
count = object.reaction_count
user_names = object.reaction_user_names
tooltip = build_reaction_tooltip(user_names, count)
if User.current.logged?
if reaction&.persisted?
reaction_button_reacted(object, reaction, count, tooltip)
else
reaction_button_not_reacted(object, count, tooltip)
end
else
reaction_button_readonly(object, count, tooltip)
end
end
def reaction_id_for(object)
dom_id(object, :reaction)
end
private
def reaction_button_reacted(object, reaction, count, tooltip)
reaction_button_wrapper object do
link_to(
sprite_icon('thumb-up-filled', count),
reaction_path(reaction, object_type: object.class.name, object_id: object),
remote: true, method: :delete,
class: ['icon', 'reaction-button', 'reacted'],
title: tooltip
)
end
end
def reaction_button_not_reacted(object, count, tooltip)
reaction_button_wrapper object do
link_to(
sprite_icon('thumb-up', count),
reactions_path(object_type: object.class.name, object_id: object),
remote: true, method: :post,
class: 'icon reaction-button',
title: tooltip
)
end
end
def reaction_button_readonly(object, count, tooltip)
reaction_button_wrapper object do
tag.span(class: 'icon reaction-button', title: tooltip) do
sprite_icon('thumb-up', count)
end
end
end
def reaction_button_wrapper(object, &)
tag.span(data: { 'reaction-button-id': reaction_id_for(object) }, &)
end
def build_reaction_tooltip(user_names, count)
return if count.zero?
display_user_names = user_names.dup
if count > Redmine::Reaction::DISPLAY_REACTION_USERS_LIMIT
others = count - Redmine::Reaction::DISPLAY_REACTION_USERS_LIMIT
display_user_names << I18n.t(:reaction_text_x_other_users, count: others)
end
display_user_names.to_sentence(locale: I18n.locale)
end
end
app/models/comment.rb
class Comment < ApplicationRecord
include Redmine::SafeAttributes
include Redmine::Reaction::Reactable
belongs_to :commented, :polymorphic => true, :counter_cache => true
belongs_to :author, :class_name => 'User'
......
safe_attributes 'comments'
delegate :visible?, to: :commented
def comments=(arg)
self.content = arg
end
app/models/issue.rb
before_validation :clear_disabled_fields
before_save :set_parent_id
include Redmine::NestedSet::IssueNestedSet
include Redmine::Reaction::Reactable
belongs_to :project
belongs_to :tracker
......
result = journals.
preload(:details).
preload(:user => :email_address).
reorder(:created_on, :id).to_a
reorder(:created_on, :id).
load_with_reactions
result.each_with_index {|j, i| j.indice = i + 1}
app/models/journal.rb
class Journal < ApplicationRecord
include Redmine::SafeAttributes
include Redmine::Reaction::Reactable
belongs_to :journalized, :polymorphic => true
# added as a quick fix to allow eager loading of the polymorphic association
app/models/message.rb
class Message < ApplicationRecord
include Redmine::SafeAttributes
include Redmine::Reaction::Reactable
belongs_to :board
belongs_to :author, :class_name => 'User'
acts_as_tree :counter_cache => :replies_count, :order => "#{Message.table_name}.created_on ASC"
app/models/news.rb
class News < ApplicationRecord
include Redmine::SafeAttributes
include Redmine::Reaction::Reactable
belongs_to :project
belongs_to :author, :class_name => 'User'
has_many :comments, lambda {order("created_on")}, :as => :commented, :dependent => :delete_all
app/models/reaction.rb
# frozen_string_literal: true
# Redmine - project management software
# Copyright (C) 2006- Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
class Reaction < ApplicationRecord
belongs_to :reactable, polymorphic: true
belongs_to :user
validates :reactable_type, inclusion: { in: Redmine::Reaction::REACTABLE_TYPES }
scope :by, ->(user) { where(user: user) }
# Returns a mapping of reactable IDs to an array of user names
#
# Returns:
# {
# 1 => ["Alice", "Bob"],
# 2 => ["Charlie"],
# ...
# }
def self.users_map_for_reactables(reactable_type, reactable_ids)
reactions = preload(:user)
.select(:reactable_id, :user_id)
.where(reactable_type: reactable_type, reactable_id: reactable_ids)
.order(id: :desc)
reactable_user_pairs = reactions.map do |reaction|
[reaction.reactable_id, reaction.user.name]
end
# Group by reactable_id and transform values to extract only user name
# [[1, "Alice"], [1, "Bob"], [2, "Charlie"], ...]
# =>
# { 1 => ["Alice", "Bob"], 2 => ["Charlie"], ...}
reactable_user_pairs
.group_by(&:first)
.transform_values { |pairs| pairs.map(&:last) }
end
end
app/models/user.rb
has_one :api_token, lambda {where "action='api'"}, :class_name => 'Token'
has_one :email_address, lambda {where :is_default => true}, :autosave => true
has_many :email_addresses, :dependent => :delete_all
has_many :reactions, dependent: :delete_all
belongs_to :auth_source
scope :logged, lambda {where("#{User.table_name}.status <> #{STATUS_ANONYMOUS}")}
app/views/issues/show.html.erb
<div class="subject">
<%= render_issue_subject_with_tree(@issue) %>
</div>
<div class="reaction">
<%= reaction_button @issue %>
</div>
<p class="author">
<%= authoring @issue.created_on, @issue.author %>.
app/views/messages/show.html.erb
<h2><%= avatar(@topic.author) %><%= @topic.subject %></h2>
<div class="message">
<div class="reaction">
<%= reaction_button @topic %>
</div>
<p><span class="author"><%= authoring @topic.created_on, @topic.author %></span></p>
<div id="message_topic_wiki" class="wiki">
<%= textilizable(@topic, :content) %>
......
<% @replies.each do |message| %>
<div class="message reply" id="<%= "message-#{message.id}" %>">
<div class="contextual">
<%= reaction_button message %>
<%= quote_reply(
url_for(:action => 'quote', :id => message, :format => 'js'),
"#message-#{message.id} .wiki",
app/views/news/show.html.erb
</div>
<% end %>
<p><% unless @news.summary.blank? %><em><%= @news.summary %></em><br /><% end %>
<span class="author"><%= authoring @news.created_on, @news.author %></span></p>
<div class="wiki">
<%= textilizable(@news, :description) %>
<div class="news">
<div class="reaction">
<%= reaction_button @news %>
</div>
<p><% unless @news.summary.blank? %><em><%= @news.summary %></em><br /><% end %>
<span class="author"><%= authoring @news.created_on, @news.author %></span></p>
<div class="wiki">
<%= textilizable(@news, :description) %>
</div>
<%= link_to_attachments @news %>
</div>
<%= link_to_attachments @news %>
<br />
<div id="comments" style="margin-bottom:16px;">
......
<% @comments.each do |comment| %>
<% next if comment.new_record? %>
<div class="contextual">
<%= reaction_button comment %>
<%= link_to_if_authorized sprite_icon('del', l(:button_delete)), { :controller => 'comments', :action => 'destroy', :id => @news, :comment_id => comment},
:data => {:confirm => l(:text_are_you_sure)}, :method => :delete,
:title => l(:button_delete),
app/views/reactions/_replace_button.js.erb
(() => {
const button = $('[data-reaction-button-id=<%= reaction_id_for @object %>]');
removeHoverTooltips(button);
button.html($('<%=j reaction_button @object, @reaction %>').children());
setupHoverTooltips(button);
})();
app/views/reactions/create.js.erb
<%= render 'replace_button' %>
app/views/reactions/destroy.js.erb
<%= render 'replace_button' %>
app/views/settings/_general.html.erb
<p><%= setting_text_field :feeds_limit, :size => 6 %></p>
<p>
<%= setting_check_box :reactions_enabled %>
<em class="info">
<%= l(:reaction_text_enabling_reactions) %>
</em>
</p>
<%= call_hook(:view_settings_general_form) %>
</div>
config/icon_source.yml
- name: unwatch
svg: eye-off
- name: copy-pre-content
svg: clipboard
svg: clipboard
- name: thumb-up
svg: thumb-up
- name: thumb-up-filled
svg: thumb-up
style: filled
config/locales/en.yml
setting_twofa: Two-factor authentication
setting_related_issues_default_columns: Related and sub issues list defaults
setting_display_related_issues_table_headers: Show table headers
setting_reactions_enabled: Enable reactions
permission_add_project: Create project
permission_add_subprojects: Create subprojects
......
text_project_destroy_enter_identifier: "To confirm, please enter the project's identifier (%{identifier}) below."
field_name_or_email_or_login: Name, email or login
setting_wiki_tablesort_enabled: Javascript based table sorting in wiki content
reaction_text_enabling_reactions: "This enables reactions in issues, forums, and news."
reaction_text_x_other_users:
one: "1 other"
other: "%{count} others"
config/locales/ja.yml
setting_display_related_issues_table_headers: Show table headers
error_can_not_remove_role_reason_members_html: "<p>The following projects have members
with this role:<br>%{projects}</p>"
setting_reactions_enabled: リアクション機能を有効にする
reaction_text_enabling_reactions: "チケット、フォーラム、ニュースでリアクション機能を有効にします。"
reaction_text_x_other_users:
one: 他1人
other: "他%{count}人"
config/routes.rb
end
end
resources :reactions, only: [:create, :destroy]
get '/projects/:project_id/issues/gantt', :to => 'gantts#show', :as => 'project_gantt'
get '/issues/gantt', :to => 'gantts#show'
config/settings.yml
default: 1
wiki_tablesort_enabled:
default: 1
reactions_enabled:
default: 1
db/migrate/20250423065135_create_reactions.rb
class CreateReactions < ActiveRecord::Migration[7.2]
def change
create_table :reactions do |t|
t.references :reactable, polymorphic: true, null: false
t.references :user, null: false
t.timestamps null: false
end
add_index :reactions, [:reactable_type, :reactable_id, :user_id], unique: true
add_index :reactions, [:reactable_type, :reactable_id, :id]
end
end
lib/redmine/reaction.rb
# frozen_string_literal: true
# Redmine - project management software
# Copyright (C) 2006- Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
module Redmine
module Reaction
# Types of objects that can have reactions
REACTABLE_TYPES = %w(Journal Issue Message News Comment)
# Maximum number of users to display in the reaction button tooltip
DISPLAY_REACTION_USERS_LIMIT = 10
module Reactable
extend ActiveSupport::Concern
included do
has_many :reactions, -> { order(id: :desc) }, as: :reactable, dependent: :delete_all
has_many :reaction_users, through: :reactions, source: :user
attr_writer :reaction_user_names, :reaction_count
end
class_methods do
def load_with_reactions
objects = all.to_a
return objects unless Setting.reactions_enabled?
object_users_map = ::Reaction.users_map_for_reactables(self.name, objects.map(&:id))
objects.each do |object|
all_user_names = object_users_map[object.id] || []
object.reaction_count = all_user_names.size
object.reaction_user_names = all_user_names.take(DISPLAY_REACTION_USERS_LIMIT)
end
objects
end
end
def reaction_user_names
@reaction_user_names || reaction_users.take(DISPLAY_REACTION_USERS_LIMIT).map(&:name)
end
def reaction_count
@reaction_count || reaction_users.size
end
def reaction_by(user)
if reactions.loaded?
reactions.find { _1.user_id == user.id }
else
reactions.find_by(user: user)
end
end
end
end
end
(7-7/30)