jro_apps/redmine Commit - r4883:36009de154e0

Adds email notifications support for news comments (#2074)....

Jean-Philippe Lang -

r4883:36009de154e0

parent child

Context file:

r4883:36009de154e0

Collapse all files

app/models/comment_observer.rb created 644 +24 0

@@ -0,0 +1,24
	1	# Redmine - project management software
	2	# Copyright (C) 2006-2011 Jean-Philippe Lang
	3	#
	4	# This program is free software; you can redistribute it and/or
	5	# modify it under the terms of the GNU General Public License
	6	# as published by the Free Software Foundation; either version 2
	7	# of the License, or (at your option) any later version.
	8	#
	9	# This program is distributed in the hope that it will be useful,
	10	# but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	# GNU General Public License for more details.
	13	#
	14	# You should have received a copy of the GNU General Public License
	15	# along with this program; if not, write to the Free Software
	16	# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
	17
	18	class CommentObserver < ActiveRecord::Observer
	19	def after_create(comment)
	20	if comment.commented.is_a?(News) && Setting.notified_events.include?('news_comment_added')
	21	Mailer.deliver_news_comment_added(comment)
	22	end
	23	end
	24	end

app/views/mailer/news_comment_added.text.html.rhtml created 644 +5 0

@@ -0,0 +1,5
	1	<h1><%= link_to(h(@news.title), @news_url) %></h1>
	2
	3	<p><%= l(:text_user_wrote, :value => h(@comment.author)) %></p>
	4
	5	<%= textilizable @comment, :comments, :only_path => false %>

app/views/mailer/news_comment_added.text.plain.rhtml created 644 +6 0

@@ -0,0 +1,6
	1	<%= @news.title %>
	2	<%= @news_url %>
	3
	4	<%= l(:text_user_wrote, :value => @comment.author) %>
	5
	6	<%= @comment.comments %>

app/controllers/news_controller.rb +4 -2

-            # redMine - project management software
+            # Redmine - project management software
-            # Copyright (C) 2006  Jean-Philippe Lang
+            # Copyright (C) 2006-2011  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
               before_filter :find_optional_project, :only => :index
               accept_key_auth :index
+              helper :watchers
               def index
                 case params[:format]
                 when 'xml', 'json'

app/models/mailer.rb +20 -2

@@ -1,5 +1,5
1	# ~~redM~~ine - project management software	1	# Redmine - project management software
2	# Copyright (C) 2006-2007 Jean-Philippe Lang	2	# Copyright (C) 2006-2011 Jean-Philippe Lang
3	#	3	#
4	# This program is free software; you can redistribute it and/or	4	# This program is free software; you can redistribute it and/or
5	# modify it under the terms of the GNU General Public License	5	# modify it under the terms of the GNU General Public License
@@ -148,6 +148,24 class Mailer < ActionMailer::Base
148	:news_url => url_for(:controller => 'news', :action => 'show', :id => news)	148	:news_url => url_for(:controller => 'news', :action => 'show', :id => news)
149	render_multipart('news_added', body)	149	render_multipart('news_added', body)
150	end	150	end
		151
		152	# Builds a tmail object used to email recipients of a news' project when a news comment is added.
		153	#
		154	# Example:
		155	# news_comment_added(comment) => tmail object
		156	# Mailer.news_comment_added(comment) => sends an email to the news' project recipients
		157	def news_comment_added(comment)
		158	news = comment.commented
		159	redmine_headers 'Project' => news.project.identifier
		160	message_id comment
		161	recipients news.recipients
		162	cc news.watcher_recipients
		163	subject "Re: [#{news.project.name}] #{l(:label_news)}: #{news.title}"
		164	body :news => news,
		165	:comment => comment,
		166	:news_url => url_for(:controller => 'news', :action => 'show', :id => news)
		167	render_multipart('news_comment_added', body)
		168	end
151		169
152	# Builds a tmail object used to email the recipients of the specified message that was posted.	170	# Builds a tmail object used to email the recipients of the specified message that was posted.
153	#	171	#

app/models/news.rb +10 -1

             # Redmine - project management software
-            # Copyright (C) 2006-2008  Jean-Philippe Lang
+            # Copyright (C) 2006-2011  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
               acts_as_event :url => Proc.new {|o| {:controller => 'news', :action => 'show', :id => o.id}}
               acts_as_activity_provider :find_options => {:include => [:project, :author]},
                                         :author_key => :author_id
+              acts_as_watchable
+              after_create :add_author_as_watcher
               named_scope :visible, lambda {|*args| {
                 :include => :project,
               def self.latest(user = User.current, count = 5)
                 find(:all, :limit => count, :conditions => Project.allowed_to_condition(user, :view_news), :include => [ :author, :project ], :order => "#{News.table_name}.created_on DESC")
               end
+              private
+              def add_author_as_watcher
+                Watcher.create(:watchable => self, :user => author)
+              end
             end

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

             <div class="contextual">
+            <%= watcher_tag(@news, User.current) %>
             <%= link_to(l(:button_edit),
                   edit_news_path(@news),
                   :class => 'icon icon-edit',

config/environment.rb +1 -1

               # Activate observers that should always be running
               # config.active_record.observers = :cacher, :garbage_collector
-              config.active_record.observers = :message_observer, :issue_observer, :journal_observer, :news_observer, :document_observer, :wiki_content_observer
+              config.active_record.observers = :message_observer, :issue_observer, :journal_observer, :news_observer, :document_observer, :wiki_content_observer, :comment_observer
               # Make Active Record use UTC-base instead of local time
               # config.active_record.default_timezone = :utc

config/locales/en.yml +1 0

               label_news_latest: Latest news
               label_news_view_all: View all news
               label_news_added: News added
+              label_news_comment_added: Comment added to a news
               label_settings: Settings
               label_overview: Overview
               label_version: Version

config/locales/fr.yml +1 0

               label_news_latest: Dernières annonces
               label_news_view_all: Voir toutes les annonces
               label_news_added: Annonce ajoutée
+              label_news_comment_added: Commentaire ajouté à une annonce
               label_settings: Configuration
               label_overview: Aperçu
               label_version: Version

lib/redmine/notifiable.rb +1 0

                   notifications << Notifiable.new('issue_status_updated', 'issue_updated')
                   notifications << Notifiable.new('issue_priority_updated', 'issue_updated')
                   notifications << Notifiable.new('news_added')
+                  notifications << Notifiable.new('news_comment_added')
                   notifications << Notifiable.new('document_added')
                   notifications << Notifiable.new('file_added')
                   notifications << Notifiable.new('message_posted')

test/unit/comment_test.rb +11 -2

-            # redMine - project management software
+            # Redmine - project management software
-            # Copyright (C) 2006-2007  Jean-Philippe Lang
+            # Copyright (C) 2006-2011  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
                 @news.reload
                 assert_equal 2, @news.comments_count
               end
+              def test_create_should_send_notification
+                Setting.notified_events << 'news_comment_added'
+                Watcher.create!(:watchable => @news, :user => @jsmith)
+                assert_difference 'ActionMailer::Base.deliveries.size' do
+                  Comment.create!(:commented => @news, :author => @jsmith, :comments => "my comment")
+                end
+              end
               def test_validate
                 comment = Comment.new(:commented => @news)

test/unit/lib/redmine/notifiable_test.rb +4 -4

-            # redMine - project management software
+            # Redmine - project management software
-            # Copyright (C) 2006-2008  Jean-Philippe Lang
+            # Copyright (C) 2006-2011  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
               end
               def test_all
-                assert_equal 11, Redmine::Notifiable.all.length
+                assert_equal 12, Redmine::Notifiable.all.length
-                %w(issue_added issue_updated issue_note_added issue_status_updated issue_priority_updated news_added document_added file_added message_posted wiki_content_added wiki_content_updated).each do |notifiable|
+                %w(issue_added issue_updated issue_note_added issue_status_updated issue_priority_updated news_added news_comment_added document_added file_added message_posted wiki_content_added wiki_content_updated).each do |notifiable|
                   assert Redmine::Notifiable.all.collect(&:name).include?(notifiable), "missing #{notifiable}"
                 end
               end

test/unit/mailer_test.rb +11 -3

-            # redMine - project management software
+            # Redmine - project management software
-            # Copyright (C) 2006-2007  Jean-Philippe Lang
+            # Copyright (C) 2006-2011  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
             class MailerTest < ActiveSupport::TestCase
               include Redmine::I18n
               include ActionController::Assertions::SelectorAssertions
-              fixtures :projects, :enabled_modules, :issues, :users, :members, :member_roles, :roles, :documents, :attachments, :news, :tokens, :journals, :journal_details, :changesets, :trackers, :issue_statuses, :enumerations, :messages, :boards, :repositories
+              fixtures :all
               def setup
                 ActionMailer::Base.deliveries.clear
                 end
               end
+              def test_news_comment_added
+                comment = Comment.find(2)
+                valid_languages.each do |lang|
+                  Setting.default_language = lang.to_s
+                  assert Mailer.deliver_news_comment_added(comment)
+                end
+              end
               def test_message_posted
                 message = Message.find(:first)
                 recipients = ([message.root] + message.root.children).collect {|m| m.author.mail if m.author}

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