Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-15T01:56:41Z

Sli41: /* Edge cases */

== Introduction ==

The expertiza project takes advantage of peer-review among students to allow them to learn from each other. To track the review time that each student spend on each submitted resources is meaningful to instructors to study and improve the teach experience. However, the time tracking of specific content on these resources is not perfect in the expertiza system. The previous team working on E1705 project has solved part of such problems by tracking the active time of windows opened from the submitted links. But for the submitted files which could be downloaded for local review, there is only a rough approximation solution yet. In this project, our team is going to solve this problem as well as improving previous time tracking methods using mature third-party APIs to record link review time more accurately. To accomplish this goal, here are the general solutions we designed and implemented in this project:

*Designed a database schema for logging the time a reviewer spend on a submission;
*Designed and implemented dynamic partial components using Javascript and Ruby to open students’ submissions in new windows to view online;
*Used DOM to control the windows holding review submission files or links, and record the open and close time;
*Modify Review report (views/review_mapping/_review_report.html.erb) to show the total and detailed time spent on each review submissions with visualization.

== Problem Description and Solution ==
Our team is going to solve the submission review time tracking by attempting to open the downloaded files inside popup windows of the web browser in order to record the time on the client side.

=== Type of submitted files ===
For most of our tasks, there are two types of submitted files.

1. One kind is online links, such as github repo or pull request link, youtube video link, expertiza wiki page link, etc

2. The other one includes files such as pdf, txt, doc, images, etc and other download contents. (instructor can include more document types in /views/submitted_content/_submitted_files.html.erb)

=== Design pattern ===
'''Strategy''' In this project, for each review page, we need to deal with different type of links. For online links, such as github repo, youtube link, etc, we use javascript to open a new window detect time when the window is closed. For submitted files, such as txt, jpg, we will open it with views/response/_submitted_files.html.erb. For other files that need to be download and open locally, we can only make approximation for review time.

=== Database shcema design ===
For this project, we need to design a database table to store all the time that we need to record for each review submission event. We would like to name the table as '''submission_viewing_events'''. For the table, we would use '''map_id''' in table response, which uses '''response_map_id''' as the primary information. Then we need to record '''reviewer_id''' and '''reviewee_id''', '''source_link''' for submitted links or file names, as well as time '''start_at''' and '''end_at''', then store them in the table.

[[File:E1791db.jpg | center]]

=== Time tracking mechanism ===

For each review, when the reviewer click on one link of the submitted files, we create an entry to the table review_time, we will write a function to record current time to the database.

For how to determine time when the reviewer complete with the opened link, there are different cases. If the reviewer click on save or submit button, close the page, or logout, we need to write to all open entry (without end_at) respect to this review and save current time to end_at. But for how to decide when the review close the opened link is a little complicated. For github and youtube links and txt, pdf, doc, image files, we will open submitted files in views/response/_submitted_files.html.erb so that when the user click on the link, it opens a popup window that shows the submission, record time when it opens and closes. This is done by controlling DOM using jQuery javascript library, and then send back the time records through Ajax. For the other files that need to be downloaded, we can only make an approximation by record the time when the reviewer click on the link until the time he/she enter the reviews.

For each task, reviewer might open each link several times, might also save the review process and restart it some times later, so we will have multiple records for each link. Every time the student click on the link, a new record is created and then the time in all records will be summed up to total time for every link and displayed on instructor page.

[[File:E1791_flowchart.png | center]]

=== View modification ===
After we record start_at and end_at time for each piece of review, we need to display time that each reviewer spent on each link. Because the reviewer may save the review and start again in the future, so for each link there might be several entries, we need to sum them together. We modifed code in review_mapping/_review_report.html.erb first to modify the view. This framework follows well the "open to extension and close to modification" principle, which makes further changes more feasible by adding additional view components without affecting current functions.
[[File:review_piechart.png | center]]

=== Edge cases ===
1. When user click on save or submit the review without closing opened windows, the system will search all records of response time for the reviewer and reviewee where end time is NULL, and update it with current time.

2. If the reviewer opens the reference links or download files, but leave them open and turn to focus other unrelated stuff, the review page will send a popup alert dialog to confirm if the review is still in review mode. If not, it will close these windows and save the time as approximation of end time. Otherwise, it will continue the review process.
[[File:E1791popup alert.jpg | center]]

3. In some cases, reviewer might shut down the computer, close the browser, log out without saving, etc., we set up periodically saving reviewing events automatically such that we will lose as less information as possible. Currently the period is 30 seconds and this can be changed. For the cases described, shut down computer etc., there will be records written in data base with end time NULL, next time when the reviewer restart the review, the system will just drop all the records with NULL end time and start a new query. Also if reviewer does not interact with the review page for a long time, it will pause the timer and commit all existing related time record in database. The time limit is now 2 minutes. Both the period and non-interaction time can be adjusted by instructors in code file /views/response/response.html.erb

== Test Plan ==
=== UI and Manual test ===
We will test the following cases during our development

1. When we work the review, if we click on GitHub link, GitHub pull request link, check whether the system record review time correctly.

2. When we work the review, if we click on doc, pdf, image link, check whether system open submitted files in views/response/_submitted_files.html.erb and recore the review time correctly.

3. Check if the reviewer save the process and start again with click on same clink, check whether the system will record all the entry, and on the view page take all entries for one link into account.

=== Rspec Test ===
Test of new model and function will be written and tested during project development:
* Test the success of a review time record given valid start and end time;

describe ResponseTimesController do
describe '#action_allowed?' do
it "should return true" do
expect(true).to be_truthy
end
end

* Test whether the start time is updated to the end time last saved in the database when the user resumes a review;

describe '#response_start_time' do
context 'when the link is opened and timed' do
it 'should update time record with start time as end time' do
response_time_records=double('ResponseTime')
allow(ResponseTime).to receive(:where).with([:map_id,:round,:link]).and_return(response_time_records)
dummy = double('BasicObject')
allow(ResponseTime).to receive(:end_at).and_return(dummy)
allow(dummy).to receive(:nil?).and_return(true)
allow(ResponseTime).to receive(:update_attributes).with(:end_at,:start_at).and_return(response_time_records)
expect(response.body).to be_blank
end
end
end

* Test whether the end time is updated as the current time when the review is saved to the database.

describe '#response_end_time' do
context 'when response does not have a end time' do
it 'should update time record with end time as current time' do
response_time_records=double('ResponseTime')
allow(ResponseTime).to receive(:where).with([:map_id,:round,:link]).and_return(response_time_records)
dummy = double('BasicObject')
allow(ResponseTime).to receive(:end_at).and_return(dummy)
allow(dummy).to receive(:nil?).and_return(true)
allow(ResponseTime).to receive(:update_attributes).with(:end_at,Time.now.to_date).and_return(response_time_records)
expect(response.body).to be_blank
end
end
end

== Related Files ==
submission_viewing_events.rb 
submission_viewing_events_controller.rb 
responses_controller.rb 
helper/review_mapping_helper.rb 
helpers/submitted_content_helper.rb 
response/response.html.erb 
review_mapping/_review_report.html.erb 
review_mapping/_review_submissions_time_spent.html.erb 
view/popup/reviewer_details_popup.html.erb 
view/submitted_content/_hyperlink.html.erb 
view/submitted_content/_submitted_files.html.erb 
db/migrate/20171117190721_create_response_times.rb 
config/routes.rb

== Future Work ==

In this project, we accomplished the requirement defined in the project instructions. However, due to the complexity of the Expertiza system and limited time period, there are still several points to improve in the future:

1. Improve the accuracy of review time record. To record the exact time that the user spends on each link or file, it is more accurate to track the active time of each new window or tab of these links or online files. We attempted this design using 'window.focus()', but it does not work once the user moved away from the review page and turned to other applications. So either tweaking the web setting or using browser APIs may solve this problem.

2. Notify the user when no response on the review page. Occasionally the user may open the review page to do the review, but is interrupted to focus on other applications. In this case, we stopped the time recording but try to alert the user that if he wants to continue the review. However, this notice cannot show in time if the user is not focusing on that review page. So a global alert is necessary to save the time and provide notice on time.

== Project Links ==
1. [https://github.com/expertiza/expertiza/pull/1124 Project Github repo]

2. [https://youtu.be/IMTBqiKth-k Project Video Demo]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:wsun12@ncsu.edu Wei Sun] 
[mailto:asundar2@ncsu.edu Aishwarya Sundararajan] 
[mailto:dbhanda@ncsu.edu Darshan Balakrishna Bhandari]

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-15T01:51:53Z

Sli41: /* Type of submitted files */

== Introduction ==

The expertiza project takes advantage of peer-review among students to allow them to learn from each other. To track the review time that each student spend on each submitted resources is meaningful to instructors to study and improve the teach experience. However, the time tracking of specific content on these resources is not perfect in the expertiza system. The previous team working on E1705 project has solved part of such problems by tracking the active time of windows opened from the submitted links. But for the submitted files which could be downloaded for local review, there is only a rough approximation solution yet. In this project, our team is going to solve this problem as well as improving previous time tracking methods using mature third-party APIs to record link review time more accurately. To accomplish this goal, here are the general solutions we designed and implemented in this project:

*Designed a database schema for logging the time a reviewer spend on a submission;
*Designed and implemented dynamic partial components using Javascript and Ruby to open students’ submissions in new windows to view online;
*Used DOM to control the windows holding review submission files or links, and record the open and close time;
*Modify Review report (views/review_mapping/_review_report.html.erb) to show the total and detailed time spent on each review submissions with visualization.

== Problem Description and Solution ==
Our team is going to solve the submission review time tracking by attempting to open the downloaded files inside popup windows of the web browser in order to record the time on the client side.

=== Type of submitted files ===
For most of our tasks, there are two types of submitted files.

1. One kind is online links, such as github repo or pull request link, youtube video link, expertiza wiki page link, etc

2. The other one includes files such as pdf, txt, doc, images, etc and other download contents. (instructor can include more document types in /views/submitted_content/_submitted_files.html.erb)

=== Design pattern ===
'''Strategy''' In this project, for each review page, we need to deal with different type of links. For online links, such as github repo, youtube link, etc, we use javascript to open a new window detect time when the window is closed. For submitted files, such as txt, jpg, we will open it with views/response/_submitted_files.html.erb. For other files that need to be download and open locally, we can only make approximation for review time.

=== Database shcema design ===
For this project, we need to design a database table to store all the time that we need to record for each review submission event. We would like to name the table as '''submission_viewing_events'''. For the table, we would use '''map_id''' in table response, which uses '''response_map_id''' as the primary information. Then we need to record '''reviewer_id''' and '''reviewee_id''', '''source_link''' for submitted links or file names, as well as time '''start_at''' and '''end_at''', then store them in the table.

[[File:E1791db.jpg | center]]

=== Time tracking mechanism ===

For each review, when the reviewer click on one link of the submitted files, we create an entry to the table review_time, we will write a function to record current time to the database.

For how to determine time when the reviewer complete with the opened link, there are different cases. If the reviewer click on save or submit button, close the page, or logout, we need to write to all open entry (without end_at) respect to this review and save current time to end_at. But for how to decide when the review close the opened link is a little complicated. For github and youtube links and txt, pdf, doc, image files, we will open submitted files in views/response/_submitted_files.html.erb so that when the user click on the link, it opens a popup window that shows the submission, record time when it opens and closes. This is done by controlling DOM using jQuery javascript library, and then send back the time records through Ajax. For the other files that need to be downloaded, we can only make an approximation by record the time when the reviewer click on the link until the time he/she enter the reviews.

For each task, reviewer might open each link several times, might also save the review process and restart it some times later, so we will have multiple records for each link. Every time the student click on the link, a new record is created and then the time in all records will be summed up to total time for every link and displayed on instructor page.

[[File:E1791_flowchart.png | center]]

=== View modification ===
After we record start_at and end_at time for each piece of review, we need to display time that each reviewer spent on each link. Because the reviewer may save the review and start again in the future, so for each link there might be several entries, we need to sum them together. We will try to modify code in review_mapping/_review_report.html.erb first to modify the view. This framework follows well the "open to extension and close to modification" principle, which makes further changes more feasible by adding additional view components without affecting current functions.
[[File:review_piechart.png | center]]

=== Edge cases ===
1. When user click on save or submit the review without closing opened windows, the system will search all records of response time for the reviewer and reviewee where end time is NULL, and update it with current time.

2. If the reviewer opens the reference links or download files, but leave them open and turn to focus other unrelated stuff, the review page will send a popup alert dialog to confirm if the review is still in review mode. If not, it will close these windows and save the time as approximation of end time. Otherwise, it will continue the review process.
[[File:E1791popup alert.jpg | center]]

3. In some cases, reviewer might shut down the computer, close the browser, log out without saving, etc., we set up periodically saving reviewing events automatically such that we will lose as less information as possible. Currently the period is 30 seconds and this can be changed. For the cases described, shut down computer etc., there will be records written in data base with end time NULL, next time when the reviewer restart the review, the system will just drop all the records with NULL end time and start a new query.

== Test Plan ==
=== UI and Manual test ===
We will test the following cases during our development

1. When we work the review, if we click on GitHub link, GitHub pull request link, check whether the system record review time correctly.

2. When we work the review, if we click on doc, pdf, image link, check whether system open submitted files in views/response/_submitted_files.html.erb and recore the review time correctly.

3. Check if the reviewer save the process and start again with click on same clink, check whether the system will record all the entry, and on the view page take all entries for one link into account.

=== Rspec Test ===
Test of new model and function will be written and tested during project development:
* Test the success of a review time record given valid start and end time;

describe ResponseTimesController do
describe '#action_allowed?' do
it "should return true" do
expect(true).to be_truthy
end
end

* Test whether the start time is updated to the end time last saved in the database when the user resumes a review;

describe '#response_start_time' do
context 'when the link is opened and timed' do
it 'should update time record with start time as end time' do
response_time_records=double('ResponseTime')
allow(ResponseTime).to receive(:where).with([:map_id,:round,:link]).and_return(response_time_records)
dummy = double('BasicObject')
allow(ResponseTime).to receive(:end_at).and_return(dummy)
allow(dummy).to receive(:nil?).and_return(true)
allow(ResponseTime).to receive(:update_attributes).with(:end_at,:start_at).and_return(response_time_records)
expect(response.body).to be_blank
end
end
end

* Test whether the end time is updated as the current time when the review is saved to the database.

describe '#response_end_time' do
context 'when response does not have a end time' do
it 'should update time record with end time as current time' do
response_time_records=double('ResponseTime')
allow(ResponseTime).to receive(:where).with([:map_id,:round,:link]).and_return(response_time_records)
dummy = double('BasicObject')
allow(ResponseTime).to receive(:end_at).and_return(dummy)
allow(dummy).to receive(:nil?).and_return(true)
allow(ResponseTime).to receive(:update_attributes).with(:end_at,Time.now.to_date).and_return(response_time_records)
expect(response.body).to be_blank
end
end
end

== Related Files ==
submission_viewing_events.rb 
submission_viewing_events_controller.rb 
responses_controller.rb 
helper/review_mapping_helper.rb 
helpers/submitted_content_helper.rb 
response/response.html.erb 
review_mapping/_review_report.html.erb 
review_mapping/_review_submissions_time_spent.html.erb 
view/popup/reviewer_details_popup.html.erb 
view/submitted_content/_hyperlink.html.erb 
view/submitted_content/_submitted_files.html.erb 
db/migrate/20171117190721_create_response_times.rb 
config/routes.rb

== Future Work ==

In this project, we accomplished the requirement defined in the project instructions. However, due to the complexity of the Expertiza system and limited time period, there are still several points to improve in the future:

1. Improve the accuracy of review time record. To record the exact time that the user spends on each link or file, it is more accurate to track the active time of each new window or tab of these links or online files. We attempted this design using 'window.focus()', but it does not work once the user moved away from the review page and turned to other applications. So either tweaking the web setting or using browser APIs may solve this problem.

2. Notify the user when no response on the review page. Occasionally the user may open the review page to do the review, but is interrupted to focus on other applications. In this case, we stopped the time recording but try to alert the user that if he wants to continue the review. However, this notice cannot show in time if the user is not focusing on that review page. So a global alert is necessary to save the time and provide notice on time.

== Project Links ==
1. [https://github.com/expertiza/expertiza/pull/1124 Project Github repo]

2. [https://youtu.be/IMTBqiKth-k Project Video Demo]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:wsun12@ncsu.edu Wei Sun] 
[mailto:asundar2@ncsu.edu Aishwarya Sundararajan] 
[mailto:dbhanda@ncsu.edu Darshan Balakrishna Bhandari]

File:Review piechart.png

2017-12-15T01:48:15Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-15T01:43:17Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-15T01:41:56Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-15T01:39:25Z

Sli41: uploaded a new version of "File:Review piechart.png"

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-06T04:23:58Z

Sli41: /* Project Links */

== Introduction ==

The expertiza project takes advantage of peer-review among students to allow them to learn from each other. To track the review time that each student spend on each submitted resources is meaningful to instructors to study and improve the teach experience. However, the time tracking of specific content on these resources is not perfect in the expertiza system. The previous team working on E1705 project has solved part of such problems by tracking the active time of windows opened from the submitted links. But for the submitted files which could be downloaded for local review, there is only a rough approximation solution yet. In this project, our team is going to solve this problem as well as improving previous time tracking methods using mature third-party APIs to record link review time more accurately. To accomplish this goal, here are the general solutions we designed and implemented in this project:

*Designed a database schema for logging the time a reviewer spend on a submission;
*Designed and implemented dynamic partial components using Javascript and Ruby to open students’ submissions in new windows to view online;
*Used DOM to control the windows holding review submission files or links, and record the open and close time;
*Modify Review report (views/review_mapping/_review_report.html.erb) to show the total and detailed time spent on each review submissions with visualization.

== Problem Description and Solution ==
Our team is going to solve the submission review time tracking by attempting to open the downloaded files inside popup windows of the web browser in order to record the time on the client side.

=== Design pattern ===

=== Type of submitted files ===
For most of our tasks, there are two types of submitted files.

1. One kind is online links, such as github repo or pull request link, youtube video link, expertiza wiki page link, etc

2. The other one includes files such as pdf, txt, doc, images, etc and other download contents.

=== Database shcema design ===
For this project, we need to design a database table to store all the time that we need to record for each review submission. We would like to name the table as '''review_time'''. For the table, we would use '''map_id''' in table response, which uses '''response_map_id''' as the primary information. Then we need to record '''reviewer_id''' and '''reviewee_id''', '''file_link''' for submitted files, as well as time '''start_at''' and '''end_at''', then store them in the table.

[[File:E1791db.png | center]]

=== Time tracking mechanism ===

For each review, when the reviewer click on one link of the submitted files, we create an entry to the table review_time, we will write a function to record current time to the database.

For how to determine time when the reviewer complete with the opened link, there are different cases. If the reviewer click on save or submit button, close the page, or logout, we need to write to all open entry (without end_at) respect to this review and save current time to end_at. But for how to decide when the review close the opened link is a little complicated. For github and youtube links and txt, pdf, doc, image files, we will open submitted files in views/response/_submitted_files.html.erb so that when the user click on the link, it opens a popup window that shows the submission, record time when it opens and closes. This is done by controlling DOM using jQuery javascript library, and then send back the time records through Ajax. For the other files that need to be downloaded, we can only make an approximation by record the time when the reviewer click on the link until the time he/she enter the reviews.

[[File:E1791_flowchart.png | center]]

=== View modification ===
After we record start_at and end_at time for each piece of review, we need to display time that each reviewer spent for each link. Because the reviewer may save the review and start again in the future, so for each link there might be several entries, we need to sum them together. We will try to modify code in review_mapping/_review_report.html.erb first to modify the view. This framework follows well the "open to extension and close to modification" principle, which makes further changes more feasible by adding additional view components without affecting current functions.
[[File:review_piechart.png | center]]

=== Edge cases ===
1. When user click on save or submit the review without closing opened windows, the system will search all records of response time for the reviewer and reviewee where end time is NULL, and update it with current time.

2. If the reviewer opens the reference links or download files, but leave them open and turn to focus other unrelated stuff, the review page will send a popup alert dialog to confirm if the review is still in review mode. If not, it will close these windows and save the time as approximation of end time. Otherwise, it will continue the review process.
[[File:Alert_popup.png | center]]

== Test Plan ==
=== UI and Manual test ===
We will test the following cases during our development

1. When we work the review, if we click on GitHub link, GitHub pull request link, check whether the system record review time correctly.

2. When we work the review, if we click on doc, pdf, image link, check whether system open submitted files in views/response/_submitted_files.html.erb and recore the review time correctly.

3. Check if the reviewer save the process and start again with click on same clink, check whether the system will record all the entry, and on the view page take all entries for one link into account.

=== Rspec Test ===
Test of new model and function will be written and tested during project development:
* Test the success of a review time record given valid start and end time;

describe ResponseTimesController do
describe '#action_allowed?' do
it "should return true" do
expect(true).to be_truthy
end
end

* Test the error handler when a review time record fails to save;
* Test the calculation of the total review time for the same link.

== Related Files ==
review_time.rb 
responses_controller.rb 
response_times_controller.rb 
helper/review_mapping_helper.rb 
response/response.html.erb 
review_mapping/_review_report.html.erb 
review_mapping/_review_submissions_time_spent.html.erb 
view/popup/reviewer_details_popup.html.erb 
view/submitted_content/_hyperlink.html.erb 
view/submitted_content/_submitted_files.html.erb 
db/migrate/20171117190721_create_response_times.rb 
config/routes.rb

== Future Work ==

In this project, we accomplished the requirement defined in the project instructions. However, due to the complexity of the Expertiza system and limited time period, there are still several points to improve in the future:

1. Improve the accuracy of review time record. To record the exact time that the user spends on each link or file, it is more accurate to track the active time of each new window or tab of these links or online files. We attempted this design using 'window.focus()', but it does not work once the user moved away from the review page and turned to other applications. So either tweaking the web setting or using browser APIs may solve this problem.

2. Notify the user when no response on the review page. Occasionally the user may open the review page to do the review, but is interrupted to focus on other applications. In this case, we stopped the time recording but try to alert the user that if he wants to continue the review. However, this notice cannot show in time if the user is not focusing on that review page. So a global alert is necessary to save the time and provide notice on time.

== Project Links ==
1. [https://github.com/expertiza/expertiza/pull/1124 Project Github repo]

2. [https://youtu.be/IMTBqiKth-k Project Video Demo]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:wsun12@ncsu.edu Wei Sun] 
[mailto:asundar2@ncsu.edu Aishwarya Sundararajan] 
[mailto:dbhanda@ncsu.edu Darshan Balakrishna Bhandari]

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-05T15:21:57Z

Sli41: /* Future Work */

== Introduction ==

The expertiza project takes advantage of peer-review among students to allow them to learn from each other. To track the review time that each student spend on each submitted resources is meaningful to instructors to study and improve the teach experience. However, the time tracking of specific content on these resources is not perfect in the expertiza system. The previous team working on E1705 project has solved part of such problems by tracking the active time of windows opened from the submitted links. But for the submitted files which could be downloaded for local review, there is only a rough approximation solution yet. In this project, our team is going to solve this problem as well as improving previous time tracking methods using mature third-party APIs to record link review time more accurately. To accomplish this goal, here are the general solutions we designed and implemented in this project:

*Designed a database schema for logging the time a reviewer spend on a submission;
*Designed and implemented dynamic partial components using Javascript and Ruby to open students’ submissions in new windows to view online;
*Used DOM to control the windows holding review submission files or links, and record the open and close time;
*Modify Review report (views/review_mapping/_review_report.html.erb) to show the total and detailed time spent on each review submissions with visualization.

== Problem Description and Solution ==
Our team is going to solve the submission review time tracking by attempting to open the downloaded files inside popup windows of the web browser in order to record the time on the client side.

=== Type of submitted files ===
For most of our tasks, there are two types of submitted files.

1. One kind is online links, such as github repo or pull request link, youtube video link, expertiza wiki page link, etc

2. The other one includes files such as pdf, txt, doc, images, etc and other download contents.

=== Database shcema design ===
For this project, we need to design a database table to store all the time that we need to record for each review submission. We would like to name the table as '''review_time'''. For the table, we would use '''map_id''' in table response, which uses '''response_map_id''' as the primary information. Then we need to record '''reviewer_id''' and '''reviewee_id''', '''file_link''' for submitted files, as well as time '''start_at''' and '''end_at''', then store them in the table.

[[File:E1791db.png | center]]

=== Time tracking mechanism ===

For each review, when the reviewer click on one link of the submitted files, we create an entry to the table review_time, we will write a function to record current time to the database.

For how to determine time when the reviewer complete with the opened link, there are different cases. If the reviewer click on save or submit button, close the page, or logout, we need to write to all open entry (without end_at) respect to this review and save current time to end_at. But for how to decide when the review close the opened link is a little complicated. For github and youtube links and txt, pdf, doc, image files, we will open submitted files in views/response/_submitted_files.html.erb so that when the user click on the link, it opens a popup window that shows the submission, record time when it opens and closes. This is done by controlling DOM using jQuery javascript library, and then send back the time records through Ajax. For the other files that need to be downloaded, we can only make an approximation by record the time when the reviewer click on the link until the time he/she enter the reviews.

[[File:E1791_flowchart.png | center]]

=== View modification ===
After we record start_at and end_at time for each piece of review, we need to display time that each reviewer spent for each link. Because the reviewer may save the review and start again in the future, so for each link there might be several entries, we need to sum them together. We will try to modify code in review_mapping/_review_report.html.erb first to modify the view. This framework follows well the "open to extension and close to modification" principle, which makes further changes more feasible by adding additional view components without affecting current functions.
[[File:review_piechart.png | center]]

=== Edge cases ===
1. When user click on save or submit the review without closing opened windows, the system will search all records of response time for the reviewer and reviewee where end time is NULL, and update it with current time.

2. If the reviewer opens the reference links or download files, but leave them open and turn to focus other unrelated stuff, the review page will send a popup alert dialog to confirm if the review is still in review mode. If not, it will close these windows and save the time as approximation of end time. Otherwise, it will continue the review process.
[[File:Alert_popup.png | center]]

== Test Plan ==
=== UI and Manual test ===
We will test the following cases during our development

1. When we work the review, if we click on GitHub link, GitHub pull request link, check whether the system record review time correctly.

2. When we work the review, if we click on doc, pdf, image link, check whether system open submitted files in views/response/_submitted_files.html.erb and recore the review time correctly.

3. Check if the reviewer save the process and start again with click on same clink, check whether the system will record all the entry, and on the view page take all entries for one link into account.

=== Rspec Test ===
Test of new model and function will be written and tested during project development:
* Test the success of a review time record given valid start and end time;

describe ResponseTimesController do
describe '#action_allowed?' do
it "should return true" do
expect(true).to be_truthy
end
end

* Test the error handler when a review time record fails to save;
* Test the calculation of the total review time for the same link.

== Related Files ==
review_time.rb 
responses_controller.rb 
response_times_controller.rb 
helper/review_mapping_helper.rb 
response/response.html.erb 
review_mapping/_review_report.html.erb 
review_mapping/_review_submissions_time_spent.html.erb 
view/popup/reviewer_details_popup.html.erb 
view/submitted_content/_hyperlink.html.erb 
view/submitted_content/_submitted_files.html.erb 
db/migrate/20171117190721_create_response_times.rb 
config/routes.rb

== Future Work ==

In this project, we accomplished the requirement defined in the project instructions. However, due to the complexity of the Expertiza system and limited time period, there are still several points to improve in the future:

1. Improve the accuracy of review time record. To record the exact time that the user spends on each link or file, it is more accurate to track the active time of each new window or tab of these links or online files. We attempted this design using 'window.focus()', but it does not work once the user moved away from the review page and turned to other applications. So either tweaking the web setting or using browser APIs may solve this problem.

2. Notify the user when no response on the review page. Occasionally the user may open the review page to do the review, but is interrupted to focus on other applications. In this case, we stopped the time recording but try to alert the user that if he wants to continue the review. However, this notice cannot show in time if the user is not focusing on that review page. So a global alert is necessary to save the time and provide notice on time.

== Project Links ==
1. [https://github.com/expertiza/expertiza/pull/1102 Project Github repo]

2. [https://youtu.be/IMTBqiKth-k Project Video Demo]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:wsun12@ncsu.edu Wei Sun] 
[mailto:asundar2@ncsu.edu Aishwarya Sundararajan] 
[mailto:dbhanda@ncsu.edu Darshan Balakrishna Bhandari]

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-05T15:11:07Z

Sli41:

File:Review piechart.png

2017-12-05T06:35:34Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-05T06:34:26Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-05T06:33:49Z

Sli41: uploaded a new version of "File:Review piechart.png"

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-05T04:31:47Z

Sli41: /* View modification */

File:Review piechart.png

2017-12-05T04:30:23Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-05T04:29:28Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-05T04:26:23Z

Sli41: uploaded a new version of "File:Review piechart.png"

File:Review piechart.png

2017-12-05T04:25:25Z

Sli41:

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T06:05:31Z

Sli41: /* Edge cases */

File:Alert popup.png

2017-12-04T06:04:28Z

Sli41: uploaded a new version of "File:Alert popup.png"

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T06:00:55Z

Sli41: /* Edge cases */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:57:23Z

Sli41: /* Edge cases */

File:Alert popup.png

2017-12-04T05:56:33Z

Sli41: uploaded a new version of "File:Alert popup.png"

File:Alert popup.png

2017-12-04T05:55:57Z

Sli41:

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:28:35Z

Sli41: /* Project Links */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:22:02Z

Sli41: /* Introduction */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:21:16Z

Sli41: /* Introduction */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:14:09Z

Sli41: /* Problem Description */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:13:23Z

Sli41: /* Introduction */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:10:38Z

Sli41: /* Edge cases */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T05:05:27Z

Sli41: /* Related Files */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T04:51:09Z

Sli41: /* Related Files */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-12-04T00:58:41Z

Sli41: /* Project Links */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-15T23:17:31Z

Sli41: /* Rspec Test */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-15T23:04:47Z

Sli41: /* View modification */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-15T23:03:37Z

Sli41: /* Edge cases */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-15T23:03:24Z

Sli41: /* View modification */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-15T22:53:13Z

Sli41: update edge cases

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-15T22:47:40Z

Sli41: /* Time tracking mechanism */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-10T06:55:20Z

Sli41: add Team

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-07T00:43:29Z

Sli41: /* Problem Description */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-07T00:40:16Z

Sli41: /* Problem Description */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-07T00:38:18Z

Sli41: /* Introduction */

CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement

2017-11-07T00:22:42Z

Sli41: set up project wiki page

== Introduction ==

== Task List ==

== Test Plan ==

== Related Files ==

== Project Links ==

== References ==

CSC/ECE 517 Fall 2017

2017-11-07T00:16:35Z

Sli41: add new final project design document

'''Design Project Documentation'''
*[[CSC/ECE 517 Fall 2017/E17A2 Lightweight Badging System]]
*[[CSC/ECE 517 Fall 2017/E17A8. Use a profiler to identify the problems / pages that take some time to load & fix them]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join]]
*[[CSC/ECE 517 Fall 2017/E17A4 Allow calibration to be part of an assignment]]
*[[CSC/ECE 517 Fall 2017/E17A0 Team-based reviewing]]
*[[CSC/ECE 517 Fall 2017/E1793. Help students find teams to join_Team1964]]
*[[CSC/ECE 517 Fall 2017/E1791. Track the time that students look at the other submissions - logging improvement]]
*[[CSC/ECE 517 Fall 2017/E1799 Improve self-review Link peer review & self-review to derive grades]]
*[[CSC/ECE_517_Fall_2017/E1797_Timestamps_for_students_submissions]]
*[[CSC/ECE_517_Fall_2017/E17A1|CSC/ECE_517_Fall_2017/E17A1 - Let experts as well as students do reviews]]
'''Writing Assignment 2'''
*[[CSC/ECE 517 Fall 2017/E1779. Fix teammate advertisements and requests to join a team]]
*[[CSC/ECE_517_Fall_2017/E1773 Investigate and Fix Expertiza Production Version Runtime Exceptions.rb]]
*[[CSC/ECE_517_Fall_2017/E1774 Metareview fixes and improvements.rb]]
*[[CSC/ECE_517_Fall_2017/E1788 OSS project Maroon Heatmap fixes]]
*[[CSC/ECE 517 Fall 2017/E1781 Topic Management]]
*[[CSC/ECE_517_Fall_2017/E1745_Refactor_response_controller.rb]]
*[[CSC/ECE_517_Fall_2017/E1752 Refactor assignments controller]]
*[[CSC/ECE_517_Fall_2017/E1776_Enhance_Imports]]
*[[CSC/ECE_517_Fall_2017/E1756 TLD Refactor response.rb]]
*[[CSC/ECE_517_Fall_2017/E1772_Refactor reputation_web_service_controller.rb]]
*[[CSC/ECE_517_Fall_2017/M1754_Mutation Testing on Servo]]
*[[CSC/ECE_517_Fall_2017/E1753 OSS project bidding tests]]
*[[CSC/ECE_517_Fall_2017/E1766_Test team functionality]]
*[[CSC/ECE 517 Fall 2017/E1767 Improve imports]]
*[[CSC/ECE_517_Fall_2017/E1786_OSS project Juniper Bookmark Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1787_OSS project Bronze Score calculations]]
*[[CSC/ECE_517_Fall_2017/E1763 Fix Staggered-Deadline Assignments]]
*[[CSC/ECE 517 Fall 2017/E1757 Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2017/E1769_Refactor assignment_form.rb]]
*[[CSC/ECE 517 Fall 2017/E1754_Feature_test_of_rubric_advice]]
*[[CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories]]
*[[CSC/ECE 517 Fall 2017/E1748 Add past-due assignments to task list]]
*[[CSC/ECE 517 Fall 2017/E1761 Test First Development Refactor assignment.rb]]
*[[CSC/ECE_517_Fall_2017/E1780_OSS_Project_Teal_Email_Notification_Enhancements]]
*[[CSC/ECE_517_Fall_2017/E1762 Test various kinds of response-map hierarchies]]
*[[CSC/ECE_517_Fall_2017/E1759 ]]
*[[CSC/ECE_517_Fall_2017/E1749_Test First Development Refactor questionnaire_controller.rb]]
*[[CSC/ECE 517 Fall 2017/E1777 Coherent specification of review requirements.rb]]
*[[CSC/ECE 517 Fall 2017/E1771_Refactor_team.rb]]

CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller

2017-10-30T00:52:04Z

Sli41: change names of methods in edit and update

==Introduction==
Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.

==About Assignments Controller==
The file assignments_controller.rb handles the logic behind Expertiza assignments and enables the creation and managements of assignments by instructional staff. Besides regular CRUD operations, it also integrates multiple parts of the expertiza components, such as users of different authorizations and priorities, corresponding courses associated with the assignment, due date and so on. Therefore, further unit and integration tests are required to guarantee that these operations work as expected. And also refactoring on the code in this controller is needed to make it more readable and reduce the complexity at the same time. Our tasks are based on the motivations above.

==About Software Testing==
Software testing is a process of examining a program or application with the intent of finding the software bugs. In software developemnt, it is usually defined as the process of validating and verifying that a software program or application or product meets the specified business and technical requirements.

Additionaly, software is tested to:
* Detect and rectify and errors made during the development phase,
* Ensure customer satisfaction in the application,
* Ensure the quality of the software product and
* Optimize the performance of the system.

Our project is guided by the Test-First Development principle. We write passing and failing tests for use cases of the assignment controller, and then turn to refactor the code. During the project, we implement the tests and refactor in Agile methodology with our mentor Zhewei through weekly delivery.

===RSpec Testing===
RSpec is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring.

The Expertiza project makes extensive use of RSpec to test the various components of the application. Tests of our tasks are in the code file: spec/controllers/assignments_controller_spec.rb

===Testing actions perfomed===
* Creating new tests for each method,
* Testing the each method and making sure the tests pass.

===Testing results===
All 22 tests were passed with zero failure on the final version of project code.

==About Refactoring==
Refactoring of computer software or code is the process of restructuring existing software code without changing its external behavior or performance of the software application. Refactoring improves nonfunctional attributes of the software. Refactoring aids in code readability and keeps the code well maintained and easy to understand.

===Refactoring actions perfomed===
* Replace magic numbers in deadline_type_id by constants with reasonable names;
* Formatting the code for readability and convention;
* Split large chunks of code in to smaller manageable chunks;
* Extract simpler and specific methods out of blocks of codes to remove code duplications using DRY principle;
* Rename existing methods with meaningful names for better readability without change on external functionality.

===Refactor edit method===
Actions: code block split, method extraction and add meaningful constants

Original
<pre>
def edit
# give an error message is instructor have not set the time zone.
if current_user.timezonepref.nil?
flash.now[:error] = "You have not specified your preferred timezone yet. Please do this before you set up the deadlines."
end
@topics = SignUpTopic.where(assignment_id: params[:id])
@assignment_form = AssignmentForm.create_form_object(params[:id])
@user = current_user

@assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: params[:id])
@due_date_all = AssignmentDueDate.where(parent_id: params[:id])
@reviewvarycheck = false
@due_date_nameurl_notempty = false
@due_date_nameurl_notempty_checkbox = false
@metareview_allowed = false
@metareview_allowed_checkbox = false
@signup_allowed = false
@signup_allowed_checkbox = false
@drop_topic_allowed = false
@drop_topic_allowed_checkbox = false
@team_formation_allowed = false
@team_formation_allowed_checkbox = false
@participants_count = @assignment_form.assignment.participants.size
@teams_count = @assignment_form.assignment.teams.size

if @assignment_form.assignment.staggered_deadline == true
@review_rounds = @assignment_form.assignment.num_review_rounds
@assignment_submission_due_dates = @due_date_all.select {|due_date| due_date.deadline_type_id == 1 }
@assignment_review_due_dates = @due_date_all.select {|due_date| due_date.deadline_type_id == 2 }
end

# Check if name and url in database is empty before webpage displays
@due_date_all.each do |dd|
@due_date_nameurl_notempty = is_due_date_nameurl_notempty(dd)
@due_date_nameurl_notempty_checkbox = @due_date_nameurl_notempty
@metareview_allowed = is_meta_review_allowed?(dd)
@drop_topic_allowed = is_drop_topic_allowed?(dd)
@signup_allowed = is_signup_allowed?(dd)
@team_formation_allowed = is_team_formation_allowed?(dd)

if dd.due_at.present?
dd.due_at = dd.due_at.to_s.in_time_zone(current_user.timezonepref)
end
if @due_date_nameurl_notempty && @due_date_nameurl_notempty_checkbox &&
(@metareview_allowed || @drop_topic_allowed || @signup_allowed || @team_formation_allowed)
break
end
end

@assignment_questionnaires.each do |aq|
unless aq.used_in_round.nil?
@reviewvarycheck = 1
break
end
end
@due_date_all = update_nil_dd_deadline_name(@due_date_all)
@due_date_all = update_nil_dd_description_url(@due_date_all)

# only when instructor does not assign rubrics and in assignment edit page will show this error message.
if !empty_rubrics_list.empty? && request.original_fullpath == "/assignments/#{@assignment_form.assignment.id}/edit"
rubrics_needed = needed_rubrics(empty_rubrics_list)
flash.now[:error] = "You did not specify all the necessary rubrics. You need " + rubrics_needed +
" of assignment #{@assignment_form.assignment.name} before saving the assignment. You can assign rubrics <a id='go_to_tabs2' style='color: blue;'>here</a>."
end

if @assignment_form.assignment.directory_path.nil? || @assignment_form.assignment.directory_path.empty?
flash.now[:error] = "You did not specify your submission directory."
end
end
</pre>

After refactoring
<pre>
def edit
handle_current_user_timezonepref_nil

edit_params_setting

assignment_form_assignment_staggered_deadline?

@due_date_all.each do |dd|
check_due_date_nameurl_notempty(dd)

adjust_timezone_when_due_date_present(dd)

break if validate_due_date
end

check_assignment_questionnaires_usage

@due_date_all = update_nil_dd_deadline_name(@due_date_all)
@due_date_all = update_nil_dd_description_url(@due_date_all)

# only when instructor does not assign rubrics and in assignment edit page will show this error message.
handle_rubrics_not_assigned_case

handle_assignment_directory_path_nonexist_case
end
</pre>
Here we first grouped the blocks of code according to their similarity of functions. Then we extracted simpler methods from each code block to make it more readable and reduce the complexity and coupling. It is obvious that after refactoring, this part is simpler and easier to maintain. In addition, we also replaced the magic numbers by constants according to the deadline type.

===Refactor update method===
Actions: split long code block and extract specific methods

Original
<pre>
def update
unless params.key?(:assignment_form)
@assignment = Assignment.find(params[:id])
@assignment.course_id = params[:course_id]
if @assignment.save
flash[:note] = 'The assignment was successfully saved.'
redirect_to list_tree_display_index_path
else
flash[:error] = "Failed to save the assignment: #{@assignment.errors.full_messages.join(' ')}"
redirect_to edit_assignment_path @assignment.id
end
return
end

@assignment_form = AssignmentForm.create_form_object(params[:id])
@assignment_form.assignment.instructor ||= current_user
params[:assignment_form][:assignment_questionnaire].reject! do |q|
q[:questionnaire_id].empty?
end

if current_user.timezonepref.nil?
parent_id = current_user.parent_id
parent_timezone = User.find(parent_id).timezonepref
flash[:error] = "We strongly suggest that instructors specify their preferred timezone to guarantee the correct display time. For now we assume you are in " + parent_timezone
current_user.timezonepref = parent_timezone
end
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.errors.get(:message)}"
end
redirect_to edit_assignment_path @assignment_form.assignment.id
end
</pre>

After refactoring
<pre>
def update
unless params.key?(:assignment_form)
assignment_form_key_nonexist_case_handler
return
end

retrieve_assignment_form

handle_current_user_timezonepref_nil

feedback_assignment_form_attributes_update

redirect_to edit_assignment_path @assignment_form.assignment.id
end
</pre>
The update method was refactored in the similar way to reduce the size of codes and improve readability. The definitions of those helper methods were placed at the bottom of the assignments_controller.rb.

===Rename existing helper methods===
Actions: rename for consistent Ruby code style

<pre>
is_due_date_nameurl_notempty → due_date_nameurl_notempty?
is_meta_review_allowed? → meta_review_allowed?
is_drop_topic_allowed? → drop_topic_allowed?
is_signup_allowed? → signup_allowed?
is_team_formation_allowed? → team_formation_allowed?
</pre>

After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec. For more cases, please check our GitHub project repo. The files we make change on are: app/controllers/assignments_controller.rb and app/helpers/deadline_helper.rb

==Additional Links==
[https://github.com/jerry-shijieli/expertiza Github project repo] 
[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]

==References==
[http://rspec.info/documentation/ Rspec Documentation] 
[http://www.betterspecs.org/ Better Specs] 
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Welcome_to_the_Expertiza_project.21 Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza NCSU]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:adeshmu@ncsu.edu Amey Deshmukh] 
[mailto:pmusyok@ncsu.edu Philip Musyoki]

CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller

2017-10-28T02:39:28Z

Sli41: reorganize section title

==Introduction==
Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.

==About Assignments Controller==
The file assignments_controller.rb handles the logic behind Expertiza assignments and enables the creation and managements of assignments by instructional staff. Besides regular CRUD operations, it also integrates multiple parts of the expertiza components, such as users of different authorizations and priorities, corresponding courses associated with the assignment, due date and so on. Therefore, further unit and integration tests are required to guarantee that these operations work as expected. And also refactoring on the code in this controller is needed to make it more readable and reduce the complexity at the same time. Our tasks are based on the motivations above.

==About Software Testing==
Software testing is a process of examining a program or application with the intent of finding the software bugs. In software developemnt, it is usually defined as the process of validating and verifying that a software program or application or product meets the specified business and technical requirements.

Additionaly, software is tested to:
* Detect and rectify and errors made during the development phase,
* Ensure customer satisfaction in the application,
* Ensure the quality of the software product and
* Optimize the performance of the system.

Our project is guided by the Test-First Development principle. We write passing and failing tests for use cases of the assignment controller, and then turn to refactor the code. During the project, we implement the tests and refactor in Agile methodology with our mentor Zhewei through weekly delivery.

===RSpec Testing===
RSpec is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring.

The Expertiza project makes extensive use of RSpec to test the various components of the application. Tests of our tasks are in the code file: spec/controllers/assignments_controller_spec.rb

===Testing actions perfomed===
* Creating new tests for each method,
* Testing the each method and making sure the tests pass.

===Testing results===
All 22 tests were passed with zero failure on the final version of project code.

==About Refactoring==
Refactoring of computer software or code is the process of restructuring existing software code without changing its external behavior or performance of the software application. Refactoring improves nonfunctional attributes of the software. Refactoring aids in code readability and keeps the code well maintained and easy to understand.

===Refactoring actions perfomed===
* Replace magic numbers in deadline_type_id by constants with reasonable names;
* Formatting the code for readability and convention;
* Split large chunks of code in to smaller manageable chunks;
* Extract simpler and specific methods out of blocks of codes to remove code duplications using DRY principle;
* Rename existing methods with meaningful names for better readability without change on external functionality.

===Refactor edit method===
Actions: code block split, method extraction and add meaningful constants

Original
<pre>
def edit
# give an error message is instructor have not set the time zone.
if current_user.timezonepref.nil?
flash.now[:error] = "You have not specified your preferred timezone yet. Please do this before you set up the deadlines."
end
@topics = SignUpTopic.where(assignment_id: params[:id])
@assignment_form = AssignmentForm.create_form_object(params[:id])
@user = current_user

@assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: params[:id])
@due_date_all = AssignmentDueDate.where(parent_id: params[:id])
@reviewvarycheck = false
@due_date_nameurl_notempty = false
@due_date_nameurl_notempty_checkbox = false
@metareview_allowed = false
@metareview_allowed_checkbox = false
@signup_allowed = false
@signup_allowed_checkbox = false
@drop_topic_allowed = false
@drop_topic_allowed_checkbox = false
@team_formation_allowed = false
@team_formation_allowed_checkbox = false
@participants_count = @assignment_form.assignment.participants.size
@teams_count = @assignment_form.assignment.teams.size

if @assignment_form.assignment.staggered_deadline == true
@review_rounds = @assignment_form.assignment.num_review_rounds
@assignment_submission_due_dates = @due_date_all.select {|due_date| due_date.deadline_type_id == 1 }
@assignment_review_due_dates = @due_date_all.select {|due_date| due_date.deadline_type_id == 2 }
end

# Check if name and url in database is empty before webpage displays
@due_date_all.each do |dd|
@due_date_nameurl_notempty = is_due_date_nameurl_notempty(dd)
@due_date_nameurl_notempty_checkbox = @due_date_nameurl_notempty
@metareview_allowed = is_meta_review_allowed?(dd)
@drop_topic_allowed = is_drop_topic_allowed?(dd)
@signup_allowed = is_signup_allowed?(dd)
@team_formation_allowed = is_team_formation_allowed?(dd)

if dd.due_at.present?
dd.due_at = dd.due_at.to_s.in_time_zone(current_user.timezonepref)
end
if @due_date_nameurl_notempty && @due_date_nameurl_notempty_checkbox &&
(@metareview_allowed || @drop_topic_allowed || @signup_allowed || @team_formation_allowed)
break
end
end

@assignment_questionnaires.each do |aq|
unless aq.used_in_round.nil?
@reviewvarycheck = 1
break
end
end
@due_date_all = update_nil_dd_deadline_name(@due_date_all)
@due_date_all = update_nil_dd_description_url(@due_date_all)

# only when instructor does not assign rubrics and in assignment edit page will show this error message.
if !empty_rubrics_list.empty? && request.original_fullpath == "/assignments/#{@assignment_form.assignment.id}/edit"
rubrics_needed = needed_rubrics(empty_rubrics_list)
flash.now[:error] = "You did not specify all the necessary rubrics. You need " + rubrics_needed +
" of assignment #{@assignment_form.assignment.name} before saving the assignment. You can assign rubrics <a id='go_to_tabs2' style='color: blue;'>here</a>."
end

if @assignment_form.assignment.directory_path.nil? || @assignment_form.assignment.directory_path.empty?
flash.now[:error] = "You did not specify your submission directory."
end
end
</pre>

After refactoring
<pre>
def edit
current_user_timezonepref_nil_message

edit_params_setting

assignment_form_assignment_staggered_deadline?

@due_date_all.each do |dd|
due_date_nameurl_notempty_check(dd)

due_date_present(dd)

break if due_date_validation
end

assignment_questionnaires_usage_check

@due_date_all = update_nil_dd_deadline_name(@due_date_all)
@due_date_all = update_nil_dd_description_url(@due_date_all)

# only when instructor does not assign rubrics and in assignment edit page will show this error message.
rubrics_not_assigned_message

assignment_directory_path_nonexist_message
end
</pre>
Here we first grouped the blocks of code according to their similarity of functions. Then we extracted simpler methods from each code block to make it more readable and reduce the complexity and coupling. It is obvious that after refactoring, this part is simpler and easier to maintain. In addition, we also replaced the magic numbers by constants according to the deadline type.

===Refactor update method===
Actions: split long code block and extract specific methods

Original
<pre>
def update
unless params.key?(:assignment_form)
@assignment = Assignment.find(params[:id])
@assignment.course_id = params[:course_id]
if @assignment.save
flash[:note] = 'The assignment was successfully saved.'
redirect_to list_tree_display_index_path
else
flash[:error] = "Failed to save the assignment: #{@assignment.errors.full_messages.join(' ')}"
redirect_to edit_assignment_path @assignment.id
end
return
end

@assignment_form = AssignmentForm.create_form_object(params[:id])
@assignment_form.assignment.instructor ||= current_user
params[:assignment_form][:assignment_questionnaire].reject! do |q|
q[:questionnaire_id].empty?
end

if current_user.timezonepref.nil?
parent_id = current_user.parent_id
parent_timezone = User.find(parent_id).timezonepref
flash[:error] = "We strongly suggest that instructors specify their preferred timezone to guarantee the correct display time. For now we assume you are in " + parent_timezone
current_user.timezonepref = parent_timezone
end
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.errors.get(:message)}"
end
redirect_to edit_assignment_path @assignment_form.assignment.id
end
</pre>

After refactoring
<pre>
def update
unless params.key?(:assignment_form)
assignment_form_key_nonexist_case_handler
return
end

assignment_form_retrieval

current_user_timezonepref_nil_handler

assignment_form_update_attributes_message

redirect_to edit_assignment_path @assignment_form.assignment.id
end
</pre>
The update method was refactored in the similar way to reduce the size of codes and improve readability. The definitions of those helper methods were placed at the bottom of the assignments_controller.rb.

===Rename existing helper methods===
Actions: rename for consistent Ruby code style

<pre>
is_due_date_nameurl_notempty → due_date_nameurl_notempty?
is_meta_review_allowed? → meta_review_allowed?
is_drop_topic_allowed? → drop_topic_allowed?
is_signup_allowed? → signup_allowed?
is_team_formation_allowed? → team_formation_allowed?
</pre>

After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec. For more cases, please check our GitHub project repo. The files we make change on are: app/controllers/assignments_controller.rb and app/helpers/deadline_helper.rb

==Additional Links==
[https://github.com/jerry-shijieli/expertiza Github project repo] 
[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]

==References==
[http://rspec.info/documentation/ Rspec Documentation] 
[http://www.betterspecs.org/ Better Specs] 
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Welcome_to_the_Expertiza_project.21 Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza NCSU]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:adeshmu@ncsu.edu Amey Deshmukh] 
[mailto:pmusyok@ncsu.edu Philip Musyoki]

CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller

2017-10-28T02:31:31Z

Sli41: add details about edit, update refactoring and helper method renaming

==Introduction==
Expertiza is an open source webapp built on Ruby on Rails stack. It provides a platform to students with various features like peer-reviewing projects, submitting work, form teams, viewing grades etc. The project is being built and maintained by students and faculty at NCSU.

==About Assignments Controller==
The file assignments_controller.rb handles the logic behind Expertiza assignments and enables the creation and managements of assignments by instructional staff. Besides regular CRUD operations, it also integrates multiple parts of the expertiza components, such as users of different authorizations and priorities, corresponding courses associated with the assignment, due date and so on. Therefore, further unit and integration tests are required to guarantee that these operations work as expected. And also refactoring on the code in this controller is needed to make it more readable and reduce the complexity at the same time. Our tasks are based on the motivations above.

==About Software Testing==
Software testing is a process of examining a program or application with the intent of finding the software bugs. In software developemnt, it is usually defined as the process of validating and verifying that a software program or application or product meets the specified business and technical requirements.

Additionaly, software is tested to:
* Detect and rectify and errors made during the development phase,
* Ensure customer satisfaction in the application,
* Ensure the quality of the software product and
* Optimize the performance of the system.

Our project is guided by the Test-First Development principle. We write passing and failing tests for use cases of the assignment controller, and then turn to refactor the code. During the project, we implement the tests and refactor in Agile methodology with our mentor Zhewei through weekly delivery.

===RSpec Testing===
RSpec is a 'Domain Specific Language' (DSL) testing tool written in Ruby to test Ruby code. It is a behavior-driven development (BDD) framework which is extensively used in the production applications. The basic idea behind this concept is that of Test Driven Development(TDD) where the tests are written first and the development is based on writing just enough code that will fulfill those tests followed by refactoring.

The Expertiza project makes extensive use of RSpec to test the various components of the application. Tests of our tasks are in the code file: spec/controllers/assignments_controller_spec.rb

===Testing actions perfomed===
* Creating new tests for each method,
* Testing the each method and making sure the tests pass.

==About Refactoring==
Refactoring of computer software or code is the process of restructuring existing software code without changing its external behavior or performance of the software application. Refactoring improves nonfunctional attributes of the software. Refactoring aids in code readability and keeps the code well maintained and easy to understand.

===Refactoring actions perfomed===
* Replace magic numbers in deadline_type_id by constants with reasonable names;
* Formatting the code for readability and convention;
* Split large chunks of code in to smaller manageable chunks;
* Extract simpler and specific methods out of blocks of codes to remove code duplications using DRY principle;
* Rename existing methods with meaningful names for better readability without change on external functionality.

====Refactor edit method: code block split, method extraction and new constants====

Original
<pre>
def edit
# give an error message is instructor have not set the time zone.
if current_user.timezonepref.nil?
flash.now[:error] = "You have not specified your preferred timezone yet. Please do this before you set up the deadlines."
end
@topics = SignUpTopic.where(assignment_id: params[:id])
@assignment_form = AssignmentForm.create_form_object(params[:id])
@user = current_user

@assignment_questionnaires = AssignmentQuestionnaire.where(assignment_id: params[:id])
@due_date_all = AssignmentDueDate.where(parent_id: params[:id])
@reviewvarycheck = false
@due_date_nameurl_notempty = false
@due_date_nameurl_notempty_checkbox = false
@metareview_allowed = false
@metareview_allowed_checkbox = false
@signup_allowed = false
@signup_allowed_checkbox = false
@drop_topic_allowed = false
@drop_topic_allowed_checkbox = false
@team_formation_allowed = false
@team_formation_allowed_checkbox = false
@participants_count = @assignment_form.assignment.participants.size
@teams_count = @assignment_form.assignment.teams.size

if @assignment_form.assignment.staggered_deadline == true
@review_rounds = @assignment_form.assignment.num_review_rounds
@assignment_submission_due_dates = @due_date_all.select {|due_date| due_date.deadline_type_id == 1 }
@assignment_review_due_dates = @due_date_all.select {|due_date| due_date.deadline_type_id == 2 }
end

# Check if name and url in database is empty before webpage displays
@due_date_all.each do |dd|
@due_date_nameurl_notempty = is_due_date_nameurl_notempty(dd)
@due_date_nameurl_notempty_checkbox = @due_date_nameurl_notempty
@metareview_allowed = is_meta_review_allowed?(dd)
@drop_topic_allowed = is_drop_topic_allowed?(dd)
@signup_allowed = is_signup_allowed?(dd)
@team_formation_allowed = is_team_formation_allowed?(dd)

if dd.due_at.present?
dd.due_at = dd.due_at.to_s.in_time_zone(current_user.timezonepref)
end
if @due_date_nameurl_notempty && @due_date_nameurl_notempty_checkbox &&
(@metareview_allowed || @drop_topic_allowed || @signup_allowed || @team_formation_allowed)
break
end
end

@assignment_questionnaires.each do |aq|
unless aq.used_in_round.nil?
@reviewvarycheck = 1
break
end
end
@due_date_all = update_nil_dd_deadline_name(@due_date_all)
@due_date_all = update_nil_dd_description_url(@due_date_all)

# only when instructor does not assign rubrics and in assignment edit page will show this error message.
if !empty_rubrics_list.empty? && request.original_fullpath == "/assignments/#{@assignment_form.assignment.id}/edit"
rubrics_needed = needed_rubrics(empty_rubrics_list)
flash.now[:error] = "You did not specify all the necessary rubrics. You need " + rubrics_needed +
" of assignment #{@assignment_form.assignment.name} before saving the assignment. You can assign rubrics <a id='go_to_tabs2' style='color: blue;'>here</a>."
end

if @assignment_form.assignment.directory_path.nil? || @assignment_form.assignment.directory_path.empty?
flash.now[:error] = "You did not specify your submission directory."
end
end
</pre>

After refactoring
<pre>
def edit
current_user_timezonepref_nil_message

edit_params_setting

assignment_form_assignment_staggered_deadline?

@due_date_all.each do |dd|
due_date_nameurl_notempty_check(dd)

due_date_present(dd)

break if due_date_validation
end

assignment_questionnaires_usage_check

@due_date_all = update_nil_dd_deadline_name(@due_date_all)
@due_date_all = update_nil_dd_description_url(@due_date_all)

# only when instructor does not assign rubrics and in assignment edit page will show this error message.
rubrics_not_assigned_message

assignment_directory_path_nonexist_message
end
</pre>
Here we first grouped the blocks of code according to their similarity of functions. Then we extracted simpler methods from each code block to make it more readable and reduce the complexity and coupling. It is obvious that after refactoring, this part is simpler and easier to maintain. In addition, we also replaced the magic numbers by constants according to the deadline type.

====Refactor update method: split long code block and extract specific methods====

Original
<pre>
def update
unless params.key?(:assignment_form)
@assignment = Assignment.find(params[:id])
@assignment.course_id = params[:course_id]
if @assignment.save
flash[:note] = 'The assignment was successfully saved.'
redirect_to list_tree_display_index_path
else
flash[:error] = "Failed to save the assignment: #{@assignment.errors.full_messages.join(' ')}"
redirect_to edit_assignment_path @assignment.id
end
return
end

@assignment_form = AssignmentForm.create_form_object(params[:id])
@assignment_form.assignment.instructor ||= current_user
params[:assignment_form][:assignment_questionnaire].reject! do |q|
q[:questionnaire_id].empty?
end

if current_user.timezonepref.nil?
parent_id = current_user.parent_id
parent_timezone = User.find(parent_id).timezonepref
flash[:error] = "We strongly suggest that instructors specify their preferred timezone to guarantee the correct display time. For now we assume you are in " + parent_timezone
current_user.timezonepref = parent_timezone
end
if @assignment_form.update_attributes(assignment_form_params, current_user)
flash[:note] = 'The assignment was successfully saved....'
else
flash[:error] = "Failed to save the assignment: #{@assignment_form.errors.get(:message)}"
end
redirect_to edit_assignment_path @assignment_form.assignment.id
end
</pre>

After refactoring
<pre>
def update
unless params.key?(:assignment_form)
assignment_form_key_nonexist_case_handler
return
end

assignment_form_retrieval

current_user_timezonepref_nil_handler

assignment_form_update_attributes_message

redirect_to edit_assignment_path @assignment_form.assignment.id
end
</pre>
The update method was refactored in the similar way to reduce the size of codes and improve readability. The definitions of those helper methods were placed at the bottom of the assignments_controller.rb.

====Rename existing helper methods: consistent with Ruby code style====
<pre>
is_due_date_nameurl_notempty → due_date_nameurl_notempty?
is_meta_review_allowed? → meta_review_allowed?
is_drop_topic_allowed? → drop_topic_allowed?
is_signup_allowed? → signup_allowed?
is_team_formation_allowed? → team_formation_allowed?
</pre>

After each refactoring procedure, we perform the testing to ensure the expected functionality in Rspec. For more cases, please check our GitHub project repo. The files we make change on are: app/controllers/assignments_controller.rb and app/helpers/deadline_helper.rb

==Additional Links==
[https://github.com/jerry-shijieli/expertiza Github project repo] 
[https://www.youtube.com/playlist?list=PLUHiK0P0uQKLvW-_hBDdRK3x4cFn6BJ4C Project Video Demo]

==References==
[http://rspec.info/documentation/ Rspec Documentation] 
[http://www.betterspecs.org/ Better Specs] 
[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation#Welcome_to_the_Expertiza_project.21 Expertiza Wiki] 
[https://expertiza.ncsu.edu/ Expertiza NCSU]

==Team==
[mailto:sli41@ncsu.edu Shijie Li] 
[mailto:adeshmu@ncsu.edu Amey Deshmukh] 
[mailto:pmusyok@ncsu.edu Philip Musyoki]

CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller

2017-10-28T01:17:24Z

Sli41: add constant part

CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller

2017-10-28T00:05:43Z

Sli41: update refactor

CSC/ECE 517 Fall 2017/E1752 Refactor assignments controller

2017-10-28T00:04:21Z

Sli41: add example to refactoring