jro_apps/redmine Commit - r1876:16e09bfd7744

Adds watch/unwatch functionality at forum topic level (#1912)....

Jean-Philippe Lang -

r1876:16e09bfd7744

parent child

Context file:

r1876:16e09bfd7744

Collapse all files

db/migrate/098_set_topic_authors_as_watchers.rb created 644 +14 0

@@ -0,0 +1,14
	1	class SetTopicAuthorsAsWatchers < ActiveRecord::Migration
	2	def self.up
	3	# Sets active users who created/replied a topic as watchers of the topic
	4	# so that the new watch functionality at topic level doesn't affect notifications behaviour
	5	Message.connection.execute("INSERT INTO watchers (watchable_type, watchable_id, user_id)" +
	6	" SELECT DISTINCT 'Message', COALESCE(messages.parent_id, messages.id), messages.author_id FROM messages, users" +
	7	" WHERE messages.author_id = users.id AND users.status = 1")
	8	end
	9
	10	def self.down
	11	# Removes all message watchers
	12	Watcher.delete_all("watchable_type = 'Message'")
	13	end
	14	end

app/controllers/messages_controller.rb +1 -1

             # redMine - project management software
             # Copyright (C) 2006-2007  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 MessagesController < ApplicationController
               menu_item :boards
               before_filter :find_board, :only => [:new, :preview]
               before_filter :find_message, :except => [:new, :preview]
               before_filter :authorize, :except => :preview
               verify :method => :post, :only => [ :reply, :destroy ], :redirect_to => { :action => :show }
               verify :xhr => true, :only => :quote
+              helper :watchers
               helper :attachments
               include AttachmentsHelper
               # Show a topic and its replies
               def show
                 @replies = @topic.children
                 @replies.reverse! if User.current.wants_comments_in_reverse_order?
                 @reply = Message.new(:subject => "RE: #{@message.subject}")
                 render :action => "show", :layout => false if request.xhr?
               end
               # Create a new topic
               def new
                 @message = Message.new(params[:message])
                 @message.author = User.current
                 @message.board = @board
                 if params[:message] && User.current.allowed_to?(:edit_messages, @project)
                   @message.locked = params[:message]['locked']
                   @message.sticky = params[:message]['sticky']
                 end
                 if request.post? && @message.save
                   attach_files(@message, params[:attachments])
                   redirect_to :action => 'show', :id => @message
                 end
               end
               # Reply to a topic
               def reply
                 @reply = Message.new(params[:reply])
                 @reply.author = User.current
                 @reply.board = @board
                 @topic.children << @reply
                 if !@reply.new_record?
                   attach_files(@reply, params[:attachments])
                 end
                 redirect_to :action => 'show', :id => @topic
               end
               # Edit a message
               def edit
                 if params[:message] && User.current.allowed_to?(:edit_messages, @project)
                   @message.locked = params[:message]['locked']
                   @message.sticky = params[:message]['sticky']
                 end
                 if request.post? && @message.update_attributes(params[:message])
                   attach_files(@message, params[:attachments])
                   flash[:notice] = l(:notice_successful_update)
                   redirect_to :action => 'show', :id => @topic
                 end
               end
               # Delete a messages
               def destroy
                 @message.destroy
                 redirect_to @message.parent.nil? ?
                   { :controller => 'boards', :action => 'show', :project_id => @project, :id => @board } :
                   { :action => 'show', :id => @message.parent }
               end
               def quote
                 user = @message.author
                 text = @message.content
                 content = "#{ll(Setting.default_language, :text_user_wrote, user)}\\n> "
                 content << text.to_s.strip.gsub(%r{<pre>((.|\s)*?)</pre>}m, '[...]').gsub('"', '\"').gsub(/(\r?\n|\r\n?)/, "\\n> ") + "\\n\\n"
                 render(:update) { |page|
                   page.<< "$('message_content').value = \"#{content}\";"
                   page.show 'reply'
                   page << "Form.Element.focus('message_content');"
                   page << "Element.scrollTo('reply');"
                   page << "$('message_content').scrollTop = $('message_content').scrollHeight - $('message_content').clientHeight;"
                 }
               end
               def preview
                 message = @board.messages.find_by_id(params[:id])
                 @attachements = message.attachments if message
                 @text = (params[:message] || params[:reply])[:content]
                 render :partial => 'common/preview'
               end
             private
               def find_message
                 find_board
                 @message = @board.messages.find(params[:id], :include => :parent)
                 @topic = @message.root
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
               def find_board
                 @board = Board.find(params[:board_id], :include => :project)
                 @project = @board.project
               rescue ActiveRecord::RecordNotFound
                 render_404
               end
             end

app/models/message.rb +9 0

             # redMine - project management software
             # Copyright (C) 2006-2007  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 Message < ActiveRecord::Base
               belongs_to :board
               belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
               acts_as_tree :counter_cache => :replies_count, :order => "#{Message.table_name}.created_on ASC"
               has_many :attachments, :as => :container, :dependent => :destroy
               belongs_to :last_reply, :class_name => 'Message', :foreign_key => 'last_reply_id'
               acts_as_searchable :columns => ['subject', 'content'],
                                  :include => {:board, :project},
                                  :project_key => 'project_id',
                                  :date_column => "#{table_name}.created_on"
               acts_as_event :title => Proc.new {|o| "#{o.board.name}: #{o.subject}"},
                             :description => :content,
                             :type => Proc.new {|o| o.parent_id.nil? ? 'message' : 'reply'},
                             :url => Proc.new {|o| {:controller => 'messages', :action => 'show', :board_id => o.board_id}.merge(o.parent_id.nil? ? {:id => o.id} :
                                                                                                                                                    {:id => o.parent_id, :anchor => "message-#{o.id}"})}
               acts_as_activity_provider :find_options => {:include => [{:board => :project}, :author]}
+              acts_as_watchable
               attr_protected :locked, :sticky
               validates_presence_of :subject, :content
               validates_length_of :subject, :maximum => 255
+              after_create :add_author_as_watcher
               def validate_on_create
                 # Can not reply to a locked topic
                 errors.add_to_base 'Topic is locked' if root.locked? && self != root
               end
               def after_create
                 board.update_attribute(:last_message_id, self.id)
                 board.increment! :messages_count
                 if parent
                   parent.reload.update_attribute(:last_reply_id, self.id)
                 else
                   board.increment! :topics_count
                 end
               end
               def after_destroy
                 # The following line is required so that the previous counter
                 # updates (due to children removal) are not overwritten
                 board.reload
                 board.decrement! :messages_count
                 board.decrement! :topics_count unless parent
               end
               def sticky?
                 sticky == 1
               end
               def project
                 board.project
               end
+              private
+              def add_author_as_watcher
+                Watcher.create(:watchable => self.root, :user => author)
+              end
             end

app/models/message_observer.rb +3 -2

             # redMine - project management software
             # Copyright (C) 2006-2007  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 MessageObserver < ActiveRecord::Observer
               def after_create(message)
-                # send notification to the authors of the thread
+                recipients = []
-                recipients = ([message.root] + message.root.children).collect {|m| m.author.mail if m.author && m.author.active?}
+                # send notification to the topic watchers
+                recipients += message.root.watcher_recipients
                 # send notification to the board watchers
                 recipients += message.board.watcher_recipients
                 # send notification to project members who want to be notified
                 recipients += message.board.project.recipients
                 recipients = recipients.compact.uniq
                 Mailer.deliver_message_posted(message, recipients) if !recipients.empty? && Setting.notified_events.include?('message_posted')
               end
             end

app/views/messages/show.rhtml +1 0

             <%= breadcrumb link_to(l(:label_board_plural), {:controller => 'boards', :action => 'index', :project_id => @project}),
                            link_to(h(@board.name), {:controller => 'boards', :action => 'show', :project_id => @project, :id => @board}) %>
             <div class="contextual">
+                <%= watcher_tag(@topic, User.current) %>
                 <%= link_to_remote_if_authorized l(:button_quote), { :url => {:action => 'quote', :id => @topic} }, :class => 'icon icon-comment' %>
                 <%= link_to_if_authorized l(:button_edit), {:action => 'edit', :id => @topic}, :class => 'icon icon-edit' %>
                 <%= link_to_if_authorized l(:button_delete), {:action => 'destroy', :id => @topic}, :method => :post, :confirm => l(:text_are_you_sure), :class => 'icon icon-del' %>
             </div>
             <h2><%=h @topic.subject %></h2>
             <div class="message">
             <p><span class="author"><%= authoring @topic.created_on, @topic.author %></span></p>
             <div class="wiki">
             <%= textilizable(@topic.content, :attachments => @topic.attachments) %>
             </div>
             <%= link_to_attachments @topic.attachments, :no_author => true %>
             </div>
             <br />
             <% unless @replies.empty? %>
             <h3 class="icon22 icon22-comment"><%= l(:label_reply_plural) %></h3>
             <% @replies.each do |message| %>
               <a name="<%= "message-#{message.id}" %>"></a>
               <div class="contextual">
                 <%= link_to_remote_if_authorized image_tag('comment.png'), { :url => {:action => 'quote', :id => message} }, :title => l(:button_quote) %>
                 <%= link_to_if_authorized image_tag('edit.png'), {:action => 'edit', :id => message}, :title => l(:button_edit) %>
                 <%= link_to_if_authorized image_tag('delete.png'), {:action => 'destroy', :id => message}, :method => :post, :confirm => l(:text_are_you_sure), :title => l(:button_delete) %>
               </div>
               <div class="message reply">
               <h4><%=h message.subject %> - <%= authoring message.created_on, message.author %></h4>
               <div class="wiki"><%= textilizable message, :content, :attachments => message.attachments %></div>
               <%= link_to_attachments message.attachments, :no_author => true %>
               </div>
             <% end %>
             <% end %>
             <% if !@topic.locked? && authorize_for('messages', 'reply') %>
             <p><%= toggle_link l(:button_reply), "reply", :focus => 'message_content' %></p>
             <div id="reply" style="display:none;">
             <% form_for :reply, @reply, :url => {:action => 'reply', :id => @topic}, :html => {:multipart => true, :id => 'message-form'} do |f| %>
               <%= render :partial => 'form', :locals => {:f => f, :replying => true} %>
               <%= submit_tag l(:button_submit) %>
               <%= link_to_remote l(:label_preview),
                                  { :url => { :controller => 'messages', :action => 'preview', :board_id => @board },
                                    :method => 'post',
                                    :update => 'preview',
                                    :with => "Form.serialize('message-form')",
                                    :complete => "Element.scrollTo('preview')"
                                  }, :accesskey => accesskey(:preview) %>
             <% end %>
             <div id="preview" class="wiki"></div>
             </div>
             <% end %>
             <% content_for :header_tags do %>
               <%= stylesheet_link_tag 'scm' %>
             <% end %>
             <% html_title h(@topic.subject) %>

test/fixtures/watchers.yml +4 0

             ---
             watchers_001:
               watchable_type: Issue
               watchable_id: 2
               user_id: 3
+            watchers_002:
+              watchable_type: Message
+              watchable_id: 1
+              user_id: 1
   No newline at end of file

test/unit/message_test.rb +12 -3

             require File.dirname(__FILE__) + '/../test_helper'
             class MessageTest < Test::Unit::TestCase
-              fixtures :projects, :boards, :messages
+              fixtures :projects, :boards, :messages, :users, :watchers
               def setup
                 @board = Board.find(1)
                 @user = User.find(1)
               end
               def test_create
                 topics_count = @board.topics_count
                 messages_count = @board.messages_count
                 message = Message.new(:board => @board, :subject => 'Test message', :content => 'Test message content', :author => @user)
                 assert message.save
                 @board.reload
                 # topics count incremented
                 assert_equal topics_count+1, @board[:topics_count]
                 # messages count incremented
                 assert_equal messages_count+1, @board[:messages_count]
                 assert_equal message, @board.last_message
+                # author should be watching the message
+                assert message.watched_by?(@user)
               end
               def test_reply
                 topics_count = @board.topics_count
                 messages_count = @board.messages_count
                 @message = Message.find(1)
                 replies_count = @message.replies_count
-                reply = Message.new(:board => @board, :subject => 'Test reply', :content => 'Test reply content', :parent => @message, :author => @user)
+                reply_author = User.find(2)
+                reply = Message.new(:board => @board, :subject => 'Test reply', :content => 'Test reply content', :parent => @message, :author => reply_author)
                 assert reply.save
                 @board.reload
                 # same topics count
                 assert_equal topics_count, @board[:topics_count]
                 # messages count incremented
                 assert_equal messages_count+1, @board[:messages_count]
                 assert_equal reply, @board.last_message
                 @message.reload
                 # replies count incremented
                 assert_equal replies_count+1, @message[:replies_count]
                 assert_equal reply, @message.last_reply
+                # author should be watching the message
+                assert @message.watched_by?(reply_author)
               end
               def test_destroy_topic
                 message = Message.find(1)
                 board = message.board
                 topics_count, messages_count = board.topics_count, board.messages_count
-                assert message.destroy
+                assert_difference('Watcher.count', -1) do
+                  assert message.destroy
+                end
                 board.reload
                 # Replies deleted
                 assert Message.find_all_by_parent_id(1).empty?
                 # Checks counters
                 assert_equal topics_count - 1, board.topics_count
                 assert_equal messages_count - 3, board.messages_count
+                # Watchers removed
               end
               def test_destroy_reply
                 message = Message.find(5)
                 board = message.board
                 topics_count, messages_count = board.topics_count, board.messages_count
                 assert message.destroy
                 board.reload
                 # Checks counters
                 assert_equal topics_count, board.topics_count
                 assert_equal messages_count - 1, board.messages_count
               end
             end

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages