Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T03:53:38Z

Mdong3: /* support more schedule tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delayed_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks into <code>delayed_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end

# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store each task's assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. In this file, we use a <code>@scheduled_jobs = DelayedJob.all </code> to read all datas from the "delayed_jobs" table. .
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures shows our UI works. 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
According to the project E1478<ref>https://github.com/expertiza/expertiza/pull/462</ref>, there is a <code>paper_trail</code><ref>https://github.com/expertiza/expertiza/pull/462</ref> gem can keep log of the models' data. What we need to do is let it also keep track of our scheduled task data. 
Since the gem need to work with <code>ActiveRecord 3+</code>, while <code>assignment_form</code> doesn't. So we created a new file named <code>delayed_job.rb</code> in <code>models</code> folder, add <code>has_paper_trail</code> in it. Then it is like: 
<pre>
class DelayedJob < Delayed::Job
has_paper_trail
end
</pre>
After that, every time when the <code>delayed_jobs</code> table has added or deleted or updated data, the log can keep track of them. The following picture shows what the log is after creating scheduled tasks. 
[[File:scheduledtasklog.png|frame|center|four scheduled tasks are added in log]] 

==support more schedule tasks==
For each scheduled task, we have done the followings:

*Create a new deadline type called "drop_outstanding_reviews". When we set the review’s due date, add an item into “delayed job” queue at the same time. When the review is due, it will automatically call a method to find all the outstanding reviews (reviews which have not been started) in the database then delete them.
There are two tables in the database to store the information about the reviews: <code>responses</code> and <code>response_maps </code>. 
<code>responses</code> is used to store all the submitted reviews while <code>response_maps</code> stores all the requested reviews, which means if one review has began it will not stored in <code>responses</code> table. Thus, we just need to find the review data in <code>response_maps</code> while not in <code>responses</code> for one assignment and delete them in database. 
We add a method in <code>/models/scheduled_task.rb</code> named <code>drop_outstanding_reviews</code> to drop those reviews. 
<pre>
def drop_outstanding_reviews
reviews = ResponseMap.where(reviewed_object_id: self.assignment_id)
for review in reviews
review_has_began = Response.where(map_id: review.id)
if review_has_began.size.zero?
review_to_drop = ResponseMap.where(id: review.id)
review_to_drop.first.destroy
end
end
end
</pre>
Then, add the following code in <code>perform</code> method of the same file to drop one specified assignment's outstanding reviews at the due time. 
<pre>
if(self.deadline_type == "drop_one_member_topics")
assignment = Assignment.find(self.assignment_id)
if(assignment.team_assignment?)
drop_one_member_topics
end
end
</pre>
*Use a previously existed deadline type called "team_formation" and enable to set a team_formation's due date and a reminder. Then add an item into “delayed job” at the same time. When “delayed job” is triggered, it will automatically call a method to find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.

*Create a new deadline type called "drop_one_member_topics". When time is due, the system will call a method to find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T03:52:53Z

Mdong3: /* support more schedule tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delayed_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks into <code>delayed_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end

# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store each task's assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. In this file, we use a <code>@scheduled_jobs = DelayedJob.all </code> to read all datas from the "delayed_jobs" table. .
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures shows our UI works. 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
According to the project E1478<ref>https://github.com/expertiza/expertiza/pull/462</ref>, there is a <code>paper_trail</code><ref>https://github.com/expertiza/expertiza/pull/462</ref> gem can keep log of the models' data. What we need to do is let it also keep track of our scheduled task data. 
Since the gem need to work with <code>ActiveRecord 3+</code>, while <code>assignment_form</code> doesn't. So we created a new file named <code>delayed_job.rb</code> in <code>models</code> folder, add <code>has_paper_trail</code> in it. Then it is like: 
<pre>
class DelayedJob < Delayed::Job
has_paper_trail
end
</pre>
After that, every time when the <code>delayed_jobs</code> table has added or deleted or updated data, the log can keep track of them. The following picture shows what the log is after creating scheduled tasks. 
[[File:scheduledtasklog.png|frame|center|four scheduled tasks are added in log]] 

==support more schedule tasks==
For each scheduled task, we have done the followings:

*Create a new deadline type called "drop_outstanding_reviews". When we set the review’s due date, add an item into “delayed job” queue at the same time. When the review is due, it will automatically call a method to find all the outstanding reviews (reviews which have not been started) in the database then delete them.
There are two table in the database to store the information about the reviews: <code>responses</code> and <code>response_maps </code>. 
<code>responses</code> is used to store all the submitted reviews while <code>response_maps</code> stores all the requested reviews, which means if one review has began it will not stored in <code>responses</code> table. Thus, we just need to find the review data in <code>response_maps</code> while not in <code>responses</code> for one assignment and delete them in database. 
We add a method in <code>/models/scheduled_task.rb</code> named <code>drop_outstanding_reviews</code> to drop those reviews. 
<pre>
def drop_outstanding_reviews
reviews = ResponseMap.where(reviewed_object_id: self.assignment_id)
for review in reviews
review_has_began = Response.where(map_id: review.id)
if review_has_began.size.zero?
review_to_drop = ResponseMap.where(id: review.id)
review_to_drop.first.destroy
end
end
end
</pre>
Then, add the following code in <code>perform</code> method of the same file to drop one specified assignment's outstanding reviews at the due time. 
<pre>
if(self.deadline_type == "drop_one_member_topics")
assignment = Assignment.find(self.assignment_id)
if(assignment.team_assignment?)
drop_one_member_topics
end
end
</pre>
*Use a previously existed deadline type called "team_formation" and enable to set a team_formation's due date and a reminder. Then add an item into “delayed job” at the same time. When “delayed job” is triggered, it will automatically call a method to find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.

*Create a new deadline type called "drop_one_member_topics". When time is due, the system will call a method to find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T03:48:49Z

Mdong3: /* support more schedule tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delayed_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks into <code>delayed_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end

# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store each task's assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. In this file, we use a <code>@scheduled_jobs = DelayedJob.all </code> to read all datas from the "delayed_jobs" table. .
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures shows our UI works. 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
According to the project E1478<ref>https://github.com/expertiza/expertiza/pull/462</ref>, there is a <code>paper_trail</code><ref>https://github.com/expertiza/expertiza/pull/462</ref> gem can keep log of the models' data. What we need to do is let it also keep track of our scheduled task data. 
Since the gem need to work with <code>ActiveRecord 3+</code>, while <code>assignment_form</code> doesn't. So we created a new file named <code>delayed_job.rb</code> in <code>models</code> folder, add <code>has_paper_trail</code> in it. Then it is like: 
<pre>
class DelayedJob < Delayed::Job
has_paper_trail
end
</pre>
After that, every time when the <code>delayed_jobs</code> table has added or deleted or updated data, the log can keep track of them. The following picture shows what the log is after creating scheduled tasks. 
[[File:scheduledtasklog.png|frame|center|four scheduled tasks are added in log]] 

==support more schedule tasks==
For each scheduled task, we have done the followings:

*Create a new deadline type called "drop_outstanding_reviews". When we set the review’s due date, add an item into “delayed job” queue at the same time. When the review is due, it will automatically call a method to find all the outstanding reviews (reviews which have not been started) in the database then delete them.
There are two table in the database to store the information about the reviews: <code>responses</code> and <code>response_maps</code>. 
<code>responses</code> is used to store all the submitted reviews while <code>response_maps</code> stores all the requested reviews, which means if one review has began it will not stored in <code>responses</code> table. Thus, we just need to find the review data in <code>response_maps</code> while not in <code>responses</code> for one assignment and delete them in database. 
We add a method in <code>/models/scheduled_task.rb</code> named <code>drop_outstanding_reviews</code> to drop those reviews. 
<pre>
def drop_outstanding_reviews
reviews = ResponseMap.where(reviewed_object_id: self.assignment_id)
for review in reviews
review_has_began = Response.where(map_id: review.id)
if review_has_began.size.zero?
review_to_drop = ResponseMap.where(id: review.id)
review_to_drop.first.destroy
end
end
end
</pre>
Then, in add following code in <code>perform</code> method of the same file to drop one kind assignment's outstanding reviews at the due time. 
<pre>
if(self.deadline_type == "drop_one_member_topics")
assignment = Assignment.find(self.assignment_id)
if(assignment.team_assignment?)
drop_one_member_topics
end
end
</pre>
*Use a previously existed deadline type called "team_formation" and enable to set a team_formation's due date and a reminder. Then add an item into “delayed job” at the same time. When “delayed job” is triggered, it will automatically call a method to find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.

*Create a new deadline type called "drop_one_member_topics". When time is due, the system will call a method to find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T03:25:55Z

Mdong3: /* Keep log of the scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delayed_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delayed_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end

# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. 
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures are our UI work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
According to the project E1478<ref>https://github.com/expertiza/expertiza/pull/462</ref>, there is a <code>paper_trail</code><ref>https://github.com/expertiza/expertiza/pull/462</ref> gem can keep log of the models' data. What we need to do is let it also keep track of our scheduled task data. 
Since the gem need to work with <code>ActiveRecord 3+</code>, while <code>assignment_form</code> doesn't. So we created a new file named <code>delayed_job.rb</code> in <code>models</code> folder, add <code>has_paper_trail</code> in it. Then it is like: 
<pre>
class DelayedJob < Delayed::Job
has_paper_trail
end
</pre>
After that, every time when the <code>delayed_jobs</code> table has added or deleted or updated data, the log can keep track of them. The following picture shows what the log is after creating scheduled tasks. 
[[File:scheduledtasklog.png|frame|center|four scheduled tasks are added in log]] 

==support more schedule tasks==

For each scheduled task, we have done the followings:

*Create a new deadline type called "drop_outstanding_reviews". When we set the review’s due date, add an item into “delayed job” queue at the same time. When the review is due, it will automatically call a method to find all the outstanding reviews (reviews which have not been started) in the database then delete them.

*Use a previously existed deadline type called "team_formation" and enable to set a team_formation's due date and a reminder. Then add an item into “delayed job” at the same time. When “delayed job” is triggered, it will automatically call a method to find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.

*Create a new deadline type called "drop_one_member_topics". When time is due, the system will call a method to find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

File:Scheduledtasklog.png

2015-04-22T03:24:44Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T03:23:35Z

Mdong3: /* Keep log of the scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delayed_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delayed_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end

# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. 
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures are our UI work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
According to the project E1478<ref>https://github.com/expertiza/expertiza/pull/462</ref>, there is a <code>paper_trail</code><ref>https://github.com/expertiza/expertiza/pull/462</ref> gem can keep log of the models' data. What we need to do is let it also keep track of our scheduled task data. 
<code></code>
<pre>

</pre>
Since the gem need to work with <code>ActiveRecord 3+</code>, while <code>assignment_form</code> doesn't. So we create a new file named <code>delayed_job.rb</code> in <code>models</code> folder, add <code>has_paper_trail</code> in it. Then it is like: 
<pre>
class DelayedJob < Delayed::Job
has_paper_trail
end
</pre>
After that, every time when the <code>delayed_jobs</code> table has added or deleted or updated data, the log can keep track of them. The following picture shows what the log is after creating scheduled tasks. 
[[File:scheduledtasklog.png|frame|center|four scheduled tasks are added in log]] 

==support more schedule tasks==

For each scheduled task, we have done the followings:

*Create a new deadline type called "drop_outstanding_reviews". When we set the review’s due date, add an item into “delayed job” queue at the same time. When the review is due, it will automatically call a method to find all the outstanding reviews (reviews which have not been started) in the database then delete them.

*Use a previously existed deadline type called "team_formation" and enable to set a team_formation's due date and a reminder. Then add an item into “delayed job” at the same time. When “delayed job” is triggered, it will automatically call a method to find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.

*Create a new deadline type called "drop_one_member_topics". When time is due, the system will call a method to find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T03:21:14Z

Mdong3: /* Keep log of the scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delayed_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delayed_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end

# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. 
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures are our UI work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
According to the project E1478<ref>https://github.com/expertiza/expertiza/pull/462</ref>, there is a <code>paper_trail</code><ref>https://github.com/expertiza/expertiza/pull/462</ref> gem can keep log of the models' data. What we need to do is let it also keep track of our scheduled task data. 
<code></code>
<pre>

</pre>
Since the gem need to work with <code>ActiveRecord 3+</code>, while <code>assignment_form</code> doesn't. So we create a new file named <code>delayed_job.rb</code> in <code>models</code> folder, add <code>has_paper_trail</code> in it. Then it is like: 
<pre>
class DelayedJob < Delayed::Job
has_paper_trail
end
</pre>
After that, every time when the <code>delayed_jobs</code> table has added or deleted or updated data, the log can keep track of them. The following picture shows what the log is after creating scheduled tasks. 

==support more schedule tasks==

For each scheduled task, we have done the followings:

*Create a new deadline type called "drop_outstanding_reviews". When we set the review’s due date, add an item into “delayed job” queue at the same time. When the review is due, it will automatically call a method to find all the outstanding reviews (reviews which have not been started) in the database then delete them.

*Use a previously existed deadline type called "team_formation" and enable to set a team_formation's due date and a reminder. Then add an item into “delayed job” at the same time. When “delayed job” is triggered, it will automatically call a method to find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.

*Create a new deadline type called "drop_one_member_topics". When time is due, the system will call a method to find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:56:25Z

Mdong3: /* Add UI to visualize for scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delay_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delay_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. 
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures are our UI work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
==support more schedule tasks==
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews (reviews which have not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.
The design we want to highlight here is that these additional scheduled tasks can be achieved in same way as email notification used. The difference is that each task refers to a different related due time(either a previously existing one or a new created one). Then they all set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, corresponding actions could be taken.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:55:18Z

Mdong3: /* Add UI to visualize for scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delay_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delay_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 

<code></code>
<pre>

</pre>

[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
We create a file <code>scheduled_tasks.erb</code> in the path: <code>/views/assignments</code> to show the form. 
<pre>
<% @assignment = Assignment.find(params[:id]) %>
<h1>Scheduled tasks for <%= @assignment.name %> assignment</h1>
<% if flash[:notice] %>
<div class="flash_note"><%= flash_message :notice %></div>
<% end %>
<% @scheduled_jobs = DelayedJob.all %>
<table class="general">
<th width="25%">Deadline type #</th>
<th width="25%">Run time</th>
<th width="25%">Due date</th>
<th width="25 %">Action</th>
<th width="25 %">Delete</th>
<% i=1 %>
<% for delayed_job in @scheduled_jobs %>
<tr>
<% if delayed_job.handler.include? "assignment_id: #{@assignment.id}"%>
<% handler = delayed_job.handler.split()%>
<td><%= handler[5] %></td>
<td><%= delayed_job.run_at %></td>
<td><%= handler[7][1..-1] + ":" + handler[8][0..-2]%></td>
<% if handler[5] == "submission" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "review" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "metareview" %>
<td><%= " "%></td>
<%end%>
<% if handler[5] == "team_formation" %>
<td><%= "send email to ask students to form teams"%></td>
<%end%>
<% if handler[5] == "drop_outstanding_reviews" %>
<td><%= "drop outstanding reviews and send emails to those students"%></td>
<%end%>
<% if handler[5] == "drop_one_member_topics" %>
<td><%= "drop one member team topics and send emails to those students"%></td>
<%end%>
<td><%= link_to image_tag('delete_icon.png', :title => 'Delete'),
{:controller => 'assignments', :action => 'delete_scheduled_task',
:id => @assignment.id, :delayed_job_id => delayed_job.id}%></td>
<% end %>
</tr>
<% i=i+1 %>
<% end %>
</table>
<% session[:return_to] = request.url %>
 
<a href="javascript:history.back()">Back</a>
</pre>
The following two pictures are our UI work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
==support more schedule tasks==
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews (reviews which have not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.
The design we want to highlight here is that these additional scheduled tasks can be achieved in same way as email notification used. The difference is that each task refers to a different related due time(either a previously existing one or a new created one). Then they all set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, corresponding actions could be taken.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:48:20Z

Mdong3: /* Add UI to visualize for scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the <code>delay_jobs</code> table in database, so the system will read from that table to show all the tasks information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delay_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 
[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
The following two pictures are our UI work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
==support more schedule tasks==
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews (reviews which have not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.
The design we want to highlight here is that these additional scheduled tasks can be achieved in same way as email notification used. The difference is that each task refers to a different related due time(either a previously existing one or a new created one). Then they all set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, corresponding actions could be taken.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

File:Delayedjobs.png

2015-04-22T02:45:28Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:45:11Z

Mdong3: /* Add UI to visualize for scheduled tasks */

E1529. Extend the Email notification feature to scheduled tasks 

=Overview=

==Introduction to Expertiza==

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

==Email notification feature to scheduled tasks==
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 

Our team aims to extend this project. This wiki page documents the problem analysis and provides a guideline for future development and enhancement.

__TOC__

=Scope=
==Project Scope==
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])

Extending this project, the new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.
*create tests to make sure the test coverage increases.
==Files Involved==
Mailers:
*delayed_mailer.rb

Models:
*assignment_form.rb
*due_date.rb
*delayed_job.rb(new created)
*scheduled_task.rb(new created)

Views:
*_due_dates.html.erb
*_assignments_actions.html.erb
* scheduled_tasks.erb(new created)

Controllers:
*assignments_controller.rb

==Gems Related==
*gem 'delayed_job_active_record'

[https://github.com/collectiveidea/delayed_job Delayed:Job] encapsulates the common pattern of asynchronously executing longer tasks in the background<ref> [https://github.com/collectiveidea/delayed_job Delayed_job Gem]</ref>. It allows to support multiple backends for storing the job queue. By using 'delayed_job_active_record' gem, we can use delayed_job with Active Record. This Active Record backend requires a job table.

After running rails generate delayed_job:active_record and rake db:migrate, a "delayed_jobs" table is created in our database. This gem integrates well with many [http://en.wikipedia.org/wiki/Relational_database_management_system RDBMS] backend such as MySQL. Using this gem, we can store all scheduled tasks queue into the "delayed_jobs" table.

*gem 'paper_trail'
PaperTrail allows to track changes of models' data, which is good for versioning. You can see how a model looked at any stage in its lifecycle, revert it to any version, and even undelete it after it's been destroyed<ref>[https://github.com/airblade/paper_trail paper trail]</ref>. Using this gem, we can keep log of the scheduled tasks.

=Problem Analysis=

== Time Issues==

Initially, when we want to verify the email function, we found many time issues in this system. That blocks our work about email notification. Some related problems are explained and analyzed in this section.

===Wrong displayed time===

Firstly, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]]

[[File:Wrong display of time 2.png |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time]]

[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]

After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. After we analyze, we found the problem may lay in the line of 68 of <code>views/assignment/edit/_due_dates.html.erb</code> file.

<pre>due_at = new Date(due_at.substr(0, 16)).format('yyyy/mm/dd HH:MM');</pre>

When we declare a Data object, this Data() function will perform a time zone conversion automatically. Yet Rails’ default timezone stored in database is UTC. So the displayed time(local time, which is EDT) and time in database is different.

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.

[[File:Delayassign.png |frame|center|Delay a time]]

After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am.

[[File:delaydatabase.png |frame|center|Time Stored in Database]]

The reason why there is a four-hour time difference is generated from the file <code>application_form.rb</code>, method <code> find_min_from_now(due_at)</code>, and line 142 <code>time_in_min=((due_at - curr_time).to_i/60)</code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT. The two time zones have four-hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.

[[File:delayagain.png]]

However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
As a result, we conclude that only one due_time record associated with different period exists in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

==UI issues==
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view or delete their delayed tasks related to an assignment. We are going to add a button under Assignment->edit, and add a view to display all delayed jobs derived from the delayed_jobs table in our database.

=System Design=
==Fix Time Issues==
===Unified time zone===
We convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
In <code>app/models/assignment_form.rb</code>, we modified <code>curr_time=DateTime.now.to_s(:db)</code> to <code>curr_time=DateTime.now.in_time_zone(zone='UTC').to_s(:db)</code> in the <code>find_min_from_now</code> method, to make sure when calculating the minutes from now, the time zone is right. 
Also, to make sure the right display of time, when log in as a administrator, go to Profile and choose the Preferred Time Zone to be "(GMT-05:00) Eastern Time (US&Canada)".

===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category. This bug has been fixed by TA.

==Add UI to visualize for scheduled tasks==
All the scheduled tasks are in the delay_jobs table in database, so the system will read from that table to show all the needed information. A new page is created to show all of those scheduled tasks and there is also a delete button for instructor to delete any task. Instructor can view this page via a <code>view delayed jobs</code> button in <code> assignment->edit </code>. 
The code in <code>app/models/assignment_form.rb</code> add the scheduled tasks in <code>delay_jobs</code> table. 
<pre>
if diff>0
dj=DelayedJob.enqueue(ScheduledTask.new(@assignment.id, deadline_type, due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
due_date.update_attribute(:delayed_job_id, dj.id)

# If the deadline type is review, add a delayed job to drop outstanding review
if deadline_type == "review"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_outstanding_reviews", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
# If the deadline type is team_formation, add a delayed job to drop one member team
if deadline_type == "team_formation"
dj = DelayedJob.enqueue(ScheduledTask.new(@assignment.id, "drop_one_member_topics", due_date.due_at.to_s(:db)),
1, diff.minutes.from_now)
change_item_type(dj.id)
end
end
</pre>
After adding to the delayed_jobs, the database will store all the assignment's id, deadline type, due date, task run time etc. 
[[File:delayedjobs.png |frame|center|the delayed jobs table in database]] 
The following two pictures are our work 
[[File:viewdelayedjobs.png |frame|center|add a button to display all scheduled tasks]] 
[[File:showscheduledtask.png|frame|center|The UI to show all the scheduled tasks]] 

==Keep log of the scheduled tasks==
==support more schedule tasks==
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews (reviews which have not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.
The design we want to highlight here is that these additional scheduled tasks can be achieved in same way as email notification used. The difference is that each task refers to a different related due time(either a previously existing one or a new created one). Then they all set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, corresponding actions could be taken.

[[File:Support more scheduled tasks.png|frame|center|Support more scheduled tasks]]

Diagram description: In our system, we would have four scheduled time: submission, review, metareview and team_up. When due time comes, the system takes corresponding actions described as above. These scheduled actions are called scheduled tasks. And the design to achieve these functions are explained above. This diagram just displays the text description above in "Support more scheduled tasks " section.

===1===
===2===
===3===

=Tests=
=References=
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:27:25Z

Mdong3: /* Add UI to visualize for scheduled tasks */

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:26:50Z

Mdong3: /* Add UI to visualize for scheduled tasks */

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:21:07Z

Mdong3: /* UI issues */

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:20:27Z

Mdong3: /* UI issues */

File:Showscheduledtask.png

2015-04-22T02:19:10Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:18:48Z

Mdong3: /* UI issues */

File:Viewdelayedjobs.png

2015-04-22T02:17:16Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-22T02:16:05Z

Mdong3: /* UI issues */

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T01:33:20Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===
Initially, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
 After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]] 
The reason why there is also exist four hours time difference is generate from the code <code>time_in_min=((due_at - curr_time).to_i/60)</code> in the file <code> application_form.rb </code>'s method<code> find_min_from_now(due_at) </code>. <code> due_at </code> is the system time for Rails (UTC), while <code> curr_time </code> is the local time which is EDT, the two time zone time have four hour time difference. 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.
[[File:delayagain.png]] 
However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
We found only one due_time record associated with different period in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

===UI issues===
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T01:31:58Z

Mdong3: /* New deadline replace the old one */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===
Initially, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
 After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]] 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.
[[File:delayagain.png]] 
However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
We found only one due_time record associated with different period in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

===UI issues===
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T01:31:05Z

Mdong3: /* New deadline replace the old one */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===
Initially, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
 After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]] 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.
[[File:delayagain.png]] 
However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
The reason why there is also exist four hours time difference is generate from the code <code>time_in_min=((due_at - curr_time).to_i/60)</code> in the file <code>application_form.rb</code>'s method<code>find_min_from_now(due_at)</code>. <code>due_at</code> is the system time for Rails (UTC), while <code>curr_time</code> is the local time which is EDT, the two time zone time have four hour time difference. 
We found only one due_time record associated with different period in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

===UI issues===
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T01:02:32Z

Mdong3: /* New deadline replace the old one */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===
Initially, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
 After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]] 

===New deadline replace the old one===
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.
[[File:delayagain.png]] 
However, the delayed_jobs database form is still the same, which means in one assignment there is only one reminder can work. 
We found only one due_time record associated with different period in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of deadline type id.

===UI issues===
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

File:Delayagain.png

2015-04-01T00:57:02Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:56:41Z

Mdong3: /* New deadline replace the old one */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===
Initially, when we set a due time to test the mail features, we found the display of time is incorrect.

In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
 After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]] 

===New deadline replace the old one===

We found only one due_time record associated with different period in the database:
*In Expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
*In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
*In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
*After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图
This time, we add a new delay in Review section, we delay the deadline from 2015/03/22 21:00 to 2015/03/30 21:00, and set the remind hr to 8 hours.
[[File:delayagain.png]]

===UI issues===
In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
In the Assignment Edit page->Due dates:
*When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
*Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
*When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:42:32Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
**After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
 After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]] 

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:
**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:39:19Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
**After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]] 
After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]]

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:
**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

File:Delaydatabase.png

2015-04-01T00:38:50Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:38:32Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
**After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 16 hours.
[[File:Delayassign.png]]
After click "save", the run time showed database is about 8:00 am. Since 20-16=4, the correct run time is 4:00 am
[[File:delaydatabase.png]]

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:
**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:34:23Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
**After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 8 hours.
[[File:Delayassign.png]]

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:
**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

File:Delayassign.png

2015-04-01T00:33:52Z

Mdong3: uploaded a new version of "File:Delayassign.png"

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:33:01Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
**After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 8 hours.
[[File:Delayassign.jpg]]

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:
**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

File:Delayassign.png

2015-04-01T00:32:22Z

Mdong3: uploaded a new version of "File:Delayassign.png"

File:Delayassign.png

2015-04-01T00:20:42Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-04-01T00:20:10Z

Mdong3: /* Different time zone */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.
**After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图
When we delay a deadline of an assignment, for example, we set the deadline of metareview from2015/03/28 16:00 to 2015/04/04 20:00 and set the reminder hr to 8 hours.
[[File:delayassign.jpg]]

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:
**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:53:04Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**Reasons: After we analyze, we found Rails’ default timezone is UTC. ?????
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the time we save. Then the problem may lay in the assignment edit view file.

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:32:24Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**Reasons: After we analyze, we found Rails’ default timezone is UTC. ?????
After several tries, we found that every time when we click "save", the saved time is 4 hours earlier then the last saved time. However, the time in the database is alway correct as the we set originally. Then the problem may lay in the assignment edit view file.

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:26:56Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. What's more, every time when we click "save", the saved time is 4 hours earlier then the last saved time 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**Reasons: After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:20:00Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
[[File:database_deadline.png |frame|center|The deadline time is stored correct in the database]]
**Reasons: After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:18:53Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
And we can see that the date is stored correct in the database
[[File:database_deadline.png]]
**Reasons: After we analyze, we found Rails’ default timezone is UTC. ?????

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:18:03Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
**Reasons: After we analyze, we found Rails’ default timezone is UTC.
And we can see that the date is stored correct in the database
[[File:database_deadline.png]]

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

File:Database deadline.png

2015-03-31T23:17:07Z

Mdong3:

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T23:16:26Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
**Reasons: After we analyze, we found Rails’ default timezone is UTC.
And we can see that the date is stored correct in the database
[[File:database_deadline.jpg]]

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T22:14:38Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
**Reasons: After we analyze, we found Rails’ default timezone is UTC. However,,,,,,,,,,,,,,,,,,,,,

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015 E1529 GLDS

2015-03-31T22:13:51Z

Mdong3: /* Wrong displayed time */

E1529. Extend the Email notification feature to scheduled tasks 

=='''Overview'''==

===Introduction to Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities<ref>[https://github.com/expertiza/expertiza Expertiza. Github]</ref>. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc). It is also a powerful tool for professor to manage courses and assignments and so on. The latest "Rails 4" branch of Expertiza, although combined with various enhancements from the past two years, is seriously broken, from data migration to key feature implementation. Part of the reason has been the design strategy and code changes by various teams.

===Email notification feature to scheduled tasks===
This is a feature that has already been partially implemented in Expertiza [https://github.com/expertiza/expertiza/pull/445 E1451] implemented both sychronous and asychoronous mailers. Sychronous Emails refer to the Emails sent immediatly after an event (e.g. when student receive a peer-review). Asychoronous Email we implemented by the Gem "delayed job” and when a task (asychronous Email) is added to the delayed queue, a count-down number of minutes needs to be specified. 
Our team aim to extend this project. This wiki page documents the changes our team has made and provided a guideline for future development and enhancement.

__TOC__

==Documentation==
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])

==Scope==
The new system should be capable of
*If one task is added to the delayed job queue, the asychronous Email should be updated or deleted automatically.
*Add UI to visualize for the task in delayed job queue, instructors should be able to view tasks related to the assignments they have created.
*Keep log of the scheduled tasks when they are scheduled and done, record events in the same log as project [https://github.com/expertiza/expertiza/pull/462 E1478].
*[optional] support more scheduled task:
**instructors are able to schedule the time to drop all the outstanding reviews (reviews which has not been started)
**instructors are able to schedule a specific time to send Emails to all the assignment participants who are still not in any team to find or form one.
**(new) instructor should be able to schedule a time to drop all the topics which are held by 1 person teams.

==Problem Analysis==
===Wrong displayed time===

*Initially, when we set a due time to test the mail features, we found the display of time is incorrect.
**In the “Assignment Edit”->“Due dates”, when we modify the “Date & time” of the deadline, the displayed time will be 4 hours ahead of the time we saved. 

[[File:Wrong display of time.png‎ |frame|center|Set due time]].
This picture shows the time we set before clicking "save" button.
[[File:Wrong display of time 2.png‎ |frame|center|After we click the save button, we can see that all the time are 4 hours ahead of the set time.]].
This picture shows the set time after clicking "save" button.
**Reasons: After we analyze, we found Rails’ default timezone is UTC. However,,,,,,,,,,,,,,,,,,,,,

===Different time zone===

*In the previous version, when current time is compared with the time stored in database, they may apply to different time zones so that the result of comparison may be wrong. 截图

===New deadline replace the old one===

* We found only one due_time record associated with different period in the database:

**In expertiza, one assignment has several period, such as submission, review, metareview. Administrates are able to set and postpone due dates for each period separately.
**In the previous version, when the instructor postpone the review deadline and then postpone the submit deadline, the submit deadline’s modification will replace the the review deadline’s modification in database.
**In this case, if both of them need Email reminder, there will be no Email about the former modified deadline.
**After our analysis, we found the due time object is identified with assignment_id, instead of ,,,,,,,,,,,,截图

===UI issues===
*In the previous version, there is no UI to display the reminders of assignments. There is no way for instructors to view their delayed tasks related to an assignment.

==System Design==
===Unified time zone===
*We can convert current time to the same time zone as the deadline stored in database. Then the result of comparison will be right so that it can be used for further usage.
===Separate deadline of each topic period===
*In each Assignment, each deadline type (E.g review, submit, metareview) should has its own Email reminder time in the database. New postponed deadline of one type can only replace the same deadline type in the same assignment id category.
===Add UI to visualize for scheduled tasks===
*In the UI module, we are going to display the scheduled time for reminder emails of submit, review and final review. And when reminder or due date are modified, the displayed content will also be changed. 截图？

===Keep log of the scheduled tasks===

===support more schedule tasks===
*In the Assignment Edit page->Due dates:
**When we set the review’s due date, create a “delayed job” at the same time. When the review is due, it will automatically find all the outstanding reviews(reviews which has not been started) in the database then delete them.
**Add a new teamup deadline, set up a reminder and create a “delayed job” at the same time. When “delayed job” is triggered, it will automatically find all the assignment participants who are still not in any team in the database, and send Emails to them to find teammate.
**When teamup time is due, the system will find all the topics which are held by 1 person teams in the database, then the professor can drop those topics.

[[File:scheduled tasks.png|frame|center|Scheduled Tasks]]

==Puzzles==
=='''References'''==
<references/>

CSC/ECE 517 Spring 2015/oss E1509 lds

2015-03-21T22:28:28Z

Mdong3: /* Deleting redundant button */

== E1509. Refactoring SignUpController and SignUpSheetController ==

This page talks about an open source project based on Expertiza. As a part of contribution to Expertiza, this project aims to refactor SignUpController and SignUpSheetControllers.

=== Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc)<ref>https://github.com/expertiza/expertiza</ref>. The Expertiza project is supported by the National Science Foundation. And it is an open source application and the source code can be cloned on [https://github.com/expertiza/expertiza Github] .

== Problem Statement ==

===Classes involved===
<pre>
* sign_up_sheet.rb
* sign_up_topic.rb
* assignments_controller.rb
* response.rb
* and possibly other model classes
</pre>
===What it does===

Lists topics available for an assignment, checks whether a user is signed up for a topic, allows users to sign up for topics.

===What's wrong with it===
* These two controllers seem to do almost the same thing. They have many of the same methods. <code>SignUpSheetController</code> is much longer, and has many more recent mods, but some methods of <code>SignUpController</code> seem more sophisticated than <code>SignUpSheetController</code>. So, your first job is to figure out if both controllers are being used. If not, remove the unused controller. Or, move the functions to a single controller if that makes sense to do.
* Neither controller is at all RESTful; i.e.., its method names aren’t the standard names <code>new</code>, <code>create</code>, <code>edit</code>, <code>delete</code>, etc. Functionality is divided differently than in a standard controller. a. <code>def confirm_topic(creator_id, topic_id, assignment_id)</code> b. <code>def delete_signup</code> c.<code>def delete_signup_for_topic(assignment_id,topic_id)</code> d. <code>def other_confirmed_topic_for_user(assignment_id, creator_id)</code> e. <code>def signup</code> f. <code>def slotAvailable?(topic_id)</code>
* Functionality that should be in models is incorporated into the controller.
* Some methods are too long and appear to do more than one thing
* This class interfaces with assignments_controller so that a list of topics can be displayed when one is editing an assignment. Please be careful that your changes do not affect the functionality on the Topics tab of editing an assignment.
* Rename the controller(s) to <code>SignupController</code> and/or <code>SignupSheetController</code>. (“Sign up”, which gets written as SignUp in camel case, is a verb, whereas “Signup” is a noun.)
* Some codes does not follow the [https://docs.google.com/a/ncsu.edu/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules].

== Modification We Made ==
=== Removing unused controller ===
After various analysis and test, we found <code>SignUpController</code> is never used. So we remove it. The reasons are listed as follows:
* There is no code about <code>SignUpController</code> in <code>route.rb</code> file.The Rails router recognizes URLs and dispatches them to a controller's action. It can also generate paths and URLs, avoiding the need to hardcode strings in your views<ref>http://guides.rubyonrails.org/routing.html#the-purpose-of-the-rails-router</ref>. Rails default routing is resource routing, which allows us to declare all the common routes for a resourceful controller. In our <code>route.rb</code>, we found a matching resourceful route for <code>SignUpSheetController</code>, which asks the router to map it to the <code>SignUpSheetController</code> action.

<pre>
resources :signup_sheet
</pre>

This route creates several different routes in the application, all mapping to the <code>SignUpSheetController</code> controller.
Here are some examples:

{| class="wikitable"
|-
! style="width:13%;"|HTTP Verb
! style="width:33%;"|Controller#Action
! style="width:43%;"|Used For
|- style="vertical-align:top;"
| GET
| sigh_up_sheet#signup
| This function lets the user choose a particular topic.
|-
| GET
| sigh_up_sheet#delete_signup
| This function is used to delete a previous signup
|-
| GET
| sigh_up_sheet#view_publishing_rights
| The function is to make sure the publishing rights for a user
|}
However, there is not a matching route for <code>SignUpController</code>.
*<code>SignUpSheetController</code> has all seven methods in <code>SignUpController</code> with same name. we found these functions are completely achieved via <code>SignUpSheetController</code>. And after test, we prove that codes in <code>SignUpController</code> never got executed when we ran the project.

=== RESTful style implementation ===
The purpose of the <code>list</code> method in the <code>SignupSheet controller</code> is to list all the topics in the specific assignments. According to RESTful rules, a method that returns a list of all available objects should be named as <code>index</code>. Therefore, we renamed the list method to the index method in the controller and in all the files that had references to the list method of the signup_sheet_controller.

Before Refactoring:
 Method: <code>list</code>
<pre>
def list
...
end
</pre>

After Refactoring:
 Method: <code>index</code>
<pre>
def index
...
end
</pre>

And we need to change some references to the method:
<pre>
verify method: 'post', :only => [:destroy, :create, :update],
:redirect_to => {:action => :index}

SignUpTopic.reassign_topic(@user_id,params[:assignment_id], params[:id])
redirect_to action: 'index', id: params[:assignment_id]

signup_team(@assignment.id, @user_id, params[:id])
redirect_to action: 'index', id: params[:assignment_id]
</pre>
For some others, it is not good to combine some functions with the standard ones. For example, <code>create</code> function creates topics, which is one of the administrator’s functions. However <code>signup</code> creates a record that includes information for topic and student, which happens when student clicks <code>signup</code> button. We can see that <code>create</code> and <code>signup</code> are designed for different role and different usage so it is not a good idea to combine them together.

=== Moving inappropriate functionality from controller to model ===
The controller connects the model with the view. In Rails, controllers are implemented as ActionController classes. The controller knows how to process the data that comes from the model and how to pass it onto the view. The controller should not include any database related actions (such as modifying data before it gets saved inside the database). This should be handled in the proper model. So we remove all the database related functionality in the signup_sheet_controller to related models.
The following files were modified:
<pre>
app/controllers/signup_sheet_controller.rb
app/models/deadline_type.rb
app/models/due_date.rb
app/models/participant.rb
app/models/sign_up_topic.rb
app/models/signed_up_user.rb
app/models/topic_deadline.rb
app/models/topic_dependency.rb
</pre>
Here are two examples on how these files changed. 
1. replace "where" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
</pre>
Also add a related method in<code> sign_up_topic.rb</code>
<pre>
def find_with_name_and_assignment_id(name, aid)
SignUpTopic.where(topic_name: name, assignment_id: aid)
end
</pre>
2. replace "find_by_sql" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + params[:id].to_s)
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_topic_id_with_assignment_id(params[:id].to_s)
</pre>
Also add a related method in <code>sign_up_topic.rb</code>
<pre>
def find_topic_id_with_assignment_id(aid)
SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + aid)
end
</pre>

=== Breaking down long methods ===
We’ve find that lots of methods do more than one thing so we separate a long function into several concise functions and call them in the original function. Here is an example:

There are some preparation works and check works before or after the actual create operation. So we separate two functions <code>update_topic_info</code> and <code>check_after_create</code> from <code>create</code>. And we call these two functions in <code>create</code> method instead of executing these codes directly.

Before Refactoring:
 Method: <code>create</code>
<pre>
def create
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
if topic != nil
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_by_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render :action => 'new', :id => params[:id]
end
end
end
</pre>

After Refactoring
 Method: <code>update_topic_info</code>, <code>check_after_create</code>, <code>create</code>
<pre>
def update_topic_info(topic)
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_with_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
end
</pre>
The method <code>update_topic_info</code> updates topics' some attributes according to received parameters, such as permitted max number of choosers and waitlisted users. This method is separated from function <code>create</code> because it doesn't really do any creation works.
<pre>
def check_after_create
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
end
</pre>
The method <code>check_after_create</code> check if the assignment is a microtask and if it applies to staggered deadline. If these two conditions are met, then execute corresponding actions. These steps should be separated from <code>create</code> function because it doesn't actually do works related with creation.
<pre>
def create
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
if topic
update_topic_info(topic)
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
check_after_create
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render action: 'new', id: params[:id]
end
end
end
</pre>
In <code>create</code> method, the two separated methods were called. By this way, function <code>create</code> will be much shorter and some works do not belong to it can be finished by other methods.

=== Deleting redundant button ===
When we move the mouse on the Assignment, there is a "Edit signup sheet" button in the popup menu. It is a redundant button since there already has such a function in Assignment "Edit" menu. What's more it's more reasonable to put this function in "Edit" Assignment because signup sheet is a part of the assignment. So we removed this button. Sometimes after making some changes, the display topics function didn’t work due to some reasons. We’ve fixed those bugs and make sure it still works after our last change. 
We delete the following lines in <code>app/views/tree_display/actions/_assignments_actions.html.erb</code>
<pre>
<% if signup_topic %>
...
<% end %>
</pre>

The origin popup menu is as following picture, there is a <code>edit signup sheet </code> button: 
[[File:originPopup.jpg]] 
 The new popup menu is: 
[[File:new_popup.png]] 
 After modifying, the other assignment functions all works well. 
[[File:AssignTopic.png]]

=== Renaming controller ===
According to the controller name convention<ref>http://guides.rubyonrails.org/action_controller_overview.html</ref>, a controller should be a singular noun. However, here <code>SignUp</code> in camel case is a verb. We should modify it to a noun written as <code>Signup</code>. As a result, we rename all class name <code>SignUpSheetController</code> to <code>SignupSheetController</code>. Then the controller name <code>sign_up_sheet_controller</code> is revised into <code>signup_sheet_controller</code> automatically. 
Here we also make sure every reference for this controller has been changed to match the new controller name. For example, in <code>views/signup_sheet/_action.html.erb</code> file, we must make sure this render path is correct as follows:
<pre>
<%= render :partial => '/signup_sheet/all_actions', :locals => {:i=>i, :topic=>topic} %>
</pre>

=== Following global rules ===
According to Global Rules, there are some codes that need some improvements to make it follow the rules correctly. Here are some of what we have done:

* change <code>users_team.size == 0</code> to <code>users_team.zero?</code>
<pre>
change:
if users_team.size == 0
to:
if users_team.zero?
or:
if users_team.empty?
</pre>

* Use <code>key: 'value'</code>, not <code>:key => 'value'</code>
<pre>
change:
redirect_to :action => 'add_signup_topics_staggered', :id => assignment_id
to:
redirect_to action: 'add_signup_topics_staggered', id: assignment_id
</pre>

* Use <code>if (var)</code> instead of <code>if (var == true)</code>
<pre>
change:
(assignment.staggered_deadline == true)?
to:
(assignment.staggered_deadline)?
</pre>

== References ==
<references/>

CSC/ECE 517 Spring 2015/oss E1509 lds

2015-03-21T22:28:10Z

Mdong3: /* Deleting redundant button */

== E1509. Refactoring SignUpController and SignUpSheetController ==

This page talks about an open source project based on Expertiza. As a part of contribution to Expertiza, this project aims to refactor SignUpController and SignUpSheetControllers.

=== Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc)<ref>https://github.com/expertiza/expertiza</ref>. The Expertiza project is supported by the National Science Foundation. And it is an open source application and the source code can be cloned on [https://github.com/expertiza/expertiza Github] .

== Problem Statement ==

===Classes involved===
<pre>
* sign_up_sheet.rb
* sign_up_topic.rb
* assignments_controller.rb
* response.rb
* and possibly other model classes
</pre>
===What it does===

Lists topics available for an assignment, checks whether a user is signed up for a topic, allows users to sign up for topics.

===What's wrong with it===
* These two controllers seem to do almost the same thing. They have many of the same methods. <code>SignUpSheetController</code> is much longer, and has many more recent mods, but some methods of <code>SignUpController</code> seem more sophisticated than <code>SignUpSheetController</code>. So, your first job is to figure out if both controllers are being used. If not, remove the unused controller. Or, move the functions to a single controller if that makes sense to do.
* Neither controller is at all RESTful; i.e.., its method names aren’t the standard names <code>new</code>, <code>create</code>, <code>edit</code>, <code>delete</code>, etc. Functionality is divided differently than in a standard controller. a. <code>def confirm_topic(creator_id, topic_id, assignment_id)</code> b. <code>def delete_signup</code> c.<code>def delete_signup_for_topic(assignment_id,topic_id)</code> d. <code>def other_confirmed_topic_for_user(assignment_id, creator_id)</code> e. <code>def signup</code> f. <code>def slotAvailable?(topic_id)</code>
* Functionality that should be in models is incorporated into the controller.
* Some methods are too long and appear to do more than one thing
* This class interfaces with assignments_controller so that a list of topics can be displayed when one is editing an assignment. Please be careful that your changes do not affect the functionality on the Topics tab of editing an assignment.
* Rename the controller(s) to <code>SignupController</code> and/or <code>SignupSheetController</code>. (“Sign up”, which gets written as SignUp in camel case, is a verb, whereas “Signup” is a noun.)
* Some codes does not follow the [https://docs.google.com/a/ncsu.edu/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules].

== Modification We Made ==
=== Removing unused controller ===
After various analysis and test, we found <code>SignUpController</code> is never used. So we remove it. The reasons are listed as follows:
* There is no code about <code>SignUpController</code> in <code>route.rb</code> file.The Rails router recognizes URLs and dispatches them to a controller's action. It can also generate paths and URLs, avoiding the need to hardcode strings in your views<ref>http://guides.rubyonrails.org/routing.html#the-purpose-of-the-rails-router</ref>. Rails default routing is resource routing, which allows us to declare all the common routes for a resourceful controller. In our <code>route.rb</code>, we found a matching resourceful route for <code>SignUpSheetController</code>, which asks the router to map it to the <code>SignUpSheetController</code> action.

<pre>
resources :signup_sheet
</pre>

This route creates several different routes in the application, all mapping to the <code>SignUpSheetController</code> controller.
Here are some examples:

{| class="wikitable"
|-
! style="width:13%;"|HTTP Verb
! style="width:33%;"|Controller#Action
! style="width:43%;"|Used For
|- style="vertical-align:top;"
| GET
| sigh_up_sheet#signup
| This function lets the user choose a particular topic.
|-
| GET
| sigh_up_sheet#delete_signup
| This function is used to delete a previous signup
|-
| GET
| sigh_up_sheet#view_publishing_rights
| The function is to make sure the publishing rights for a user
|}
However, there is not a matching route for <code>SignUpController</code>.
*<code>SignUpSheetController</code> has all seven methods in <code>SignUpController</code> with same name. we found these functions are completely achieved via <code>SignUpSheetController</code>. And after test, we prove that codes in <code>SignUpController</code> never got executed when we ran the project.

=== RESTful style implementation ===
The purpose of the <code>list</code> method in the <code>SignupSheet controller</code> is to list all the topics in the specific assignments. According to RESTful rules, a method that returns a list of all available objects should be named as <code>index</code>. Therefore, we renamed the list method to the index method in the controller and in all the files that had references to the list method of the signup_sheet_controller.

Before Refactoring:
 Method: <code>list</code>
<pre>
def list
...
end
</pre>

After Refactoring:
 Method: <code>index</code>
<pre>
def index
...
end
</pre>

And we need to change some references to the method:
<pre>
verify method: 'post', :only => [:destroy, :create, :update],
:redirect_to => {:action => :index}

SignUpTopic.reassign_topic(@user_id,params[:assignment_id], params[:id])
redirect_to action: 'index', id: params[:assignment_id]

signup_team(@assignment.id, @user_id, params[:id])
redirect_to action: 'index', id: params[:assignment_id]
</pre>
For some others, it is not good to combine some functions with the standard ones. For example, <code>create</code> function creates topics, which is one of the administrator’s functions. However <code>signup</code> creates a record that includes information for topic and student, which happens when student clicks <code>signup</code> button. We can see that <code>create</code> and <code>signup</code> are designed for different role and different usage so it is not a good idea to combine them together.

=== Moving inappropriate functionality from controller to model ===
The controller connects the model with the view. In Rails, controllers are implemented as ActionController classes. The controller knows how to process the data that comes from the model and how to pass it onto the view. The controller should not include any database related actions (such as modifying data before it gets saved inside the database). This should be handled in the proper model. So we remove all the database related functionality in the signup_sheet_controller to related models.
The following files were modified:
<pre>
app/controllers/signup_sheet_controller.rb
app/models/deadline_type.rb
app/models/due_date.rb
app/models/participant.rb
app/models/sign_up_topic.rb
app/models/signed_up_user.rb
app/models/topic_deadline.rb
app/models/topic_dependency.rb
</pre>
Here are two examples on how these files changed. 
1. replace "where" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
</pre>
Also add a related method in<code> sign_up_topic.rb</code>
<pre>
def find_with_name_and_assignment_id(name, aid)
SignUpTopic.where(topic_name: name, assignment_id: aid)
end
</pre>
2. replace "find_by_sql" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + params[:id].to_s)
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_topic_id_with_assignment_id(params[:id].to_s)
</pre>
Also add a related method in <code>sign_up_topic.rb</code>
<pre>
def find_topic_id_with_assignment_id(aid)
SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + aid)
end
</pre>

=== Breaking down long methods ===
We’ve find that lots of methods do more than one thing so we separate a long function into several concise functions and call them in the original function. Here is an example:

There are some preparation works and check works before or after the actual create operation. So we separate two functions <code>update_topic_info</code> and <code>check_after_create</code> from <code>create</code>. And we call these two functions in <code>create</code> method instead of executing these codes directly.

Before Refactoring:
 Method: <code>create</code>
<pre>
def create
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
if topic != nil
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_by_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render :action => 'new', :id => params[:id]
end
end
end
</pre>

After Refactoring
 Method: <code>update_topic_info</code>, <code>check_after_create</code>, <code>create</code>
<pre>
def update_topic_info(topic)
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_with_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
end
</pre>
The method <code>update_topic_info</code> updates topics' some attributes according to received parameters, such as permitted max number of choosers and waitlisted users. This method is separated from function <code>create</code> because it doesn't really do any creation works.
<pre>
def check_after_create
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
end
</pre>
The method <code>check_after_create</code> check if the assignment is a microtask and if it applies to staggered deadline. If these two conditions are met, then execute corresponding actions. These steps should be separated from <code>create</code> function because it doesn't actually do works related with creation.
<pre>
def create
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
if topic
update_topic_info(topic)
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
check_after_create
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render action: 'new', id: params[:id]
end
end
end
</pre>
In <code>create</code> method, the two separated methods were called. By this way, function <code>create</code> will be much shorter and some works do not belong to it can be finished by other methods.

=== Deleting redundant button ===
When we move the mouse on the Assignment, there is a "Edit signup sheet" button in the popup menu. It is a redundant button since there already has such a function in Assignment "Edit" menu. What's more it's more reasonable to put this function in "Edit" Assignment because signup sheet is a part of the assignment. So we removed this button. Sometimes after making some changes, the display topics function didn’t work due to some reasons. We’ve fixed those bugs and make sure it still works after our last change. 
We delete the following lines in <code>app/views/tree_display/actions/_assignments_actions.html.erb</code>
<pre>
<% if signup_topic %>
...
<% end %>
</pre>

The origin popup menu is as following picture, there is a <code>edit signup sheet </code> button: 
[[File:originPopup.jpg]] 
 The new popup menu is: 
[[File:new_popup.png]] 
After modifying, the other assignment functions all works well. 
[[File:AssignTopic.png]]

=== Renaming controller ===
According to the controller name convention<ref>http://guides.rubyonrails.org/action_controller_overview.html</ref>, a controller should be a singular noun. However, here <code>SignUp</code> in camel case is a verb. We should modify it to a noun written as <code>Signup</code>. As a result, we rename all class name <code>SignUpSheetController</code> to <code>SignupSheetController</code>. Then the controller name <code>sign_up_sheet_controller</code> is revised into <code>signup_sheet_controller</code> automatically. 
Here we also make sure every reference for this controller has been changed to match the new controller name. For example, in <code>views/signup_sheet/_action.html.erb</code> file, we must make sure this render path is correct as follows:
<pre>
<%= render :partial => '/signup_sheet/all_actions', :locals => {:i=>i, :topic=>topic} %>
</pre>

=== Following global rules ===
According to Global Rules, there are some codes that need some improvements to make it follow the rules correctly. Here are some of what we have done:

* change <code>users_team.size == 0</code> to <code>users_team.zero?</code>
<pre>
change:
if users_team.size == 0
to:
if users_team.zero?
or:
if users_team.empty?
</pre>

* Use <code>key: 'value'</code>, not <code>:key => 'value'</code>
<pre>
change:
redirect_to :action => 'add_signup_topics_staggered', :id => assignment_id
to:
redirect_to action: 'add_signup_topics_staggered', id: assignment_id
</pre>

* Use <code>if (var)</code> instead of <code>if (var == true)</code>
<pre>
change:
(assignment.staggered_deadline == true)?
to:
(assignment.staggered_deadline)?
</pre>

== References ==
<references/>

CSC/ECE 517 Spring 2015/oss E1509 lds

2015-03-21T22:27:35Z

Mdong3: /* Deleting redundant button */

== E1509. Refactoring SignUpController and SignUpSheetController ==

This page talks about an open source project based on Expertiza. As a part of contribution to Expertiza, this project aims to refactor SignUpController and SignUpSheetControllers.

=== Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc)<ref>https://github.com/expertiza/expertiza</ref>. The Expertiza project is supported by the National Science Foundation. And it is an open source application and the source code can be cloned on [https://github.com/expertiza/expertiza Github] .

== Problem Statement ==

===Classes involved===
<pre>
* sign_up_sheet.rb
* sign_up_topic.rb
* assignments_controller.rb
* response.rb
* and possibly other model classes
</pre>
===What it does===

Lists topics available for an assignment, checks whether a user is signed up for a topic, allows users to sign up for topics.

===What's wrong with it===
* These two controllers seem to do almost the same thing. They have many of the same methods. <code>SignUpSheetController</code> is much longer, and has many more recent mods, but some methods of <code>SignUpController</code> seem more sophisticated than <code>SignUpSheetController</code>. So, your first job is to figure out if both controllers are being used. If not, remove the unused controller. Or, move the functions to a single controller if that makes sense to do.
* Neither controller is at all RESTful; i.e.., its method names aren’t the standard names <code>new</code>, <code>create</code>, <code>edit</code>, <code>delete</code>, etc. Functionality is divided differently than in a standard controller. a. <code>def confirm_topic(creator_id, topic_id, assignment_id)</code> b. <code>def delete_signup</code> c.<code>def delete_signup_for_topic(assignment_id,topic_id)</code> d. <code>def other_confirmed_topic_for_user(assignment_id, creator_id)</code> e. <code>def signup</code> f. <code>def slotAvailable?(topic_id)</code>
* Functionality that should be in models is incorporated into the controller.
* Some methods are too long and appear to do more than one thing
* This class interfaces with assignments_controller so that a list of topics can be displayed when one is editing an assignment. Please be careful that your changes do not affect the functionality on the Topics tab of editing an assignment.
* Rename the controller(s) to <code>SignupController</code> and/or <code>SignupSheetController</code>. (“Sign up”, which gets written as SignUp in camel case, is a verb, whereas “Signup” is a noun.)
* Some codes does not follow the [https://docs.google.com/a/ncsu.edu/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules].

== Modification We Made ==
=== Removing unused controller ===
After various analysis and test, we found <code>SignUpController</code> is never used. So we remove it. The reasons are listed as follows:
* There is no code about <code>SignUpController</code> in <code>route.rb</code> file.The Rails router recognizes URLs and dispatches them to a controller's action. It can also generate paths and URLs, avoiding the need to hardcode strings in your views<ref>http://guides.rubyonrails.org/routing.html#the-purpose-of-the-rails-router</ref>. Rails default routing is resource routing, which allows us to declare all the common routes for a resourceful controller. In our <code>route.rb</code>, we found a matching resourceful route for <code>SignUpSheetController</code>, which asks the router to map it to the <code>SignUpSheetController</code> action.

<pre>
resources :signup_sheet
</pre>

This route creates several different routes in the application, all mapping to the <code>SignUpSheetController</code> controller.
Here are some examples:

{| class="wikitable"
|-
! style="width:13%;"|HTTP Verb
! style="width:33%;"|Controller#Action
! style="width:43%;"|Used For
|- style="vertical-align:top;"
| GET
| sigh_up_sheet#signup
| This function lets the user choose a particular topic.
|-
| GET
| sigh_up_sheet#delete_signup
| This function is used to delete a previous signup
|-
| GET
| sigh_up_sheet#view_publishing_rights
| The function is to make sure the publishing rights for a user
|}
However, there is not a matching route for <code>SignUpController</code>.
*<code>SignUpSheetController</code> has all seven methods in <code>SignUpController</code> with same name. we found these functions are completely achieved via <code>SignUpSheetController</code>. And after test, we prove that codes in <code>SignUpController</code> never got executed when we ran the project.

=== RESTful style implementation ===
The purpose of the <code>list</code> method in the <code>SignupSheet controller</code> is to list all the topics in the specific assignments. According to RESTful rules, a method that returns a list of all available objects should be named as <code>index</code>. Therefore, we renamed the list method to the index method in the controller and in all the files that had references to the list method of the signup_sheet_controller.

Before Refactoring:
 Method: <code>list</code>
<pre>
def list
...
end
</pre>

After Refactoring:
 Method: <code>index</code>
<pre>
def index
...
end
</pre>

And we need to change some references to the method:
<pre>
verify method: 'post', :only => [:destroy, :create, :update],
:redirect_to => {:action => :index}

SignUpTopic.reassign_topic(@user_id,params[:assignment_id], params[:id])
redirect_to action: 'index', id: params[:assignment_id]

signup_team(@assignment.id, @user_id, params[:id])
redirect_to action: 'index', id: params[:assignment_id]
</pre>
For some others, it is not good to combine some functions with the standard ones. For example, <code>create</code> function creates topics, which is one of the administrator’s functions. However <code>signup</code> creates a record that includes information for topic and student, which happens when student clicks <code>signup</code> button. We can see that <code>create</code> and <code>signup</code> are designed for different role and different usage so it is not a good idea to combine them together.

=== Moving inappropriate functionality from controller to model ===
The controller connects the model with the view. In Rails, controllers are implemented as ActionController classes. The controller knows how to process the data that comes from the model and how to pass it onto the view. The controller should not include any database related actions (such as modifying data before it gets saved inside the database). This should be handled in the proper model. So we remove all the database related functionality in the signup_sheet_controller to related models.
The following files were modified:
<pre>
app/controllers/signup_sheet_controller.rb
app/models/deadline_type.rb
app/models/due_date.rb
app/models/participant.rb
app/models/sign_up_topic.rb
app/models/signed_up_user.rb
app/models/topic_deadline.rb
app/models/topic_dependency.rb
</pre>
Here are two examples on how these files changed. 
1. replace "where" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
</pre>
Also add a related method in<code> sign_up_topic.rb</code>
<pre>
def find_with_name_and_assignment_id(name, aid)
SignUpTopic.where(topic_name: name, assignment_id: aid)
end
</pre>
2. replace "find_by_sql" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + params[:id].to_s)
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_topic_id_with_assignment_id(params[:id].to_s)
</pre>
Also add a related method in <code>sign_up_topic.rb</code>
<pre>
def find_topic_id_with_assignment_id(aid)
SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + aid)
end
</pre>

=== Breaking down long methods ===
We’ve find that lots of methods do more than one thing so we separate a long function into several concise functions and call them in the original function. Here is an example:

There are some preparation works and check works before or after the actual create operation. So we separate two functions <code>update_topic_info</code> and <code>check_after_create</code> from <code>create</code>. And we call these two functions in <code>create</code> method instead of executing these codes directly.

Before Refactoring:
 Method: <code>create</code>
<pre>
def create
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
if topic != nil
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_by_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render :action => 'new', :id => params[:id]
end
end
end
</pre>

After Refactoring
 Method: <code>update_topic_info</code>, <code>check_after_create</code>, <code>create</code>
<pre>
def update_topic_info(topic)
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_with_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
end
</pre>
The method <code>update_topic_info</code> updates topics' some attributes according to received parameters, such as permitted max number of choosers and waitlisted users. This method is separated from function <code>create</code> because it doesn't really do any creation works.
<pre>
def check_after_create
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
end
</pre>
The method <code>check_after_create</code> check if the assignment is a microtask and if it applies to staggered deadline. If these two conditions are met, then execute corresponding actions. These steps should be separated from <code>create</code> function because it doesn't actually do works related with creation.
<pre>
def create
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
if topic
update_topic_info(topic)
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
check_after_create
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render action: 'new', id: params[:id]
end
end
end
</pre>
In <code>create</code> method, the two separated methods were called. By this way, function <code>create</code> will be much shorter and some works do not belong to it can be finished by other methods.

=== Deleting redundant button ===
When we move the mouse on the Assignment, there is a "Edit signup sheet" button in the popup menu. It is a redundant button since there already has such a function in Assignment "Edit" menu. What's more it's more reasonable to put this function in "Edit" Assignment because signup sheet is a part of the assignment. So we removed this button. Sometimes after making some changes, the display topics function didn’t work due to some reasons. We’ve fixed those bugs and make sure it still works after our last change. 
We delete the following lines in <code>app/views/tree_display/actions/_assignments_actions.html.erb</code>
<pre>
<% if signup_topic %>
...
<% end %>
</pre>

The origin popup menu is as following picture, there is a <code>edit signup sheet </code> button: 
[[File:originPopup.jpg]] 
The new popup menu is: 
[[File:new_popup.png]] 
After modifying, the other assignment functions all works well. 
[[File:AssignTopic.png]]

=== Renaming controller ===
According to the controller name convention<ref>http://guides.rubyonrails.org/action_controller_overview.html</ref>, a controller should be a singular noun. However, here <code>SignUp</code> in camel case is a verb. We should modify it to a noun written as <code>Signup</code>. As a result, we rename all class name <code>SignUpSheetController</code> to <code>SignupSheetController</code>. Then the controller name <code>sign_up_sheet_controller</code> is revised into <code>signup_sheet_controller</code> automatically. 
Here we also make sure every reference for this controller has been changed to match the new controller name. For example, in <code>views/signup_sheet/_action.html.erb</code> file, we must make sure this render path is correct as follows:
<pre>
<%= render :partial => '/signup_sheet/all_actions', :locals => {:i=>i, :topic=>topic} %>
</pre>

=== Following global rules ===
According to Global Rules, there are some codes that need some improvements to make it follow the rules correctly. Here are some of what we have done:

* change <code>users_team.size == 0</code> to <code>users_team.zero?</code>
<pre>
change:
if users_team.size == 0
to:
if users_team.zero?
or:
if users_team.empty?
</pre>

* Use <code>key: 'value'</code>, not <code>:key => 'value'</code>
<pre>
change:
redirect_to :action => 'add_signup_topics_staggered', :id => assignment_id
to:
redirect_to action: 'add_signup_topics_staggered', id: assignment_id
</pre>

* Use <code>if (var)</code> instead of <code>if (var == true)</code>
<pre>
change:
(assignment.staggered_deadline == true)?
to:
(assignment.staggered_deadline)?
</pre>

== References ==
<references/>

CSC/ECE 517 Spring 2015/oss E1509 lds

2015-03-21T22:27:17Z

Mdong3: /* Deleting redundant button */

== E1509. Refactoring SignUpController and SignUpSheetController ==

This page talks about an open source project based on Expertiza. As a part of contribution to Expertiza, this project aims to refactor SignUpController and SignUpSheetControllers.

=== Introduction to Expertiza ===

[http://expertiza.ncsu.edu/ Expertiza] is a web application developed by Ruby on Rails framework. It serves as a peer review system for professors and students at NC State and some other colleges and universities. Students can submit different assignments and peer-review reusable learning objects (articles, code, web sites, etc)<ref>https://github.com/expertiza/expertiza</ref>. The Expertiza project is supported by the National Science Foundation. And it is an open source application and the source code can be cloned on [https://github.com/expertiza/expertiza Github] .

== Problem Statement ==

===Classes involved===
<pre>
* sign_up_sheet.rb
* sign_up_topic.rb
* assignments_controller.rb
* response.rb
* and possibly other model classes
</pre>
===What it does===

Lists topics available for an assignment, checks whether a user is signed up for a topic, allows users to sign up for topics.

===What's wrong with it===
* These two controllers seem to do almost the same thing. They have many of the same methods. <code>SignUpSheetController</code> is much longer, and has many more recent mods, but some methods of <code>SignUpController</code> seem more sophisticated than <code>SignUpSheetController</code>. So, your first job is to figure out if both controllers are being used. If not, remove the unused controller. Or, move the functions to a single controller if that makes sense to do.
* Neither controller is at all RESTful; i.e.., its method names aren’t the standard names <code>new</code>, <code>create</code>, <code>edit</code>, <code>delete</code>, etc. Functionality is divided differently than in a standard controller. a. <code>def confirm_topic(creator_id, topic_id, assignment_id)</code> b. <code>def delete_signup</code> c.<code>def delete_signup_for_topic(assignment_id,topic_id)</code> d. <code>def other_confirmed_topic_for_user(assignment_id, creator_id)</code> e. <code>def signup</code> f. <code>def slotAvailable?(topic_id)</code>
* Functionality that should be in models is incorporated into the controller.
* Some methods are too long and appear to do more than one thing
* This class interfaces with assignments_controller so that a list of topics can be displayed when one is editing an assignment. Please be careful that your changes do not affect the functionality on the Topics tab of editing an assignment.
* Rename the controller(s) to <code>SignupController</code> and/or <code>SignupSheetController</code>. (“Sign up”, which gets written as SignUp in camel case, is a verb, whereas “Signup” is a noun.)
* Some codes does not follow the [https://docs.google.com/a/ncsu.edu/document/d/1qQD7fcypFk77nq7Jx7ZNyCNpLyt1oXKaq5G-W7zkV3k/edit Global Rules].

== Modification We Made ==
=== Removing unused controller ===
After various analysis and test, we found <code>SignUpController</code> is never used. So we remove it. The reasons are listed as follows:
* There is no code about <code>SignUpController</code> in <code>route.rb</code> file.The Rails router recognizes URLs and dispatches them to a controller's action. It can also generate paths and URLs, avoiding the need to hardcode strings in your views<ref>http://guides.rubyonrails.org/routing.html#the-purpose-of-the-rails-router</ref>. Rails default routing is resource routing, which allows us to declare all the common routes for a resourceful controller. In our <code>route.rb</code>, we found a matching resourceful route for <code>SignUpSheetController</code>, which asks the router to map it to the <code>SignUpSheetController</code> action.

<pre>
resources :signup_sheet
</pre>

This route creates several different routes in the application, all mapping to the <code>SignUpSheetController</code> controller.
Here are some examples:

{| class="wikitable"
|-
! style="width:13%;"|HTTP Verb
! style="width:33%;"|Controller#Action
! style="width:43%;"|Used For
|- style="vertical-align:top;"
| GET
| sigh_up_sheet#signup
| This function lets the user choose a particular topic.
|-
| GET
| sigh_up_sheet#delete_signup
| This function is used to delete a previous signup
|-
| GET
| sigh_up_sheet#view_publishing_rights
| The function is to make sure the publishing rights for a user
|}
However, there is not a matching route for <code>SignUpController</code>.
*<code>SignUpSheetController</code> has all seven methods in <code>SignUpController</code> with same name. we found these functions are completely achieved via <code>SignUpSheetController</code>. And after test, we prove that codes in <code>SignUpController</code> never got executed when we ran the project.

=== RESTful style implementation ===
The purpose of the <code>list</code> method in the <code>SignupSheet controller</code> is to list all the topics in the specific assignments. According to RESTful rules, a method that returns a list of all available objects should be named as <code>index</code>. Therefore, we renamed the list method to the index method in the controller and in all the files that had references to the list method of the signup_sheet_controller.

Before Refactoring:
 Method: <code>list</code>
<pre>
def list
...
end
</pre>

After Refactoring:
 Method: <code>index</code>
<pre>
def index
...
end
</pre>

And we need to change some references to the method:
<pre>
verify method: 'post', :only => [:destroy, :create, :update],
:redirect_to => {:action => :index}

SignUpTopic.reassign_topic(@user_id,params[:assignment_id], params[:id])
redirect_to action: 'index', id: params[:assignment_id]

signup_team(@assignment.id, @user_id, params[:id])
redirect_to action: 'index', id: params[:assignment_id]
</pre>
For some others, it is not good to combine some functions with the standard ones. For example, <code>create</code> function creates topics, which is one of the administrator’s functions. However <code>signup</code> creates a record that includes information for topic and student, which happens when student clicks <code>signup</code> button. We can see that <code>create</code> and <code>signup</code> are designed for different role and different usage so it is not a good idea to combine them together.

=== Moving inappropriate functionality from controller to model ===
The controller connects the model with the view. In Rails, controllers are implemented as ActionController classes. The controller knows how to process the data that comes from the model and how to pass it onto the view. The controller should not include any database related actions (such as modifying data before it gets saved inside the database). This should be handled in the proper model. So we remove all the database related functionality in the signup_sheet_controller to related models.
The following files were modified:
<pre>
app/controllers/signup_sheet_controller.rb
app/models/deadline_type.rb
app/models/due_date.rb
app/models/participant.rb
app/models/sign_up_topic.rb
app/models/signed_up_user.rb
app/models/topic_deadline.rb
app/models/topic_dependency.rb
</pre>
Here are two examples on how these files changed. 
1. replace "where" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
</pre>
Also add a related method in<code> sign_up_topic.rb</code>
<pre>
def find_with_name_and_assignment_id(name, aid)
SignUpTopic.where(topic_name: name, assignment_id: aid)
end
</pre>
2. replace "find_by_sql" in the controller with a new method in related model. 
Before Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + params[:id].to_s)
</pre>

After Refactoring: 
In <code>signup_sheet_controller.rb</code>:
<pre>
@duedates = SignUpTopic.find_topic_id_with_assignment_id(params[:id].to_s)
</pre>
Also add a related method in <code>sign_up_topic.rb</code>
<pre>
def find_topic_id_with_assignment_id(aid)
SignUpTopic.find_by_sql("SELECT s.id as topic_id FROM sign_up_topics s WHERE s.assignment_id = " + aid)
end
</pre>

=== Breaking down long methods ===
We’ve find that lots of methods do more than one thing so we separate a long function into several concise functions and call them in the original function. Here is an example:

There are some preparation works and check works before or after the actual create operation. So we separate two functions <code>update_topic_info</code> and <code>check_after_create</code> from <code>create</code>. And we call these two functions in <code>create</code> method instead of executing these codes directly.

Before Refactoring:
 Method: <code>create</code>
<pre>
def create
topic = SignUpTopic.where(topic_name: params[:topic][:topic_name], assignment_id: params[:id]).first
if topic != nil
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_by_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render :action => 'new', :id => params[:id]
end
end
end
</pre>

After Refactoring
 Method: <code>update_topic_info</code>, <code>check_after_create</code>, <code>create</code>
<pre>
def update_topic_info(topic)
topic.topic_identifier = params[:topic][:topic_identifier]
if SignedUpUser.find_with_topic_id(topic.id).nil? || topic.max_choosers == params[:topic][:max_choosers]
topic.max_choosers = params[:topic][:max_choosers]
else
if topic.max_choosers.to_i < params[:topic][:max_choosers].to_i
topic.update_waitlisted_users(params[:topic][:max_choosers])
topic.max_choosers = params[:topic][:max_choosers]
else
flash[:error] = 'Value of maximum choosers can only be increased! No change has been made to max choosers.'
end
end
end
</pre>
The method <code>update_topic_info</code> updates topics' some attributes according to received parameters, such as permitted max number of choosers and waitlisted users. This method is separated from function <code>create</code> because it doesn't really do any creation works.
<pre>
def check_after_create
if @assignment.is_microtask?
@sign_up_topic.micropayment = params[:topic][:micropayment]
end
if @assignment.staggered_deadline?
topic_set = Array.new
topic = @sign_up_topic.id
end
end
</pre>
The method <code>check_after_create</code> check if the assignment is a microtask and if it applies to staggered deadline. If these two conditions are met, then execute corresponding actions. These steps should be separated from <code>create</code> function because it doesn't actually do works related with creation.
<pre>
def create
topic = SignUpTopic.find_with_name_and_assignment_id(params[:topic][:topic_name], params[:id]).first
if topic
update_topic_info(topic)
topic.category = params[:topic][:category]
topic.save
redirect_to_sign_up(params[:id])
else
set_values_for_new_topic
check_after_create
if @sign_up_topic.save
undo_link("Topic: \"#{@sign_up_topic.topic_name}\" has been created successfully. ")
redirect_to edit_assignment_path(@sign_up_topic.assignment_id) + "#tabs-5"
else
render action: 'new', id: params[:id]
end
end
end
</pre>
In <code>create</code> method, the two separated methods were called. By this way, function <code>create</code> will be much shorter and some works do not belong to it can be finished by other methods.

=== Deleting redundant button ===
When we move the mouse on the Assignment, there is a "Edit signup sheet" button in the popup menu. It is a redundant button since there already has such a function in Assignment "Edit" menu. What's more it's more reasonable to put this function in "Edit" Assignment because signup sheet is a part of the assignment. So we removed this button. Sometimes after making some changes, the display topics function didn’t work due to some reasons. We’ve fixed those bugs and make sure it still works after our last change. 
We delete the following lines in <code>app/views/tree_display/actions/_assignments_actions.html.erb</code>
<pre>
<% if signup_topic %>
...
<% end %>
</pre>

the origin popup menu is as following picture, there is a <code>edit signup sheet </code> button: 
[[File:originPopup.jpg]] 
The new popup menu is: 
[[File:new_popup.png]] 
After modifying, the other assignment functions all works well. 
[[File:AssignTopic.png]]

=== Renaming controller ===
According to the controller name convention<ref>http://guides.rubyonrails.org/action_controller_overview.html</ref>, a controller should be a singular noun. However, here <code>SignUp</code> in camel case is a verb. We should modify it to a noun written as <code>Signup</code>. As a result, we rename all class name <code>SignUpSheetController</code> to <code>SignupSheetController</code>. Then the controller name <code>sign_up_sheet_controller</code> is revised into <code>signup_sheet_controller</code> automatically. 
Here we also make sure every reference for this controller has been changed to match the new controller name. For example, in <code>views/signup_sheet/_action.html.erb</code> file, we must make sure this render path is correct as follows:
<pre>
<%= render :partial => '/signup_sheet/all_actions', :locals => {:i=>i, :topic=>topic} %>
</pre>

=== Following global rules ===
According to Global Rules, there are some codes that need some improvements to make it follow the rules correctly. Here are some of what we have done:

* change <code>users_team.size == 0</code> to <code>users_team.zero?</code>
<pre>
change:
if users_team.size == 0
to:
if users_team.zero?
or:
if users_team.empty?
</pre>

* Use <code>key: 'value'</code>, not <code>:key => 'value'</code>
<pre>
change:
redirect_to :action => 'add_signup_topics_staggered', :id => assignment_id
to:
redirect_to action: 'add_signup_topics_staggered', id: assignment_id
</pre>

* Use <code>if (var)</code> instead of <code>if (var == true)</code>
<pre>
change:
(assignment.staggered_deadline == true)?
to:
(assignment.staggered_deadline)?
</pre>

== References ==
<references/>