Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016 E1678: Review configuration options

2016-12-11T06:57:50Z

Smurali8: /* Requirement 5 */

=Introduction=
Expertiza is an online system that is used by students to view/submit assignments and review others' work. Expertiza also provides tools to visualize the scores and gauge the improvements made during the course semester. It also facilitates and monitors team projects. It is targeted at educational and non-profit organizations. The project is funded by the National Software Foundation (NSF), NCSU Learning in a Technology-Rich Environment (LITRE) program, the NCSU Faculty Center for Teaching and Learning, the NCSU STEM Initiative, and the Center for Advanced Computing and Communication.
Expertiza is an open-source project with the source code available as a public repository on GitHub. It is developed using Ruby on Rails and is increasingly becoming robust thanks to the innumerable bugs being fixed by the community. The project has a micro-blog on SourceForge where the developer community report bugs and document updates.

=Task Description=
==Requirement 1==
===Problem===
Expertiza has two kinds of review strategies, as specified in the Review Strategy tab of assignment creation:
;Auto-selected: Reviews are not preassigned, but when a student comes to do a review, (s)he can select from the reviews that are available at that point.
;Instructor-selected:
Instructor decides in advance who reviews whom.Until now, when the strategy is auto-selected, there has been no maximum on the number of reviews a student could select. So students can review as many topics as they want.

===Requirement===
Set a maximum on the number of reviews a student can choose with auto-selected reviewing. Implement a maximum, and allow the instructor to set that maximum via a checkbox asking whether there is a maximum, and if the box is checked, a textbox to specify what the maximum number should be.If there is a maximum, and a reviewer has already selected the maximum number of reviews, the button that allows selecting an additional review should be disabled.

===Design===
This requirement needs changes to the instructor view and student’s review page. These are small changes to the existing code. So we didn’t find any design pattern which can be used as part of requirement.
;Instructor view changes
:While creating the assignment, instructor should be able to specify maximum on the number of reviews done by each student. Assignment related configurations are handled by '''edit''' method in the '''assignment_controller'''. This method gathers all the information and calls '''edit''' view to display results. We added checkbox for this selection under '''Review Strategy''' tab of instructor view. If the instructor selects this checkbox, he’ll be prompted to enter the value for the maximum reviews allowed for each student. This threshold value is stored in '''num_reviews''' column of '''Assignment''' table. All these codes are part of '''assignments/edit/review_strategy''' file since it displays all the elements in '''Review strategy''' tab. Controller stores these values in '''assignments''' database. There are no changes to assignments controller. Instructor view looks as shown below.

[[File:R1iview.png |frame|upright=0.5|center|Requirement 1 - Instructor View Changes]]
;Student Topic Review page changes:
:Students review topics page is displayed by '''list''' method of '''Student_review_controller'''. We added a check in the controller to see if the chosen number of topics exceeds the value set by the instructor. Topic selection will be disabled in '''views/student_review/_set_dynamic_review.html.erb''' file if the selected number of topics exceeds configured maximum value as shown below.

[[File:Stview.png |frame|upright=0.5|center|Requirement 1 - Student View Changes]]

==Requirement 2==
===Problem===
Current behaviour of expertiza doesn’t allow the students to drop the reviews. If the student selects some topic and want to drop for some reason, he/she need to contact instructor to drop that review.

===Requirement===
Allow students to drop reviews. When a student has selected a review, there should be a button allowing the student to drop the review. But student should only be able drop a review if the review has not already been submitted.

===Design===
;Student Topic Review page changes:
:Students review topics page is displayed by list method of '''Student_review_controller'''. '''List.html.erb''' file calls '''/views/student_review/_responses.html.erb''' partial to display already selected topics. Add a delete symbol to the review topics if the assignment stage is not '''“finished”''' and review is '''“not submitted”'''.

[[File:Drop.png |frame|upright=0.5|center|Requirement 2 - Allow students to drop reviews]]
[[File:Drop1.png |frame|upright=0.5|center|Requirement 2 - Allow students to drop reviews only if Review has not been submitted.]]

;Student_review_controller changes:
:Add destroy method to student_review controller. This method should track down the corresponding response map for the topic that needs to be dropped and then delete it.

==Requirement 3==
===Problem===
While creating the assignments instructor can allow students to see their teammate score by selecting '''Show teammate reviews?''' checkbox. But this option shows both the scores and teammate reviews on the '''grades/view_my_score''' page.

===Requirement===
Instructor should get finer level control to specify these options like '''show only teammate reviews and not scores''', '''show only teammate scores but not reviews''', '''Don’t show anything'''

===Design===
There is already existing code to display and hide the teammate reviews. This requirement doesn’t need any design patterns since we need to modify small portion of the existing code.
;Instructor view changes
:General tab of assignment creation has '''"show teammate reviews ?"''' option. We replaced this option with two options. '''"show teammate scores ?"''' , '''"show teammate reviews?"'''. '''"Show teammate reviews ?"''' checkbox value is stored in '''show_teammate_reviews''' column in the '''Assignments''' table. We added one more boolean column '''show_teammate_score''' to hold the selection value of '''"show teammate scores ?"''' option. This is how instructor view will change after implementation.
[[File:Iview.png |frame|upright=0.5|center|Requirement 3 - Instructor View Changes]]

;Changes to students view score page:
:Code to display teammate reviews and scores is present in the '''/views/grades/view_my_scores''' file. We added a code to selectively display scores and reviews based on the boolean variables ( show_teammate_reviews, show_teammate_score) present in the Assignments database table. If the instructor only selects '''show teammate scores?''' student will be able to see aggregate teammate score as shown below.
[[File:Sscore.png |frame|upright=0.5|center|Requirement 3 - Show aggregate teammate scores]]
Students will be able to see only reviews if the instructor selects '''show teammate reviews ?''' during assignment creation.
[[File:Rstudent.png |frame|upright=0.5|center|Requirement 3 -Show only teammate reviews]]
Students will be able to see both the score and teammate reviews if the instructors checks both boxes from assignment configuration page.

==Requirement 4==
===Problem===
There is no option that lets reviewers see others’ reviews of the same work after they submit their review of that work.

===Requirement===
Implement an option that lets reviewers see others’ reviews of the same work, after they submit their review of that work. This could help reviewers learn from other reviewers of the same work.

===Design===
This option should be specified in a reasonable way on the Create Assignment page. So we didn’t find any design pattern which can be used as part of requirement 4, but we re-used code that displays reviews submitted by student for a chosen topic.

;Instructor view changes:
:While creating the assignment, instructor should be able to specify if students should be allowed to see reviews done by other students for the same work. Assignment related configurations are handled by '''edit''' method in the '''assignment_controllers'''. This method gathers all the information and calls '''edit''' view to display results.We are planning to add checkbox '''show_other_reviews''' for this selection under '''General''' tab of instructor view. If the instructor selects this checkbox, this feature will be active for the assignment. The checkbox will be added in the "assignments/edit/_general" file since It displays all the elements in '''General''' tab. '''show_other_reviews''' will be a hidden form field that stores the value of this checkbox that is finally persisted in '''assignments''' database.

[[File:Instructor review others.png |frame|upright=0.5|center|Requirement 4 - Instructor view to allow students to review others work]]

;Changes to student_response controller and views:
:The ''View'' link displays the submitted/in progress reviews of the student and is handled by the list action of the StudentReviewController (student_review_controller.rb) and the associated list view is "/views/student_review/list.html.erb" file. We plan to add another link ''Other Reviews'' to the partial '''_reponses''' view. This link would be visible only if the '''show_other_reviews''' option has been enabled by the instructor and the review for the topic has been submitted by the student. This link would be next to each of the Review Topics submitted by the student of that assignment. Clicking this link would be handled by an action '''other_reviews''' of the '''reponse_controller'''(response_controller.rb). After fetching some necessary query parameters the action method would filter responses submitted by other students for that topic and all rounds, exclude the response of the logged in student and set some instance variables. These instance variables would be displayed in the new view '''other_reviews''' in (views/response/other_reviews.erb).

[[File:View other reviews.png |frame|upright=0.5|center|Requirement 4 - Student view - link to view other submitted reviews]]

[[File:Other student responses.png |frame|upright=0.5|center|Requirement 4 - Student view - Reviews submitted by other reviewers for the same work]]

==Requirement 5==
===Problem===
The existing implementation of expertiza doesn’t provide a student the option to not see review scores or the text feedback. Sometimes a student might just want to see the scores and not the reviews and other times might want to see the reviews and not the scores. The ability to turn off either one is not provided by expertiza.

===Requirement===
When a student signs in there should be an option that allows the students to change the review score settings. The students will be provided with options of choosing either viewing only the review score or viewing only the text feedback or viewing both.

===Design===
;Database Changes:
:In the participants table, we add a new field called reviewsetting which contains details about the student's chosen review setting. If the value is set to 0 then the student can view both scores and feedback, if the value is set to 1 then the student can view only the scores and if the value is set to 2, then the student can view only the feedback. By default, the value is set to 0.
;Participant Controller Changes:
:In the participants controller a new method is introduced to handle the change in the reviewsetting value. The controller is in charge of updating the value in the database based on the option selected by the student.
;Student View Task page changes:
:In the student task view, the page where the student can submit work, view scores, review others, etc. we added a new option for the student to change review settings. Clicking on that link takes the student to the change_reviewsettings page where the student can choose to either view both scores and feedback or just scores or feedback.
;Review page changes:
:In the partial to view the reviews _review.html.erb, conditions have been added to check the value of the reviewsetting variable. Based on the value of the variable, either both the scores and feedback or just the scores or just the feedback is displayed to the student.

CSC/ECE 517 Fall 2016 E1678: Review configuration options

2016-11-10T02:52:54Z

Smurali8: /* Design */

=Introduction=
Expertiza is an online system that is used by students to view/submit assignments and review others' work. Expertiza also provides tools to visualize the scores and gauge the improvements made during the course semester. It also facilitates and monitors team projects. It is targeted at educational and non-profit organizations. The project is funded by the National Software Foundation (NSF), NCSU Learning in a Technology-Rich Environment (LITRE) program, the NCSU Faculty Center for Teaching and Learning, the NCSU STEM Initiative, and the Center for Advanced Computing and Communication.
Expertiza is an open-source project with the source code available as a public repository on GitHub. It is developed using Ruby on Rails and is increasingly becoming robust thanks to the innumerable bugs being fixed by the community. The project has a micro-blog on SourceForge where the developer community report bugs and document updates.

=Task Description=
==Requirement 1==
===Problem===
Expertiza has two kinds of review strategies, as specified in the Review Strategy tab of assignment creation:
;Auto-selected: Reviews are not preassigned, but when a student comes to do a review, (s)he can select from the reviews that are available at that point.
;Instructor-selected:
Instructor decides in advance who reviews whom.Until now, when the strategy is auto-selected, there has been no maximum on the number of reviews a student could select. So students can review as many topics as they want.

===Requirement===
Set a maximum on the number of reviews a student can choose with auto-selected reviewing. Implement a maximum, and allow the instructor to set that maximum via a checkbox asking whether there is a maximum, and if the box is checked, a textbox to specify what the maximum number should be.If there is a maximum, and a reviewer has already selected the maximum number of reviews, the button that allows selecting an additional review should be disabled.

===Design===
This requirement needs changes to the instructor view and student’s review page. These are small changes to the existing code. So we didn’t find any design pattern which can be used as part of requirement.
;Instructor view changes
:While creating the assignment, instructor should be able to specify maximum on the number of reviews done by each student. Assignment related configurations are handled by '''edit''' method in the assignment_controllers. This method gathers all the information and calls '''edit''' view to display results. We are planning to add checkbox for this selection under '''Review Strategy''' tab of instructor view. If the instructor selects this checkbox, he’ll be prompted to enter the value for the maximum reviews allowed for each student. We need to fill this value in '''num_reviews''' column of Assignment model. All these codes will be added in '''assignments/edit/review_strategy''' file since it displays all the elements in '''Review strategy''' tab. Controller stores these values in '''assignments''' database. There are no changes assignments controller.
;Student Topic Review page changes:
:Students review topics page is displayed by list method of '''Student_review_controller'''. Add a check in the controller to see if the chosen number of topics exceeds the value set by the instructor. Disable topic selection in '''views/student_review/_set_dynamic_review.html.erb''' file if the selected number of topics exceeds configured maximum value.

==Requirement 2==
===Problem===
Current behaviour of expertiza doesn’t allow the students to drop the reviews. If the student selects some topic and want to drop for some reason, he/she need to contact instructor to drop that review.

===Requirement===
Allow students to drop reviews. When a student has selected a review, there should be a button allowing the student to drop the review. But student should only be able drop a review if the review has not already been submitted.

===Design===
;Student Topic Review page changes:
:Students review topics page is displayed by list method of '''Student_review_controller'''. '''List.html.erb''' file calls '''/views/student_review/_responses.html.erb''' partial to display already selected topics. Add a delete symbol to the review topics if the assignment stage is not '''“finished”''' and review is '''“not submitted”'''.
;Student_review_controller changes:
:Add destroy method to student_review controller. This method should delete signed up topic for the user/team from '''signed_up_teams''' table. And also it deletes all the non submitted responses from '''response_maps''' table recorded by that team so far.

==Requirement 3==
===Problem===
While creating the assignments instructor can allow students to see their teammate score by selecting '''Show teammate reviews?''' checkbox. But this option shows both the scores and teammate reviews on the '''grades/view_my_score''' page.

===Requirement===
Instructor should get finer level control to specify these options like '''show only teammate reviews and not scores''', '''show only teammate scores but not reviews''', '''Don’t show anything'''

===Design===
There is already existing code to display and hide the teammate reviews. This requirement doesn’t need any design patterns since we need to modify small portion of the existing code.
;Instructor view changes
:General tab of assignment creation has '''"show teammate reviews ?"''' option. Replace this option with two options. '''"show teammate scores ?"''' , '''"show teammate reviews?"'''. '''"Show teammate reviews ?"''' value will be stored in '''show_teammate_reviews''' column in the '''Assignments''' table. We will add one more boolean column '''show_teammate_score''' to hold the selection value of '''"show teammate scores ?"''' option.
;Changes to students view score page:
:Code to display teammate reviews and scores is present in the '''/views/grades/view_my_scores''' file. We will add a code to selectively display scores and reviews based on the boolean variables ( show_teammate_reviews, show_teammate_score) present in the Assignments database table

==Requirement 4==
===Problem===
There is no option that lets reviewers see others’ reviews of the same work after they submit their review of that work.

===Requirement===
Implement an option that lets reviewers see others’ reviews of the same work, after they submit their review of that work. This could help reviewers learn from other reviewers of the same work.

===Design===
This option should be specified in a reasonable way on the Create Assignment page. So we didn’t find any design pattern which can be used as part of requirement 4.

;Instructor view changes:
:While creating the assignment, instructor should be able to specify if students should be allowed to see reviews done by other students for the same work. Assignment related configurations are handled by '''edit''' method in the '''assignment_controllers'''. This method gathers all the information and calls '''edit''' view to display results.We are planning to add checkbox for this selection under '''Review Strategy''' tab of instructor view. If the instructor selects this checkbox, this feature will be active for the assignment.All these codes will be added in "assignments/edit/review_strategy" file since It displays all the elements in '''Review strategy''' tab. Controller will have an instance variable that stores the value of this checkbox that finally is stored in '''assignments''' database.

;Changes to student_review controller and views:
:Code that displays the student reviews is handled by the list action of the '''StudentReviewController''' (student_review_controller.rb) and the associated list view is "/views/student_review/list.html.erb" file. The '''@metareview_mappings''' refers to the reviews submitted by the student. We will check if the checkbox is checked for the assignment and if yes, will create another instance variable in the list action of the controller that queries reviews submitted for the same work by other students. We will also add a block of code in the list view that renders this data returned by this instance variable.

==Requirement 5==
===Problem===
The existing implementation of expertiza doesn’t provide a student the option to not see review scores or the text feedback. Sometimes a student might just want to see the scores and not the reviews and other times might want to see the reviews and not the scores. The ability to turn off either one is not provided by expertiza.

===Requirement===
When a student signs in there should be an option that allows the students to change the review score settings. The students will be provided with options of choosing either viewing only the review score or viewing only the text feedback or viewing both.

===Design===
;Student View Scores page changes:
:Student review scores is displayed in the View Score page and the /views/grades/view_my_score.html.erb file handles this operation. In this view we plan to provide a dropdown list in which the student can select if he/she wants to view scores only, view feedback only or both. The default setting will be to view both.
;Grades Controller changes:
:The view_my_score method in the grades controller performs the task of retrieving the scores and feedback from the database and also does various additional functions like calculating average, etc. In this method, based on the option chosen by the student either only scores or text feedback or both will be retreived. If the student does not explicitly specify any option then both the scores and feedback will be fetched.

CSC/ECE 517 Fall 2016 E1678: Review configuration options

2016-11-10T01:20:55Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-05T05:58:52Z

Smurali8:

= E1637: Refactor penalty_helper.rb and late_policies_controller.rb =
== Expertiza ==
[http://expertiza.ncsu.edu/ Expertiza] is an educational web application built on [http://rubyonrails.org/ Ruby on Rails] framework. It provides functionality for the instructor to create assignments for a specific course. The students can sign up for a list of topics created by the instructor. Expertiza allows students to form teams and work together. Students can provide feedback to assignments and projects submitted by other students. The students can also provide reviews about each individual member in their team as well. The numerous functionalities provided by expertiza makes the process of assignment submission, feedback and management much simpler and for the students and the instructors.
== Motivation ==
This project deals with LatePoliciesController and PenaltyHelper files. It focuses on calculating a penalty which would be deducted from the total score obtained by the student if the student submits the assignment or review past the specified deadline. The goal of our project is to make the task of calculating and deducting penalties function perfectly and also refactor the code to make it more intuitive and modular.
== Files Modified ==
The files modified for the penalty functionality to work are as follows,
=== Controllers ===
==== LatePolicyController ====
This controller contains the functions to create, update and delete a late policy. The instructor can create a late policy for any assignment, where in the instructor can specify the points per unit and the maximum penalty that can be applied for a particular assignment. The create and the update functions in this module were very long and it had to be refactored so that the code was modular.
==== GradesController ====
In grades controller, the total penalty was not getting deducted from the total score due to the mismatch of conditions. The conditions were modified in this controller for the penalty to be deducted from the total score obtained.
=== Helpers ===
==== PenaltyHelper ====
This helper file has functions to calculate submission, review and metareview penalties. This function was not returning the values of the calculated penalty as required and modifications were made so that the correct penalty values are returned.
=== Views ===
In the current implementation, the penalty deducted is not displayed when a student views scores. The views were modified so that the deducted penalties and total score are displayed appropriately. The list of views modified are as follows,
*_participant.html.erb
*_participant_charts.html.erb
*_participant_title.html.erb
=== Rspec Testing ===
==== LatePolicy Model Testing ====
Rspec tests were written to test the functionality of the LatePolicy model. The tests ensure that the attributes in the model obtain the correct value. In addition, the tests also ensure that none of the fields are empty and ensures the maximum penalty and penalty per unit is a positive number which lies in a specified range.

== List of Tasks ==
*T1: Refactor the create function in LatePoliciesController to make the code more modular
*T2: Refactor the update function in LatePoliciesController to make the code more modular
*T3: Modify the PenaltyHelper to calculate and return the correct penalty value
*T4: Modify the GradesController to deduct the total penalty from the total score
*T5: Modify the ViewScores page to display the penalties deducted
*T6: Test the working of the LatePolicy model by writing necessary RSpec tests

== Implementation of Tasks ==
=== T1: Refactor create function in LatePoliciesController ===
The create function performed various checks on the parameters passed from the form instead of calling appropriate functions to do them. The same checks were performed by the update function. This violated the DRY principle. To overcome this discrepancy, two functions were created namely, validate_penalty_unit and validate_duplicate_policy which perform the required checks.
==== validate_penalty_unit ====
This function checks that the penalty per unit is less than the maximum penalty. If this function returns fall, the LatePolicy will not be created.
<pre>
private def validate_penalty_unit(params)
penalty_valid = false
if params[:late_policy][:max_penalty].to_i < params[:late_policy][:penalty_per_unit].to_i
flash[:error] = "The maximum penalty cannot be less than penalty per unit."
else
penalty_valid = true
end
penalty_valid
end
</pre>
==== validate_duplicate_policy ====
This function checks that another policy with the same name created by a different instructor does not exist. Duplicate policy names are permissable if created by the same instructor.
<pre>
private def validate_duplicate_policy(params)
not_duplicate = false
@late_policy = LatePolicy.where(policy_name: params[:late_policy][:policy_name])
if !@late_policy.nil? && !@late_policy.empty?
@late_policy.each do |p|
if p.instructor_id != instructor_id
flash[:error] = "A policy with the same name already exists."
return not_duplicate
end
end
end
not_duplicate = true
not_duplicate
end
</pre>
=== T2: Refactor the update function in LatePoliciesController ===
The update function performs the same checks as the create function. The check statements are replaced by the appropriate calls to validate_penalty_unit and validate_duplicate_policy. In addition, when the late policy is updated, the corresponding penalty calculations have to be updated for students enrolled in assignments using the corresponding late policy. So a new function called values_update is introduced which performs the necessary task.
==== values_update ====
<pre>
private def values_update(params)
@penaltyObjs = CalculatedPenalty.all
@penaltyObjs.each do |pen|
@participant = AssignmentParticipant.find(pen.participant_id)
@assignment = @participant.assignment
next unless @assignment.late_policy_id == @penalty_policy.id
@penalties = calculate_penalty(pen.participant_id)
@total_penalty = (@penalties[:submission] + @penalties[:review] + @penalties[:meta_review])
if pen.deadline_type_id.to_i == 1
{penalty_points: @penalties[:submission]}
pen.update_attribute(:penalty_points, @penalties[:submission])
elsif pen.deadline_type_id.to_i == 2
{penalty_points: @penalties[:review]}
pen.update_attribute(:penalty_points, @penalties[:review])
elsif pen.deadline_type_id.to_i == 5
{penalty_points: @penalties[:meta_review]}
pen.update_attribute(:penalty_points, @penalties[:meta_review])
end
end
end
</pre>
=== T3: Modify the PenaltyHelper ===
The helper function penalty_helper.rb aides in calculating associated penalties with a late submission. In the original implementation, penalties were not calculated and returned. Minor modifications were made in the penalty_helper.rb file to return the value of calculated penalty.
=== T4: Modify the GradesController ===
The controller grades_controller.rb performs all the necessary functions involved with calculating scores. In the original implementation, the calculated penalties were not subtracted from the total score when a late submission was made. This controller is now modified such that based on the time of submission (if late) penalty points would be deducted from the total obtained score.
=== T5: Modify the ViewScores ===
When a student clicks on view scores link for an assignment he/she can view the scores obtained for that assignment. In the original implementation, the students could not view the penalty deductions obtained for the assignment. To enable this, additional code was added to /app/views/grades/_participant.html.erb, /app/views/grades/_participant_charts.html.erb and /app/views/grades/_participant_title.html.erb. Now when the student clicks on the view scores link, he/she can see all the penalty deductions in addition to the total score obtained.
=== T6: Test the working of the LatePolicy model ===
While creating a late policy many constraints have to be kept in mind like the policy name should not be blank or empty, every late policy should have an instructor associated with it, the maximum penalty and penalty per unit should be a positive number and the penalty unit should always be set (seconds/minutes/hours). We have ensured that these constraints function effectively by writing the necessary rspec tests. The rspec test can be located in /spec/models/late_policy_spec.rb.
==== late_policy_spec.rb ====
<pre>
require 'rails_helper'

describe 'LatePolicy' do
let (:late_policy) {LatePolicy.new policy_name: "Test", instructor_id: 1234, max_penalty: 20, penalty_per_unit: 2, penalty_unit: "hours"}

describe "#policy_name" do
it "returns the name of late policy" do
expect(late_policy.policy_name).to eq("Test")
end
it "validates that the policy_name is not blank" do
late_policy.policy_name = ' '
expect(late_policy).not_to be_valid
end
end

describe "#instructor_id" do
it "returns the instructor id" do
expect(late_policy.instructor_id).to eq(1234)
end
end

describe "#max_penalty" do
it "returns the maximum penalty value" do
expect(late_policy.max_penalty).to eq(20)
end
it "validate max penalty is a number" do
expect(late_policy.max_penalty).to eq(20)
late_policy.max_penalty = 'a'
expect(late_policy).not_to be_valid
end
it "should be greater than 0" do
expect(late_policy.max_penalty).to eq(20)
late_policy.max_penalty = -20
expect(late_policy).not_to be_valid
late_policy.max_penalty = 20
end
it "should be less than 0" do
expect(late_policy.max_penalty).to eq(20)
late_policy.max_penalty = 51
expect(late_policy).not_to be_valid
late_policy.max_penalty = 20
end
end

describe "#penalty_per_unit" do
it "returns the penalty per unit value" do
expect(late_policy.penalty_per_unit).to eq(2)
end
it "validate penalty per unit is a number" do
expect(late_policy.penalty_per_unit).to eq(2)
late_policy.penalty_per_unit = 'a'
expect(late_policy).not_to be_valid
end
it "should be greater than 0" do
expect(late_policy.penalty_per_unit).to eq(2)
late_policy.penalty_per_unit = -2
expect(late_policy).not_to be_valid
late_policy.penalty_per_unit = 2
end
end

describe "#penalty_unit" do
it "returns the penalty unit value" do
expect(late_policy.penalty_unit).to eq("hours")
end
it "validates that the penalty_unit is not blank" do
late_policy.penalty_unit = ' '
expect(late_policy).not_to be_valid
end
end

end
</pre>
== Testing ==
=== Rspec Testing ===
As mentioned earlier, rspec tests are written to test the proper functioning of the LatePolicy model. The rspec tests can be found in /spec/models/late_policy_spec.rb file.
=== UI Testing ===
==== Testing LatePoliciesController ====
The create and the update code was refactored and modularized in the LatePoliciesController. The following steps can be followed from the Web UI to ensure that the refactoring did not affect the functionality of LatePoliciesController.
#Login as instructor
#Create an assignment in course
#In the due dates tab in create assignment check the "Apply Late Policy" box
#Select "New Late Policy" link
#Fill in the form with necessary details and submit
#The newly created late policy will be displayed in the list of all late policies
#Select the "Edit" option for the created late policy
#Change the required fields and save the changes
#The updated late policy is displayed in the list of late policies
#Edit the assignment/create a new assignment
#In the due dates tab, the newly created late policy will be displayed in the dropdown
==== Testing Penalty Calculation and Deduction ====
Changes were made in the Penalty Helper file and Grades Controller to calculate the correct penalty value and deduct it from the total scores obtained. Changes were made in so that the View Scores option would display the penalties in addition to the total score. The following steps can be followed to ensure that the penalties get deducted appropriately from the total score and are visible to the student.
#Login as instructor
#Create an assignment in course along with a late policy
#Create a team of 2-3 students for the created assignment
#Login as a student
#Make a submission for the assignment past the mentioned deadline
#Go to view scores and the deducted penalty will be displayed

=== Link for demo ===
The demo for testing this functionality can be viewed at https://youtu.be/mOoIKkyu5cA. Please do turn on closed captions while viewing the video to obtain a better understanding.

== Scope for future ==
While the late penalty has been implemented, there are few aspects of this project that can be improved.

#Currently the review penalty is not being calculated because submission of review is not allowed after the mentioned deadline. If the review for an assignment is submitted after the mentioned deadline no points get deducted even after enabling late review. This will require code changes in assignment and other controllers.

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-05T05:54:28Z

Smurali8:

= E1637: Refactor penalty_helper.rb and late_policies_controller.rb =
== Expertiza ==
Expertiza is an educational web application built on Ruby on Rails framework. It provides functionality for the instructor to create assignments for a specific course. The students can sign up for a list of topics created by the instructor. Expertiza allows students to form teams and work together. Students can provide feedback to assignments and projects submitted by other students. The students can also provide reviews about each individual member in their team as well. The numerous functionalities provided by expertiza makes the process of assignment submission, feedback and management much simpler and for the students and the instructors.
== Motivation ==
This project deals with LatePoliciesController and PenaltyHelper files. It focuses on calculating a penalty which would be deducted from the total score obtained by the student if the student submits the assignment or review past the specified deadline. The goal of our project is to make the task of calculating and deducting penalties function perfectly and also refactor the code to make it more intuitive and modular.
== Files Modified ==
The files modified for the penalty functionality to work are as follows,
=== Controllers ===
==== LatePolicyController ====
This controller contains the functions to create, update and delete a late policy. The instructor can create a late policy for any assignment, where in the instructor can specify the points per unit and the maximum penalty that can be applied for a particular assignment. The create and the update functions in this module were very long and it had to be refactored so that the code was modular.
==== GradesController ====
In grades controller, the total penalty was not getting deducted from the total score due to the mismatch of conditions. The conditions were modified in this controller for the penalty to be deducted from the total score obtained.
=== Helpers ===
==== PenaltyHelper ====
This helper file has functions to calculate submission, review and metareview penalties. This function was not returning the values of the calculated penalty as required and modifications were made so that the correct penalty values are returned.
=== Views ===
In the current implementation, the penalty deducted is not displayed when a student views scores. The views were modified so that the deducted penalties and total score are displayed appropriately. The list of views modified are as follows,
*_participant.html.erb
*_participant_charts.html.erb
*_participant_title.html.erb
=== Rspec Testing ===
==== LatePolicy Model Testing ====
Rspec tests were written to test the functionality of the LatePolicy model. The tests ensure that the attributes in the model obtain the correct value. In addition, the tests also ensure that none of the fields are empty and ensures the maximum penalty and penalty per unit is a positive number which lies in a specified range.

== List of Tasks ==
*T1: Refactor the create function in LatePoliciesController to make the code more modular
*T2: Refactor the update function in LatePoliciesController to make the code more modular
*T3: Modify the PenaltyHelper to calculate and return the correct penalty value
*T4: Modify the GradesController to deduct the total penalty from the total score
*T5: Modify the ViewScores page to display the penalties deducted
*T6: Test the working of the LatePolicy model by writing necessary RSpec tests

== Implementation of Tasks ==
=== T1: Refactor create function in LatePoliciesController ===
The create function performed various checks on the parameters passed from the form instead of calling appropriate functions to do them. The same checks were performed by the update function. This violated the DRY principle. To overcome this discrepancy, two functions were created namely, validate_penalty_unit and validate_duplicate_policy which perform the required checks.
==== validate_penalty_unit ====
This function checks that the penalty per unit is less than the maximum penalty. If this function returns fall, the LatePolicy will not be created.
<pre>
private def validate_penalty_unit(params)
penalty_valid = false
if params[:late_policy][:max_penalty].to_i < params[:late_policy][:penalty_per_unit].to_i
flash[:error] = "The maximum penalty cannot be less than penalty per unit."
else
penalty_valid = true
end
penalty_valid
end
</pre>
==== validate_duplicate_policy ====
This function checks that another policy with the same name created by a different instructor does not exist. Duplicate policy names are permissable if created by the same instructor.
<pre>
private def validate_duplicate_policy(params)
not_duplicate = false
@late_policy = LatePolicy.where(policy_name: params[:late_policy][:policy_name])
if !@late_policy.nil? && !@late_policy.empty?
@late_policy.each do |p|
if p.instructor_id != instructor_id
flash[:error] = "A policy with the same name already exists."
return not_duplicate
end
end
end
not_duplicate = true
not_duplicate
end
</pre>
=== T2: Refactor the update function in LatePoliciesController ===
The update function performs the same checks as the create function. The check statements are replaced by the appropriate calls to validate_penalty_unit and validate_duplicate_policy. In addition, when the late policy is updated, the corresponding penalty calculations have to be updated for students enrolled in assignments using the corresponding late policy. So a new function called values_update is introduced which performs the necessary task.
==== values_update ====
<pre>
private def values_update(params)
@penaltyObjs = CalculatedPenalty.all
@penaltyObjs.each do |pen|
@participant = AssignmentParticipant.find(pen.participant_id)
@assignment = @participant.assignment
next unless @assignment.late_policy_id == @penalty_policy.id
@penalties = calculate_penalty(pen.participant_id)
@total_penalty = (@penalties[:submission] + @penalties[:review] + @penalties[:meta_review])
if pen.deadline_type_id.to_i == 1
{penalty_points: @penalties[:submission]}
pen.update_attribute(:penalty_points, @penalties[:submission])
elsif pen.deadline_type_id.to_i == 2
{penalty_points: @penalties[:review]}
pen.update_attribute(:penalty_points, @penalties[:review])
elsif pen.deadline_type_id.to_i == 5
{penalty_points: @penalties[:meta_review]}
pen.update_attribute(:penalty_points, @penalties[:meta_review])
end
end
end
</pre>
=== T3: Modify the PenaltyHelper ===
The helper function penalty_helper.rb aides in calculating associated penalties with a late submission. In the original implementation, penalties were not calculated and returned. Minor modifications were made in the penalty_helper.rb file to return the value of calculated penalty.
=== T4: Modify the GradesController ===
The controller grades_controller.rb performs all the necessary functions involved with calculating scores. In the original implementation, the calculated penalties were not subtracted from the total score when a late submission was made. This controller is now modified such that based on the time of submission (if late) penalty points would be deducted from the total obtained score.
=== T5: Modify the ViewScores ===
When a student clicks on view scores link for an assignment he/she can view the scores obtained for that assignment. In the original implementation, the students could not view the penalty deductions obtained for the assignment. To enable this, additional code was added to /app/views/grades/_participant.html.erb, /app/views/grades/_participant_charts.html.erb and /app/views/grades/_participant_title.html.erb. Now when the student clicks on the view scores link, he/she can see all the penalty deductions in addition to the total score obtained.
=== T6: Test the working of the LatePolicy model ===
While creating a late policy many constraints have to be kept in mind like the policy name should not be blank or empty, every late policy should have an instructor associated with it, the maximum penalty and penalty per unit should be a positive number and the penalty unit should always be set (seconds/minutes/hours). We have ensured that these constraints function effectively by writing the necessary rspec tests. The rspec test can be located in /spec/models/late_policy_spec.rb.
==== late_policy_spec.rb ====
<pre>
require 'rails_helper'

describe 'LatePolicy' do
let (:late_policy) {LatePolicy.new policy_name: "Test", instructor_id: 1234, max_penalty: 20, penalty_per_unit: 2, penalty_unit: "hours"}

describe "#policy_name" do
it "returns the name of late policy" do
expect(late_policy.policy_name).to eq("Test")
end
it "validates that the policy_name is not blank" do
late_policy.policy_name = ' '
expect(late_policy).not_to be_valid
end
end

describe "#instructor_id" do
it "returns the instructor id" do
expect(late_policy.instructor_id).to eq(1234)
end
end

describe "#max_penalty" do
it "returns the maximum penalty value" do
expect(late_policy.max_penalty).to eq(20)
end
it "validate max penalty is a number" do
expect(late_policy.max_penalty).to eq(20)
late_policy.max_penalty = 'a'
expect(late_policy).not_to be_valid
end
it "should be greater than 0" do
expect(late_policy.max_penalty).to eq(20)
late_policy.max_penalty = -20
expect(late_policy).not_to be_valid
late_policy.max_penalty = 20
end
it "should be less than 0" do
expect(late_policy.max_penalty).to eq(20)
late_policy.max_penalty = 51
expect(late_policy).not_to be_valid
late_policy.max_penalty = 20
end
end

describe "#penalty_per_unit" do
it "returns the penalty per unit value" do
expect(late_policy.penalty_per_unit).to eq(2)
end
it "validate penalty per unit is a number" do
expect(late_policy.penalty_per_unit).to eq(2)
late_policy.penalty_per_unit = 'a'
expect(late_policy).not_to be_valid
end
it "should be greater than 0" do
expect(late_policy.penalty_per_unit).to eq(2)
late_policy.penalty_per_unit = -2
expect(late_policy).not_to be_valid
late_policy.penalty_per_unit = 2
end
end

describe "#penalty_unit" do
it "returns the penalty unit value" do
expect(late_policy.penalty_unit).to eq("hours")
end
it "validates that the penalty_unit is not blank" do
late_policy.penalty_unit = ' '
expect(late_policy).not_to be_valid
end
end

end
</pre>
== Testing ==
=== Rspec Testing ===
As mentioned earlier, rspec tests are written to test the proper functioning of the LatePolicy model. The rspec tests can be found in /spec/models/late_policy_spec.rb file.
=== UI Testing ===
==== Testing LatePoliciesController ====
The create and the update code was refactored and modularized in the LatePoliciesController. The following steps can be followed from the Web UI to ensure that the refactoring did not affect the functionality of LatePoliciesController.
#Login as instructor
#Create an assignment in course
#In the due dates tab in create assignment check the "Apply Late Policy" box
#Select "New Late Policy" link
#Fill in the form with necessary details and submit
#The newly created late policy will be displayed in the list of all late policies
#Select the "Edit" option for the created late policy
#Change the required fields and save the changes
#The updated late policy is displayed in the list of late policies
#Edit the assignment/create a new assignment
#In the due dates tab, the newly created late policy will be displayed in the dropdown
==== Testing Penalty Calculation and Deduction ====
Changes were made in the Penalty Helper file and Grades Controller to calculate the correct penalty value and deduct it from the total scores obtained. Changes were made in so that the View Scores option would display the penalties in addition to the total score. The following steps can be followed to ensure that the penalties get deducted appropriately from the total score and are visible to the student.
#Login as instructor
#Create an assignment in course along with a late policy
#Create a team of 2-3 students for the created assignment
#Login as a student
#Make a submission for the assignment past the mentioned deadline
#Go to view scores and the deducted penalty will be displayed

=== Link for demo ===
The demo for testing this functionality can be viewed at https://youtu.be/mOoIKkyu5cA. Please do turn on closed captions while viewing the video to obtain a better understanding.

== Scope for future ==
While the late penalty has been implemented, there are few aspects of this project that can be improved.

#Currently the review penalty is not being calculated because submission of review is not allowed after the mentioned deadline. If the review for an assignment is submitted after the mentioned deadline no points get deducted even after enabling late review. This will require code changes in assignment and other controllers.

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-05T05:22:31Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-04T19:53:20Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-04T19:14:47Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-04T19:07:33Z

Smurali8: /* validate_duplicate_policy */

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-04T18:56:18Z

Smurali8: /* T1: Refactor create function in LatePoliciesController */

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-04T18:48:03Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-11-04T18:27:42Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-29T22:01:22Z

Smurali8: /* = Testing LatePoliciesController */

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-29T22:00:50Z

Smurali8: /* UI Testing */

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-29T21:36:13Z

Smurali8: /* List of Tasks */

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-29T21:31:34Z

Smurali8: /* Files Modified */

User:Smurali8

2016-10-28T23:12:15Z

Smurali8: moved User:Smurali8 to CSC/ECE 517 Fall 2016/OSS E1637

#REDIRECT [[CSC/ECE 517 Fall 2016/OSS E1637]]

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T23:12:15Z

Smurali8: moved User:Smurali8 to CSC/ECE 517 Fall 2016/OSS E1637

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T23:10:56Z

Smurali8: /* E1637: Refactor penalty_helper.rb and late_policies_controller.rb */

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T22:56:45Z

Smurali8: /* List of Tasks */

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T22:55:24Z

Smurali8: /* E1637: Refactor penalty_helper.rb and late_policies_controller.rb */

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T22:47:53Z

Smurali8:

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T22:01:29Z

Smurali8: /* CSC/ECE 517 Fall 2016/OSS E1637 */

= CSC/ECE 517 Fall 2016/OSS E1637 =
== E1637: Refactor penalty_helper.rb and late_policies_controller.rb ==
=== Expertiza ===
Expertiza is an educational web application built on Ruby on Rails framework. It provides functionality for the instructor to create assignments for a specific course. The students can sign up for a list of topics created by the instructor. Expertiza allows students to form teams and work together. Students can provide feedback to assignments and projects submitted by other students. The students can also provide reviews about each individual member in their team as well. The numerous functionalities provided by expertiza makes the process of assignment submission, feedback and management much simpler and for the students and the instructors.
=== Motivation ===
This project deals with LatePoliciesController and PenaltyHelper files. It focuses on calculating a penalty which would be deducted from the total score obtained by the student if the student submits the assignment or review past the specified deadline. The goal of our project is to make the task of calculating and deducting penalties function perfectly and also refactor the code to make it more intuitive and modular.

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T17:55:31Z

Smurali8: /* CSC/ECE 517 Fall 2016/OSS E1637 */

= CSC/ECE 517 Fall 2016/OSS E1637 =
== E1637: Refactor penalty_helper.rb and late_policies_controller.rb ==

CSC/ECE 517 Fall 2016/OSS E1637

2016-10-28T17:51:54Z

Smurali8: Created page with "= CSC/ECE 517 Fall 2016/OSS E1637 ="

= CSC/ECE 517 Fall 2016/OSS E1637 =