Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-12-13T07:00:49Z

Ppkhawas: /* Our Work */

== Introduction ==
A “calibration assignment” is an assignment where the students are asked to review work that has also been reviewed by a member of the course staff. If the student’s review “resembles” the staff member’s review, then the student is presumed to be a competent reviewer. Here is a further description of calibration assignments. The instructor (or TA) adds a few extra participants to the assignment to set up calibration. The instructor (or TA) then impersonates the extra participants and submits work on behalf of each of the extra participants.

== Problem Statement ==

As of now, when one clicks on the copy button next to the assignment and a copy is created, you can observe that the calibration tab of the copied assignment renders no results at all.
An empty table is shown

[[File:networking.png|1200px]]

Having the instructor (or TA) impersonate the extra participants, and submit work on behalf of each of the extra participants is extra trouble. It would be nice if an instructor didn’t have to resubmit the same calibration submissions every semester. Copying the extra participants along with their teams, submissions, and responses when copying an assignment makes things much easier.

== Previous Submission ==

=== What was Done ===

They created a new class method that checks if the an assignment was calibrated and if it was, it calls methods from models. It performs the following:

# They copy all submission records with the assignment_id matching the original assignment.
# Copy all participants with the parent_id matching the original assignment ID.
# Copy all the teams with a parent_id matching the original assignment ID.
# Recreated mappings needed to associate participants with teams and review_response maps.
## Their copy methods for teams and participants return hash maps that are used to lookup previous mappings.
##Create new TeamsUsers. Associates participants with teams.
###Create new ReviewResponseMap. Associates reviewers and reviewees, linked to an assignment, together.
# Copy all review_responses, using the original review response map as the reference.

Their 'copy_calibrated_reviews' is called in the existing assignment_form class method 'copy', if the copied assignment is able to be saved (to avoid creating new records).

They also added methods for copy naming schemes so that the assignment model validates uniqueness of both the assignment name and directory_path.

=== Issues ===

'''Issue 1: Not all uses of class methods are good. '''

*self.copy_participants_for_assignment: copies old participants to new --> assignment_participant.rb, it is in teams_users.rb, which seems misplaced.

'''Issue 2: Returns a mapping from the old response map to the new response map.

*self.copy_review_response_map, returns a mapping from the old response map to the new response map. It is in review_response_map.rb. This can be an instance method. There is a copy_review_responses in this class too.

'''Issue 3: Code missing without causing a bug

*Line 65 of submit_hyperlink has missing code.

'''Issue 4: Old code not reused.'''

*New code was written to copy a team in teams_user.rb. There already exists code to copy a team.

'''Issue 5: No Automated tests written'''

=== Files Changed ===

'''assignment_form.rb'''
* Added a new method "copy_name" to name copied assignments. Where they changed the name of the copied assignments to “copy of copy” and "copy of copy of copy", etc to "Copy of <name> <copy number>"
* Added new method for copying objects needed to recreate calibration reviews

'''participant.rb'''
* Wrote a "createparticipant" method in assignment_participant in place of a similar method in participant.rb

'''response.rb'''
* Implemented a method for copying previous responses

'''response_map.rb'''
* Implemented a method to create ReviewResponse mapping based on mapping of copied assignment

'''submission_record.rb'''
* Added method for copying submission records of an assignment

'''teams_user.rb'''
* Added a method to create new teams_users so that new participants and teams are associated the same way they were for the previous assignment

'''assignment_participant.rb'''
* Added a method for copying extra participants, to not copy participants with type 'CourseParticipant'

== Design ==

=== Principles we plan to use ===

#DRY: We intend to write code that is written only once and utilised wherever needed.
#Single Responsibility: Our modules, classes and functions would have one responsibility.
#Open-Closed: We would try to ensure that there is minimum necessity to modify our code and at the same time make sure that there is an opportunity for extension.
#Law of Demeter: Our classes would be written in such a way that they do not have knowledge of the internal working of other objects. They would not manipulate other objects.
#Maximize Cohesion and minimize coupling: Our modules would be written to have low dependency on other modules while depending highly on its member functions.

=== Proposed Workflow ===

[[File:flowOSS2.png]]

=== Pseudocode ===
#Get Participant instructor_participant with user_id = assignment.instructor_id
#Create duplicate new_instructor_participant from instructor_participant
#Set new_instructor_participant.parent_id = new_assignment_id
#Save new_instructor_participant
#Get all ResponseMaps with reviewed_object = assignment.id and calibrate_to = True
#For each response_map
##Create duplicate new_response_map from response_map
##Set new_response_map.reviewed_object_id = new_assignment_id
##Find Team team where id = new_response_map.reviewee_id
##Create duplicate new_team from team
##Set new_team.parent_id = new_assignment_id
##Save new_team
##Set new_response_map.reviewer_id = new_instructor_participant.id
##Set new_response_map.reviewee_id = new_team.id
##Save new_response_map
##Copy members of team to new_team
##Get all TeamUsers where team_id = new_team.id
##For each team_user
###Get Participant participant where parent_id = assignment.id and user_id = team_user.user_id
###Create duplicate new_participant from participant
###Set new_participant.parent_id = new_assignment_id
###Save new_participant
##Get all SubmissionRecords with assignment_id = old_assignment_id and team_id = team.id
##For each submission_record
###Create duplicate new_submission_record from submission_record
###Set new_submission_record.assignment_id = new_assignment_id
###Set new_submission_record.team_id = new_team.id
###Save new_submission_record
##Get all Responses with map_id = response_map.id
##For each response
###Create duplicate new_response from response
###Set new_response.map_id = new_response_map.id
###Save new_response
###Get all Answers with response_id = response.id
###For each answer
####Create duplicate new_answer from answer
####Set new_answer.response_id = new_response.id
####Save new_answer

=== Planned Code Changes ===
'''app/models/assignment.rb'''
#Add an instance method copy_calibrated_responses_from(old_assignment) that copies submissions, teams, participants, and responses from a calibrated assignment to the assignment instance.
#Add an instance method copy_submissions_from(old_assignment) that copies SubmissionRecords from the old_assignment to the assignment.
#Add an instance method copy_participants_from(old_assignment) that copies Participants from the old_assignment to the assignment.
'''app/models/team.rb'''
#Add a method get_review_response_mappings() that retrieves all ReviewResponseMappings associated to a team.
'''app/models/review_response_map.rb'''
#Add a method get_response() that retrieves the response for the review response mapping.

== Our Work ==
=== Added Participant#copy_to_another_assignment(assignment) ===
This method copies a duplicate entry of itself to another assignment. This method will be used in multiple places ahead.
def copy_to_another_assignment(assignment)
new_participant = dup
new_participant.parent_id = assignment.id
new_participant.save
new_participant
end

=== Added Answer#copy_to_response(response) ===
This method copies a duplicate entry of itself to another response. This method will be used while copying all answers for a response.
def copy_to_response(response)
new_answer = dup
new_answer.response_id = response.id
new_answer.save
new_answer
end
=== Added Response#copy_to_another_response_map(response_map) ===
This method copies a duplicate entry of itself to another response map along with all the associated answers.
def copy_to_another_response_map(response_map)
new_response = dup
new_response.map_id = response_map.id
new_response.save
answers = Answer.where(response_id: id)
answers.each do |answer|
new_answer = answer.copy_to_response(new_response)
end
new_response
end
=== Added SubmissionRecord#copy_to_another_team(team) ===
This method copies a duplicate entry of itself to another team.
def copy_to_another_team(team)
new_submission_record = dup
new_submission_record.team_id = team.id
new_submission_record.assignment_id = team.parent_id
new_submission_record.save
new_submission_record
end
=== Added Team#copy_to_another_assignment(assignment) ===
This method copies a duplicate entry of itself to another assignment along with associated team users, team user nodes and creates participants for the team users if not created before. Team#copy_members is reused to comply with DRY principle.
def copy_to_another_assignment(new_assignment)
new_team = dup
new_team.parent_id = new_assignment.id
new_team.save
copy_members(new_team)
# Creates a new Participant for every User in the Team and associates the Participant to the new Assignment
team_users = TeamsUser.where(team_id: new_team.id)
team_users.each do |team_user|
# Checks if Participant for the new Assignment is missing for the given User
participant_missing = Participant.where(
parent_id: new_assignment.id, user_id: team_user.user_id
).first.nil?
if participant_missing
participant = Participant.where(parent_id: parent_id, user_id: team_user.user_id).first
participant.copy_to_another_assignment(new_assignment)
end
end
new_team
end
=== Added ResponseMap#copy_to_another_assignment(assignment) ===
This method copies a duplicate entry of itself to another assignment along with the reviewee team and its associated submission records, and the responses and its associated answers.
def copy_to_another_assignment(assignment, team, instructor_participant)
new_response_map = dup
new_response_map.reviewed_object_id = assignment.id
new_response_map.reviewer_id = instructor_participant.id
new_response_map.reviewee_id = team.id
new_response_map.save
submission_records = SubmissionRecord.where(assignment_id: reviewed_object_id, team_id: reviewee_id)
submission_records.each do |submission_record|
submission_record.copy_to_another_team(team)
end
responses = Response.where(map_id: id)
responses.each do |response|
response.copy_to_another_response_map(new_response_map)
end
new_response_map
end
=== Added Assignment#copy_calibrated_submissions(new_assignment) ===
This method is the key method in our solution to copying calibrated submissions for an assignment. The method creates a participant for the instructor to allow them to be reviewers and processes each calibration response map object.
def copy_calibration_submissions(new_assignment)
# Create Participant entry for instructors to allow them to become reviewers
instructor_participant = Participant.where(parent_id: id, user_id: instructor_id).first
new_instructor_participant = instructor_participant.copy_to_another_assignment(new_assignment)
response_maps = ResponseMap.where(reviewed_object_id: id, calibrate_to: 1)
response_maps.each do |response_map|
# Create a duplicate Team object from the Team associated with the ResponseMap object to add teams who's
# submissions were used for calibration in the previous Assignments
team = Team.where(id: response_map.reviewee_id).first
new_team = team.copy_to_another_assignment(new_assignment)
response_map.copy_to_another_assignment(new_assignment, new_team, new_instructor_participant)
end

Finally the call to Assignment#copy_calibrated_submissions was added in AssignmentForm::copy.
# Copies all calibration submissions along with Participants, Teams, TeamUsers, SubmissionRecords and Responses
# of the old assignment on to the new Assignment
old_assign.copy_calibration_submissions(new_assign)

== Test Plan ==

=== Testing Goals ===

The main goal of our testing is to ensure that when a new calibration assignment is added, all of the qualifying previous calibration submissions
and reviews are successfully copied over without overwriting any existing submissions.

=== Automated Testing using Rspec===

====Context====
When the original assignment to be copied is a calibrated assignment

====Behaviors to Verify====

For the copied assignment, we need to verify if:

1. All the submission records are copied from the old assignment to the new assignment.

2. Extra participants are copied.

3. All review responses are copied.

===Manual UI Testing===

This feature is accessible only by an instructor.

1. Log in as an instructor.

2. Go to Assignments and select an existing assignment.

3. Make sure that the assignment has a calibration tab since this feature handles only calibration assignments.

4. Click on the copy option next to the assignment name and this creates a copy of the assignment and a number is appended to the name in order to name the new copied assignment.

5. After the successful implementation of the feature, you should be able to click on the calibration tab of the copied assignment and this should enlist all the participants, submissions, and reviews.

6. This shows that the feature of copying submissions from old calibration assignments to new calibration assignments was successful.

== Team Information ==

=== Mentor ===
Dr. Ed Gehringer (efg@ncsu.edu)
=== Team Members ===
Pradyumna Khawas (ppkhawas@ncsu.edu) 
Abhimanyu Bellam (abellam2@ncsu.edu) 
Vishnu Vinod Erapalli (verapal@ncsu.edu) 

== Resources ==

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-12-13T06:57:52Z

Ppkhawas: Our Work

== Introduction ==
A “calibration assignment” is an assignment where the students are asked to review work that has also been reviewed by a member of the course staff. If the student’s review “resembles” the staff member’s review, then the student is presumed to be a competent reviewer. Here is a further description of calibration assignments. The instructor (or TA) adds a few extra participants to the assignment to set up calibration. The instructor (or TA) then impersonates the extra participants and submits work on behalf of each of the extra participants.

== Problem Statement ==

As of now, when one clicks on the copy button next to the assignment and a copy is created, you can observe that the calibration tab of the copied assignment renders no results at all.
An empty table is shown

[[File:networking.png|1200px]]

Having the instructor (or TA) impersonate the extra participants, and submit work on behalf of each of the extra participants is extra trouble. It would be nice if an instructor didn’t have to resubmit the same calibration submissions every semester. Copying the extra participants along with their teams, submissions, and responses when copying an assignment makes things much easier.

== Previous Submission ==

=== What was Done ===

They created a new class method that checks if the an assignment was calibrated and if it was, it calls methods from models. It performs the following:

# They copy all submission records with the assignment_id matching the original assignment.
# Copy all participants with the parent_id matching the original assignment ID.
# Copy all the teams with a parent_id matching the original assignment ID.
# Recreated mappings needed to associate participants with teams and review_response maps.
## Their copy methods for teams and participants return hash maps that are used to lookup previous mappings.
##Create new TeamsUsers. Associates participants with teams.
###Create new ReviewResponseMap. Associates reviewers and reviewees, linked to an assignment, together.
# Copy all review_responses, using the original review response map as the reference.

Their 'copy_calibrated_reviews' is called in the existing assignment_form class method 'copy', if the copied assignment is able to be saved (to avoid creating new records).

They also added methods for copy naming schemes so that the assignment model validates uniqueness of both the assignment name and directory_path.

=== Issues ===

'''Issue 1: Not all uses of class methods are good. '''

*self.copy_participants_for_assignment: copies old participants to new --> assignment_participant.rb, it is in teams_users.rb, which seems misplaced.

'''Issue 2: Returns a mapping from the old response map to the new response map.

*self.copy_review_response_map, returns a mapping from the old response map to the new response map. It is in review_response_map.rb. This can be an instance method. There is a copy_review_responses in this class too.

'''Issue 3: Code missing without causing a bug

*Line 65 of submit_hyperlink has missing code.

'''Issue 4: Old code not reused.'''

*New code was written to copy a team in teams_user.rb. There already exists code to copy a team.

'''Issue 5: No Automated tests written'''

=== Files Changed ===

'''assignment_form.rb'''
* Added a new method "copy_name" to name copied assignments. Where they changed the name of the copied assignments to “copy of copy” and "copy of copy of copy", etc to "Copy of <name> <copy number>"
* Added new method for copying objects needed to recreate calibration reviews

'''participant.rb'''
* Wrote a "createparticipant" method in assignment_participant in place of a similar method in participant.rb

'''response.rb'''
* Implemented a method for copying previous responses

'''response_map.rb'''
* Implemented a method to create ReviewResponse mapping based on mapping of copied assignment

'''submission_record.rb'''
* Added method for copying submission records of an assignment

'''teams_user.rb'''
* Added a method to create new teams_users so that new participants and teams are associated the same way they were for the previous assignment

'''assignment_participant.rb'''
* Added a method for copying extra participants, to not copy participants with type 'CourseParticipant'

== Design ==

=== Principles we plan to use ===

#DRY: We intend to write code that is written only once and utilised wherever needed.
#Single Responsibility: Our modules, classes and functions would have one responsibility.
#Open-Closed: We would try to ensure that there is minimum necessity to modify our code and at the same time make sure that there is an opportunity for extension.
#Law of Demeter: Our classes would be written in such a way that they do not have knowledge of the internal working of other objects. They would not manipulate other objects.
#Maximize Cohesion and minimize coupling: Our modules would be written to have low dependency on other modules while depending highly on its member functions.

=== Proposed Workflow ===

[[File:flowOSS2.png]]

=== Pseudocode ===
#Get Participant instructor_participant with user_id = assignment.instructor_id
#Create duplicate new_instructor_participant from instructor_participant
#Set new_instructor_participant.parent_id = new_assignment_id
#Save new_instructor_participant
#Get all ResponseMaps with reviewed_object = assignment.id and calibrate_to = True
#For each response_map
##Create duplicate new_response_map from response_map
##Set new_response_map.reviewed_object_id = new_assignment_id
##Find Team team where id = new_response_map.reviewee_id
##Create duplicate new_team from team
##Set new_team.parent_id = new_assignment_id
##Save new_team
##Set new_response_map.reviewer_id = new_instructor_participant.id
##Set new_response_map.reviewee_id = new_team.id
##Save new_response_map
##Copy members of team to new_team
##Get all TeamUsers where team_id = new_team.id
##For each team_user
###Get Participant participant where parent_id = assignment.id and user_id = team_user.user_id
###Create duplicate new_participant from participant
###Set new_participant.parent_id = new_assignment_id
###Save new_participant
##Get all SubmissionRecords with assignment_id = old_assignment_id and team_id = team.id
##For each submission_record
###Create duplicate new_submission_record from submission_record
###Set new_submission_record.assignment_id = new_assignment_id
###Set new_submission_record.team_id = new_team.id
###Save new_submission_record
##Get all Responses with map_id = response_map.id
##For each response
###Create duplicate new_response from response
###Set new_response.map_id = new_response_map.id
###Save new_response
###Get all Answers with response_id = response.id
###For each answer
####Create duplicate new_answer from answer
####Set new_answer.response_id = new_response.id
####Save new_answer

=== Planned Code Changes ===
'''app/models/assignment.rb'''
#Add an instance method copy_calibrated_responses_from(old_assignment) that copies submissions, teams, participants, and responses from a calibrated assignment to the assignment instance.
#Add an instance method copy_submissions_from(old_assignment) that copies SubmissionRecords from the old_assignment to the assignment.
#Add an instance method copy_participants_from(old_assignment) that copies Participants from the old_assignment to the assignment.
'''app/models/team.rb'''
#Add a method get_review_response_mappings() that retrieves all ReviewResponseMappings associated to a team.
'''app/models/review_response_map.rb'''
#Add a method get_response() that retrieves the response for the review response mapping.

== Our Work ==
=== Added Participant#copy_to_another_assignment(assignment) ===
This method copies a duplicate entry of itself to another assignment. This method will be used in multiple places ahead.
def copy_to_another_assignment(assignment)
new_participant = dup
new_participant.parent_id = assignment.id
new_participant.save
new_participant
end

=== Added Answer#copy_to_response(response) ===
This method copies a duplicate entry of itself to another response. This method will be used while copying all answers for a response.
def copy_to_response(response)
new_answer = dup
new_answer.response_id = response.id
new_answer.save
new_answer
end
=== Added Response#copy_to_another_response_map(response_map) ===
This method copies a duplicate entry of itself to another response map along with all the associated answers.
def copy_to_another_response_map(response_map)
new_response = dup
new_response.map_id = response_map.id
new_response.save
answers = Answer.where(response_id: id)
answers.each do |answer|
new_answer = answer.copy_to_response(new_response)
end
new_response
end
=== Added SubmissionRecord#copy_to_another_team(team) ===
This method copies a duplicate entry of itself to another team.
def copy_to_another_team(team)
new_submission_record = dup
new_submission_record.team_id = team.id
new_submission_record.assignment_id = team.parent_id
new_submission_record.save
new_submission_record
end
=== Added Team#copy_to_another_assignment(assignment) ===
This method copies a duplicate entry of itself to another assignment along with associated team users, team user nodes and creates participants for the team users if not created before. Team#copy_members is reused to comply with DRY principle.
def copy_to_another_assignment(new_assignment)
new_team = dup
new_team.parent_id = new_assignment.id
new_team.save
copy_members(new_team)
# Creates a new Participant for every User in the Team and associates the Participant to the new Assignment
team_users = TeamsUser.where(team_id: new_team.id)
team_users.each do |team_user|
# Checks if Participant for the new Assignment is missing for the given User
participant_missing = Participant.where(
parent_id: new_assignment.id, user_id: team_user.user_id
).first.nil?
if participant_missing
participant = Participant.where(parent_id: parent_id, user_id: team_user.user_id).first
participant.copy_to_another_assignment(new_assignment)
end
end
new_team
end
=== Added ResponseMap#copy_to_another_assignment(assignment) ===
This method copies a duplicate entry of itself to another assignment along with the reviewee team and its associated submission records, and the responses and its associated answers.
def copy_to_another_assignment(assignment, team, instructor_participant)
new_response_map = dup
new_response_map.reviewed_object_id = assignment.id
new_response_map.reviewer_id = instructor_participant.id
new_response_map.reviewee_id = team.id
new_response_map.save
submission_records = SubmissionRecord.where(assignment_id: reviewed_object_id, team_id: reviewee_id)
submission_records.each do |submission_record|
submission_record.copy_to_another_team(team)
end
responses = Response.where(map_id: id)
responses.each do |response|
response.copy_to_another_response_map(new_response_map)
end
new_response_map
end
=== Added Assignment#copy_calibrated_submissions(new_assignment) ===
This method is the key method in our solution to copying calibrated submissions for an assignment. The method creates a participant for the instructor to allow them to be reviewers and processes each calibration response map object.
def copy_calibration_submissions(new_assignment)
# Create Participant entry for instructors to allow them to become reviewers
instructor_participant = Participant.where(parent_id: id, user_id: instructor_id).first
new_instructor_participant = instructor_participant.copy_to_another_assignment(new_assignment)
response_maps = ResponseMap.where(reviewed_object_id: id, calibrate_to: 1)
response_maps.each do |response_map|
# Create a duplicate Team object from the Team associated with the ResponseMap object to add teams who's
# submissions were used for calibration in the previous Assignments
team = Team.where(id: response_map.reviewee_id).first
new_team = team.copy_to_another_assignment(new_assignment)
response_map.copy_to_another_assignment(new_assignment, new_team, new_instructor_participant)
end

== Test Plan ==

=== Testing Goals ===

The main goal of our testing is to ensure that when a new calibration assignment is added, all of the qualifying previous calibration submissions
and reviews are successfully copied over without overwriting any existing submissions.

=== Automated Testing using Rspec===

====Context====
When the original assignment to be copied is a calibrated assignment

====Behaviors to Verify====

For the copied assignment, we need to verify if:

1. All the submission records are copied from the old assignment to the new assignment.

2. Extra participants are copied.

3. All review responses are copied.

===Manual UI Testing===

This feature is accessible only by an instructor.

1. Log in as an instructor.

2. Go to Assignments and select an existing assignment.

3. Make sure that the assignment has a calibration tab since this feature handles only calibration assignments.

4. Click on the copy option next to the assignment name and this creates a copy of the assignment and a number is appended to the name in order to name the new copied assignment.

5. After the successful implementation of the feature, you should be able to click on the calibration tab of the copied assignment and this should enlist all the participants, submissions, and reviews.

6. This shows that the feature of copying submissions from old calibration assignments to new calibration assignments was successful.

== Team Information ==

=== Mentor ===
Dr. Ed Gehringer (efg@ncsu.edu)
=== Team Members ===
Pradyumna Khawas (ppkhawas@ncsu.edu) 
Abhimanyu Bellam (abellam2@ncsu.edu) 
Vishnu Vinod Erapalli (verapal@ncsu.edu) 

== Resources ==

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-12-13T06:36:11Z

Ppkhawas: Added Our Work Section

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-12-13T06:23:30Z

Ppkhawas: /* Pseudocode */

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-12-13T06:22:56Z

Ppkhawas: Updated Pseudocode

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-23T00:09:24Z

Ppkhawas: /* Pseudocode */

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-21T00:30:54Z

Ppkhawas: Updated Pseudocode

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-16T06:04:39Z

Ppkhawas: Added Planned Code Changes

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-16T05:00:17Z

Ppkhawas: Added Pseudocode

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-16T01:25:00Z

Ppkhawas: /* Design */

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-16T00:32:56Z

Ppkhawas: /* Previous Implementation */

CSC/ECE 517 Fall 2022 - E2284. Calibration submissions should be copied along with calibration assignments

2022-11-14T21:52:36Z

Ppkhawas: Minor Refactoring

Development:Setup:Linux:Debian

2022-11-06T20:24:36Z

Ppkhawas: Updating Ruby version from 2.1.5 to 2.3.1 (version used in production)

==Prerequisites==
* You must have shell access
* You must have root access (via sudo), or the required software must already be installed
==Install Git==
<pre style="white-space:normal;">sudo apt-get install git curl</pre>

==Get Expertiza==
====Expertiza Repository URLs====
* (ssh, read/write) git@github.com:expertiza/expertiza.git
* (https, read/write) https://github.com/expertiza/expertiza.git
* (git, read-only) git://github.com/expertiza/expertiza.git
====Default====
<pre style="white-space:normal;">git clone <remote></pre>
<pre style="white-space:normal;">git clone git@github.com:expertiza/expertiza.git</pre>
====Options====
<pre style="white-space:normal;">git clone -b <branch> <remote></pre>
<pre style="white-space:normal;">git clone -b production git@github.com:expertiza/expertiza.git</pre>
====To Rename the Central Remote====
<pre style="white-space:normal;">git remote rename <current_name> <desired_name></pre>
<pre style="white-space:normal;">git remote rename origin upstream</pre>

==Install RVM==
[https://rvm.io/rvm/install/ RVM Install]
====Single User Mode (Recommended)====
<pre style="white-space:normal;">\curl -L https://get.rvm.io | bash -s stable</pre>
=====Load RVM as a Function=====
<pre style="white-space:normal;">source ~/.rvm/scripts/rvm</pre>

====Multi User Mode (Not Recommended)====
<pre style="white-space:normal;">\curl -L https://get.rvm.io | sudo bash -s stable</pre>
=====Load RVM as a Function=====
<pre style="white-space:normal;">source /etc/profile</pre>

====Post-Installation====
=====Is RVM a Function?=====
<pre style="white-space:normal;">$ type rvm | head -1
rvm is a shell function</pre>
If not, try loading RVM as a function again. If it is still not a function, try reinstalling RVM.

=====Make sure all the dependencies are met for RVM=====
<pre style="white-space:normal;">rvm requirements</pre>
This will show a yum command. Run it to install the dependancies for Ruby.
For example:
<pre style="white-space:normal;">sudo apt-get --no-install-recommends -y install build-essential openssl libreadline6 libreadline6-dev curl git-core zlib1g zlib1g-dev libssl-dev libyaml-dev libsqlite3-dev sqlite3 libxml2-dev libxslt-dev autoconf libc6-dev libgdbm-dev ncurses-dev automake libtool bison subversion pkg-config libffi-dev</pre>

==Install Ruby v. 2.3.1==
<pre style="white-space:normal;">rvm install 2.3.1</pre>
<pre style="white-space:normal;">rvm use 2.3.1</pre>

==Create Expertiza Gemset (optional)==
<pre style="white-space:normal;">rvm use 2.3.1</pre>
<pre style="white-space:normal;">rvm gemset create expertiza</pre>
<pre style="white-space:normal;">rvm use 2.3.1@expertiza</pre>
====Create a .rvmrc File (optional)====
<pre style="white-space:normal;">echo 'rvm use 2.3.1@expertiza' > .rvmrc</pre>

==Install Native Expertiza Dependencies==
Dependencies are for the gems raspell, rjb, nokogiri, and mysql.
You may be prompted multiple times to set a root password for mysql. This password is up to you, but it can be left blank.
<pre style="white-space:normal;">sudo apt-get install openjdk-6-jre-headless openjdk-6-source mysql-client mysql-server libmysqlclient-dev libaspell-dev libpq-dev</pre>

==Install Bundled Gems==
Set JAVA_HOME for the rjb gem:
Your path may be different. You can generally find out the path by looking at the symbolic link at /etc/alternatives/java
<pre style="white-space:normal;">ls -la /etc/alternatives/java</pre>
This outputs something like '/usr/lib/jvm/java-6-openjdk-amd64/jre/bin/java'. Only part of this path may need to be set to JAVA_HOME. In this instance, it is '/usr/lib/jvm/java-6-openjdk-amd64'.
<pre style="white-space:normal;">export JAVA_HOME=/usr/lib/jvm/java-6-openjdk-amd64</pre>
<pre style="white-space:normal;">bundle install</pre>

==Setup Redis==
Please install redis on your machine and then run redis-server command.
These commands will help you run redis easily:
$ wget http://download.redis.io/releases/redis-4.0.1.tar.gz
$ tar xzf redis-4.0.1.tar.gz
$ cd redis-4.0.1
$ make
$ src/redis-server

==Set Up the Database==
====Enable and Start the MySql Daemon====
<pre style="white-space:normal;">sudo service mysqld enable</pre>
<pre style="white-space:normal;">sudo service mysqld start</pre>
====Set the MySql Root Password====
<pre style="white-space:normal;">mysqladmin -u root password</pre>
===Automatic Configuration===
<pre style="white-space:normal;">mysql -uroot < db/grant_expertiza.sql</pre>
===Manual Configuration===
====Log in to MySql====
<pre style="white-space:normal;">mysql -uroot -p</pre>
The following commands are executed inside mysql
====Create the Expertiza User====
<pre style="white-space:normal;">create user expertiza@localhost;</pre>

====Create the Databases====
<pre style="white-space:normal;">create database pg_development;</pre>
<pre style="white-space:normal;">create database pg_test;</pre>
====Grant Privileges to the Expertiza User====
<pre style="white-space:normal;">grant all on pg_development.* to expertiza@localhost;</pre>
<pre style="white-space:normal;">grant all on pg_test.* to expertiza@localhost;</pre>

==Build the Expertiza Database==
<pre style="white-space:normal;">rake db:migrate</pre>
<pre style="white-space:normal;">rake db:test:prepare</pre>
====Import Production Data (Optional)====
This step requires that you have your ssh private/public key pairs loaded in the production server under the rails user. 
[[How to Add SSH Keys to the Expertiza Production Server]] 
You must run the following command from your local Expertiza project directory.
<pre style="white-space:normal;">cap load_production_data</pre>

CSC/ECE 517 Fall 2022 - E2252. Refactor auth controller.rb & password retrieval controller.rb

2022-10-26T07:04:35Z

Ppkhawas: /* Changes to spec/controllers/password_retrieval_controller_spec.rb */

== Overview of Expertiza ==
Expertiza is an open source software written using Ruby on Rails which functions as a learning management software system. It has man different functions and abilities including the ability to create assignments, quizzes, assignment groups and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system for user authentication with different user roles and permissions that determine how each user interacts with the content. The <code>auth_controller.rb</code> and <code>password_retrieval_controller.rb</code> which are the files primarily addressed in this project are both critical controllers in providing this functionality.
== Description of Project ==
TODO: Describe the objectives of the project and what issues we were attempting to address.
<code>auth_controller</code> is used for authentication purposes.

The <code>password_retrieval_controller</code> deals with the process of updating and resetting a user password. The <code>send_password</code> method generates a token and appends it to a password reset URL. If a user submits a valid email address on the <code>password_retrieval/forgotten</code> view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the <code>password_retrieval/reset_password</code> view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that primarily look at the <code>update_password</code> method.

== Files Modified ==
=== Changes to <code>app/controllers/password_retrieval_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Updated <code>check_reset_url</code> method name to <code>check_token_validity</code>
|The method validates that the password reset token is valid and present. The updated method name provides a more functionally descriptive name.
|[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]
|-
|2
|Replaced repeated code in lines 35-36 and 62-63
|The use of repeated code violates the DRY principle and so it was moved to a new method.
|[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]
|-
|3
|Change token expiration time to constant in line 41
|This time should not be hardwired; it should be a constant or a parameter.
|[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]
|-
|4
|Reload page if email is nil or empty on <code>password_retrieval/forgotten</code> view
|An empty email parameter was causing the send password button to freeze.
|[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]
|-
|5
|Improve overall comments and rewrite error messages
|The comments and error messages in the controller need to be more meaningful, specific and clear.
|[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]
|}

=== Changes to <code>spec/controllers/password_retrieval_controller_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added two new RSpec tests for the <code>update_password</code> method
|There were no tests for the <code>update_password</code> method. We wanted to enhance the test suite of this controller by increasing the coverage of its Rspec tests.
|[https://github.com/expertiza/expertiza/commit/a90b1aada9878c7cdf7319dd022432cca8eadd2f Commit]
|-
|2
|Added two new RSpec tests for the <code>send_password</code> method to check nil or blank input for email
|There were no tests for the <code>send_password</code> method pertaining to checking invalid inputs in the request params
|[https://github.com/greyfiles/expertiza/commit/1d2d2d94ef730ab427bb326049bc5ec800a0dfc9 Commit] [https://github.com/greyfiles/expertiza/commit/781d6f42ca37829e0e514de8bcef1c85b2a035a2 Commit]
|-
|}

=== Changes to <code>config/routes.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Updated URL path and controller action to updated method name <code>check_token_validity</code>
|The action and URL path must be renamed to generate pathing to the controller method and views.
|[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]
|-
|}

=== Changes to <code>app/controllers/auth_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Move logger messages to <code>before_action</code> blocks wherever possible
|Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either <code>before_action</code> or <code>after_action</code> blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.
|[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]
|-
|2
|Replaced repeated code for re-caching the user role
|We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called <code>self.rebuild_role_cache</code>.
|[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]
|-
|3
|Improved helper function names
|Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.
|[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]
|}

== Testing ==
TODO: Show how the existing testing suite was passing before and after our refactoring - preserving functionality.

=== Testing <code>password_retrieval_controller.rb</code> ===
Before any refactoring to auth_controller.rb was done, we ran the rspec tests created for the controller with the following command: rspec spec/controllers/password_retrieval_controller_spec.rb

[[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

Tests prior to the changes covered 63.3% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]

After adding tests, the tests covered 91.1% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]

=== Testing <code>auth_controller_.rb</code> ===
Before any refactoring to <code>auth_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

After making all of the above changes to <code>auth_controller.rb</code>, we ran the rspec tests for the controller again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]

We have successfully preserved the passing tests after the improvements we made to the <code>auth_controller.rb</code>.

== Relevant Links ==
* '''Github Repository:''' https://github.com/greyfiles/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460
* '''VCL Server:''' http://152.7.98.115:8080/

== Contributors to this project ==
* Grey Files (unityid: mgfiles, github: greyfiles)
* Colin Odowd (unityid: cdodowd, github: colin-odowd)
* Pradyumna Khawas (unityid: ppkhawas, github: therealppk)

CSC/ECE 517 Fall 2022 - E2252. Refactor auth controller.rb & password retrieval controller.rb

2022-10-26T06:41:32Z

Ppkhawas: Added Rspec Coverage Reports

== Overview of Expertiza ==
Expertiza is an open source software written using Ruby on Rails which functions as a learning management software system. It has man different functions and abilities including the ability to create assignments, quizzes, assignment groups and topics, and also a complete mechanism for providing peer reviews and feedback for other groups and other teammates. Part of its functionality is a system for user authentication with different user roles and permissions that determine how each user interacts with the content. The <code>auth_controller.rb</code> and <code>password_retrieval_controller.rb</code> which are the files primarily addressed in this project are both critical controllers in providing this functionality.
== Description of Project ==
TODO: Describe the objectives of the project and what issues we were attempting to address.
<code>auth_controller</code> is used for authentication purposes.

The <code>password_retrieval_controller</code> deals with the process of updating and resetting a user password. The <code>send_password</code> method generates a token and appends it to a password reset URL. If a user submits a valid email address on the <code>password_retrieval/forgotten</code> view, the URL is sent to the user's email. When a user goes to the password reset URL, the token parameter is decrypted and checked for expiration. Next, the <code>password_retrieval/reset_password</code> view is loaded where a user enters an updated password and is sent back to the home page. In this project, the method was refactored in the following ways: to adhere to DRY principles, removal of hardwired constants, renaming of methods and variables, and enhanced comments. In addition, RSpec testing coverage of the controller was improved from 63.33% to 91.8% through a series of new tests that primarily look at the <code>update_password</code> method.

== Files Modified ==
=== Changes to <code>app/controllers/password_retrieval_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Updated <code>check_reset_url</code> method name to <code>check_token_validity</code>
|The method validates that the password reset token is valid and present. The updated method name provides a more functionally descriptive name.
|[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]
|-
|2
|Replaced repeated code in lines 35-36 and 62-63
|The use of repeated code violates the DRY principle and so it was moved to a new method.
|[https://github.com/expertiza/expertiza/commit/5429abd6fcb39f7bdbb0aaa1813f19c8101d7e25 Commit]
|-
|3
|Change token expiration time to constant in line 41
|This time should not be hardwired; it should be a constant or a parameter.
|[https://github.com/expertiza/expertiza/commit/3f0b51f6f2f106df8338483396a95d4068e39c7f Commit]
|-
|4
|Reload page if email is nil or empty on <code>password_retrieval/forgotten</code> view
|An empty email parameter was causing the send password button to freeze.
|[https://github.com/expertiza/expertiza/commit/70f77ac851b234f840709859dc1ee9d6725c34fc Commit]
|-
|5
|Improve overall comments and rewrite error messages
|The comments and error messages in the controller need to be more meaningful, specific and clear.
|[https://github.com/expertiza/expertiza/commit/1af745dc3b59641cb0266ebe49ee996718381fd0 Commit]
|}

=== Changes to <code>spec/controllers/password_retrieval_controller_spec.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Added two new RSpec tests for the <code>update_password</code> method
|There were no tests for the <code>update_password</code> method. We wanted to enhance the test suite of this controller by increasing the coverage of its Rspec tests.
|[https://github.com/expertiza/expertiza/commit/a90b1aada9878c7cdf7319dd022432cca8eadd2f Commit]
|-
|}

=== Changes to <code>config/routes.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Updated URL path and controller action to updated method name <code>check_token_validity</code>
|The action and URL path must be renamed to generate pathing to the controller method and views.
|[https://github.com/expertiza/expertiza/commit/3f9f63ab51e90743dfab0b860574aa9b673f2717 Commit]
|-
|}

=== Changes to <code>app/controllers/auth_controller.rb</code> ===
{| class="wikitable" style="width: 100%;
!  #  !! Change !! Rationale !! Commit Link
|-
|1
|Move logger messages to <code>before_action</code> blocks wherever possible
|Logger messages are inserted to log important events occurring in the code and do not relate directly to the logic. When possible, moving them to either <code>before_action</code> or <code>after_action</code> blocks makes the code more readable and easier to understand. It also separates the functionality of the method itself and the logging functionality.
|[https://github.com/greyfiles/expertiza/commit/7069f5d3cbfa2b7259e85e39dbfbf6fb41a0ce1d Commit]
|-
|2
|Replaced repeated code for re-caching the user role
|We noticed that although not listed on the recommended changes, this action involved exactly repeated code in the controller. The use of repeated code violates the DRY principle and so it was moved to a new method called <code>self.rebuild_role_cache</code>.
|[https://github.com/greyfiles/expertiza/commit/9ef20cffa0fe7b8440b97856a6db4b5351eece35 Commit]
|-
|3
|Improved helper function names
|Originally we made the new helper functions used in logging have unhelpful, confusing names. Making them more clear helps the code to be more understandable.
|[https://github.com/greyfiles/expertiza/commit/32f8435255add7b44b38fd747f81f435d331d14d Commit]
|}

== Testing ==
TODO: Show how the existing testing suite was passing before and after our refactoring - preserving functionality.

=== Testing <code>password_retrieval_controller.rb</code> ===
Before any refactoring to auth_controller.rb was done, we ran the rspec tests created for the controller with the following command: rspec spec/controllers/password_retrieval_controller_spec.rb

[[File:before_refactor_password_retrieval_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

Tests prior to the changes covered 63.3% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_before.png|center|frame|rspec test coverage report before the refactoring was completed]]

After adding tests, the tests covered 91.1% of <code>password_retrieval_controller.rb</code>.
[[File:E2252_password_retrieval_coverage_report_after.png|center|frame|rspec test coverage report after the refactoring was completed]]

=== Testing <code>auth_controller_.rb</code> ===
Before any refactoring to <code>auth_controller.rb</code> was done, we ran the rspec tests created for the controller with the following command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:before_refactor_auth_controller.png|center|frame|rspec tests all passing before the refactoring was completed]]

After making all of the above changes to <code>auth_controller.rb</code>, we ran the rspec tests for the controller again with the command: <code>rspec spec/controllers/auth_controller_spec.rb</code>

[[File:after_refactor_auth_controller.png|center|frame|rspec tests continuing to all pass after completing the refactoring]]

We have successfully preserved the passing tests after the improvements we made to the <code>auth_controller.rb</code>.

== Relevant Links ==
* '''Github Repository:''' https://github.com/greyfiles/expertiza
* '''Pull Request:''' https://github.com/expertiza/expertiza/pull/2460
* '''VCL Server:''' http://152.7.98.115:8080/

== Contributors to this project ==
* Grey Files (unityid: mgfiles, github: greyfiles)
* Colin Odowd (unityid: cdodowd, github: colin-odowd)
* Pradyumna Khawas (unityid: ppkhawas, github: therealppk)

File:E2252 password retrieval coverage report after.png

2022-10-26T06:38:53Z

Ppkhawas: The picture shows the coverage report after committing changes (E2252) to password_retrieval_controller.rb.

The picture shows the coverage report after committing changes (E2252) to password_retrieval_controller.rb.

File:E2252 password retrieval coverage report before.png

2022-10-26T06:37:56Z

Ppkhawas: The picture shows the coverage report before committing changes to password_retrieval_controller.rb.

The picture shows the coverage report before committing changes to password_retrieval_controller.rb.