Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews

2018-05-04T00:17:04Z

Aksahoo: /* External Links */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the course staff (Instructor/ TAs) would want to submit reviews as well. This project aims to implement this feature by allowing course staff to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peers work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions and Implementation''' ==

We performed the following changes to let staff perform reviews as well:

'''Step 1: Add a way for the instructors to perform a review.'''

To do this, we added links for performing/viewing/editing/updating a review in the assignment submissions view.
When the instructor/TA reviews a work for the first time, he is added as a participant and a review response mapping is created.

Files edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb'' - To add links in the instructor view
* '''Controller: ''' ''app/controllers/review_mapping_controller.rb'' - Method: add_instructor_as_reviewer

Code snippet from the controller:
<pre>
def add_instructor_as_reviewer
assignment_team = AssignmentTeam.find(params[:team_id])
reviewer = AssignmentParticipant.where(user_id: params[:reviewer_id], parent_id: assignment_team.parent_id).first
if reviewer.nil?
reviewer = AssignmentParticipant.create(parent_id: assignment_team.parent_id, user_id: session[:user].id, can_submit: false, can_review: true,
can_take_quiz: false, handle: 'handle')

end
@review_map_id=ReviewResponseMap.where(reviewee_id: assignment_team.id, reviewer_id: reviewer.id,
reviewed_object_id: params[:assignment_id]).first
@review_map_id=assignment_team.assign_reviewer(reviewer) if @review_map_id.nil?
redirect_to controller: 'response', action: 'new', id: @review_map_id.map_id
end
</pre>

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review and submits it, we can see the 'View review'. In case he just saves the review, an 'Edit review' link will appear.
If the review deadline of one round is passed, the 'Edit review' link becomes 'Update review' link. This follows in line with what the student sees while performing a review. However, the course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add the instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files edited:
* '''Assets: ''' ''app/assets/stylesheets/grades.scss'' - To make an instructor performed review distinct from other reviews
* '''View: ''' ''app/views/grades/view_team.html.erb'' - Modified the "Others work" page to include the instructor review as well as ensure the score is not used.
* '''Models: '''
** ''app/models/answer.rb'' - Method: compute_scores | Modification in logic to ensure instructor review scores are not counted in the overall score of the student.
** ''app/models/vm_question_response_score_cell.rb'' - Included a new variable called 'is_instructor_review' to identify an instructor review
** ''app/models/vm_question_response_row.rb'' - Change in average_score_for_row method to not include an instructor review score
** ''app/models/vm_question_response.rb'' - Modified the add_answer method to include the is_instructor_review to each row_score object

Code snippet from the add_answer method:
<pre>
participant= Participant.find(ResponseMap.find(Response.find(response_id).map_id).reviewer_id)
user_id = participant.user_id
course = Course.find(@assignment.course_id)
row.score_row.push(VmQuestionResponseScoreCell.new(answer.answer, color_code, answer.comments,
course.is_ta_or_instructor?(user_id), vm_tag_prompts))
</pre>

[[File:View_team.PNG | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review with a golden border as seen in the round two score table along with explicitly stating that it is an 'Instructor review'.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

Additional Files modified:
* '''Controllers: '''
** ''app/controllers/response_controller.rb'' - Change in re-directions in case of an instructor taking him back to the submissions page.
* '''Models: '''
** ''app/models/assignment.rb'' - Method: number_of_current_round_for_instructor | To allow an instructor to review an assignment even after the due date
** ''app/models/course.rb'' - Method: is_ta_or_instructor? | To identify whether the user is a TA or an instructor of the current course

Code snippet from the model:
<pre>
def is_ta_or_instructor?(user_id)
instructors = TaMapping.where(course_id: self.id).collect { |x| x.ta_id}
instructors.push(self.instructor_id)
return user_id.in?(instructors)
end
</pre>

== '''Test Plan''' ==

'''Features testing:''' Many of our changes are reflected on views (user interface). Following is the list of tests that are conducted with rspec/capybara.

# it "should let instructor/TAs perform a review for the submission of latest finished round if instructor/TAs has not started a review for the submission yet"
# it "should let instructor/TAs save a review"
# it "should let instructor/TAs review a previously saved review"
# it "should let instructor/TAs edit a previously saved review"
# it "should allow instructor/TAs perform a review after the deadline for reviewing has passed"

<pre>
describe "instructor review testing" do
before(:each) do
create(:assignment, name: "TestAssignment", directory_path: 'test_assignment')
create_list(:participant, 3)
create(:assignment_node)
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create(:assignment_due_date, deadline_type: DeadlineType.where(name: 'review').first, due_at: Time.now.in_time_zone + 1.day)
create(:topic)
create(:topic, topic_name: "TestReview")
create(:team_user, user: User.where(role_id: 2).first)
create(:team_user, user: User.where(role_id: 2).second)
create(:assignment_team)
create(:team_user, user: User.where(role_id: 2).third, team: AssignmentTeam.second)
create(:signed_up_team)
create(:signed_up_team, team_id: 2, topic: SignUpTopic.second)
create(:assignment_questionnaire)
create(:question)
create(:review_response_map, reviewer_id: User.find_by(name: "instructor6").id, reviewee: AssignmentTeam.second)
end

it "lets instructor perform a review and saves" do
assignment = Assignment.first
login_as("instructor6")
visit "/assignments/list_submissions?id=#{assignment.id}"
expect(page).to have_content 'Perform review'
all(:link, 'Perform review')[1].click
fill_in "responses[0][comment]", with: "DRY"
select 5, from: "responses[0][score]"
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end

it "lets instructor view a saved review" do
assignment = Assignment.first
login_as("instructor6")
visit "/assignments/list_submissions?id=#{assignment.id}"
all(:link, 'Perform review')[1].click
fill_in "responses[0][comment]", with: "Hello world"
click_button "Save Review"
visit "/assignments/list_submissions?id=#{assignment.id}"
expect(page).to have_content 'View review'
click_link "View review"
expect(page).to have_content "show review"
end

it "lets instructor edit a saved review and saves" do
assignment = Assignment.first
login_as("instructor6")
visit "/assignments/list_submissions?id=#{assignment.id}"
all(:link, 'Perform review')[1].click
fill_in "responses[0][comment]", with: "Good job"
click_button "Save Review"
visit "/assignments/list_submissions?id=#{assignment.id}"
expect(page).to have_content 'Edit review'
click_link "Edit review"
expect(page).to have_text "Good job"
fill_in "review[comments]", with: "Excellent work"
click_button "Save Review"
expect(page.current_path).to eq "/assignments/list_submissions"
end

it "allows instructor perform a review and saves after deadline for reviewing has passed" do
assignment = Assignment.first
due_date = AssignmentDueDate.first
due_date.due_at = Time.now.in_time_zone - 1.day
login_as("instructor6")
visit "/assignments/list_submissions?id=#{assignment.id}"
expect(page).to have_content 'Perform review'
all(:link, 'Perform review')[1].click
fill_in "responses[0][comment]", with: "DRY"
select 5, from: "responses[0][score]"
click_button "Save Review"
expect(page).to have_content "Your response was successfully saved."
end
end
</pre>

'''Controllers testing:''' review_mapping_controller#add_instructor_as_reviewer

<pre>
describe '#add_instructor_as_reviewer' do
context 'when instructor is not a participant for the assignment and review_response_map has not been created' do
it 'adds instructor as a participant for the assignment and creates review_response_map and redirects to responses#new' do
allow(AssignmentTeam).to receive(:find).with('1').and_return(team2)
allow(AssignmentParticipant).to receive_message_chain(:where, :first)
.with(user_id: 1, parent_id: '1').with(no_args).and_return(nil)
allow(AssignmentParticipant).to receive(:create)
.with(parent_id: '1', user_id: 1, can_submit: false, can_review: true, can_take_quiz: false, handle: 'handle').and_return(participant)
allow(ReviewResponseMap).to receive_message_chain(:where, :first)
.with(reviewee_id: '1', reviewer_id: 1, reviewed_object_id: '1').with(no_args).and_return(nil)
allow(team2).to receive(:assign_reviewer)
.with(participant).and_return(review_response_map)
params = {id: 1, team_id: 1, assignment_id: 1}
session = {user: build(:instructor, id: 1)}
get :add_instructor_as_reviewer, params, session
expect(response).to redirect_to '/response/new?id=1'
end
end

context 'when instructor is already a participant for the assignment and review_response_map has been created' do
it 'does not need to add instructor as a participant for the assignment or create review_repsonse_map and redirects to response#new' do
allow(AssignmentTeam).to receive(:find).with('1').and_return(team2)
allow(AssignmentParticipant).to receive_message_chain(:where, :first)
.with(user_id: 1, parent_id: '1').with(no_args).and_return(participant)
allow(ReviewResponseMap).to receive_message_chain(:where, :first)
.with(reviewee_id: '1', reviewer_id: 1, reviewed_object_id: '1').with(no_args).and_return(review_response_map)
params = {id: 1, team_id: 1, assignment_id: 1}
session = {user: build(:instructor, id: 1)}
get :add_instructor_as_reviewer, params, session
expect(response).to redirect_to '/response/new?id=1'
end
end
end
</pre>

'''More testing:'''

# it "should let instructor/TAs update a review for the submission of latest finished round if instructor/TAs performed and saved a review for the previous round"
# it "should show "Instructor review" when a student views feedback on his/her submission if an instructor/TA has reviewed his/his team's work"
# it "should exclude the instructor's/TA's review score when calculating the average peer review score for the team"
# it "should exclude the instructor's/TA's review score when calculating the average score for each question in the review"

== '''External Links''' ==
* Forked Repository: https://github.com/kushalnawalakha/expertiza
* Pull Request: https://github.com/expertiza/expertiza/pull/1182
* Deployment: http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000/
* Screencast Demo Link: https://youtu.be/_r0qHcaaq1o

== '''Team Members''' ==
*Ashis Sahoo
*Satvik Shetty
*Xiaohui Ellis
*Kushal Nawalakha

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews

2018-04-29T08:24:34Z

Aksahoo: /* External Links */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the instructor would want to submit reviews as well. This project aims to implement this feature by allowing instructors to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peer's work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions''' ==

We propose to perform the following changes to let staff perform reviews as well:

'''Step 1: Add a ''Perform review'' link in the assignment submissions page view for the instructors.'''

Files to be edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb''
* '''Controller: ''' ''app/controllers/response_controller.rb'' - Add authorization for instructors to perform review

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform Review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review, we can see the 'View Review' and 'Edit Review' links, as seen in the first case.
If the review deadline of one round is passed, the 'Edit Review' link becomes 'Update Review' link. The course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files to be edited:
* '''View: ''' ''app/views/grades/view_team.html.erb''
* '''Controller: ''' ''app/controllers/grades_controller.rb'' - Method: view_team

[[File:View_team.PNG | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review as seen in the round two score table.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

== '''Test Plan''' ==

Many of our changes would be reflected on views (user interface). Following is the list of tests that should be conducted with rspec/capybara:

# it "should see the Perform Review link (beside Assign Grade link) for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has passed"
# it "should see the Perform Review link only for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has started and review deadline has not passed"
# it "should see neither Perform Review link nor Assign Grade link after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has not started"
# it "should pull up a review page for the submission of the team after the Perform Review link is clicked on by an instructor"
# it "should show highlighted reviews done by instructors when a student views feedback on his/her submission"
# it "should pull up a calibration report when a student wants to see the difference between his/her reviews on other's submission and the instructor's"

== '''External Links''' ==
* Forked Repository: https://github.com/kushalnawalakha/expertiza
* Pull Request: https://github.com/expertiza/expertiza/pull/1182
* Deployment: http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000/

== '''Team Members''' ==
*Ashis Sahoo
*Satvik Shetty
*Xiaohui Ellis
*Kushal Nawalakha

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews

2018-04-29T06:59:17Z

Aksahoo: /* Proposed Solutions */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the instructor would want to submit reviews as well. This project aims to implement this feature by allowing instructors to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peer's work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions''' ==

We propose to perform the following changes to let staff perform reviews as well:

'''Step 1: Add a ''Perform review'' link in the assignment submissions page view for the instructors.'''

Files to be edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb''
* '''Controller: ''' ''app/controllers/response_controller.rb'' - Add authorization for instructors to perform review

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform Review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review, we can see the 'View Review' and 'Edit Review' links, as seen in the first case.
If the review deadline of one round is passed, the 'Edit Review' link becomes 'Update Review' link. The course staff will be allowed to perform a review even if the deadline for reviewing has passed.

'''Step 2: Add instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files to be edited:
* '''View: ''' ''app/views/grades/view_team.html.erb''
* '''Controller: ''' ''app/controllers/grades_controller.rb'' - Method: view_team

[[File:View_team.PNG | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review as seen in the round two score table.
The average peer review score for the team has been modified to exclude the instructor's scores. Same has been taken into account for the average score calculated for each row.

== '''Test Plan''' ==

Many of our changes would be reflected on views (user interface). Following is the list of tests that should be conducted with rspec/capybara:

# it "should see the Perform Review link (beside Assign Grade link) for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has passed"
# it "should see the Perform Review link only for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has started and review deadline has not passed"
# it "should see neither Perform Review link nor Assign Grade link after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has not started"
# it "should pull up a review page for the submission of the team after the Perform Review link is clicked on by an instructor"
# it "should show highlighted reviews done by instructors when a student views feedback on his/her submission"
# it "should pull up a calibration report when a student wants to see the difference between his/her reviews on other's submission and the instructor's"

== '''External Links''' ==
* Forked Repository: https://github.com/kushalnawalakha/expertiza
* Deployment: http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000/

== '''Team Members''' ==
*Ashis Sahoo
*Satvik Shetty
*Xiaohui Ellis
*Kushal Nawalakha

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:View team.PNG

2018-04-29T06:50:00Z

Aksahoo:

CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews

2018-04-29T05:04:40Z

Aksahoo: /* Proposed Solutions */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the instructor would want to submit reviews as well. This project aims to implement this feature by allowing instructors to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peer's work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions''' ==

We propose to perform the following changes to let staff perform reviews as well:

'''Step 1: Add a ''Perform review'' link in the assignment submissions page view for the instructors.'''

Files to be edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb''
* '''Controller: ''' ''app/controllers/response_controller.rb'' - Add authorization for instructors to perform review

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform Review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review, we can see the 'View Review' and 'Edit Review' links, as seen in the first case.
If the review deadline of one round is passed, the 'Edit Review' link becomes 'Update Review' link. The course staff will be allowed to perform a review even if the deadline for reviewing has passed.

In the second case, an intermediate submission deadline has passed and hence there is a link only for performing a review.

In the third case, if no submission deadline has passed, there won't be a link for Performing a review nor assigning a grade. [No, it should be dependent on whether reviewing is allowed during the current assignment phase.]

'''Step 2: Add instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files to be edited:
* '''View: ''' ''app/views/grades/view_team.html.erb''
* '''Controller: ''' ''app/controllers/grades_controller.rb'' - Method: view_team

[[File: Grades_view_team_instr.png | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the instructor's review.

== '''Test Plan''' ==

Many of our changes would be reflected on views (user interface). Following is the list of tests that should be conducted with rspec/capybara:

# it "should see the Perform Review link (beside Assign Grade link) for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has passed"
# it "should see the Perform Review link only for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has started and review deadline has not passed"
# it "should see neither Perform Review link nor Assign Grade link after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has not started"
# it "should pull up a review page for the submission of the team after the Perform Review link is clicked on by an instructor"
# it "should show highlighted reviews done by instructors when a student views feedback on his/her submission"
# it "should pull up a calibration report when a student wants to see the difference between his/her reviews on other's submission and the instructor's"

== '''External Links''' ==
* Forked Repository: https://github.com/kushalnawalakha/expertiza
* Deployment: http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000/

== '''Team Members''' ==
*Ashis Sahoo
*Satvik Shetty
*Xiaohui Ellis
*Kushal Nawalakha

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews

2018-04-29T05:03:26Z

Aksahoo: /* Problem Statement */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the instructor would want to submit reviews as well. This project aims to implement this feature by allowing instructors to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peer's work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

== '''Proposed Solutions''' ==

We propose to perform the following changes to let staff perform reviews as well:

'''Step 1: Add a ''Perform review'' link in the assignment submissions page view for the instructors.'''

Files to be edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb''
* '''Controller: ''' ''app/controllers/response_controller.rb'' - Add authorization for instructors to perform review

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform Review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review, we can see the 'View Review' and 'Edit Review' links, as seen in the first case.
If the review deadline of one round is passed, the 'Edit Review' link becomes 'Update Review' link. The course staff will be allowed to perform a review even if the deadline for reviewing has passed.

In the second case, an intermediate submission deadline has passed and hence there is a link only for performing a review.

In the third case, if no submission deadline has passed, there won't be a link for Performing a review nor assigning a grade. [No, it should be dependent on whether reviewing is allowed during the current assignment phase.]

'''Step 2: Add instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files to be edited:
* '''View: ''' ''app/views/grades/view_team.html.erb''
* '''Controller: ''' ''app/controllers/grades_controller.rb'' - Method: view_team

[[File: Grades_view_team_instr.png | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the intructor's review.

'''Step 3: If instructor has reviewed the same work as you have reviewed, provide a way to show his review as well in ''Others work'''''

Files to be edited:
* '''View: ''' ''app/views/student_review/list.html.erb''
* '''Controller: ''' ''app/controllers/student_review_controller.rb'' - Method: view_team

[[File: Others_work_proposed.jpeg | center]]

If the instructor has reviewed the work of a team you have reviewed, there will be a link to view how the instructor has reviewed the same work. In case the instructor has not reviewed the work (like in case of review 4), there won't be any ''Instructor's Review'' link

== '''Test Plan''' ==

Many of our changes would be reflected on views (user interface). Following is the list of tests that should be conducted with rspec/capybara:

# it "should see the Perform Review link (beside Assign Grade link) for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has passed"
# it "should see the Perform Review link only for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has started and review deadline has not passed"
# it "should see neither Perform Review link nor Assign Grade link after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has not started"
# it "should pull up a review page for the submission of the team after the Perform Review link is clicked on by an instructor"
# it "should show highlighted reviews done by instructors when a student views feedback on his/her submission"
# it "should pull up a calibration report when a student wants to see the difference between his/her reviews on other's submission and the instructor's"

== '''External Links''' ==
* Forked Repository: https://github.com/kushalnawalakha/expertiza
* Deployment: http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000/

== '''Team Members''' ==
*Ashis Sahoo
*Satvik Shetty
*Xiaohui Ellis
*Kushal Nawalakha

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

CSC/ECE 517 Spring 2018- Project E1824: Let course staff as well as students do reviews

2018-04-29T04:55:25Z

Aksahoo: /* Proposed Solutions */

== '''Introduction''' ==

The way Expertiza is set up right now is that only peers can review your work. However, there are cases when the instructor would want to submit reviews as well. This project aims to implement this feature by allowing instructors to review the project on the same metrics as other students who review the project.

== '''Problem Statement''' ==

Peer review is a great way for students to learn about how well they have developed their application. However there are some problems with this:
* Sometimes, the peer reviews may not be thorough and the team/person's work reviewed might not reflect the actual status of the development.
* The reviewer might not know how well they are reviewing the peer's work. They might not entirely know as to what tone to use or what suggestions to put forward.

By letting course staff perform reviews as well, the reviewer and the reviewee are both benefited, which can improve the overall learning experience.

=== Current scenario ===

This is how some of the pages we are concerned with, currently look.

==== Submissions page for an assignment in Instructor View ====

[[File: Submissions_instr.jpeg | center]]

==== A typical Scores table in a Student View ====

[[File: Grades_view_team_current.png | center]]

==== Others work reviewed in a Student View ====

[[File: Others_work_current.jpeg | center]]

== '''Proposed Solutions''' ==

We propose to perform the following changes to let staff perform reviews as well:

'''Step 1: Add a ''Perform review'' link in the assignment submissions page view for the instructors.'''

Files to be edited:
* '''View: ''' ''app/views/assignments/list_submissions.html.erb''
* '''Controller: ''' ''app/controllers/response_controller.rb'' - Add authorization for instructors to perform review

[[File:Instructor review view.PNG | center]]

In the second case, we can see a 'Perform Review' link. This is the initial state when instructor review has not been added to the submission.
Once the instructor adds a review, we can see the 'View Review' and 'Edit Review' links, as seen in the first case.
If the review deadline of one round is passed, the 'Edit Review' link becomes 'Update Review' link. The course staff will be allowed to perform a review even if the deadline for reviewing has passed.

In the second case, an intermediate submission deadline has passed and hence there is a link only for performing a review.

In the third case, if no submission deadline has passed, there won't be a link for Performing a review nor assigning a grade. [No, it should be dependent on whether reviewing is allowed during the current assignment phase.]

'''Step 2: Add instructor review in ''Your Scores'' table in case he has reviewed your work. Provide a highlight/way to make it look distinct.'''

Files to be edited:
* '''View: ''' ''app/views/grades/view_team.html.erb''
* '''Controller: ''' ''app/controllers/grades_controller.rb'' - Method: view_team

[[File: Grades_view_team_instr.png | center]]

A student should be able to make out if an instructor has reviewed his/his team's work. In case the instructor performs a review on the team's work, it will highlight the intructor's review.

'''Step 3: If instructor has reviewed the same work as you have reviewed, provide a way to show his review as well in ''Others work'''''

Files to be edited:
* '''View: ''' ''app/views/student_review/list.html.erb''
* '''Controller: ''' ''app/controllers/student_review_controller.rb'' - Method: view_team

[[File: Others_work_proposed.jpeg | center]]

If the instructor has reviewed the work of a team you have reviewed, there will be a link to view how the instructor has reviewed the same work. In case the instructor has not reviewed the work (like in case of review 4), there won't be any ''Instructor's Review'' link

== '''Test Plan''' ==

Many of our changes would be reflected on views (user interface). Following is the list of tests that should be conducted with rspec/capybara:

# it "should see the Perform Review link (beside Assign Grade link) for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has passed"
# it "should see the Perform Review link only for each submission after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has started and review deadline has not passed"
# it "should see neither Perform Review link nor Assign Grade link after a list of submissions are pulled up by an instructor if the final due date for the assignment has not passed and review period has not started"
# it "should pull up a review page for the submission of the team after the Perform Review link is clicked on by an instructor"
# it "should show highlighted reviews done by instructors when a student views feedback on his/her submission"
# it "should pull up a calibration report when a student wants to see the difference between his/her reviews on other's submission and the instructor's"

== '''External Links''' ==
* Forked Repository: https://github.com/kushalnawalakha/expertiza
* Deployment: http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000/

== '''Team Members''' ==
*Ashis Sahoo
*Satvik Shetty
*Xiaohui Ellis
*Kushal Nawalakha

== '''References''' ==

Expertiza
* https://expertiza.ncsu.edu/

Expertiza Github
* https://github.com/expertiza/expertiza

Expertiza Documentation
* http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation

File:Instructor review view.PNG

2018-04-29T04:42:00Z

Aksahoo:

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-17T17:04:12Z

Aksahoo: /* External Links */

== Introduction ==
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University]. Peer review is a great way for a student to learn how to approach a project and get ideas for their own projects. Currently, there is no way for a student to view another student's work, unless they are reviewing the other student's work.

== Problem Statement ==
The objective of this project is to:
# Add a feature to allow teams to publish their work for other students to see.
# Add a feature for a student to view sample submissions for a given assignment made available by other students:
## In the same assignment, available after deadline.
## In an old assignment, selected by the instructor from sample submissions made in an old assignment.
# Add a feature for instructor to select a previous assignment to show sample submissions for a new assignment.

== Proposed Design ==
The proposed features will involve two kinds of users : Students and Instructors.
Students will use the application to make their submissions public and view published reviews.

[[File:Application Flow Student.png]]

Instructors will use the application to make submissions from a previous assignment available as sample submissions for a current assignment. Only those submissions will be visible which were previously made public by the students.

[[Image:Application Flow Instructor.png]]

== Project Tasks ==
The tasks that need to be completed as part of this project can be listed as follows:
# Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
# Add column make_public to table teams for storing user permission (published or not) for each project.
# Add controller for Sample submissions and implement corresponding methods.
# Add views for sample submissions
# Make changes to page student_task/view which would have link to sample submissions for each project.
# Add drop down in assignments/edit/_general view.
# Add controller code for the drop down.
# Add column sample_assignment_id to table assignment.
# Add test scripts for all the functionality.

== Current status of Development ==
All tasks mentioned in Project tasks are completed.

== Developed Code ==
1. Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
<pre>
<% if !participant.team.nil? %>
<td align=center>
<input id="makeSubPublic" teamid="<%= participant.team.id %>" type="checkbox" onclick="publishConfirmation(this)" <% if participant.team.make_public %>checked<% end %>>
</td>
<% end %>
</pre>

2. Add column make_public to table teams for storing user permission (published or not) for each project.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
3. Add controller for Sample submissions and implement corresponding methods.
<pre>
# To give permission for making a submission available to others
def make_public
@team = Team.find(params[:id])
@team.make_public = params[:status]
@team.save
respond_to do |format|
format.html { head :no_content }
end
end
</pre>
4. Add views for sample submissions
<pre>

<h2>Sample Submissions for <%= @assignment.name%>:</h2>
<br>

<h3>Submissions made public by peers:</h3>
<% if @assignment_due_date==nil or @assignment_due_date>Time.new() %>
<br><i>Will be available once the assignment submission is completed</i>
<% elsif @assignment_teams==[] %>
<br><i>No sample submissions from current assignment made public yet</i>
<% else %>
<ul>
<% @assignment_teams.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<li>
<ul>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</ul>
</li>
<%end%>
<% end%>
</ul>
<% end %>
<br>
<hr/>
<br>


<h3>Submissions made public by instructor:</h3>
<% if @assignment_teams_professor == [] %>
<br><i>No sample submissions from previous assignments made available yet</i>
<% else %>
<ul>
<% @assignment_teams_professor.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<ul>
<li>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</li>
</ul>
<%end%>
<% end%>
</ul>
<% end %>
<br><br>

<a href="javascript:window.history.back()">Back</a>
</pre>
5. Make changes to page student_task/view which would have link to sample submissions for each project.
<pre>
<li>
<%= link_to "Sample Submissions", controller: 'sample_submissions', :action => 'index', :id => @assignment.id %>
(View sample work submitted by other participants/teams)
</li>
</pre>
6. Add drop down in assignments/edit/_general view.
<pre>

<tr>
<td style='padding:5px'><%= label_tag('assignment_form[assignment][sample_assignment_id]', 'Sample Assignment:') %>
<img src="/assets/info.png" title='- Select an assignment that students can refer sample submission from.'>
</td>
<td style='padding:5px'><%= select('assignment_form[assignment]', 'sample_assignment_id', sample_sub_options, :selected => @assignment_form.assignment.sample_assignment_id) %>
</td>
</tr>
</pre>
7. Add controller code for the drop down.
<pre>
def sample_sub_options
assignments = Assignment.all
options = []
assignments.each do |assignment|
course_name = ""
if assignment.course_id and assignment.course_id != 0 and !Course.find(assignment.course_id).nil?
course_name = Course.find(assignment.course_id).name
end
options << [course_name + '- ' + assignment.name, assignment.id]
end
options.uniq.sort
options.unshift(['-----------', nil])
end
</pre>
8. Add column sample_assignment_id to table assignment.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
9. Add test scripts for all the functionality.
<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Sample Submissions View ==

1. The first screenshot of the application is taken when the deadline for the current assignment has not crossed and the instructor also has not given any sample assignment for this assignment.

[[Image:Assignments not made public.PNG]]

2. The second screenshot of the application is taken when the deadline for the current assignment has not crossed but the instructor has selected a sample assignment for viewing against this assignment.

[[Image:Assignment submission date not passed.PNG]]

3. The third screenshot of the application is taken when both the deadline for the current assignment has crossed and the instructor has selected a sample assignment for viewing.

[[Image:Assignments available.PNG]]

== Test Plan ==

Many of our changes are reflected on views (user interface). So we build tests with rspec/capybara. Following is the list of tests that conduct:

# it "is able to make an assignment public"
# it "is able to view sample submissions page"
# it "should not see current assignment submissions if deadline is not met"
# it "should see current assignment submissions if deadline is met"
# it "should not see instructor selected submissions if instructor has not selected them"
# it "should see instructor selected submissions if instructor has selected them"

<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Future Scope ==
# Publishing sample reviews made by students: This feature will require students to allow their review to be published as a sample review. This can then be made available to future students.

== External Links ==
# link to forked repository [https://github.com/ashiskumar123/expertiza]
# link to the git pull request [https://github.com/expertiza/expertiza/pull/1169]
# link to the deployed application [http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000]

== References ==
# Link to expertiza website: [https://expertiza.ncsu.edu/]

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-04T21:26:42Z

Aksahoo: /* Current status of Development */

== Introduction ==
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University]. Peer review is a great way for a student to learn how to approach a project and get ideas for their own projects. Currently, there is no way for a student to view another student's work, unless they are reviewing the other student's work.

== Problem Statement ==
The objective of this project is to:
# Add a feature to allow teams to publish their work for other students to see.
# Add a feature for a student to view sample submissions for a given assignment made available by other students:
## In the same assignment, available after deadline.
## In an old assignment, selected by the instructor from sample submissions made in an old assignment.
# Add a feature for instructor to select a previous assignment to show sample submissions for a new assignment.

== Proposed Design ==
The proposed features will involve two kinds of users : Students and Instructors.
Students will use the application to make their submissions public and view published reviews.

[[File:Application Flow Student.png]]

Instructors will use the application to make submissions from a previous assignment available as sample submissions for a current assignment. Only those submissions will be visible which were previously made public by the students.

[[Image:Application Flow Instructor.png]]

== Project Tasks ==
The tasks that need to be completed as part of this project can be listed as follows:
# Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
# Add column make_public to table teams for storing user permission (published or not) for each project.
# Add controller for Sample submissions and implement corresponding methods.
# Add views for sample submissions
# Make changes to page student_task/view which would have link to sample submissions for each project.
# Add drop down in assignments/edit/_general view.
# Add controller code for the drop down.
# Add column sample_assignment_id to table assignment.
# Add test scripts for all the functionality.

== Current status of Development ==
All tasks mentioned in Project tasks are completed.

== Developed Code ==
1. Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
<pre>
<% if !participant.team.nil? %>
<td align=center>
<input id="makeSubPublic" teamid="<%= participant.team.id %>" type="checkbox" onclick="publishConfirmation(this)" <% if participant.team.make_public %>checked<% end %>>
</td>
<% end %>
</pre>

2. Add column make_public to table teams for storing user permission (published or not) for each project.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
3. Add controller for Sample submissions and implement corresponding methods.
<pre>
# To give permission for making a submission available to others
def make_public
@team = Team.find(params[:id])
@team.make_public = params[:status]
@team.save
respond_to do |format|
format.html { head :no_content }
end
end
</pre>
4. Add views for sample submissions
<pre>

<h2>Sample Submissions for <%= @assignment.name%>:</h2>
<br>

<h3>Submissions made public by peers:</h3>
<% if @assignment_due_date==nil or @assignment_due_date>Time.new() %>
<br><i>Will be available once the assignment submission is completed</i>
<% elsif @assignment_teams==[] %>
<br><i>No sample submissions from current assignment made public yet</i>
<% else %>
<ul>
<% @assignment_teams.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<li>
<ul>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</ul>
</li>
<%end%>
<% end%>
</ul>
<% end %>
<br>
<hr/>
<br>


<h3>Submissions made public by instructor:</h3>
<% if @assignment_teams_professor == [] %>
<br><i>No sample submissions from previous assignments made available yet</i>
<% else %>
<ul>
<% @assignment_teams_professor.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<ul>
<li>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</li>
</ul>
<%end%>
<% end%>
</ul>
<% end %>
<br><br>

<a href="javascript:window.history.back()">Back</a>
</pre>
5. Make changes to page student_task/view which would have link to sample submissions for each project.
<pre>
<li>
<%= link_to "Sample Submissions", controller: 'sample_submissions', :action => 'index', :id => @assignment.id %>
(View sample work submitted by other participants/teams)
</li>
</pre>
6. Add drop down in assignments/edit/_general view.
<pre>

<tr>
<td style='padding:5px'><%= label_tag('assignment_form[assignment][sample_assignment_id]', 'Sample Assignment:') %>
<img src="/assets/info.png" title='- Select an assignment that students can refer sample submission from.'>
</td>
<td style='padding:5px'><%= select('assignment_form[assignment]', 'sample_assignment_id', sample_sub_options, :selected => @assignment_form.assignment.sample_assignment_id) %>
</td>
</tr>
</pre>
7. Add controller code for the drop down.
<pre>
def sample_sub_options
assignments = Assignment.all
options = []
assignments.each do |assignment|
course_name = ""
if assignment.course_id and assignment.course_id != 0 and !Course.find(assignment.course_id).nil?
course_name = Course.find(assignment.course_id).name
end
options << [course_name + '- ' + assignment.name, assignment.id]
end
options.uniq.sort
options.unshift(['-----------', nil])
end
</pre>
8. Add column sample_assignment_id to table assignment.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
9. Add test scripts for all the functionality.
<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Sample Submissions View ==

1. The first screenshot of the application is taken when the deadline for the current assignment has not crossed and the instructor also has not given any sample assignment for this assignment.

[[Image:Assignments not made public.PNG]]

2. The second screenshot of the application is taken when the deadline for the current assignment has not crossed but the instructor has selected a sample assignment for viewing against this assignment.

[[Image:Assignment submission date not passed.PNG]]

3. The third screenshot of the application is taken when both the deadline for the current assignment has crossed and the instructor has selected a sample assignment for viewing.

[[Image:Assignments available.PNG]]

== Test Plan ==

Many of our changes are reflected on views (user interface). So we build tests with rspec/capybara. Following is the list of tests that conduct:

# it "is able to make an assignment public"
# it "is able to view sample submissions page"
# it "should not see current assignment submissions if deadline is not met"
# it "should see current assignment submissions if deadline is met"
# it "should not see instructor selected submissions if instructor has not selected them"
# it "should see instructor selected submissions if instructor has selected them"

<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Future Scope ==
# Publishing sample reviews made by students: This feature will require students to allow their review to be published as a sample review. This can then be made available to future students.

== External Links ==
# link to forked repository [https://github.com/ashiskumar123/expertiza]
# link to the git pull request [https://github.com/expertiza/expertiza/pull/1164]
# link to the deployed application [http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000]

== References ==
# Link to expertiza website: [https://expertiza.ncsu.edu/]

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-04T04:21:19Z

Aksahoo:

== Introduction ==
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University]. Peer review is a great way for a student to learn how to approach a project and get ideas for their own projects. Currently, there is no way for a student to view another student's work, unless they are reviewing the other student's work.

== Problem Statement ==
The objective of this project is to:
# Add a feature to allow teams to publish their work for other students to see.
# Add a feature for a student to view sample submissions for a given assignment made available by other students:
## In the same assignment, available after deadline.
## In an old assignment, selected by the instructor from sample submissions made in an old assignment.
# Add a feature for instructor to select a previous assignment to show sample submissions for a new assignment.

== Proposed Design ==
The proposed features will involve two kinds of users : Students and Instructors.
Students will use the application to make their submissions public and view published reviews.

[[File:Application Flow Student.png]]

Instructors will use the application to make submissions from a previous assignment available as sample submissions for a current assignment. Only those submissions will be visible which were previously made public by the students.

[[Image:Application Flow Instructor.png]]

== Project Tasks ==
The tasks that need to be completed as part of this project can be listed as follows:
# Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
# Add column make_public to table teams for storing user permission (published or not) for each project.
# Add controller for Sample submissions and implement corresponding methods.
# Add views for sample submissions
# Make changes to page student_task/view which would have link to sample submissions for each project.
# Add drop down in assignments/edit/_general view.
# Add controller code for the drop down.
# Add column sample_assignment_id to table assignment.
# Add test scripts for all the functionality.

== Current status of Development ==
All tasks mentioned in Project tasks are implemented.

== Developed Code ==
1. Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
<pre>
<% if !participant.team.nil? %>
<td align=center>
<input id="makeSubPublic" teamid="<%= participant.team.id %>" type="checkbox" onclick="publishConfirmation(this)" <% if participant.team.make_public %>checked<% end %>>
</td>
<% end %>
</pre>

2. Add column make_public to table teams for storing user permission (published or not) for each project.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
3. Add controller for Sample submissions and implement corresponding methods.
<pre>
# To give permission for making a submission available to others
def make_public
@team = Team.find(params[:id])
@team.make_public = params[:status]
@team.save
respond_to do |format|
format.html { head :no_content }
end
end
</pre>
4. Add views for sample submissions
<pre>

<h2>Sample Submissions for <%= @assignment.name%>:</h2>
<br>

<h3>Submissions made public by peers:</h3>
<% if @assignment_due_date==nil or @assignment_due_date>Time.new() %>
<br><i>Will be available once the assignment submission is completed</i>
<% elsif @assignment_teams==[] %>
<br><i>No sample submissions from current assignment made public yet</i>
<% else %>
<ul>
<% @assignment_teams.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<li>
<ul>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</ul>
</li>
<%end%>
<% end%>
</ul>
<% end %>
<br>
<hr/>
<br>


<h3>Submissions made public by instructor:</h3>
<% if @assignment_teams_professor == [] %>
<br><i>No sample submissions from previous assignments made available yet</i>
<% else %>
<ul>
<% @assignment_teams_professor.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<ul>
<li>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</li>
</ul>
<%end%>
<% end%>
</ul>
<% end %>
<br><br>

<a href="javascript:window.history.back()">Back</a>
</pre>
5. Make changes to page student_task/view which would have link to sample submissions for each project.
<pre>
<li>
<%= link_to "Sample Submissions", controller: 'sample_submissions', :action => 'index', :id => @assignment.id %>
(View sample work submitted by other participants/teams)
</li>
</pre>
6. Add drop down in assignments/edit/_general view.
<pre>

<tr>
<td style='padding:5px'><%= label_tag('assignment_form[assignment][sample_assignment_id]', 'Sample Assignment:') %>
<img src="/assets/info.png" title='- Select an assignment that students can refer sample submission from.'>
</td>
<td style='padding:5px'><%= select('assignment_form[assignment]', 'sample_assignment_id', sample_sub_options, :selected => @assignment_form.assignment.sample_assignment_id) %>
</td>
</tr>
</pre>
7. Add controller code for the drop down.
<pre>
def sample_sub_options
assignments = Assignment.all
options = []
assignments.each do |assignment|
course_name = ""
if assignment.course_id and assignment.course_id != 0 and !Course.find(assignment.course_id).nil?
course_name = Course.find(assignment.course_id).name
end
options << [course_name + '- ' + assignment.name, assignment.id]
end
options.uniq.sort
options.unshift(['-----------', nil])
end
</pre>
8. Add column sample_assignment_id to table assignment.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
9. Add test scripts for all the functionality.
<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Sample Submissions View ==

1. The first screenshot of the application is taken when the deadline for the current assignment has not crossed and the instructor also has not given any sample assignment for this assignment.

[[Image:Assignments not made public.PNG]]

2. The second screenshot of the application is taken when the deadline for the current assignment has not crossed but the instructor has selected a sample assignment for viewing against this assignment.

[[Image:Assignment submission date not passed.PNG]]

3. The third screenshot of the application is taken when both the deadline for the current assignment has crossed and the instructor has selected a sample assignment for viewing.

[[Image:Assignments available.PNG]]

== Test Plan ==

Many of our changes are reflected on views (user interface). So we build tests with rspec/capybara. Following is the list of tests that conduct:

# it "is able to make an assignment public"
# it "is able to view sample submissions page"
# it "should not see current assignment submissions if deadline is not met"
# it "should see current assignment submissions if deadline is met"
# it "should not see instructor selected submissions if instructor has not selected them"
# it "should see instructor selected submissions if instructor has selected them"

<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Future Scope ==
# Publishing sample reviews made by students: This feature will require students to allow their review to be published as a sample review. This can then be made available to future students.

== External Links ==
# link to forked repository [https://github.com/ashiskumar123/expertiza]
# link to the git pull request [https://github.com/expertiza/expertiza/pull/1164]
# link to the deployed application [http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000]

== References ==
# Link to expertiza website: [https://expertiza.ncsu.edu/]

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T22:36:24Z

Aksahoo: /* Developed Code */

== Introduction ==
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University]. Peer review is a great way for a student to learn how to approach a project and get ideas for their own projects. Currently, there is no way for a student to view another student's work, unless they are reviewing the other student's work.

== Problem Statement ==
The objective of this project is to:
# Add a feature to allow teams to publish their work for other students to see.
# Add a feature for a student to view sample submissions for a given assignment made available by other students:
## In the same assignment, available after deadline.
## In an old assignment, selected by the instructor from sample submissions made in an old assignment.
# Add a feature for instructor to select a previous assignment to show sample submissions for a new assignment.

== Proposed Design ==
The proposed features will involve two kinds of users : Students and Instructors.
Students will use the application to make their submissions public and view published reviews.

[[File:Application Flow Student.png]]

Instructors will use the application to make submissions from a previous assignment available as sample submissions for a current assignment. Only those submissions will be visible which were previously made public by the students.

[[Image:Application Flow Instructor.png]]

== Project Tasks ==
The tasks that need to be completed as part of this project can be listed as follows:
# Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
# Add column make_public to table teams for storing user permission (published or not) for each project.
# Add controller for Sample submissions and implement corresponding methods.
# Add views for sample submissions
# Make changes to page student_task/view which would have link to sample submissions for each project.
# Add drop down in assignments/edit/_general view.
# Add controller code for the drop down.
# Add column sample_assignment_id to table assignment.
# Add test scripts for all the functionality.

== Current status of Development ==
All tasks mentioned in Project tasks are implemented.

== Developed Code ==
1. Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
<pre>
<% if !participant.team.nil? %>
<td align=center>
<input id="makeSubPublic" teamid="<%= participant.team.id %>" type="checkbox" onclick="publishConfirmation(this)" <% if participant.team.make_public %>checked<% end %>>
</td>
<% end %>
</pre>

2. Add column make_public to table teams for storing user permission (published or not) for each project.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
3. Add controller for Sample submissions and implement corresponding methods.
<pre>
# To give permission for making a submission available to others
def make_public
@team = Team.find(params[:id])
@team.make_public = params[:status]
@team.save
respond_to do |format|
format.html { head :no_content }
end
end
</pre>
4. Add views for sample submissions
<pre>

<h2>Sample Submissions for <%= @assignment.name%>:</h2>
<br>

<h3>Submissions made public by peers:</h3>
<% if @assignment_due_date==nil or @assignment_due_date>Time.new() %>
<br><i>Will be available once the assignment submission is completed</i>
<% elsif @assignment_teams==[] %>
<br><i>No sample submissions from current assignment made public yet</i>
<% else %>
<ul>
<% @assignment_teams.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<li>
<ul>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</ul>
</li>
<%end%>
<% end%>
</ul>
<% end %>
<br>
<hr/>
<br>


<h3>Submissions made public by instructor:</h3>
<% if @assignment_teams_professor == [] %>
<br><i>No sample submissions from previous assignments made available yet</i>
<% else %>
<ul>
<% @assignment_teams_professor.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<ul>
<li>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</li>
</ul>
<%end%>
<% end%>
</ul>
<% end %>
<br><br>

<a href="javascript:window.history.back()">Back</a>
</pre>
5. Make changes to page student_task/view which would have link to sample submissions for each project.
<pre>
<li>
<%= link_to "Sample Submissions", controller: 'sample_submissions', :action => 'index', :id => @assignment.id %>
(View sample work submitted by other participants/teams)
</li>
</pre>
6. Add drop down in assignments/edit/_general view.
<pre>

<tr>
<td style='padding:5px'><%= label_tag('assignment_form[assignment][sample_assignment_id]', 'Sample Assignment:') %>
<img src="/assets/info.png" title='- Select an assignment that students can refer sample submission from.'>
</td>
<td style='padding:5px'><%= select('assignment_form[assignment]', 'sample_assignment_id', sample_sub_options, :selected => @assignment_form.assignment.sample_assignment_id) %>
</td>
</tr>
</pre>
7. Add controller code for the drop down.
<pre>
def sample_sub_options
assignments = Assignment.all
options = []
assignments.each do |assignment|
course_name = ""
if assignment.course_id and assignment.course_id != 0 and !Course.find(assignment.course_id).nil?
course_name = Course.find(assignment.course_id).name
end
options << [course_name + '- ' + assignment.name, assignment.id]
end
options.uniq.sort
options.unshift(['-----------', nil])
end
</pre>
8. Add column sample_assignment_id to table assignment.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
9. Add test scripts for all the functionality.
<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== Sample Submissions View ==

1. The first screenshot of the application is taken when the deadline for the current assignment has not crossed and the instructor also has not given any sample assignment for this assignment.

[[Image:Assignments not made public.PNG]]

2. The second screenshot of the application is taken when the deadline for the current assignment has not crossed but the instructor has selected a sample assignment for viewing against this assignment.

[[Image:Assignment submission date not passed.PNG]]

3. The third screenshot of the application is taken when both the deadline for the current assignment has crossed and the instructor has selected a sample assignment for viewing.

[[Image:Assignments available.PNG]]

== Test Plan ==

Many of our changes are reflected on views (user interface). So we build tests with rspec/capybara. Following is the list of tests that conduct:

# it "is able to make an assignment public"
# it "is able to view sample submissions page"
# it "should not see current assignment submissions if deadline is not met"
# it "should see current assignment submissions if deadline is met"
# it "should not see instructor selected submissions if instructor has not selected them"
# it "should see instructor selected submissions if instructor has selected them"

<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== External Links ==
# link to forked repository [https://github.com/ashiskumar123/expertiza]
# link to the git pull request [https://github.com/expertiza/expertiza/pull/1164]
# link to the deployed application [http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000]

== References ==
# Link to expertiza website: [https://expertiza.ncsu.edu/]

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T13:20:04Z

Aksahoo: /* Test Plan */

== Introduction ==
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University]. Peer review is a great way for a student to learn how to approach a project and get ideas for their own projects. Currently, there is no way for a student to view another student's work, unless they are reviewing the other student's work.

== Problem Statement ==
The objective of this project is to:
# Add a feature to allow teams to publish their work for other students to see.
# Add a feature for a student to view sample submissions for a given assignment made available by other students:
## In the same assignment, available after deadline.
## In an old assignment, selected by the instructor from sample submissions made in an old assignment.
# Add a feature for instructor to select a previous assignment to show sample submissions for a new assignment.

== Proposed Design ==
The proposed features will involve two kinds of users : Students and Instructors.
Students will use the application to make their submissions public and view published reviews.

[[File:Application Flow Student.png]]

Instructors will use the application to make submissions from a previous assignment available as sample submissions for a current assignment. Only those submissions will be visible which were previously made public by the students.

[[Image:Application Flow Instructor.png]]

== Project Tasks ==
The tasks that need to be completed as part of this project can be listed as follows:
# Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
# Add column make_public to table teams for storing user permission (published or not) for each project.
# Add controller for Sample submissions and implement corresponding methods.
# Add views for sample submissions
# Make changes to page student_task/view which would have link to sample submissions for each project.
# Add drop down in assignments/edit/_general view.
# Add controller code for the drop down.
# Add column sample_assignment_id to table assignment.
# Add test scripts for all the functionality.

== Current status of Development ==
All tasks mentioned in Project tasks are implemented.

== Developed Code ==
1. Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
<pre>
<% if !participant.team.nil? %>
<td align=center>
<input id="makeSubPublic" teamid="<%= participant.team.id %>" type="checkbox" onclick="publishConfirmation(this)" <% if participant.team.make_public %>checked<% end %>>
</td>
<% end %>
</pre>

2. Add column make_public to table teams for storing user permission (published or not) for each project.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
3. Add controller for Sample submissions and implement corresponding methods.
<pre>
# To give permission for making a submission available to others
def make_public
@team = Team.find(params[:id])
@team.make_public = params[:status]
@team.save
respond_to do |format|
format.html { head :no_content }
end
end
</pre>
4. Add views for sample submissions
<pre>

<h2>Sample Submissions for <%= @assignment.name%>:</h2>
<br>

<h3>Submissions made public by peers:</h3>
<% if @assignment_due_date==nil or @assignment_due_date>Time.new() %>
<br><i>Will be available once the assignment submission is completed</i>
<% elsif @assignment_teams==[] %>
<br><i>No sample submissions from current assignment made public yet</i>
<% else %>
<ul>
<% @assignment_teams.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<li>
<ul>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</ul>
</li>
<%end%>
<% end%>
</ul>
<% end %>
<br>
<hr/>
<br>


<h3>Submissions made public by instructor:</h3>
<% if @assignment_teams_professor == [] %>
<br><i>No sample submissions from previous assignments made available yet</i>
<% else %>
<ul>
<% @assignment_teams_professor.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<ul>
<li>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</li>
</ul>
<%end%>
<% end%>
</ul>
<% end %>
<br><br>

<a href="javascript:window.history.back()">Back</a>
</pre>
5. Make changes to page student_task/view which would have link to sample submissions for each project.
<pre>
<li>
<%= link_to "Sample Submissions", controller: 'sample_submissions', :action => 'index', :id => @assignment.id %>
(View sample work submitted by other participants/teams)
</li>
</pre>
6. Add drop down in assignments/edit/_general view.
<pre>

<tr>
<td style='padding:5px'><%= label_tag('assignment_form[assignment][sample_assignment_id]', 'Sample Assignment:') %>
<img src="/assets/info.png" title='- Select an assignment that students can refer sample submission from.'>
</td>
<td style='padding:5px'><%= select('assignment_form[assignment]', 'sample_assignment_id', sample_sub_options, :selected => @assignment_form.assignment.sample_assignment_id) %>
</td>
</tr>
</pre>
7. Add controller code for the drop down.
<pre>
def sample_sub_options
assignments = Assignment.all
options = []
assignments.each do |assignment|
course_name = ""
if assignment.course_id and assignment.course_id != 0 and !Course.find(assignment.course_id).nil?
course_name = Course.find(assignment.course_id).name
end
options << [course_name + '- ' + assignment.name, assignment.id]
end
options.uniq.sort
options.unshift(['-----------', nil])
end
</pre>
8. Add column sample_assignment_id to table assignment.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
9. Add test scripts for all the functionality.
<pre>
</pre>

== Sample Submissions View ==

1. The first screenshot of the application is taken when the deadline for the current assignment has not crossed and the instructor also has not given any sample assignment for this assignment.

[[Image:Assignments not made public.PNG]]

2. The second screenshot of the application is taken when the deadline for the current assignment has not crossed but the instructor has selected a sample assignment for viewing against this assignment.

[[Image:Assignment submission date not passed.PNG]]

3. The third screenshot of the application is taken when both the deadline for the current assignment has crossed and the instructor has selected a sample assignment for viewing.

[[Image:Assignments available.PNG]]

== Test Plan ==

Many of our changes are reflected on views (user interface). So we build tests with rspec/capybara. Following is the list of tests that conduct:

# it "is able to make an assignment public"
# it "is able to view sample submissions page"
# it "should not see current assignment submissions if deadline is not met"
# it "should see current assignment submissions if deadline is met"
# it "should not see instructor selected submissions if instructor has not selected them"
# it "should see instructor selected submissions if instructor has selected them"

<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== External Links ==
# link to forked repository [https://github.com/ashiskumar123/expertiza]
# link to the git pull request [https://github.com/expertiza/expertiza/pull/1164]
# link to the deployed application [http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000]

== References ==
# Link to expertiza website: [https://expertiza.ncsu.edu/]

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T13:18:07Z

Aksahoo: /* Test Plan */

== Introduction ==
[http://expertiza.ncsu.edu/ Expertiza] is a web based open source peer reviewing tool developed and maintained by current and past students of [https://en.wikipedia.org/wiki/North_Carolina_State_University North Carolina State University]. Peer review is a great way for a student to learn how to approach a project and get ideas for their own projects. Currently, there is no way for a student to view another student's work, unless they are reviewing the other student's work.

== Problem Statement ==
The objective of this project is to:
# Add a feature to allow teams to publish their work for other students to see.
# Add a feature for a student to view sample submissions for a given assignment made available by other students:
## In the same assignment, available after deadline.
## In an old assignment, selected by the instructor from sample submissions made in an old assignment.
# Add a feature for instructor to select a previous assignment to show sample submissions for a new assignment.

== Proposed Design ==
The proposed features will involve two kinds of users : Students and Instructors.
Students will use the application to make their submissions public and view published reviews.

[[File:Application Flow Student.png]]

Instructors will use the application to make submissions from a previous assignment available as sample submissions for a current assignment. Only those submissions will be visible which were previously made public by the students.

[[Image:Application Flow Instructor.png]]

== Project Tasks ==
The tasks that need to be completed as part of this project can be listed as follows:
# Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
# Add column make_public to table teams for storing user permission (published or not) for each project.
# Add controller for Sample submissions and implement corresponding methods.
# Add views for sample submissions
# Make changes to page student_task/view which would have link to sample submissions for each project.
# Add drop down in assignments/edit/_general view.
# Add controller code for the drop down.
# Add column sample_assignment_id to table assignment.
# Add test scripts for all the functionality.

== Current status of Development ==
All tasks mentioned in Project tasks are implemented.

== Developed Code ==
1. Add checkbox against each assignment in student_tasks/list view to allow student to publish their work
<pre>
<% if !participant.team.nil? %>
<td align=center>
<input id="makeSubPublic" teamid="<%= participant.team.id %>" type="checkbox" onclick="publishConfirmation(this)" <% if participant.team.make_public %>checked<% end %>>
</td>
<% end %>
</pre>

2. Add column make_public to table teams for storing user permission (published or not) for each project.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
3. Add controller for Sample submissions and implement corresponding methods.
<pre>
# To give permission for making a submission available to others
def make_public
@team = Team.find(params[:id])
@team.make_public = params[:status]
@team.save
respond_to do |format|
format.html { head :no_content }
end
end
</pre>
4. Add views for sample submissions
<pre>

<h2>Sample Submissions for <%= @assignment.name%>:</h2>
<br>

<h3>Submissions made public by peers:</h3>
<% if @assignment_due_date==nil or @assignment_due_date>Time.new() %>
<br><i>Will be available once the assignment submission is completed</i>
<% elsif @assignment_teams==[] %>
<br><i>No sample submissions from current assignment made public yet</i>
<% else %>
<ul>
<% @assignment_teams.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<li>
<ul>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</ul>
</li>
<%end%>
<% end%>
</ul>
<% end %>
<br>
<hr/>
<br>


<h3>Submissions made public by instructor:</h3>
<% if @assignment_teams_professor == [] %>
<br><i>No sample submissions from previous assignments made available yet</i>
<% else %>
<ul>
<% @assignment_teams_professor.each do |assignment_team| %>
<% if assignment_team.hyperlinks != [] %>
<ul>
<li>
<h4>Team name : <%=assignment_team.name%></h4>
<% assignment_team.hyperlinks.each do |assignment_link| %>
<li><a href="<%=assignment_link%>"><%=assignment_link%></a></li>
<%end%>
</li>
</ul>
<%end%>
<% end%>
</ul>
<% end %>
<br><br>

<a href="javascript:window.history.back()">Back</a>
</pre>
5. Make changes to page student_task/view which would have link to sample submissions for each project.
<pre>
<li>
<%= link_to "Sample Submissions", controller: 'sample_submissions', :action => 'index', :id => @assignment.id %>
(View sample work submitted by other participants/teams)
</li>
</pre>
6. Add drop down in assignments/edit/_general view.
<pre>

<tr>
<td style='padding:5px'><%= label_tag('assignment_form[assignment][sample_assignment_id]', 'Sample Assignment:') %>
<img src="/assets/info.png" title='- Select an assignment that students can refer sample submission from.'>
</td>
<td style='padding:5px'><%= select('assignment_form[assignment]', 'sample_assignment_id', sample_sub_options, :selected => @assignment_form.assignment.sample_assignment_id) %>
</td>
</tr>
</pre>
7. Add controller code for the drop down.
<pre>
def sample_sub_options
assignments = Assignment.all
options = []
assignments.each do |assignment|
course_name = ""
if assignment.course_id and assignment.course_id != 0 and !Course.find(assignment.course_id).nil?
course_name = Course.find(assignment.course_id).name
end
options << [course_name + '- ' + assignment.name, assignment.id]
end
options.uniq.sort
options.unshift(['-----------', nil])
end
</pre>
8. Add column sample_assignment_id to table assignment.
<pre>
class AddSampleAssignmentToAssignments < ActiveRecord::Migration
def change
add_column :assignments, :sample_assignment_id, :integer, index: true
add_foreign_key :assignments, :assignments, column: :sample_assignment_id
end
end
</pre>
9. Add test scripts for all the functionality.
<pre>
</pre>

== Sample Submissions View ==

1. The first screenshot of the application is taken when the deadline for the current assignment has not crossed and the instructor also has not given any sample assignment for this assignment.

[[Image:Assignments not made public.PNG]]

2. The second screenshot of the application is taken when the deadline for the current assignment has not crossed but the instructor has selected a sample assignment for viewing against this assignment.

[[Image:Assignment submission date not passed.PNG]]

3. The third screenshot of the application is taken when both the deadline for the current assignment has crossed and the instructor has selected a sample assignment for viewing.

[[Image:Assignments available.PNG]]

== Test Plan ==

Many of our changes are reflected on views (user interface). So we build tests with capybara. Following is the list of tests that conduct:

# it "is able to make an assignment public"
# it "is able to view sample submissions page"
# it "should not see current assignment submissions if deadline is not met"
# it "should see current assignment submissions if deadline is met"
# it "should not see instructor selected submissions if instructor has not selected them"
# it "should see instructor selected submissions if instructor has selected them"

<pre>
def create_assignment_team(assignment_name, parent_id)
assignment_team = AssignmentTeam.new
assignment_team.name = assignment_name
assignment_team.parent_id = parent_id
assignment_team.save!
end

def init_test
# create assignment and topic
assignment = build(Assignment)
course = Course.new
course.name = "SampleSubmissionTestCourse"
course.save
assignment.course_id = course.id
assignment.save

create_assignemnt_team("ss_assignment_team_1", assignment.id)
create_assignemnt_team("ss_assignment_team_2", assignment.id)
end

def visit_sample_submissions_page
visit '/student_task/list'
click_on "Example Assignment"
click_on "Sample Submissions"
end

describe "sample submission test" do
before(:each) { init_test }

it "is able to make an assignment public" do
visit '/student_task/list'
find(:css, "#makeSubPublic[teamid='6050']").trigger("click")
click_button 'OK'
expect(page).to have_http_status(200)
end

it "should not see current assignment submissions if deadline is not met" do # Set deadline after current time.
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from current assignment made public yet"
end

it "should see current assignment submissions if deadline is met" do # Set deadline before current time.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from current assignment made public yet"
end

it "should not see instructor selected submissions if instructor has not selected them" do
visit_sample_submissions_page
expect(page).to have_content "No sample submissions from previous assignment made available yet"
end

it "should see instructor selected submissions if instructor has selected them" do # Instructor makes submission available.
visit_sample_submissions_page
expect(page).to_not have_content "No sample submissions from previous assignment made available yet"
end
end
</pre>

== External Links ==
# link to forked repository [https://github.com/ashiskumar123/expertiza]
# link to the git pull request [https://github.com/expertiza/expertiza/pull/1164]
# link to the deployed application [http://ec2-13-59-7-94.us-east-2.compute.amazonaws.com:3000]

== References ==
# Link to expertiza website: [https://expertiza.ncsu.edu/]

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T03:45:34Z

Aksahoo: /* References */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T03:43:27Z

Aksahoo: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T03:42:54Z

Aksahoo: /* Test Plan */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T03:39:30Z

Aksahoo: /* External Links */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T03:38:56Z

Aksahoo: /* Tests */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T01:39:55Z

Aksahoo: /* Problem Statement */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T01:36:26Z

Aksahoo: /* External Links */

CSC/ECE 517 Spring 2018- Project E1810: Show sample submissions and reviews

2018-04-03T01:28:31Z