Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2019/E1927 Let Course Staff as Well as Students Do Reviews

2019-04-11T05:52:06Z

Jwboykin: /* References */

='''Problem Summary'''=
In Expertiza, students are able to perform reviews on other students work by filling out a review form on Expertiza. Instructors and TAs for the course should be able to submit a review in the same manner as a student. Only instructors or TAs who are participants in the assignment should be allowed to leave reviews. However, the instructor and TA reviews should be distinguished from other student reviews so the student knows the review was written by the instructor.

='''Project Tasks'''=

==Task 1:==
'''Problem:'''

Each submission on the submissions page should link to "perform review" instead of "assign grade" iff [the instructor/ta is a participant of the assignment and the last due date for the assignment has not passed]

'''Solution:'''
list_submissions_html.erb should be modified to change the link as noted above. TBD if controller changes in assignment_controler are needed to get due date information and participant information to the view.

==Task 2:==
'''Problem:'''

Review page should allow instructor/TA to submit review if they are a participant of the assignment and the last due date hasn't passed

'''Solution:'''

Check response.html.erb to make sure there aren't any restrictions preventing instructor/ta from submitting reviews if they meet the criteria above. Existing logic may assume all reviewers are student. TBD if any modifications to response_controller is necessary to enable this functionality.

==Task 3:==
'''Problem:'''

An instructor icon should be used to indicate an instructor review and this icon should be seen on the review page read by the student.

'''Solution:'''

Modify response.html.erb to distinguish reviews done by the instructor. TBD if the response controller needs modification to deliver this information to the view. Modify the add-ta-128.png icon file to look more like an instructor and add it to the view next to the reviews done by the instructor.

[[File:E1927_Add-ta-128.png|alt=Add a TA]]

==Task 4: (OPTIONAL)==
'''Problem:'''

Similar to the calibration report from the Design Exercise assignment, create a view that would allow the student reviewers differ from the reviews completed by the course staff.

'''Solution:'''
Review the code from the Design Exercise calibration assignment. Discuss ideas with the professor (as advised from previous mentor meetings) to form a plan on how to address this task.
From the assignment page student_task/view.html.erb add a new link reviewers to the calibration report _calibration_report.html.erb IF they have submitted a review and the instructor has submitted a review to the same assignment.

='''Test Plan'''=
The following shall be tested:

For a given assignment, If instructor/ta is a participant and the last due date is not past then the submission list should link to "perform review"

For a given assignment, If instructor/ta is a participant and the last due date is past then the submission list should link to "assign grade"

For a given assignment, If instructor/ta is not a participant and the last due date is past then the submission list should link to "assign grade"

For a given assignment, If instructor/ta is not a participant and the last due date is not past then the submission list should link to "assign grade"

A review submitted by an instructor/ta should be accepted like any other review so long as they are a participant and the last submission due date has not passed

Optional: Test optional functionality

='''References'''=
1. Project Document: https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.bumi2mscmmgf

2. Github Repo: https://github.com/mblewallncsu/expertiza

3. Previous Work, Project E1824: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1824:_Let_course_staff_as_well_as_students_do_reviews

4. Previous Work, Project E1855: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1855_let_course_staff_as_well_as_students_do_reviews

5. Projected hosted at: http://final.flazzle.com

='''Team Members'''=

1. Jimmy Boykin

2. Srikara Krishna

3. Michael Lewallen

CSC/ECE 517 Spring 2019/E1927 Let Course Staff as Well as Students Do Reviews

2019-04-11T05:51:13Z

Jwboykin: /* Test Plan */

='''Problem Summary'''=
In Expertiza, students are able to perform reviews on other students work by filling out a review form on Expertiza. Instructors and TAs for the course should be able to submit a review in the same manner as a student. Only instructors or TAs who are participants in the assignment should be allowed to leave reviews. However, the instructor and TA reviews should be distinguished from other student reviews so the student knows the review was written by the instructor.

='''Project Tasks'''=

==Task 1:==
'''Problem:'''

Each submission on the submissions page should link to "perform review" instead of "assign grade" iff [the instructor/ta is a participant of the assignment and the last due date for the assignment has not passed]

'''Solution:'''
list_submissions_html.erb should be modified to change the link as noted above. TBD if controller changes in assignment_controler are needed to get due date information and participant information to the view.

==Task 2:==
'''Problem:'''

Review page should allow instructor/TA to submit review if they are a participant of the assignment and the last due date hasn't passed

'''Solution:'''

Check response.html.erb to make sure there aren't any restrictions preventing instructor/ta from submitting reviews if they meet the criteria above. Existing logic may assume all reviewers are student. TBD if any modifications to response_controller is necessary to enable this functionality.

==Task 3:==
'''Problem:'''

An instructor icon should be used to indicate an instructor review and this icon should be seen on the review page read by the student.

'''Solution:'''

Modify response.html.erb to distinguish reviews done by the instructor. TBD if the response controller needs modification to deliver this information to the view. Modify the add-ta-128.png icon file to look more like an instructor and add it to the view next to the reviews done by the instructor.

[[File:E1927_Add-ta-128.png|alt=Add a TA]]

==Task 4: (OPTIONAL)==
'''Problem:'''

Similar to the calibration report from the Design Exercise assignment, create a view that would allow the student reviewers differ from the reviews completed by the course staff.

'''Solution:'''
Review the code from the Design Exercise calibration assignment. Discuss ideas with the professor (as advised from previous mentor meetings) to form a plan on how to address this task.
From the assignment page student_task/view.html.erb add a new link reviewers to the calibration report _calibration_report.html.erb IF they have submitted a review and the instructor has submitted a review to the same assignment.

='''Test Plan'''=
The following shall be tested:

For a given assignment, If instructor/ta is a participant and the last due date is not past then the submission list should link to "perform review"

For a given assignment, If instructor/ta is a participant and the last due date is past then the submission list should link to "assign grade"

For a given assignment, If instructor/ta is not a participant and the last due date is past then the submission list should link to "assign grade"

For a given assignment, If instructor/ta is not a participant and the last due date is not past then the submission list should link to "assign grade"

A review submitted by an instructor/ta should be accepted like any other review so long as they are a participant and the last submission due date has not passed

Optional: Test optional functionality

='''References'''=
1. Project Document: https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.bumi2mscmmgf

2. Github Repo: https://github.com/mblewallncsu/expertiza

3. Previous Work, Project E1824: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1824:_Let_course_staff_as_well_as_students_do_reviews

4. Previous Work, Project E1855: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1855_let_course_staff_as_well_as_students_do_reviews

='''Team Members'''=

1. Jimmy Boykin

2. Srikara Krishna

3. Michael Lewallen

CSC/ECE 517 Spring 2019/E1927 Let Course Staff as Well as Students Do Reviews

2019-04-11T05:45:58Z

Jwboykin: /* Project Tasks */

='''Problem Summary'''=
In Expertiza, students are able to perform reviews on other students work by filling out a review form on Expertiza. Instructors and TAs for the course should be able to submit a review in the same manner as a student. Only instructors or TAs who are participants in the assignment should be allowed to leave reviews. However, the instructor and TA reviews should be distinguished from other student reviews so the student knows the review was written by the instructor.

='''Project Tasks'''=

==Task 1:==
'''Problem:'''

Each submission on the submissions page should link to "perform review" instead of "assign grade" iff [the instructor/ta is a participant of the assignment and the last due date for the assignment has not passed]

'''Solution:'''
list_submissions_html.erb should be modified to change the link as noted above. TBD if controller changes in assignment_controler are needed to get due date information and participant information to the view.

==Task 2:==
'''Problem:'''

Review page should allow instructor/TA to submit review if they are a participant of the assignment and the last due date hasn't passed

'''Solution:'''

Check response.html.erb to make sure there aren't any restrictions preventing instructor/ta from submitting reviews if they meet the criteria above. Existing logic may assume all reviewers are student. TBD if any modifications to response_controller is necessary to enable this functionality.

==Task 3:==
'''Problem:'''

An instructor icon should be used to indicate an instructor review and this icon should be seen on the review page read by the student.

'''Solution:'''

Modify response.html.erb to distinguish reviews done by the instructor. TBD if the response controller needs modification to deliver this information to the view. Modify the add-ta-128.png icon file to look more like an instructor and add it to the view next to the reviews done by the instructor.

[[File:E1927_Add-ta-128.png|alt=Add a TA]]

==Task 4: (OPTIONAL)==
'''Problem:'''

Similar to the calibration report from the Design Exercise assignment, create a view that would allow the student reviewers differ from the reviews completed by the course staff.

'''Solution:'''
Review the code from the Design Exercise calibration assignment. Discuss ideas with the professor (as advised from previous mentor meetings) to form a plan on how to address this task.
From the assignment page student_task/view.html.erb add a new link reviewers to the calibration report _calibration_report.html.erb IF they have submitted a review and the instructor has submitted a review to the same assignment.

='''Test Plan'''=
Write testing methodology (logic) here.

='''References'''=
1. Project Document: https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.bumi2mscmmgf

2. Github Repo: https://github.com/mblewallncsu/expertiza

3. Previous Work, Project E1824: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1824:_Let_course_staff_as_well_as_students_do_reviews

4. Previous Work, Project E1855: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1855_let_course_staff_as_well_as_students_do_reviews

='''Team Members'''=

1. Jimmy Boykin

2. Srikara Krishna

3. Michael Lewallen

CSC/ECE 517 Spring 2019/E1927 Let Course Staff as Well as Students Do Reviews

2019-04-11T05:45:20Z

Jwboykin: /* Project Tasks */

='''Problem Summary'''=
In Expertiza, students are able to perform reviews on other students work by filling out a review form on Expertiza. Instructors and TAs for the course should be able to submit a review in the same manner as a student. Only instructors or TAs who are participants in the assignment should be allowed to leave reviews. However, the instructor and TA reviews should be distinguished from other student reviews so the student knows the review was written by the instructor.

='''Project Tasks'''=

==Task 1:==
'''Problem:'''

Each submission on the submissions page should link to "perform review" instead of "assign grade" iff [the instructor/ta is a participant of the assignment and the last due date for the assignment has not passed]

'''Solution:'''
list_submissions_html.erb should be modified to change the link as noted above. TBD if controller changes in assignment_controler are needed to get due date information and participant information to the view.

==Task 2:==
'''Problem:'''

Review page should allow instructor/TA to submit review if they are a participant of the assignment and the last due date hasn't passed

'''Solution:'''

Check response.html.erb to make sure there aren't any restrictions preventing instructor/ta from submitting reviews if they meet the criteria above. Existing logic may assume all reviewers are student. TBD if any modifications to response_controller is necessary to enable this functionality.

==Task 3:==
'''Problem:'''

An instructor icon should be used to indicate an instructor review and this icon should be seen on the review page read by the student.

'''Solution:'''

Modify response.html.erb to distinguish reviews done by the instructor. TBD if the response controller needs modification to deliver this information to the view. Modify the add-ta-128.png icon file to look more like an instructor and add it to the view next to the reviews done by the instructor.

[[File:E1927_Add-ta-128.png|alt=Add a TA]]

==Task 4:==
'''Problem:'''

Refactor: A "course_staff" column was added to the "response_maps" table. Is it really necessary to have a column named as "course_staff" for reviews?

'''Solution:'''
Remove the column name from the response maps, if it exists.

Find another way of indicating the review is an instructor review.

==Task 5: (OPTIONAL)==
'''Problem:'''

Similar to the calibration report from the Design Exercise assignment, create a view that would allow the student reviewers differ from the reviews completed by the course staff.

'''Solution:'''
Review the code from the Design Exercise calibration assignment. Discuss ideas with the professor (as advised from previous mentor meetings) to form a plan on how to address this task.
From the assignment page student_task/view.html.erb add a new link reviewers to the calibration report _calibration_report.html.erb IF they have submitted a review and the instructor has submitted a review to the same assignment.

='''Test Plan'''=
Write testing methodology (logic) here.

='''References'''=
1. Project Document: https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.bumi2mscmmgf

2. Github Repo: https://github.com/mblewallncsu/expertiza

3. Previous Work, Project E1824: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1824:_Let_course_staff_as_well_as_students_do_reviews

4. Previous Work, Project E1855: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1855_let_course_staff_as_well_as_students_do_reviews

='''Team Members'''=

1. Jimmy Boykin

2. Srikara Krishna

3. Michael Lewallen

CSC/ECE 517 Spring 2019/E1927 Let Course Staff as Well as Students Do Reviews

2019-04-11T05:31:58Z

Jwboykin: /* Project Tasks */

='''Problem Summary'''=
In Expertiza, students are able to perform reviews on other students work by filling out a review form on Expertiza. Instructors and TAs for the course should be able to submit a review in the same manner as a student. Only instructors or TAs who are participants in the assignment should be allowed to leave reviews. However, the instructor and TA reviews should be distinguished from other student reviews so the student knows the review was written by the instructor.

='''Project Tasks'''=

==Task 1:==
'''Problem:'''

Each submission on the submissions page should link to "perform review" instead of "assign grade" iff [the instructor/ta is a participant of the assignment and the last due date for the assignment has not passed]

'''Solution:'''
list_submissions_html.erb should be modified to change the link as noted above. TBD if controller changes in assignment_controler are needed to get due date information and participant information to the view.

==Task 2:==
'''Problem:'''

Review page should allow instructor/TA to submit review if they are a participant of the assignment and the last due date hasn't passed

'''Solution:'''

Check response.html.erb to make sure there aren't any restrictions preventing instructor/ta from submitting reviews if they meet the criteria above. Existing logic may assume all reviewers are student. TBD if any modifications to response_controller is necessary to enable this functionality.

==Task 3:==
'''Problem:'''

An instructor icon should be used to indicate an instructor review and this icon should be seen on the review page read by the student.

'''Solution:'''

Modify the add-ta-128.png icon file to look more like an instructor and add it to the view.

[[File:E1927_Add-ta-128.png|alt=Add a TA]]

==Task 4:==
'''Problem:'''

Refactor: A "course_staff" column was added to the "response_maps" table. Is it really necessary to have a column named as "course_staff" for reviews?

'''Solution:'''
Remove the column name from the response maps, if it exists.

Find another way of indicating the review is an instructor review.

==Task 5: (OPTIONAL)==
'''Problem:'''

Similar to the calibration report from the Design Exercise assignment, create a view that would allow the student reviewers differ from the reviews completed by the course staff.

'''Solution:'''
Review the code from the Design Exercise calibration assignment. Discuss ideas with the professor (as advised from previous mentor meetings) to form a plan on how to address this task.

='''Test Plan'''=
Write testing methodology (logic) here.

='''References'''=
1. Project Document: https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.bumi2mscmmgf

2. Github Repo: https://github.com/mblewallncsu/expertiza

3. Previous Work, Project E1824: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1824:_Let_course_staff_as_well_as_students_do_reviews

4. Previous Work, Project E1855: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1855_let_course_staff_as_well_as_students_do_reviews

='''Team Members'''=

1. Jimmy Boykin

2. Srikara Krishna

3. Michael Lewallen

CSC/ECE 517 Spring 2019/E1927 Let Course Staff as Well as Students Do Reviews

2019-04-11T05:11:32Z

Jwboykin: /* Problem Summary */

='''Problem Summary'''=
In Expertiza, students are able to perform reviews on other students work by filling out a review form on Expertiza. Instructors and TAs for the course should be able to submit a review in the same manner as a student. Only instructors or TAs who are participants in the assignment should be allowed to leave reviews. However, the instructor and TA reviews should be distinguished from other student reviews so the student knows the review was written by the instructor.

='''Project Tasks'''=

==Task 1:==
'''Problem:'''

An instructor or TA who is a participant of an assignment, then the instructor should be able to review any team that submitted the assignment.

'''Solution:'''
(Find the code that validates the TA is a participant. See the comments in the project description for more information.)

==Task 2:==
'''Problem:'''

If the last due date for the assignment has not passed, then the “Assign grade” link should be changed to “Perform review”, and when clicked on, it should pull up a review page for the team, showing their submitted work at the top, as a review page normally does.

'''Solution:'''

(Put the name of the file to be revised here. Show the current code, the revised code, and your results.)

==Task 3:==
'''Problem:'''

An instructor icon should be used to indicate an instructor review and this icon should be seen on the instructor review page read by the student.

'''Solution:'''

Modify the add-ta-128.png icon file to look more like an instructor and add it to the view.

[[File:E1927_Add-ta-128.png|alt=Add a TA]]

==Task 4:==
'''Problem:'''

Refactor: A "course_staff" column was added to the "response_maps" table. Is it really necessary to have a column named as "course_staff" for reviews?

'''Solution:'''
Remove the column name from the response maps, if it exists.

Find another way of indicating the review is an instructor review.

==Task 5: (OPTIONAL)==
'''Problem:'''

Similar to the calibration report from the Design Exercise assignment, create a view that would allow the student reviewers differ from the reviews completed by the course staff.

'''Solution:'''
Review the code from the Design Exercise calibration assignment. Discuss ideas with the professor (as advised from previous mentor meetings) to form a plan on how to address this task.

='''Test Plan'''=
Write testing methodology (logic) here.

='''References'''=
1. Project Document: https://docs.google.com/document/d/1Ozw2Bj2u_LyeKUdDqAyQtz1stEIKrxkmRnwmNyUgmzw/edit#heading=h.bumi2mscmmgf

2. Github Repo: https://github.com/mblewallncsu/expertiza

3. Previous Work, Project E1824: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Spring_2018-_Project_E1824:_Let_course_staff_as_well_as_students_do_reviews

4. Previous Work, Project E1855: http://wiki.expertiza.ncsu.edu/index.php/CSC/ECE_517_Fall_2018/E1855_let_course_staff_as_well_as_students_do_reviews

='''Team Members'''=

1. Jimmy Boykin

2. Srikara Krishna

3. Michael Lewallen

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T19:00:05Z

Jwboykin: /* Solution */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====

A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

<pre>
#returns the next due date
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end
</pre>

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.

[[File:Big1.png]]

Removed test related to the function. Removed the one call to this function.

[[File:big2.png]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:59:39Z

Jwboykin: /* Solution */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====

A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

<pre>
#returns the next due date
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end
</pre>

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.
[[File:Big1.png]]

Removed test related to the function. Removed the one call to this function.
[[File:big2.png]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

File:Big2.png

2019-03-25T18:59:25Z

Jwboykin:

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:58:30Z

Jwboykin: /* Solution */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====

A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

<pre>
#returns the next due date
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end
</pre>

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.
[[File:Big1.png]]

Removed test related to the function. Removed the one call to this function.
[[File:Screen_Shot_2019-03-25_at_2.41.51_PM.png]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

File:Big1.png

2019-03-25T18:58:06Z

Jwboykin:

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:53:18Z

Jwboykin: /* Problem 7 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====

A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

<pre>
#returns the next due date
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end
</pre>

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.
[[File:Screen_Shot_2019-03-25_at_2.42.04_PM.png]]

Removed test related to the function. Removed the one call to this function.
[[File:Screen_Shot_2019-03-25_at_2.41.51_PM.png]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:52:10Z

Jwboykin: /* Problem 7 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====

A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

<pre>
#returns the next due date
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end
</pre>

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.
[[File:Screen_Shot_2019-03-25_at_2.42.04_PM.png|800px]]

Removed test related to the function. Removed the one call to this function.
[[File:Screen_Shot_2019-03-25_at_2.41.51_PM.png|800px]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:50:20Z

Jwboykin: /* Solution */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====

A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

<pre>
#returns the next due date
def next_due_date(topic_id = nil)
DueDate.get_next_due_date(self.id, topic_id)
end
</pre>

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.
[[File:Screen_Shot_2019-03-25_at_2.42.04_PM.png] | width 200]

Removed test related to the function. Removed the one call to this function.
[[File:Screen_Shot_2019-03-25_at_2.41.51_PM.png]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:46:19Z

Jwboykin: /* Problem 6 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===
Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====
A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.
[[File:Screen_Shot_2019-03-25_at_2.33.27_PM.png]]

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 7'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function.
[[File:Screen_Shot_2019-03-25_at_2.42.04_PM.png]]

Removed test related to the function. Removed the one call to this function.
[[File:Screen_Shot_2019-03-25_at_2.41.51_PM.png]]

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

File:Screen Shot 2019-03-25 at 2.42.04 PM.png

2019-03-25T18:44:24Z

Jwboykin: assignment modify url view

assignment modify url view

File:Screen Shot 2019-03-25 at 2.41.51 PM.png

2019-03-25T18:43:43Z

Jwboykin: assignment remove link

assignment remove link

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:37:55Z

Jwboykin: /* Problem 3 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===
Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====
A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.
[[File:Screen_Shot_2019-03-25_at_2.33.27_PM.png]]

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function. Removed test related to the function. Removed the one call to this function.

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:37:41Z

Jwboykin: /* Problem 3 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===
Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====
A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.
[[File:creen_Shot_2019-03-25_at_2.33.27_PM.png]]

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function. Removed test related to the function. Removed the one call to this function.

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

File:Screen Shot 2019-03-25 at 2.33.27 PM.png

2019-03-25T18:36:57Z

Jwboykin: refactor current stage name screenshot

refactor current stage name screenshot

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:32:34Z

Jwboykin: /* Problem 3 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===
Multiple functions in the code were calling DueDate.get_next_due_date(self.id, topic_id).

===='''Solution'''====
A new private function next_due_date was added. Other calls to the DueDate.get_next_due_date were replaced.

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function. Removed test related to the function. Removed the one call to this function.

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:29:19Z

Jwboykin: /* Problem 3 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

===='''Solution'''====

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===

link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====

Removed function. Removed test related to the function. Removed the one call to this function.

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T18:26:29Z

Jwboykin: /* Solutions Implemented */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

===='''Solution'''====

==='''Problem 4'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was like nesting of calls and not very Ruby standard.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 5'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 6'''===

current_stage_name(topic_id=nil)[This is the initial one] method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

After removing the current_stage_name method, its uses were replaced with current_stage_name. One example of the refactoring is shown below:

[[File:Current_stage.png|center]]

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===
link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====
Removed function. Removed test related to the function. Removed the one call to this function.

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T17:54:58Z

Jwboykin: /* Problem 6 */

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was creating a chain of calls.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 4'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to get_current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def get_current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with get_current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 5'''===

current_stage_name(topic_id=nil) method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if topic_missing?(topic_id)
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def get_current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

After removing the current_stage_name method, its uses were replaced with get_current_stage_name. One example of the refactoring is shown below:

[[File:Current_stage.png|center]]

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===
link_for_current_stage function served no purpose. The function checked to see if any given due date had a link (presumably web URL) and would return it. The database had no values and there is no where in the application this URL could be provided. There doesn't appear to be any use for having a separate URL for each stage.

===='''Solution'''====
Removed function. Removed test related to the function. Removed the one call to this function.

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to get_current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#get_current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]

CSC/ECE 517 Spring 2019 E1906 Refactor stage deadlines in Assignment.rb

2019-03-25T17:48:39Z

Jwboykin: moved CSC/ECE 517 Spring 2019 E1906 Refactor stage deadlines in Assignment.rb to CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

#REDIRECT [[CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb]]

CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

2019-03-25T17:48:39Z

Jwboykin: moved CSC/ECE 517 Spring 2019 E1906 Refactor stage deadlines in Assignment.rb to CSC/ECE 517 Spring 2019 - Project E1906. Refactor stage deadlines in Assignment.rb

This wiki page is for the description of changes made under E1906 OSS assignment for Spring 2019, CSC/ECE 517.

=='''Expertiza Background'''==
[http://expertiza.ncsu.edu/ Expertiza] is a web application developed using Ruby on Rails Framework whose creation and maintenance is taken care of by students as well as the faculty of NCSU.It's code is available on Github [https://github.com/expertiza/expertiza Expertiza on GitHub].Expertiza allows the instructor to create and edit new as well as existing assignments.This also includes creating a wide range of topics under each assignment which students can sign up for.They can also publish surveys and reviews,view statistical results, set deadlines for assignments and make announcements.It provides a platform for students to signup for topics,form teams,view and submit assignments and give peer reviews and feedback.

=='''Stage Deadline Background'''==
An assignment in Expertiza has many deadlines possible: deadlines for submission and review in each round,deadlines for signing up and dropping topics,submitting meta-reviews,etc.Depending on what the next deadline is,an Expertiza assignment is said to be in a particular kind of what is called "stage".For example,if the next deadline(after the current time) is a submission deadline which is a DueDate object,then the assignment is said to be in a "submission" phase.

[[File: StageBackground.png|center]]

Depending on which stage an assignment is in, certain activities may be permissible or impermissible.For example, the default for a submission stage is to allow submission but not review,and in a review stage,the default is to allow review but not submission.These defaults may be changed by checking the relevant boxes on the Due Dates tab of assignment creation or editing.In the figure below it can be seen the "Other's work" link is grayed out as review is not permissible during submission phase.

[[File: Statusinadeadline.jpg|center]]

=='''Important Links'''==

[http://oss.flazzle.com/ Deployed_Project_Link]

[https://github.com/jwboykin/expertiza Expertiza_Link_for_this_Project]

=='''Problem Statement'''==
E1906 is an Expertiza based OSS project which deals basically with refactoring stage deadlines in assignment.rb file.Class assignment.rb has several methods for checking what kind of stage an assignment is in at the current time.These are:

* current_stage_name(topic_id = nil)
* find_current_stage(topic_id = nil)
* get_current_stage(topic_id = nil)
* link_for_current_stage(topic_id = nil)
* stage_deadline(topic_id = nil)

The goal of the project focuses on refactoring some of the above more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. This project is basically an attempt to make this part of the application easier to read and maintain.

=='''Solutions Implemented'''==

==='''Problem 1'''===

The above methods were being used at various places to check if the assignment is 'Finished' which made the code very redundant. Assignment is said to be finished if the next_due_date is nil.

===='''Solution'''====

We have created a new method "finished?" that checks if the next_due_date is nil (which means that the assignment is "finished").

<pre>
# New function to check if the assignment is finished
def finished?( topic_id = nil )
DueDate.get_next_due_date(self.id, topic_id).nil?
end
</pre>

We have called this method at all the places where previously different methods were being used to check the same thing.
*Signup sheet table uses assignment finished? method instead of current_stage_name
[[File:Problem1_1.png‎|center]]

*Use assignment finished? method where only a comparison to "Finished" was being done using get_current_stage and find_current_stage
[[File:Problem1_2.png|center]] [[File:Problem1_3.png|center]]

==='''Problem 2'''===

The check for a topic_id to be nil when it is a staggered assignment and return 'Unknown' when it is true was being done at many places.This was not following Ruby and Rails rules.

===='''Solution'''====

To make the code DRY and more easy to understand,we have created a new private method "topic_missing?" to check if the topic_id is nil in case of staggered assignment.

<pre>
# Function to check if topic id is null when its a staggered assignment
def topic_missing?( topic_id = nil)
topic_id.nil? and self.staggered_deadline?
end
</pre>

*Refactoring with new method topic_missing?

[[File:Topic missing.png|center]]

==='''Problem 3'''===

find_current_stage(topic_id=nil) method is being used only locally in the assignment.rb and once in the student_teams controller to check to check whether to display or not the reviews option for team members.This method was calling another function to get the next_due_date for an assignment that was creating a chain of calls.

===='''Solution'''====

We have removed this function.We have replaced it with finished? method in the student_teams controller(shown in screenshot above in Problem 1) and with DueDate.get_next_due_date where the next due date was required.

<pre>
Before :
due_date = find_current_stage(topic_id)

After :
due_date = DueDate.get_next_due_date(self.id, topic_id)
</pre>

==='''Problem 4'''===

get_current_stage method is returning the stage name which the assignment is in at current time.This is not very clear from the name of the method.

===='''Solution'''====

We have changed the method name to get_current_stage_name(topic_id=nil) to make it more clear to understand.

<pre>
def get_current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

*Refactored get_current_stage with get_current_stage_name

[[File:Get current stage name.png|center]]

==='''Problem 5'''===

current_stage_name(topic_id=nil) method was implementing things which was already being done by other methods and thus this method was redundant.
The initial code given was:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline?
return (topic_id.nil? ? 'Unknown' : get_current_stage(topic_id))
end
due_date = find_current_stage(topic_id)

unless self.staggered_deadline?
if due_date != 'Finished' && !due_date.nil? && !due_date.deadline_name.nil?
return due_date.deadline_name
else
return get_current_stage(topic_id)
end
end
end
</pre>

First thing we noticed was that due_date.deadline_name was always nil because there was no field to enter the deadline name on the form, and therefore, the statement <pre> return due_date.deadline_name </pre> was never getting executed.

===='''Solution'''====

This method was checking for the due_date.deadline_name which was always nil. After removing the dead code, we get:

<pre>
def current_stage_name(topic_id = nil)
if self.staggered_deadline? and topic_id.nil?
return 'Unknown'
else
get_current_stage(topic_id)
end
end
</pre>

Looking at the get_current_stage_name(topic_id=nil) method shown below and comparing it to what we have above, this code was surely redundant.That is why we removed this code and made appropriate changes wherever required within assignment.rb.
*Below is the get_current_stage_name method for reference

<pre>
def get_current_stage_name(topic_id = nil)
return 'Unknown' if topic_missing?(topic_id)
due_date = DueDate.get_next_due_date(self.id, topic_id)
finished?(topic_id)? "Finished" : DeadlineType.find(due_date.deadline_type_id).name
end
</pre>

After removing the current_stage_name method, its uses were replaced with get_current_stage_name. One example of the refactoring is shown below:

[[File:Current_stage.png|center]]

The associated rspec tests that tested the current_stage method were also no longer needed.

==='''Problem 6'''===

===='''Solution'''====

=='''Automated Testing using RSPEC'''==

===='''Tests for get_current_stage_name'''====

The current version of expertiza did not have any tests for get_current_stage(topic_id=nil) method.Now as we have changed it to get_current_stage_name(topic_id=nil),we have added its tests as well.

<pre>
describe '#get_current_stage_name' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.get_current_stage_name).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns Finished' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.get_current_stage_name(123)).to eq('Finished')
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns current stage name' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(assignment).to receive(:topic_missing?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1,123).and_return(assignment_due_date)
deadline = create(:deadline_type, id: 1, name:"Review")
allow(DeadlineType).to receive(:find).with(1).and_return(deadline)
expect(assignment.get_current_stage_name(123)).to eq('Review')
end
end
end
end
</pre>

===='''Tests for finished?'''====

We have added tests for the new method that we have added finished?.

<pre>
describe '#finished?' do
context 'when assignment next due date is nil' do
it 'returns True' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(nil)
expect(assignment.finished?(123)).to eq(TRUE)
end
end
end

describe '#finished?' do
context 'when there is a next due date' do
it 'returns False' do
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return('2021-11-11 11:11:11')
expect(assignment.finished?(123)).to eq(false)
end
end
end
</pre>

As topic_missing? method is made private,there was no need to test this.

===='''Tests for stage_deadline'''====

We also have corrected the tests for stage_deadline according to the modifications done(It is using finished? and topic_missing? methods).

<pre>
describe '#stage_deadline' do
context 'when topic id is nil and current assignment has staggered deadline' do
it 'returns Unknown' do
allow(assignment).to receive(:topic_missing?).and_return(true)
expect(assignment.stage_deadline).to eq('Unknown')
end
end

context 'when current assignment does not have staggered deadline' do
context 'when due date is nil' do
it 'returns nil' do
allow(assignment).to receive(:finished?).with(123).and_return(true)
expect(assignment.stage_deadline(123)).to be nil
end
end

context 'when due date is not nil and due date is not equal to Finished' do
it 'returns due date' do
allow(assignment).to receive(:finished?).with(123).and_return(false)
allow(DueDate).to receive(:get_next_due_date).with(1, 123).and_return(assignment_due_date)
expect(assignment.stage_deadline(123)).to match('2011-11-11 11:11:11')
end
end
end
end
</pre>

=='''Team'''==
[mailto:jwboykin@ncsu.edu Jimmy Boykin] 
[mailto:rkaur@ncsu.edu Ramandeep Kaur] 
[mailto:sbasnet2@ncsu.edu Sushan Basnet]