jro_apps/redmine Commit - r2548:b4be8849c0de

Added observers to watch model objects for mail delivery instead of calling Mailer....

Eric Davis -

r2548:b4be8849c0de

parent child

Context file:

r2548:b4be8849c0de

Collapse all files

app/models/document_observer.rb created 644 +22 0

@@ -0,0 +1,22
	1	# redMine - project management software
	2	# Copyright (C) 2006-2007 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 DocumentObserver < ActiveRecord::Observer
	19	def after_create(document)
	20	Mailer.deliver_document_added(document) if Setting.notified_events.include?('document_added')
	21	end
	22	end

app/models/issue_observer.rb created 644 +22 0

@@ -0,0 +1,22
	1	# redMine - project management software
	2	# Copyright (C) 2006-2007 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 IssueObserver < ActiveRecord::Observer
	19	def after_create(issue)
	20	Mailer.deliver_issue_add(issue) if Setting.notified_events.include?('issue_added')
	21	end
	22	end

app/models/journal_observer.rb created 644 +22 0

@@ -0,0 +1,22
	1	# redMine - project management software
	2	# Copyright (C) 2006-2007 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 JournalObserver < ActiveRecord::Observer
	19	def after_create(journal)
	20	Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
	21	end
	22	end

app/models/news_observer.rb created 644 +22 0

@@ -0,0 +1,22
	1	# redMine - project management software
	2	# Copyright (C) 2006-2007 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 NewsObserver < ActiveRecord::Observer
	19	def after_create(news)
	20	Mailer.deliver_news_added(news) if Setting.notified_events.include?('news_added')
	21	end
	22	end

app/controllers/documents_controller.rb 0 -1

                 if request.post? and @document.save
                   attach_files(@document, params[:attachments])
                   flash[:notice] = l(:notice_successful_create)
-                  Mailer.deliver_document_added(@document) if Setting.notified_events.include?('document_added')
                   redirect_to :action => 'index', :project_id => @project
                 end
               end

app/controllers/issues_controller.rb +1 -6

                   if @issue.save
                     attach_files(@issue, params[:attachments])
                     flash[:notice] = l(:notice_successful_create)
-                    Mailer.deliver_issue_add(@issue) if Setting.notified_events.include?('issue_added')
                     call_hook(:controller_issues_new_after_save, { :params => params, :issue => @issue})
                     redirect_to(params[:continue] ? { :action => 'new', :tracker_id => @issue.tracker } :
                                                     { :action => 'show', :id => @issue })
                     if !journal.new_record?
                       # Only send notification if something was actually changed
                       flash[:notice] = l(:notice_successful_update)
-                      Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
                     end
                     call_hook(:controller_issues_edit_after_save, { :params => params, :issue => @issue, :time_entry => @time_entry, :journal => journal})
                     redirect_to(params[:back_to] || {:action => 'show', :id => @issue})
                     issue.custom_field_values = custom_field_values if custom_field_values && !custom_field_values.empty?
                     call_hook(:controller_issues_bulk_edit_before_save, { :params => params, :issue => issue })
                     # Don't save any change to the issue if the user is not authorized to apply the requested status
-                    if (status.nil? || (issue.status.new_status_allowed_to?(status, current_role, issue.tracker) && issue.status = status)) && issue.save
+                    unless (status.nil? || (issue.status.new_status_allowed_to?(status, current_role, issue.tracker) && issue.status = status)) && issue.save
-                      # Send notification for each issue (if changed)
-                      Mailer.deliver_issue_edit(journal) if journal.details.any? && Setting.notified_events.include?('issue_updated')
-                    else
                       # Keep unsaved issue ids to display them in flash error
                       unsaved_issue_ids << issue.id
                     end

app/controllers/news_controller.rb 0 -1

                   @news.attributes = params[:news]
                   if @news.save
                     flash[:notice] = l(:notice_successful_create)
-                    Mailer.deliver_news_added(@news) if Setting.notified_events.include?('news_added')
                     redirect_to :controller => 'news', :action => 'index', :project_id => @project
                   end
                 end

app/models/changeset.rb 0 -1

                       issue.status = fix_status
                       issue.done_ratio = done_ratio if done_ratio
                       issue.save
-                      Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
                     end
                   end
                   referenced_issues += target_issues

app/models/mail_handler.rb +2 -5

                   end
                   h
                 end
+                # add To and Cc as watchers before saving so the watchers can reply to Redmine
+                add_watchers(issue)
                 issue.save!
                 add_attachments(issue)
                 logger.info "MailHandler: issue ##{issue.id} created by #{user}" if logger && logger.info
-                # add To and Cc as watchers
-                add_watchers(issue)
-                # send notification after adding watchers so that they can reply to Redmine
-                Mailer.deliver_issue_add(issue) if Setting.notified_events.include?('issue_added')
                 issue
               end
                 end
                 issue.save!
                 logger.info "MailHandler: issue ##{issue.id} updated by #{user}" if logger && logger.info
-                Mailer.deliver_issue_edit(journal) if Setting.notified_events.include?('issue_updated')
                 journal
               end

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
+              config.active_record.observers = :message_observer, :issue_observer, :journal_observer, :news_observer, :document_observer
               # Make Active Record use UTC-base instead of local time
               # config.active_record.default_timezone = :utc

test/functional/documents_controller_test.rb +3 0

               end
               def test_new_with_one_attachment
+                ActionMailer::Base.deliveries.clear
+                Setting.notified_events << 'document_added'
                 @request.session[:user_id] = 2
                 set_tmp_attachments_directory
                 assert_equal Enumeration.find(2), document.category
                 assert_equal 1, document.attachments.size
                 assert_equal 'testfile.txt', document.attachments.first.filename
+                assert_equal 1, ActionMailer::Base.deliveries.size
               end
               def test_edit_routing

test/functional/issues_controller_test.rb +45 0

@@ -503,6 +503,21 class IssuesControllerTest < Test::Unit::TestCase
503	assert [mail.bcc, mail.cc].flatten.include?(User.find(3).mail)	503	assert [mail.bcc, mail.cc].flatten.include?(User.find(3).mail)
504	end	504	end
505		505
		506	def test_post_new_should_send_a_notification
		507	ActionMailer::Base.deliveries.clear
		508	@request.session[:user_id] = 2
		509	post :new, :project_id => 1,
		510	:issue => {:tracker_id => 3,
		511	:subject => 'This is the test_new issue',
		512	:description => 'This is the description',
		513	:priority_id => 5,
		514	:estimated_hours => '',
		515	:custom_field_values => {'2' => 'Value for field 2'}}
		516	assert_redirected_to :action => 'show'
		517
		518	assert_equal 1, ActionMailer::Base.deliveries.size
		519	end
		520
506	def test_post_should_preserve_fields_values_on_validation_failure	521	def test_post_should_preserve_fields_values_on_validation_failure
507	@request.session[:user_id] = 2	522	@request.session[:user_id] = 2
508	post :new, :project_id => 1,	523	post :new, :project_id => 1,
@@ -760,6 +775,20 class IssuesControllerTest < Test::Unit::TestCase
760	# No email should be sent	775	# No email should be sent
761	assert ActionMailer::Base.deliveries.empty?	776	assert ActionMailer::Base.deliveries.empty?
762	end	777	end
		778
		779	def test_post_edit_should_send_a_notification
		780	@request.session[:user_id] = 2
		781	ActionMailer::Base.deliveries.clear
		782	issue = Issue.find(1)
		783	old_subject = issue.subject
		784	new_subject = 'Subject modified by IssuesControllerTest#test_post_edit'
		785
		786	post :edit, :id => 1, :issue => {:subject => new_subject,
		787	:priority_id => '6',
		788	:category_id => '1' # no change
		789	}
		790	assert_equal 1, ActionMailer::Base.deliveries.size
		791	end
763		792
764	def test_post_edit_with_invalid_spent_time	793	def test_post_edit_with_invalid_spent_time
765	@request.session[:user_id] = 2	794	@request.session[:user_id] = 2
@@ -797,6 +826,22 class IssuesControllerTest < Test::Unit::TestCase
797	assert_equal 1, journal.details.size	826	assert_equal 1, journal.details.size
798	end	827	end
799		828
		829	def test_bullk_edit_should_send_a_notification
		830	@request.session[:user_id] = 2
		831	ActionMailer::Base.deliveries.clear
		832	post(:bulk_edit,
		833	{
		834	:ids => [1, 2],
		835	:priority_id => 7,
		836	:assigned_to_id => '',
		837	:custom_field_values => {'2' => ''},
		838	:notes => 'Bulk editing'
		839	})
		840
		841	assert_response 302
		842	assert_equal 2, ActionMailer::Base.deliveries.size
		843	end
		844
800	def test_bulk_edit_custom_field	845	def test_bulk_edit_custom_field
801	@request.session[:user_id] = 2	846	@request.session[:user_id] = 2
802	# update issues priority	847	# update issues priority

test/functional/news_controller_test.rb +4 0

               end
               def test_post_new
+                ActionMailer::Base.deliveries.clear
+                Setting.notified_events << 'news_added'
                 @request.session[:user_id] = 2
                 post :new, :project_id => 1, :news => { :title => 'NewsControllerTest',
                                                         :description => 'This is the description',
                 assert_equal 'This is the description', news.description
                 assert_equal User.find(2), news.author
                 assert_equal Project.find(1), news.project
+                assert_equal 1, ActionMailer::Base.deliveries.size
               end
               def test_edit_routing

test/unit/changeset_test.rb +2 0

               end
               def test_ref_keywords_any
+                ActionMailer::Base.deliveries.clear
                 Setting.commit_fix_status_id = IssueStatus.find(:first, :conditions => ["is_closed = ?", true]).id
                 Setting.commit_fix_done_ratio = '90'
                 Setting.commit_ref_keywords = '*'
                 fixed = Issue.find(1)
                 assert fixed.closed?
                 assert_equal 90, fixed.done_ratio
+                assert_equal 1, ActionMailer::Base.deliveries.size
               end
               def test_ref_keywords_any_line_start

test/unit/document_test.rb +9 0

@@ -25,6 +25,15 class DocumentTest < Test::Unit::TestCase
25	assert doc.save	25	assert doc.save
26	end	26	end
27		27
		28	def test_create_should_send_email_notification
		29	ActionMailer::Base.deliveries.clear
		30	Setting.notified_events << 'document_added'
		31	doc = Document.new(:project => Project.find(1), :title => 'New document', :category => Enumeration.find_by_name('User documentation'))
		32
		33	assert doc.save
		34	assert_equal 1, ActionMailer::Base.deliveries.size
		35	end
		36
28	def test_create_with_default_category	37	def test_create_with_default_category
29	# Sets a default category	38	# Sets a default category
30	e = Enumeration.find_by_name('Technical documentation')	39	e = Enumeration.find_by_name('Technical documentation')

test/unit/issue_test.rb +8 0

@@ -241,4 +241,12 class IssueTest < Test::Unit::TestCase
241	assert !Issue.new(:due_date => nil).overdue?	241	assert !Issue.new(:due_date => nil).overdue?
242	assert !Issue.new(:due_date => 1.day.ago.to_date, :status => IssueStatus.find(:first, :conditions => {:is_closed => true})).overdue?	242	assert !Issue.new(:due_date => 1.day.ago.to_date, :status => IssueStatus.find(:first, :conditions => {:is_closed => true})).overdue?
243	end	243	end
		244
		245	def test_create_should_send_email_notification
		246	ActionMailer::Base.deliveries.clear
		247	issue = Issue.new(:project_id => 1, :tracker_id => 1, :author_id => 3, :status_id => 1, :priority => Enumeration.priorities.first, :subject => 'test_create', :estimated_hours => '1:30')
		248
		249	assert issue.save
		250	assert_equal 1, ActionMailer::Base.deliveries.size
		251	end
244	end	252	end

test/unit/journal_test.rb +11 0

@@ -36,4 +36,15 class JournalTest < Test::Unit::TestCase
36	assert_kind_of IssueStatus, status	36	assert_kind_of IssueStatus, status
37	assert_equal 2, status.id	37	assert_equal 2, status.id
38	end	38	end
		39
		40	def test_create_should_send_email_notification
		41	ActionMailer::Base.deliveries.clear
		42	issue = Issue.find(:first)
		43	user = User.find(:first)
		44	journal = issue.init_journal(user, issue)
		45
		46	assert journal.save
		47	assert_equal 1, ActionMailer::Base.deliveries.size
		48	end
		49
39	end	50	end

test/unit/mail_handler_test.rb +15 0

                 Role.anonymous.add_permission!(:add_issues)
                 assert_equal false, submit_email('ticket_without_from_header.eml')
               end
+              def test_add_issue_should_send_email_notification
+                ActionMailer::Base.deliveries.clear
+                # This email contains: 'Project: onlinestore'
+                issue = submit_email('ticket_on_given_project.eml')
+                assert issue.is_a?(Issue)
+                assert_equal 1, ActionMailer::Base.deliveries.size
+              end
               def test_add_issue_note
                 journal = submit_email('ticket_reply.eml')
                 assert_match /This is reply/, journal.notes
                 assert_equal IssueStatus.find_by_name("Resolved"), issue.status
               end
+              def test_add_issue_note_should_send_email_notification
+                ActionMailer::Base.deliveries.clear
+                journal = submit_email('ticket_reply.eml')
+                assert journal.is_a?(Journal)
+                assert_equal 1, ActionMailer::Base.deliveries.size
+              end
               def test_reply_to_a_message
                 m = submit_email('message_reply.eml')

test/unit/news_test.rb +17 -3

             class NewsTest < Test::Unit::TestCase
               fixtures :projects, :users, :roles, :members, :enabled_modules, :news
+              def valid_news
+                { :title => 'Test news', :description => 'Lorem ipsum etc', :author => User.find(:first) }
+              end
               def setup
               end
+              def test_create_should_send_email_notification
+                ActionMailer::Base.deliveries.clear
+                Setting.notified_events << 'news_added'
+                news = Project.find(:first).news.new(valid_news)
+                assert news.save
+                assert_equal 1, ActionMailer::Base.deliveries.size
+              end
               def test_should_include_news_for_projects_with_news_enabled
                 project = projects(:projects_001)
                 assert project.enabled_modules.any?{ |em| em.name == 'news' }
                 assert ! project.enabled_modules.any?{ |em| em.name == 'news' }
                 # Add a piece of news to the project
-                news = project.news.create(:title => 'Test news', :description => 'This should not be returned by News.latest')
+                news = project.news.create(valid_news)
                 # News.latest should not return that new piece of news
                 assert News.latest.include?(news) == false
               def test_should_limit_the_amount_of_returned_news
                 # Make sure we have a bunch of news stories
-.times { projects(:projects_001).news.create(:title => 'Test news', :description => 'Lorem ipsum etc') }
+.times { projects(:projects_001).news.create(valid_news) }
                 assert_equal 2, News.latest(users(:users_002), 2).size
                 assert_equal 6, News.latest(users(:users_002), 6).size
               end
               def test_should_return_5_news_stories_by_default
                 # Make sure we have a bunch of news stories
-.times { projects(:projects_001).news.create(:title => 'Test news', :description => 'Lorem ipsum etc') }
+.times { projects(:projects_001).news.create(valid_news) }
                 assert_equal 5, News.latest(users(:users_004)).size
               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