Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1586 AnonymousChatBetweenAuthorAndReviewer

2015-11-13T21:46:36Z

Agohil:

'''E1586 AnonymousChatBetweenAuthorAndReviewer'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at developing an email based anonymous session between author and a reviewer so that reviewers can ask questions to the authors for any doubts related to the assignments during peer reviewing.

==Project==

=== Introduction to Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides an incremental class based learning together with the instructors and the peers. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza handles assignment submissions, team formations, assignment reviews and grades, etc.

=== Purpose ===
During reviews, many times reviewers will be having questions about the submitted material and if it's a blocker there is no way that the reviewer can progress further with the review. As a result, reviewers will end up submitting the empty or incomplete review.

=== Scope ===
This project is limited to an email based conversation for asking questions and answers. The reviewers would ask questions related to assignment submission doubts to which authors can respond. All this would be taken care as email responses using a link provided in the email. This project does not cater to any live interactive session with spontaneous back-to-back questions and responses.

Following tasks would be incorporated in the project:
* Provide a ‘TextArea’ input field on review forms, where any reviewer can type in their questions.
* Create a new button ‘Ask for Quick Help’ on the review forms.
* An email would be send to the author with the link where he can respond to the questions asked by the reviewers for their submitted work.
* Reviewers would be notified by an email when authors respond to the the questions.

== Design ==

=== Discussion of Resolution ===

We will make the following modifications to implement the chat feature:- 

*Create a new model which will help extract,store and validate data in the database table which contains information about the interaction between the author/s and reviewer.

*Edit the view which is used by the response controller to incorporate the text area input field on the review form where the reviewer can ask his/her initial query.

*Create a new controller which will contain methods to send emails to the author and reviewers as well as retrieve and display the chat history between the two.

*Create a new view which will facilitate the author to respond to the queries asked by the reviewer. The reviewer can also use this view to ask any follow up questions.

=== Mock-Ups ===
The sample question box would look like:

[[File: ARSNMockup1.JPG]]

An interface with the question would be displayed on opening a link from the email.
The authors can reply the query which reviewers ask.

[[File: ARSNMockup2.JPG]]

=== Design Patterns ===
The implementation team expects that the following design patterns be used in the solution:

* '''Observer Pattern'''<ref>Observer Design Pattern https://en.wikipedia.org/wiki/Observer_pattern</ref>: The observer pattern is a software design pattern in which an object, called the subject, maintains a list of its dependents, called observers, and notifies them automatically of any state changes, usually by calling one of their methods. For example, we are notifying the team members whenever the reviewer submits the query.

* '''Iterator Pattern''': In our instance, we need to display the entire chat history of a particular interaction, hence we can use the iterator design pattern to iterate through the previous chat messages.

=== Database Design ===

[[File:DatabaseTable.jpg]]

The above figure shows the schema of a new table which will be created in Expertiza to store relevant information about the chat. It contains the following attributes:
* id: This attribute is auto-generated by rails when we create a table and is auto incremented with each record. It is also the primary key of our table.
* assignment_id: Stores the ID of the assignment for which the interaction between author and reviewer is taking place.
* reviewer_id: Stores the ID of the reviewer who asks the questions.
* team_id: Stores the ID of the team to which the topic belongs.
* type_flag: Flag which is used to indicate if the particular tuple contains a question or answer. It can take two values, 'Q' for question and 'A' for answer.
* content: Stores the question asked by the reviewer or the response given by the author/s depending on the value of the type flag.

Records for a particular interaction can be identified by using a combination of assignment_id, reviewer_id and team_id.

=== Use Cases ===
'''Name:''' Send a question to the author/s about their work. 
'''Actor:''' Reviewer. 
'''Description:''' The reviewer enters his question in the text area which is provided and clicks on the "Ask question" button which is provided as shown in the mock up. On clicking this button an email is sent to the author/s along which a link to answer the question. 
 
'''Name:''' Answer the question which has been asked by the reviewer. 
'''Actor:''' Author/s 
'''Description:''' The author/s click on the link received in their email and are redirected to a page where they can answer the question. Once they submit the answer, an email is sent to the reviewer notifying him/her that their question has been answered. 

[[File:ARSNUsecase.jpeg]]

=== Proposed Tests ===
1. For use case 1, test whether all the team members receive email with the question. 
2. For use case 2, test whether the reviewer receive email with the response. 
3. Test whether all the previous interactions are displayed as chat history. 
4. The 'Ask Question' button should not be enabled until some text has been entered in the text area.

== Implementation ==

'''Files created/modified'''

*Create a new model '''ReviewChat''' .

*Create a new controller '''ReviewChats'''.

*Create new views as discussed in the design.

*Modify view expertiza/app/views/response/response.html.erb to incorporate text box and corresponding submit button.

'''Flowchart'''

[[File: ARSNFlowchart1.png]]

'''Flow'''

*The reviewer enters his question in the text area provided and clicks on the "Ask Question" button.
*On clicking this button the appropriate method is called in ReviewChats controller which sends an email to all the authors of the topic indicating that a question has been asked about their work. The email contains a link which when clicked on will redirect the author to the appropriate view where he/she can answer the question.
*On answering the question, the reviewer receives an email indicating that his question has been answered. It also contains a link which redirects the reviewer to the appropriate view where the answer will be displayed.
*This view also contains the chat history between the author/s and the reviewer for the entire duration of the interaction.

== Suggestions for Future Improvements ==

* This can be extended to a live interactive author-reviewer anonymous chat session inside the Expertiza reviews window.
* A purging script can be developed which will clear all the interaction records every semester.

==Resources==

* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref>

==References==
<references/>

CSC/ECE 517 Fall 2015 E1586 AnonymousChatBetweenAuthorAndReviewer

2015-11-10T04:50:17Z

Agohil:

'''E1586 AnonymousChatBetweenAuthorAndReviewer'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at developing an email based anonymous session between author and a reviewer so that reviewers can ask questions to the authors for any doubts related to the assignments during peer reviewing.

==Project==

=== Introduction to Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides an incremental class based learning together with the instructors and the peers. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza handles assignment submissions, team formations, assignment reviews and grades, etc.

=== Purpose ===
During reviews, many times reviewers will be having questions about the submitted material and if it's a blocker there is no way that the reviewer can progress further with the review. As a result, reviewers will end up submitting the empty or incomplete review.

=== Scope ===
This project is limited to an email based conversation for asking questions and answers. The reviewers would ask questions related to assignment submission doubts to which authors can respond. All this would be taken care as email responses using a link provided in the email. This project does not cater to any live interactive session with spontaneous back-to-back questions and responses.

Following tasks would be incorporated in the project:
* Provide a ‘TextArea’ input field on review forms, where any reviewer can type in their questions.
* Create a new button ‘Ask for Quick Help’ on the review forms.
* An email would be send to the author with the link where he can respond to the questions asked by the reviewers for their submitted work.
* Reviewers would be notified by an email when authors respond to the the questions.

== Design ==

=== Discussion of Resolution ===

We will make the following modifications to implement the chat feature:- 

*Create a new model which will help extract,store and validate data in the database table which contains information about the interaction between the author/s and reviewer.

*Edit the view which is used by the response controller to incorporate the text area input field on the review form where the reviewer can ask his/her initial query.

*Create a new controller which will contain methods to send emails to the author and reviewers as well as retrieve and display the chat history between the two.

*Create a new view which will facilitate the author to respond to the queries asked by the reviewer. The reviewer can also use this view to ask any follow up questions.

=== Mock-Ups ===
The sample question box would look like:

[[File: ARSNMockup1.JPG]]

An interface with the question would be displayed on opening a link from the email.
The authors can reply the query which reviewers ask.

[[File: ARSNMockup2.JPG]]

=== Database Design ===

[[File:DatabaseTable.jpg]]

The above figure shows the schema of a new table which will be created in Expertiza to store relevant information about the chat. It contains the following attributes:
* id: This attribute is auto-generated by rails when we create a table and is auto incremented with each record. It is also the primary key of our table.
* assignment_id: Stores the ID of the assignment for which the interaction between author and reviewer is taking place.
* reviewer_id: Stores the ID of the reviewer who asks the questions.
* team_id: Stores the ID of the team to which the topic belongs.
* type_flag: Flag which is used to indicate if the particular tuple contains a question or answer. It can take two values, 'Q' for question and 'A' for answer.
* content: Stores the question asked by the reviewer or the response given by the author/s depending on the value of the type flag.

Records for a particular interaction can be identified by using a combination of assignment_id, reviewer_id and team_id.

=== Use Cases ===
'''Name:''' Send a question to the author/s about their work. 
'''Actor:''' Reviewer. 
'''Description:''' The reviewer enters his question in the text area which is provided and clicks on the "Ask question" button which is provided as shown in the mock up. On clicking this button an email is sent to the author/s along which a link to answer the question. 
 
'''Name:''' Answer the question which has been asked by the reviewer. 
'''Actor:''' Author/s 
'''Description:''' The author/s click on the link received in their email and are redirected to a page where they can answer the question. Once they submit the answer, an email is sent to the reviewer notifying him/her that their question has been answered. 

=== Proposed Tests ===
1. For use case 1, test whether all the team members receive email with the question. 
2. For use case 2, test whether the reviewer receive email with the response. 
3. Test whether all the previous interactions are displayed as chat history. 
4. The 'Ask Question' button should not be enabled until some text has been entered in the text area.

== Implementation ==

'''Files created/modified:-'''

*Create a new model chat_feedback.rb

*Create a new controller review_interactions_controller.rb

*Create new views as discussed in the design.

*Modify view expertiza/app/views/response/response.html.erb to incorporate text box and corresponding submit button.

'''Flow:-'''

*The reviewer enters his question in the text area provided and clicks on the "Ask Question" button.
*On clicking this button the appropriate method is called in review_interactions_controller.rb which sends an email to all the authors of the topic indicating that a question has been asked about their work. The email contains a link which when clicked on will redirect the author to the appropriate view where he/she can answer the question.
*On answering the question, the reviewer receives an email indicating that his question has been answered. It also contains a link which redirects the reviewer to the appropriate view where the answer will be displayed.
*This view also contains the chat history between the author/s and the reviewer for the entire duration of the interaction.

== Suggestions for Future Improvements ==

* This can be extended to a live interactive author-reviewer anonymous chat session inside the Expertiza reviews window.
* A purging script can be developed which will clear all the interaction records every semester.

==Resources==

* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref>

==References==
<references/>

CSC/ECE 517 Fall 2015 E1586 AnonymousChatBetweenAuthorAndReviewer

2015-11-10T04:40:54Z

Agohil:

'''E1586 AnonymousChatBetweenAuthorAndReviewer'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at developing an email based anonymous session between author and a reviewer so that reviewers can ask questions to the authors for any doubts related to the assignments during peer reviewing.

==Project==

=== Introduction to Expertiza ===
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides an incremental class based learning together with the instructors and the peers. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza handles assignment submissions, team formations, assignment reviews and grades, etc.

=== Purpose ===
During reviews, many times reviewers will be having questions about the submitted material and if it's a blocker there is no way that the reviewer can progress further with the review. As a result, reviewers will end up submitting the empty or incomplete review.

=== Scope ===
This project is limited to an email based conversation for asking questions and answers. The reviewers would ask questions related to assignment submission doubts to which authors can respond. All this would be taken care as email responses using a link provided in the email. This project does not cater to any live interactive session with spontaneous back-to-back questions and responses.

Following tasks would be incorporated in the project:
* Provide a ‘TextArea’ input field on review forms, where any reviewer can type in their questions.
* Create a new button ‘Ask for Quick Help’ on the review forms.
* An email would be send to the author with the link where he can respond to the questions asked by the reviewers for their submitted work.
* Reviewers would be notified by an email when authors respond to the the questions.

== Design ==

=== Discussion of Resolution ===

We will make the following modifications to implement the chat feature:- 

*Create a new model which will help extract,store and validate data in the database table which contains information about the interaction between the author/s and reviewer.

*Edit the view which is used by the response controller to incorporate the text area input field on the review form where the reviewer can ask his/her initial query.

*Create a new controller which will contain methods to send emails to the author and reviewers as well as retrieve and display the chat history between the two.

*Create a new view which will facilitate the author to respond to the queries asked by the reviewer. The reviewer can also use this view to ask any follow up questions.

=== Mock-Ups ===
The sample question box would look like:

[[File: ARSNMockup1.JPG]]

An interface with the question would be displayed on opening a link from the email.
The authors can reply the query which reviewers ask.

[[File: ARSNMockup2.JPG]]

=== Database Design ===

[[File:DatabaseTable.jpg]]

The above figure shows the schema of a new table which will be created in Expertiza to store relevant information about the chat. It contains the following attributes:
* id: This attribute is auto-generated by rails when we create a table and is auto incremented with each record. It is also the primary key of our table.
* assignment_id: Stores the ID of the assignment for which the interaction between author and reviewer is taking place.
* reviewer_id: Stores the ID of the reviewer who asks the questions.
* team_id: Stores the ID of the team to which the topic belongs.
* type_flag: Flag which is used to indicate if the particular tuple contains a question or answer. It can take two values, 'Q' for question and 'A' for answer.
* content: Stores the question asked by the reviewer or the response given by the author/s depending on the value of the type flag.

Records for a particular interaction can be identified by using a combination of assignment_id, reviewer_id and team_id.

=== Use Cases ===
'''Name:''' Send a question to the author/s about their work. 
'''Actor:''' Reviewer. 
'''Description:''' The reviewer enters his question in the text area which is provided and clicks on the "Ask question" button which is provided as shown in the mock up. On clicking this button an email is sent to the author/s along which a link to answer the question. 
 
'''Name:''' Answer the question which has been asked by the reviewer. 
'''Actor:''' Author/s 
'''Description:''' The author/s click on the link received in their email and are redirected to a page where they can answer the question. Once they submit the answer, an email is sent to the reviewer notifying him/her that their question has been answered. 

=== Proposed Tests ===
1. Test whether all the team members receive email with the question. 
2. Test whether previous interactions are displayed as chat history. 

== Implementation ==

'''Files created/modified:-'''

*Create a new model chat_feedback.rb

*Create a new controller review_interactions_controller.rb

*Create new views as discussed in the design.

*Modify view expertiza/app/views/response/response.html.erb to incorporate text box and corresponding submit button.

'''Flow:-'''

*The reviewer enters his question in the text area provided and clicks on the "Ask Question" button.
*On clicking this button the appropriate method is called in review_interactions_controller.rb which sends an email to all the authors of the topic indicating that a question has been asked about their work. The email contains a link which when clicked on will redirect the author to the appropriate view where he/she can answer the question.
*On answering the question, the reviewer receives an email indicating that his question has been answered. It also contains a link which redirects the reviewer to the appropriate view where the answer will be displayed.
*This view also contains the chat history between the author/s and the reviewer for the entire duration of the interaction.

== Suggestions for Future Improvements ==

* This can be extended to a live interactive author-reviewer anonymous chat session inside the Expertiza reviews window.
* A purging script can be developed which will clear all the interaction records every semester.

==Resources==

* Expertiza Github repository<ref>Expertiza Github repository https://github.com/expertiza/expertiza</ref>

==References==
<references/>

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-09T22:35:03Z

Agohil:

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-09T22:24:32Z

Agohil:

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T04:36:32Z

Agohil:

This wiki page is for the description of changes made under E1555 OSS assignment for Fall 2015, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely: 
1.GradesController 
2.GradesHelper 

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

== GradesHelper ==

This is a helper class which contains methods for constructing a table(construct_table) and to check whether an assignment has a team and metareveiw(has_team_and_metareview)

== List of changes ==
We worked on the following work items 
WI1 : Refactor calculate_all_penalties method into smaller methods 
WI2 : Move the repeated code in conflict_notification & edit methods to a separate method list_questions. 
WI3 : Refactor the code as per the Ruby style guidelines and incorporate the good practices 
WI4 : Test the conflict_notification method to test the changes made.

== Solutions Implemented and Delivered ==

*WI1 : Refactoring calculate_all_penalties method

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods: 
i. calculate_all_penalties 
ii. calculate_penatly_attributes 
iii. assign_all_penalties 
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
.
.
.
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
.
.
.
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

New methods:
def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

*WI2 Move the redundant piece of code from conflict_notification & edit methods to a new method list_questions

The conflict_notification method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
.
.
.
end

After:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@reviewers_email_hash = Hash.new
.
.
.
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

edit method:

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@scores = @participant.scores(@questions)
end

New method:
#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

== Testing Details==

There were no exiting test cases for the GradesController. We have added a new spec file 'grades_spec.rb' which covers testing scenario for the newly added method.

=== UI Testing ===

Following steps needs to be performed to test this code from UI: 
1. Login as instructor. Create a course and an assignment under that course. 
2. Keep the has team checkbox checked while creating the assignment. Add a grading rubric to it. Add at least two students as participants to the assignment. 
3. Create topics for the assignment. 
4. Sign in as one of the students who were added to the assignment. 
5. Go to the assignment and sign up for a topic. 
6. Submit student's work by clicking 'Your work' under that assignment. 
7. Sign in as a different student which is participant of the assignment. 
8. Go to Assignments--><assignment name>-->Others' work (If the link is disabled, login as instructor and change the due date of the assignment to current time). 
9. Give reviews on first student's work. 
10. Login as instructor or first student to look at the review grades.

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T04:33:56Z

Agohil:

This wiki page is for the description of changes made under E1555 OSS assignment for Fall 2015, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely:
1.GradesController
2.GradesHelper

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

== GradesHelper ==

This is a helper class which contains methods for constructing a table(construct_table) and to check whether an assignment has a team and metareveiw(has_team_and_metareview)

== List of changes ==
We worked on the following work items
WI1 : Refactor calculate_all_penalties method into smaller methods
WI2 : Move the repeated code in conflict_notification & edit methods to a separate method list_questions.
WI3 : Refactor the code as per the Ruby style guidelines and incorporate the good practices
WI4 : Test the conflict_notification method to test the changes made.

== Solutions Implemented and Delivered ==

*WI1 : Refactoring calculate_all_penalties method

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods: 
i. calculate_all_penalties 
ii. calculate_penatly_attributes 
iii. assign_all_penalties 
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
.
.
.
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
.
.
.
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

New methods:
def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

*WI2 Move the redundant piece of code from conflict_notification & edit methods to a new method list_questions

The conflict_notification method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
.
.
.
end

After:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@reviewers_email_hash = Hash.new
.
.
.
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

edit method:

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@scores = @participant.scores(@questions)
end

New method:
#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

== Testing Details==

There were no exiting test cases for the GradesController. We have added a new spec file 'grades_spec.rb' which covers testing scenario for the newly added method.

=== UI Testing ===

Following steps needs to be performed to test this code from UI: 
1. Login as instructor. Create a course and an assignment under that course. 
2. Keep the has team checkbox checked while creating the assignment. Add a grading rubric to it. Add at least two students as participants to the assignment. 
3. Create topics for the assignment. 
4. Sign in as one of the students who were added to the assignment. 
5. Go to the assignment and sign up for a topic. 
6. Submit student's work by clicking 'Your work' under that assignment. 
7. Sign in as a different student which is participant of the assignment. 
8. Go to Assignments--><assignment name>-->Others' work (If the link is disabled, login as instructor and change the due date of the assignment to current time). 
9. Give reviews on first student's work. 
10. Login as instructor or first student to look at the review grades.

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T04:32:48Z

Agohil:

This wiki page is for the description of changes made under E1555 OSS assignment for Fall 2015, CSC/ECE 517.

== Peer Review Information ==

For users intending to view the deployed Expertiza associated with this assignment, the credentials are below:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student4340, password -> password
* Student login: username -> student4405, password -> password

== Expertiza Background==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely:
1.GradesController
2.GradesHelper

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

There were no existing test cases for the controller. We have added a spec file named 'grades_spec.rb' under the spec folder. As no changes were done for the model, no tests for the model were included.

== GradesHelper ==

This is a helper class which contains methods for constructing a table(construct_table) and to check whether an assignment has a team and metareveiw(has_team_and_metareview)

== List of changes ==
We worked on the following work items
WI1 : Refactor calculate_all_penalties method into smaller methods
WI2 : Move the repeated code in conflict_notification & edit methods to a separate method list_questions.
WI3 : Refactor the code as per the Ruby style guidelines and incorporate the good practices
WI4 : Test the conflict_notification method to test the changes made.

== Solutions Implemented and Delivered ==

*WI1 : Refactoring calculate_all_penalties method

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods: 
i. calculate_all_penalties 
ii. calculate_penatly_attributes 
iii. assign_all_penalties 
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
.
.
.
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
.
.
.
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

New methods:
def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

*WI2 Move the redundant piece of code from conflict_notification & edit methods to a new method list_questions

The conflict_notification method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
.
.
.
end

After:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@reviewers_email_hash = Hash.new
.
.
.
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

edit method:

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@scores = @participant.scores(@questions)
end

New method:
#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

== Testing Details==

There were no exiting test cases for the GradesController. We have added a new spec file 'grades_spec.rb' which covers testing scenario for the newly added method.

=== UI Testing ===

Following steps needs to be performed to test this code from UI:
1. Login as instructor. Create a course and an assignment under that course.
2. Keep the has team checkbox checked while creating the assignment. Add a grading rubric to it. Add at least two students as participants to the assignment.
3. Create topics for the assignment
4. Sign in as one of the students who were added to the assignment.
5. Go to the assignment and sign up for a topic.
6. Submit student's work by clicking 'Your work' under that assignment.
7. Sign in as a different student which is participant of the assignment.
8. Go to Assignments--><assignment name>-->Others' work (If the link is disabled, login as instructor and change the due date of the assignment to current time).
9. Give reviews on first student's work.
10. Login as instructor or first student to look at the review grades.

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:40:21Z

Agohil: /* calculate_all_penalties */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:39:31Z

Agohil: /* edit */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:37:22Z

Agohil: /* calculate_all_penalties */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:30:28Z

Agohil: /* edit */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely:
1.GradesController
2.GradesHelper

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

=== calculate_all_penalties ===

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods:
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

=== conflict_notification ===

This method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
.
.
.
end

After:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@reviewers_email_hash = Hash.new
.
.
.
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

=== edit ===

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@scores = @participant.scores(@questions)
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:26:45Z

Agohil: /* conflict_notification */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely:
1.GradesController
2.GradesHelper

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

=== calculate_all_penalties ===

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods:
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

=== conflict_notification ===

This method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
.
.
.
end

After:

def conflict_notification
.
.
.
@assignment = Assignment.find(@participant.parent_id)
#Refactored--> Replaced with a methood call
list_questions (@assignment)
@reviewers_email_hash = Hash.new
.
.
.
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

=== edit ===

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
##################################################################################
# @questions = Hash.new
# questionnaires = assignment.questionnaires
# questionnaires.each {
# |questionnaire|
# @questions[questionnaire.symbol] = questionnaire.questions
# }
##################################################################################
#Refactored--> Replaced with a methood call
list_questions (@assignment)
#################################################################################
@scores = @participant.scores(@questions)
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:18:37Z

Agohil: /* Expertiza */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on Ruby on Rails platform and it’s code is available on Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely:
1.GradesController
2.GradesHelper

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

=== calculate_all_penalties ===

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods:
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

=== conflict_notification ===

This method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
@subject = " Your "+@collabel.downcase+" score for " + @assignment.name + " conflicts with another "+@rowlabel.downcase+"'s score."
@body = get_body_text(params[:submission])
end

After:

def conflict_notification
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
##################################################################################
# @questions = Hash.new
# questionnaires = assignment.questionnaires
# questionnaires.each {
# |questionnaire|
# @questions[questionnaire.symbol] = questionnaire.questions
# }
##################################################################################
#Refactored--> Replaced with a methood call
list_questions (@assignment)
#################################################################################
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
@subject = " Your "+@collabel.downcase+" score for " + @assignment.name + " conflicts with another "+@rowlabel.downcase+"'s score."
@body = get_body_text(params[:submission])
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

=== edit ===

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
##################################################################################
# @questions = Hash.new
# questionnaires = assignment.questionnaires
# questionnaires.each {
# |questionnaire|
# @questions[questionnaire.symbol] = questionnaire.questions
# }
##################################################################################
#Refactored--> Replaced with a methood call
list_questions (@assignment)
#################################################################################
@scores = @participant.scores(@questions)
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-01T01:17:14Z

Agohil: /* calculate_all_penalties */

== Expertiza ==

Expertiza is an educational web application created and maintained by the joint efforts of the students and the faculty at NCSU. It’s an open source project developed on the Ruby on Rails platform and it’s code is available of Github. It allows students to review each other’s work and improve their work upon this feedback.

== Description of the current project ==

The following is an Expertiza based OSS project which deals primarily with the GradesController and GradesHelper. It focusses on refactoring some of the more complex methods, modifying some of the language to make it more Ruby friendly, removing some redundant code. The goal of this project is to attempt to make this part of the application easier to read and maintain.

== Files modified in current project ==

A controller and a helper file were modified for this project namely:
1.GradesController
2.GradesHelper

== GradesController ==

This is a controller that helps students and instructors view grades and reviews, update scores, check for grading conflicts and calculate penalties. A couple of long and complex methods were refactored from this controller along with removal of some non-functional code and a few language changes to make it Ruby style.
Three methods in particular, namely conflict_notification ,calculate_all_penalties and edit were found to be too long and were in need of refactoring into smaller, easier to manage methods. Few more compact methods were created for this purpose.

=== calculate_all_penalties ===

This is used to calculate various penalty values for each assignment if penalty is applicable.
This method was very complex, performing too many functions within a single method and had to be broken into 3 smaller methods each having a more well defined function.
This was split into the following three methods:
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties
Changes were also made to make the code follow ruby style. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

Before :
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants == true
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end
end
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end
unless @assignment.is_penalty_calculated
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

After:
def calculate_all_penalties(assignment_id)
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
………………………………………………………………………………………………………………………………………………………………
if calculate_for_participants
calculate_penatly_attributes(@participant) #Refactored#Removed
end
end
assign_all_penalties(@participant)
end
unless @assignment.is_penalty_calculated #Refactored#Removed
@assignment.update_attribute(:is_penalty_calculated, true)
end
end

def calculate_penatly_attributes(participant)
penalty_attr1 = {:deadline_type_id => 1,:participant_id => @participant.id, :penalty_points => penalties[:submission]}
CalculatedPenalty.create(penalty_attr1)
penalty_attr2 = {:deadline_type_id => 2,:participant_id => @participant.id, :penalty_points => penalties[:review]}
CalculatedPenalty.create(penalty_attr2)
penalty_attr3 = {:deadline_type_id => 5,:participant_id => @participant.id, :penalty_points => penalties[:meta_review]}
CalculatedPenalty.create(penalty_attr3)
end

def assign_all_penalties(participant)
@all_penalties[participant.id] = {}
@all_penalties[participant.id][:submission] = penalties[:submission]
@all_penalties[participant.id][:review] = penalties[:review]
@all_penalties[participant.id][:meta_review] = penalties[:meta_review]
@all_penalties[participant.id][:total_penalty] = @total_penalty
end

Removal of non-functional code :

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
unless penalties[:submission]
penalties[:submission] = 0
end
unless penalties[:review]
penalties[:review] = 0
end
unless penalties[:meta_review]
penalties[:meta_review] = 0
end
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

After:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)
@total_penalty = (penalties[:submission] + penalties[:review] + penalties[:meta_review])

Change of language to make it more Ruby friendly:

Before:

if(penalties[:submission] != 0 || penalties[:review] != 0 || penalties[:meta_review] != 0)

After:

unless(penalties[:submission].zero? || penalties[:review].zero? || penalties[:meta_review].zero? )

=== conflict_notification ===

This method is used to help the instructors decide if one of the reviews are unfair or inaccurate.
This was again split into 2 methods with some part of the code which is repeated in another method refactored into a new method.

Before:

def conflict_notification
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
@subject = " Your "+@collabel.downcase+" score for " + @assignment.name + " conflicts with another "+@rowlabel.downcase+"'s score."
@body = get_body_text(params[:submission])
end

After:

def conflict_notification
if session[:user].role_id !=6
@instructor = session[:user]
else
@instructor = Ta.get_my_instructor(session[:user].id)
end
@participant = AssignmentParticipant.find(params[:id])
@assignment = Assignment.find(@participant.parent_id)
##################################################################################
# @questions = Hash.new
# questionnaires = assignment.questionnaires
# questionnaires.each {
# |questionnaire|
# @questions[questionnaire.symbol] = questionnaire.questions
# }
##################################################################################
#Refactored--> Replaced with a methood call
list_questions (@assignment)
#################################################################################
@reviewers_email_hash = Hash.new
@caction = "view"
@submission = params[:submission]
if @submission == "review"
@caction = "view_review"
@symbol = "review"
process_response("Review", "Reviewer", @participant.reviews, "ReviewQuestionnaire")
elsif @submission == "review_of_review"
@symbol = "metareview"
process_response("Metareview", "Metareviewer", @participant.metareviews, "MetareviewQuestionnaire")
elsif @submission == "review_feedback"
@symbol = "feedback"
process_response("Feedback", "Author", @participant.feedback, "AuthorFeedbackQuestionnaire")
elsif @submission == "teammate_review"
@symbol = "teammate"
process_response("Teammate Review", "Reviewer", @participant.teammate_reviews, "TeammateReviewQuestionnaire")
end
@subject = " Your "+@collabel.downcase+" score for " + @assignment.name + " conflicts with another "+@rowlabel.downcase+"'s score."
@body = get_body_text(params[:submission])
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end

=== edit ===

This method is used to edit the questionnaires. This method again has code which is repeated in the conflict_notification method and thus the repeated section was split into a new method.

Before:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
@questions = Hash.new
questionnaires = @assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
@scores = @participant.scores(@questions)
end

After:
def edit
@participant = AssignmentParticipant.find(params[:id])
@assignment = @participant.assignment
##################################################################################
# @questions = Hash.new
# questionnaires = assignment.questionnaires
# questionnaires.each {
# |questionnaire|
# @questions[questionnaire.symbol] = questionnaire.questions
# }
##################################################################################
#Refactored--> Replaced with a methood call
list_questions (@assignment)
#################################################################################
@scores = @participant.scores(@questions)
end

#Refactored #Created a method which was a duplicate in conflict_notification and edit methods
def list_questions (assignment)
@questions = Hash.new
questionnaires = assignment.questionnaires
questionnaires.each {
|questionnaire|
@questions[questionnaire.symbol] = questionnaire.questions
}
end