Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-10T01:57:38Z

Bradhak: /* Solutions Implemented and Delivered */

File:Latest2.png

2015-11-10T01:35:26Z

Bradhak:

File:Latest1.png

2015-11-10T01:35:12Z

Bradhak:

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:28:48Z

Bradhak: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:26:50Z

Bradhak: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:26:14Z

Bradhak: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:24:14Z

Bradhak: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:23:00Z

Bradhak: /* Solutions Implemented and Delivered */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:18:00Z

Bradhak: /* Solutions Implemented and Delivered */

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.

The following changes were made:

1.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.

2.The following 3 methods were created after splitting the first method
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties

3. Changes were also made to make the code follow ruby style.The language was made more ruby friendly.

4. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

[[File:Change6_new.png]]

Removal of non-functional code :

[[File:Change5_new.png]]

Change of language to make it more Ruby friendly:

[[File:Change1_new.png]]
*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.

File:Change1 new.png

2015-11-07T05:16:02Z

Bradhak:

File:Change2 new.png

2015-11-07T05:15:49Z

Bradhak:

File:Change3 new.png

2015-11-07T05:15:39Z

Bradhak:

File:Change4 new.png

2015-11-07T05:15:26Z

Bradhak:

File:Change5 new.png

2015-11-07T05:15:15Z

Bradhak: uploaded a new version of "File:Change5 new.png"

File:Change5 new.png

2015-11-07T05:09:48Z

Bradhak:

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T05:09:34Z

Bradhak: /* Solutions Implemented and Delivered */

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.

The following changes were made:

1.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.

2.The following 3 methods were created after splitting the first method
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties

3. Changes were also made to make the code follow ruby style.The language was made more ruby friendly.

4. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

[[File:Change6_new.png]]

Removal of non-functional code :

[[File:Change5_new.png]]

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-07T05:07:38Z

Bradhak: /* Solutions Implemented and Delivered */

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.

The following changes were made:

1.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.

2.The following 3 methods were created after splitting the first method
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties

3. Changes were also made to make the code follow ruby style.The language was made more ruby friendly.

4. Finally some redundant code was commented out as it was non-functional.

Refactoring into smaller more specific methods:

[[File:Change6_new.png]]

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.

File:Change6 new.png

2015-11-07T05:03:40Z

Bradhak: uploaded a new version of "File:Change6 new.png"

File:Change6 new.png

2015-11-07T05:03:28Z

Bradhak:

File:Change6.png

2015-11-07T04:52:29Z

Bradhak:

File:Change5.png

2015-11-07T04:52:13Z

Bradhak:

File:Change4.png

2015-11-07T04:52:00Z

Bradhak:

File:Change3.png

2015-11-07T04:51:48Z

Bradhak:

File:Change2.png

2015-11-07T04:51:36Z

Bradhak:

File:Change1.png

2015-11-07T04:51:22Z

Bradhak:

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T04:41:07Z

Bradhak: /* Solutions Implemented and Delivered */

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.

The following changes were made:

1.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.

2.The following 3 methods were created after splitting the first method
i. calculate_all_penalties
ii. calculate_penatly_attributes
iii. assign_all_penalties

3. Changes were also made to make the code follow ruby style.The language was made more ruby friendly.

4. 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:30:25Z

Bradhak: /* calculate_all_penalties */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-11-07T04:29:06Z

Bradhak: /* calculate_all_penalties */

CSC/ECE 517 Fall 2015/oss E1566 ARB

2015-10-31T23:04:33Z

Bradhak: /* 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 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)
##################################################################
# 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])

Change of language to make it more Ruby friendly:

Before:

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

After:

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

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-10-31T23:04:05Z

Bradhak: Created page with "== 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 ..."

CSC/ECE 517 Fall 2015

2015-10-31T22:33:25Z

Bradhak: /* Writing Assignment 2 */

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]
*[[CSC/ECE 517 Fall 2015/oss/M1502/AAAASS]]
*[[CSC/ECE 517 Fall 2015/oss/M1503/IntegrateXMLParser]]
*[[CSC/ECE_517_Fall_2015/ossE1568BZHXJS]]
*[[CSC/ECE_517_Fall_2015/ossE1572VGA]]
*[[CSC/ECE_517_Fall_2015/oss_E1573_sap]]
*[[CSC/ECE 517 Fall 2015/oss E1559 rrz]]
*[[CSC/ECE 517 Fall 2015/oss E1570 avr]]
*[[CSC/ECE 517 Fall 2015/oss E1556 CHM]]
*[[CSC/ECE 517 Fall 2015/oss M1504 JJD]]
*[[CSC/ECE 517 Fall 2015/oss E1562 APS]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss M1501 GSN]]
*[[CSC/ECE 517 Fall 2015/oss E1550 KMM]]
*[[CSC/ECE 517 Fall 2015/oss E1551 RGS]]
*[[CSC/ECE 517 Fall 2015/oss E1555 GMR]]
*[[CSC/ECE 517 Fall 2015/oss E1552 NRR]]
*[[CSC/ECE 517 Fall 2015/oss E1565 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1561 WZL]]
*[[CSC/ECE 517 Fall 2015/oss E1553 AAJ]]
*[[CSC/ECE 517 Fall 2015/oss E1554 AAR]]
*[[CSC/ECE 517 Fall 2015/oss E1569 JNR]]
*[[CSC/ECE 517 Fall 2015/oss E1560 PSV]]
*[[CSC/ECE 517 Fall 2015/oss M1505 MSV]]
*[[CSC/ECE 517 Fall 2015/oss E1557 GXM]]
*[[CSC/ECE 517 Fall 2015/oss E1566 ARB]]
*[[CSC/ECE 517 Fall 2015/oss E1567 APT]]