CSC/ECE 517 Spring 2017 E1711: Difference between revisions

From Expertiza_Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<font size="5"><b> E1711. Refactor delayed_mailer.rb and scheduled_task.rb</b></font>
<font size="5"><b> E1711. Refactor delayed_mailer.rb and scheduled_task.rb</b></font>
__TOC__


=Overview=
=Overview=
Line 7: Line 9:
[http://expertiza.ncsu.edu/ Expertiza] is a web based tool that allows instructors to create collaborative assignments where students can provide peer feedback on each others work.  It provides instructors a system to manage assignments and different courses.
[http://expertiza.ncsu.edu/ Expertiza] is a web based tool that allows instructors to create collaborative assignments where students can provide peer feedback on each others work.  It provides instructors a system to manage assignments and different courses.


==Goal of project E1711==
==Scope of project E1711==
The goal of E1711 was to refactor code found in the files delayed_mailer.rb and scheduled_task.rb.  scheduled_task.rb was added as a part of project Project E1529 (make this a link) and duplicated the vast majority of the code in delayed_mailer.rb.  One of the goals of this project was
The goal of E1711 was to refactor code found in the files <i>delayed_mailer.rb</i> and <i>scheduled_task.rb</i>.   


__TOC__
The following issues were identified as the scope of this project


=Scope=
* <i>scheduled_task.rb</i> duplicated most of its code from <i>delayed_mailer.rb</i>. Our objective is to reduce/remove the duplication in keeping with the DRY principle.
==Project Scope==
* The <code>perform</code> method uses a giant case statement, instead we were to incorporate the use of polymorphism
E1451. ​Create Mailers for All Email Messages [https://github.com/expertiza/expertiza/pull/445 github] [http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2014/OSS_E1451_las wiki] [http://expertiza.ncsu.edu/submitted_content/download/28122?current_folder%5Bname%5D=%2Flocal%2Frails%2Fexpertiza%2Freleases%2F20140702225848%2Fpg_data%2Fefg%2Fcsc517%2Ff14%2F%2F18&download=E1451_Report.pdf report] (Merged in [https://docs.google.com/a/ncsu.edu/document/d/1aypHb5UOe-3nPfruNeh2HZjeT-wfv6f-ZsZg2jDMNkQ/edit E1483])
* The <code>mail_signed_up_users</code> is long and should be broken into smaller and better named methods
* Add/modify test cases as we added/removed/modified areas of the code

Revision as of 23:43, 22 March 2017

E1711. Refactor delayed_mailer.rb and scheduled_task.rb

Overview

Introduction to Expertiza

Expertiza is a web based tool that allows instructors to create collaborative assignments where students can provide peer feedback on each others work. It provides instructors a system to manage assignments and different courses.

Scope of project E1711

The goal of E1711 was to refactor code found in the files delayed_mailer.rb and scheduled_task.rb.

The following issues were identified as the scope of this project

  • scheduled_task.rb duplicated most of its code from delayed_mailer.rb. Our objective is to reduce/remove the duplication in keeping with the DRY principle.
  • The perform method uses a giant case statement, instead we were to incorporate the use of polymorphism
  • The mail_signed_up_users is long and should be broken into smaller and better named methods
  • Add/modify test cases as we added/removed/modified areas of the code
Retrieved from "https://wiki.expertiza.ncsu.edu/index.php?title=CSC/ECE_517_Spring_2017_E1711&oldid=107138"