Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-05T04:51:50Z

Hxia3: /* Links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

Run test using the command "rspec spec/features/student_sign_in_spec.rb"

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

Run test using the command "rspec spec/features/add_member_spec.rb "

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, as this user has already signed up for this topic, we should get the following message: Your topic(s): Self-plagiarism.
# sign out
Run test using the command "rspec spec/features/select_a_topic_spec.rb "

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# sign out
Run test using the command "rspec spec/features/select_a_submission_to_review_spec.rb "

=== Bring up a review form ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# check that a review form has successfully been created
Run test using the command "rspec spec/features/bring_up_review_form_spec.rb "

=== Fill out and submit a review form ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# fill out all text fields
# select all scores from dropdowns
# save form
# check for successful save
Run test using the command "rspec spec/features/fill_out_review_form_spec.rb "

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.
To run this test run: $ rspec spec/features/student_view_score.rb

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Check for confirmation that the feedback was saved
To run this test run:$ rspec spec/features/review_feedback.rb

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Pull requests link: https://github.com/expertiza/expertiza/pull/640
*Demo videos(4 in total): 
1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE 
2. https://drive.google.com/a/ncsu.edu/file/d/0B-l-xu44qiJUZDRFMU02U09kZWs/view?usp=sharing 
3. https://drive.google.com/a/ncsu.edu/file/d/0B80MLsKsoSOmWFdvYThJZzdCVVE/view?usp=sharing 
4. https://drive.google.com/a/ncsu.edu/file/d/0B7dSj1bvwNp9X29TTHJMVFhPWkE/view?usp=sharing 
Note: There is a problem at the end of the third video and the save can not complete because of a time out issue. This does not effect the test, just the ability to demonstrate the test.

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-05T04:39:35Z

Hxia3: /* We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb " */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

Run test using the command "rspec spec/features/student_sign_in_spec.rb"

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

Run test using the command "rspec spec/features/add_member_spec.rb "

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, as this user has already signed up for this topic, we should get the following message: Your topic(s): Self-plagiarism.
# sign out
Run test using the command "rspec spec/features/select_a_topic_spec.rb "

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# sign out
Run test using the command "rspec spec/features/select_a_submission_to_review_spec.rb "

=== Bring up a review form ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# check that a review form has successfully been created
Run test using the command "rspec spec/features/bring_up_review_form_spec.rb "

=== Fill out and submit a review form ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# fill out all text fields
# select all scores from dropdowns
# save form
# check for successful save
Run test using the command "rspec spec/features/fill_out_review_form_spec.rb "

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.
To run this test run: $ rspec spec/features/student_view_score.rb

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Check for confirmation that the feedback was saved
To run this test run:$ rspec spec/features/review_feedback.rb

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Demo videos(4 in total): 
1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE 
2. https://drive.google.com/a/ncsu.edu/file/d/0B-l-xu44qiJUZDRFMU02U09kZWs/view?usp=sharing 
3. https://drive.google.com/a/ncsu.edu/file/d/0B80MLsKsoSOmWFdvYThJZzdCVVE/view?usp=sharing 
4. https://drive.google.com/a/ncsu.edu/file/d/0B7dSj1bvwNp9X29TTHJMVFhPWkE/view?usp=sharing 
Note: There is a problem at the end of the third video and the save can not complete because of a time out issue. This does not effect the test, just the ability to demonstrate the test.

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-05T04:39:06Z

Hxia3: /* We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb" */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

Run test using the command "rspec spec/features/student_sign_in_spec.rb"

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, as this user has already signed up for this topic, we should get the following message: Your topic(s): Self-plagiarism.
# sign out
Run test using the command "rspec spec/features/select_a_topic_spec.rb "

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# sign out
Run test using the command "rspec spec/features/select_a_submission_to_review_spec.rb "

=== Bring up a review form ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# check that a review form has successfully been created
Run test using the command "rspec spec/features/bring_up_review_form_spec.rb "

=== Fill out and submit a review form ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# fill out all text fields
# select all scores from dropdowns
# save form
# check for successful save
Run test using the command "rspec spec/features/fill_out_review_form_spec.rb "

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.
To run this test run: $ rspec spec/features/student_view_score.rb

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Check for confirmation that the feedback was saved
To run this test run:$ rspec spec/features/review_feedback.rb

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Demo videos(4 in total): 
1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE 
2. https://drive.google.com/a/ncsu.edu/file/d/0B-l-xu44qiJUZDRFMU02U09kZWs/view?usp=sharing 
3. https://drive.google.com/a/ncsu.edu/file/d/0B80MLsKsoSOmWFdvYThJZzdCVVE/view?usp=sharing 
4. https://drive.google.com/a/ncsu.edu/file/d/0B7dSj1bvwNp9X29TTHJMVFhPWkE/view?usp=sharing 
Note: There is a problem at the end of the third video and the save can not complete because of a time out issue. This does not effect the test, just the ability to demonstrate the test.

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-05T01:37:31Z

Hxia3: /* Select a submission to review */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, as this user has already signed up for this topic, we should get the following message: Your topic(s): Self-plagiarism.
# sign out
Run test using the command "rspec spec/features/select_a_topic_spec.rb "

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# sign out
Run test using the command "rspec spec/features/select_a_submission_to_review_spec.rb "

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# open a review form
# fill out all text fields
# select all scores from dropdowns
# submit form
# check for successful save

* Scenario 2:
# open a review form
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# fill out some text fields
# select some scores
# save form
# reopen form
# fill out remaining fields and scores
# save form
# check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.
To run this test run: $ rspec spec/features/student_view_score.rb

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Check for confirmation that the feedback was saved
To run this test run:$ rspec spec/features/review_feedback.rb

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Demo videos(4 in total):
1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE
2. https://drive.google.com/a/ncsu.edu/file/d/0B-l-xu44qiJUZDRFMU02U09kZWs/view?usp=sharing
3.
4. https://drive.google.com/a/ncsu.edu/file/d/0B7dSj1bvwNp9X29TTHJMVFhPWkE/view?usp=sharing

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-05T01:05:22Z

Hxia3: /* Links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, as this user has already signed up for this topic, we should get the following message: Your topic(s): Self-plagiarism.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# open a review form
# fill out all text fields
# select all scores from dropdowns
# submit form
# check for successful save

* Scenario 2:
# open a review form
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# fill out some text fields
# select some scores
# save form
# reopen form
# fill out remaining fields and scores
# save form
# check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.
To run this test run: $ rspec spec/features/student_view_score.rb

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Check for confirmation that the feedback was saved
To run this test run:$ rspec spec/features/review_feedback.rb

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Demo videos(4 in total):
1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE
2. https://drive.google.com/a/ncsu.edu/file/d/0B-l-xu44qiJUZDRFMU02U09kZWs/view?usp=sharing
3.
4. https://drive.google.com/a/ncsu.edu/file/d/0B7dSj1bvwNp9X29TTHJMVFhPWkE/view?usp=sharing

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T22:13:45Z

Hxia3: /* Test Plan */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, as this user has already signed up for this topic, we should get the following message: Your topic(s): Self-plagiarism.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click 'Begin'
# check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# open a review form
# fill out all text fields
# select all scores from dropdowns
# submit form
# check for successful save

* Scenario 2:
# open a review form
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# fill out some text fields
# select some scores
# save form
# reopen form
# fill out remaining fields and scores
# save form
# check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Demo videos(4 in total): 1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T16:55:25Z

Hxia3: /* Links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features
*Demo videos(4 in total): 1. https://drive.google.com/open?id=0B3EOsci5DEveMGZOdVNIazJlNVE

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:24:02Z

Hxia3: /* We have "add_member_spec.rb" to do this task. Run test use the command "rspec spec/features/add_member_spec.rb " */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test using the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:23:50Z

Hxia3: /* We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb" */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Run test using command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test use the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:23:14Z

Hxia3: /* Add someone to a team */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test use the command "rspec spec/features/add_member_spec.rb "====

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:23:04Z

Hxia3: /* Add someone to a team */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

====We have "add_member_spec.rb" to do this task. Run test use the command "rspec spec/features/add_member_spec.rb "

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:21:37Z

Hxia3: /* Add someone to a team */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link certain assignment(in this test: Ethical analysis 2)
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’

On this page, we expect the sender's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:19:46Z

Hxia3: /* Links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
*Github repository: https://github.com/xhy279/expertiza/tree/fall2015/spec/features

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:19:28Z

Hxia3: /* External links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==Links==
* Github repository: [https://github.com/xhy279/expertiza/tree/fall2015/spec/features]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:11:02Z

Hxia3: /* We have file "student_sign_in.rb" do this take. Please run command " rspec spec/features/student_sign_in_spec.rb" */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have test file "student_sign_in.rb" do this task. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==External links==
* [http://rspec.info/ Official website]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-12-04T02:10:25Z

Hxia3: /* Log in */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

==== We have file "student_sign_in.rb" do this take. Please run command " rspec spec/features/student_sign_in_spec.rb"====

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==External links==
* [http://rspec.info/ Official website]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-11-17T02:04:55Z

Hxia3: /* Testing tools */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave. It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==External links==
* [http://rspec.info/ Official website]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-11-17T02:04:27Z

Hxia3: /* External links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave.<ref name="origin">Ed Gibbs, [http://edgibbs.com/2007/12/02/jbehave-and-rspec-history/ JBehave and RSpec History] (Blog entry)</ref> It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==External links==
* [http://rspec.info/ Official website]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-11-17T02:04:19Z

Hxia3: /* Respond to a review (“author feedback”) */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave.<ref name="origin">Ed Gibbs, [http://edgibbs.com/2007/12/02/jbehave-and-rspec-history/ JBehave and RSpec History] (Blog entry)</ref> It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==External links==
[http://rspec.info/ Official website]

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-11-17T02:03:56Z

Hxia3: /* External links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave.<ref name="origin">Ed Gibbs, [http://edgibbs.com/2007/12/02/jbehave-and-rspec-history/ JBehave and RSpec History] (Blog entry)</ref> It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

CSC/ECE 517 Fall 2015 E1581 Integration testing for student interface

2015-11-17T02:03:39Z

Hxia3: /* External links */

Create integration tests for the student interface using capybara and rspec. Integration testing is the phase in software testing in which individual software modules are combined and tested as a group. It occurs after unit testing and before validation testing. Integration testing takes as its input modules that have been unit tested, groups them in larger aggregates, applies tests defined in an integration test plan to those aggregates, and delivers as its output the integrated system ready for system testing.

== Design ==
To properly execute the integration tests we will write the test cases to mimic a user operating the system. We will create strong integration test cases to help ensure the outcome of application's student interface remains the same regardless of changes to its inner functionality. In an attempt to keep our tests DRY we will put common code in a support directory.

== Testing tools ==
'''RSpec''' is a behavior-driven development (BDD) framework for the Ruby (programming language)|Ruby programming language, inspired by JBehave.<ref name="origin">Ed Gibbs, [http://edgibbs.com/2007/12/02/jbehave-and-rspec-history/ JBehave and RSpec History] (Blog entry)</ref> It contains its own mocking framework that is fully integrated into the framework based upon JMock.

'''Capybara''' is a web-based automation framework used for creating functional tests which can simulate how users would interact with your application.

== Test Plan ==
There are 8 features to be tested:
# Log in
# Add someone to a team Should not be possible if you exceed the max # of team members)
# Select a topic(if the assignment has topics)
# Select a submission to review For assignments with or without topics
# Bring up a review form
# Fill out & submit a review form
# View your scores
# Respond to a review (“author feedback”)

=== Log in ===
we create a file called ‘student_signin_spec.rb’. We define a method named login; and because we need this method in every later feature test we will put this in the support directory.
* Scenario 1: Log in with ‘invalid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘Invalid username/password’ appear in the new page.
* Scenario 2: Log in with ‘valid combination of username and password’
When we sign in with correct name and password; we expect that there should be content ‘User: (username)’ appear in the new page.

=== Add someone to a team ===
* Scenario 1: Team member exceed max amount
# Sign in
# Click link assignment
# Click link “Your team”
# Fill in the box with invitation receiver name and click button send invitation.
After doing these steps, we expect fault would happen. We could capture contents ‘Your team already has max members.’
* Scenario 2 : Team member don't exceed max amount
# Sign in
# Click link certain assignment
# Click link “Your team”
# Fill in the text area with invitation receiver name
# Click send invitation button
# Sign out.
# Sign in as receiver
# Click link assignment
# Click link “Your team”
# Click button ‘accept’
# Sign out.
# Sign in as the sender
# Click link certain assignment
# Click link “Your team”
On this page, we expect the receiver's name will appear.

=== Select a topic ===
Note: assignment has topics

We need the following steps:
# sign in.
# click the link for assignment
# click link “signup sheet”
# click the sign up for the remaining topic we want, or join the waiting list if the topic is not available.
# sign out

=== Select a submission to review ===
# sign in.
# click the link for the assignment we want to review.
# click the link for “other’s work”
# click the link for the submission we want to review
# fill in all the required forms, and then click “save” to save our review.
# sign out

=== Bring up a review form ===
Repeated for an assignment without a topic and an assignment with a topic
# Execute the ‘Request a new submission’ button action
# Check that a review form has successfully been created

=== Fill out and submit a review form ===
* Scenario 1:
Note: Do this for an assignment without a topic and an assignment with a topic.
# Open a review form
# Fill out all text fields
# Select all scores from dropdowns
# Submit form
# Check for successful save
* Scenario 2:
# Open a review form
# Fill out some text fields
# Select some scores
# Save form
# Reopen form
# Fill out remaining fields and scores
# Save form
# Check for successful save

=== View your scores ===
* Scenario 1: No Scores available yet
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that nothing exists yet
# Check for dashes.
* Scenario 2: Scores available.
# Sign in
# Click link for Assignment
# Click ‘Your scores’
# Check that displayed scores match scores independently calculated from all reviews.

=== Respond to a review (“author feedback”) ===
# Sign in as author
# Click link for Assignment
# Click ‘Your scores’
# Click ‘show reviews’
# Click ‘Give feedback’
# Fill out Feedback form
# Click Save Feedback
# Sign out
# Sign in as reviewer
# Click link for Assignment
# Click ‘Other’s work’
# Check that a feedback exists.

==External links==
[http://rspec.info/ Official website]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:59:50Z

Hxia3: /* RUN TEST: rspec spec/models/answer_spec.rb */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

=RUN TEST with command in terminal: rspec spec/models/answer_spec.rb=

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to 'Assignments' then pick an assignment; and check scores. The result remains same.

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:59:27Z

Hxia3: /* RUN the Test: rspec spec/models/answer_spec.rb */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

=RUN TEST: rspec spec/models/answer_spec.rb=

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to 'Assignments' then pick an assignment; and check scores. The result remains same.

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:58:48Z

Hxia3: /* Command to run the test: rspec spec/models/answer_spec.rb */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

=RUN the Test: rspec spec/models/answer_spec.rb=

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to 'Assignments' then pick an assignment; and check scores. The result remains same.

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:57:37Z

Hxia3: /* Command to run the test: rspec spec/models/answer_spec.rb */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

=Command to run the test: rspec spec/models/answer_spec.rb=

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to 'Assignments' then pick an assignment; and check scores. The result remains same.

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:53:32Z

Hxia3: /* Test from UI */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

====Command to run the test: rspec spec/models/answer_spec.rb====

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to 'Assignments' then pick an assignment; and check scores. The result remains same.

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:53:04Z

Hxia3: /* Test from UI */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

====Command to run the test: rspec spec/models/answer_spec.rb====

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to Assignments and pick an assignment; and check scores. The result remains same.

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-11-04T02:52:32Z

Hxia3:

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

====Command to run the test: rspec spec/models/answer_spec.rb====

require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

==Test from UI==
To verify that our code did not break the original functions. Sign in as instructor6 with password of 'password' and go to Assignments and pick an assignment; and check scores. The result remains same.

Go to Assignments
Pick an assignment, and check scores
=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-10-27T20:11:16Z

Hxia3: /* Relative links */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=Relative Links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-10-27T20:08:54Z

Hxia3: /* Relative links */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=Relative links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[http://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-10-27T20:08:07Z

Hxia3: /* Relative links */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=Relative links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[https://52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-10-27T20:07:30Z

Hxia3:

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=Relative links=
#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository]
#[52.10.11.33:3000 Deployment]
#[https://github.com/expertiza/expertiza/pull/584 Pull Request on GitHub]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-10-27T19:42:11Z

Hxia3: /* Rewrite Line 89 long SQL */

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrote Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

CSC/ECE 517 Fall 2015/ossE1568BZHXJS

2015-10-27T19:39:42Z

Hxia3: Created page with "== E1568. Remove AnswersController== = Introduction = Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc)..."

== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

CSC/ECE 517 Fall 2015

2015-10-27T19:38:58Z

Hxia3:

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]
*[[CSC/ECE 517 Fall 2015/oss/M1502/AAAASS]]
*[[CSC/ECE 517 Fall 2015/oss/M1503/IntegrateXMLParser]]
*[[CSC/ECE_517_Fall_2015/ossE1568BZHXJS]]

User:Hxia3

2015-10-27T19:31:50Z

Hxia3: /* Refactored self.compute_scores method */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project, the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T19:31:37Z

Hxia3: /* Command to run the test: rspec spec/models/answer_spec.rb */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T19:31:18Z

Hxia3: /* Command to run the test: rspec spec/models/answer_spec.rb */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
====Command to run the test: rspec spec/models/answer_spec.rb====
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T19:30:57Z

Hxia3: /* Command to run the test: rspec spec/models/answer_spec.rb */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
====Command to run the test: rspec spec/models/answer_spec.rb====
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'

#Unit test for 'compute_scores'
describe 'compute_scores' do
context 'when assessment is not nil' do
it 'should return valid scores' do
question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
assessment = 'Assessment'
scores1 = {max: 100, min: 100, avg: 100}
allow(Answer).to receive(:compute_stat).and_return([100, scores1])
expect(Answer.compute_scores([assessment], [question])).to eq scores1
end
end

context 'when assessment is nil' do
it 'should return nil for score hash' do
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_scores(nil, nil)).to eq scores2
end
end
end

#Unit test for 'computer_quiz_scores'
describe 'compute_quiz_scores' do
before(:each) {
allow_message_expectations_on_nil
}

context 'when responses is not nil' do
it 'should return valid scores' do
responses=Response.new
responses.id=1000
responses.created_at = DateTime.current
responses.updated_at = DateTime.current
responses.map_id=1
responses.additional_comment="additional_comment"
responses.version_num=1

allow(QuizQuestionnaire).to receive(:find)
allow(nil).to receive(:questions)
allow(nil).to receive(:reviewed_object_id)
allow(Answer).to receive(:get_total_score).and_return(100)
scores1 = {max: 100, min: 100, avg: 100}
expect(Answer.compute_quiz_scores([responses])).to eq scores1
end
end

context 'when responses is empty' do
it 'should return nil for score hash' do
responses = []
scores2 = {max: nil, min: nil, avg: nil}
expect(Answer.compute_quiz_scores(responses)).to eq scores2
end
end
end

#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
allow(Answer).to receive(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}

it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
allow(ScoreView).to receive(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end

it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end

end

#Unit test for 'compute_stat'
describe 'compute_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
allow(Answer).to receive(:get_total_score).and_return(100)
}

context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end

context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

#Unit test for 'submission valid'
describe 'submission valid' do
before(:each) {
allow_message_expectations_on_nil
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1

map=double(:ResponseMap)
allow(ResponseMap).to receive(:find).and_return(map)
allow(map).to receive(:reviewed_object_id)
allow(map).to receive(:reviewee_id)
allow(DueDate).to receive(:where).and_return(sorted_deadlines)
allow(sorted_deadlines).to receive(:order).and_return(sorted_deadlines)
allow(ResubmissionTime).to receive(:where)
allow(nil).to receive(:order)
allow(Answer).to receive(:latest_review_deadline)
}

it 'invalid should be 1' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end

it 'invalid should be 0' do
allow(@responses).to receive(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

#Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]

it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T19:27:31Z

Hxia3: /* Unit tests using Rspec */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
====Command to run the test: rspec spec/models/answer_spec.rb====
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:
====Command to run the test: rspec spec/models/answer_spec.rb====
require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T19:26:15Z

Hxia3: /* Refactored "submission_valid?" method */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
We found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:
====Command to run the test: rspec spec/models/answer_spec.rb====
===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T04:18:42Z

Hxia3: /* Refactored self.submission_valid? method */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored "submission_valid?" method==
we found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T04:16:56Z

Hxia3: /* Unit tests using Rspec */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored self.submission_valid? method==
we found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T04:16:15Z

Hxia3: /* Unit tests using Rspec */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored self.submission_valid? method==
we found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T04:13:21Z

Hxia3: /* Refactored self.submission_valid? method */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored self.submission_valid? method==
we found some parts of codes in the 'self.submission_valid?' method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as 'latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T04:12:42Z

Hxia3: /* Rewrite Line 89 long SQL */

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored self.submission_valid? method==
we found some parts of codes in the self.submission_valid? method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as "self.latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violates the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T01:33:24Z

Hxia3:

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored self.submission_valid? method==
we found some parts of codes in the self.submission_valid? method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as "self.latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violated the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

=References=

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/junjieshen/expertiza GitHub Project Repository Fork]

User:Hxia3

2015-10-27T01:30:57Z

Hxia3: Created page with "CSC/ECE_517_Fall_2015/ossE1568BZHXJS == E1568. Remove AnswersController== = Introduction = Expertiza is a web application where students can submit and peer-review learning obj..."

CSC/ECE_517_Fall_2015/ossE1568BZHXJS
== E1568. Remove AnswersController==

= Introduction =
Expertiza is a web application where students can submit and peer-review learning objects (articles, code, web sites, etc). It is used in select courses at NC State and by professors at several other colleges and universities. This page provides a description of the Expertiza based on OSS project. As the project, our team members successfully removed the answer controller, split confusing methods and provided all unit test in the Answer model. Changes can be found in the Answer.rb file which locates in expertiza/app/models/.

= Problem Statement =
There is a answer.rb file which handle all methods related to answer calculations. But there is no related view file related to AnswerController. All methods in it are show,action_allowed? and calculate_all_penalties. It is obvious that calculate_all_penalties method has already been deployed in GradesController. So we can get rid of calculate_all_penalties in AnswersController. Action_allowed? method is used to set the access authorization for different users.

= Changes =
==Remove AnswersController.rb==
Because there is not show view page related to show method. So we can remove AnswerController. This can be checked in the controllers folder.

==Refactored self.compute_scores method==
As described in OSS project , the self.compute_scores method is complex. Followed the principle that one method only do one thing, we split the the self.compute_scores by adding a method called self.compute_stat to take on some responsibilities from the self.compute_scores method, namely, computing the current score. Specific changes before and after are shown below:

===Before changes===
class Answer < ActiveRecord::Base
belongs_to :question
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil?&&assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments=assessments.length.to_f
assessments.each { |assessment|
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid==1
length_of_assessments=length_of_assessments-1
curr_score=0
end
total_score += curr_score
}
if (length_of_assessments!=0)
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg]=0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

----

===After changes===
====Method "compute_scores"====
# Computes the total score for a *list of assessments*
# parameters
# assessments - a list of assessments of some type (e.g., author feedback, teammate review)
# questions - the list of questions that was filled out in the process of doing those assessments
def self.compute_scores(assessments, questions)
scores = Hash.new
if !assessments.nil? && assessments.length > 0
scores[:max] = -999999999
scores[:min] = 999999999
total_score = 0
length_of_assessments = assessments.length.to_f
assessments.each do |assessment|
current_score, scores = compute_stat(assessment, questions, scores, length_of_assessments)
total_score += current_score
end
if length_of_assessments != 0
scores[:avg] = total_score.to_f / length_of_assessments
else
scores[:avg] = 0
end
else
scores[:max] = nil
scores[:min] = nil
scores[:avg] = nil
end
return scores
end

==== Method "compute_stat" ====
def self.compute_stat(assessment, questions, scores, length_of_assessments)
curr_score = get_total_score(:response => [assessment], :questions => questions)
if curr_score > scores[:max]
scores[:max] = curr_score
end
if curr_score < scores[:min]
scores[:min] = curr_score
end
# Check if the review is invalid. If is not valid do not include in score calculation
if @invalid == 1
length_of_assessments = length_of_assessments - 1
curr_score = 0
end
return curr_score, scores
end

==Refactored self.submission_valid? method==
we found some parts of codes in the self.submission_valid? method can be taken out as a individual method. To fulfill the function which calculates the latest review phase start time, we named this method as "self.latest_review_deadline". See the changes below:

===Before changes===
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if @sorted_deadlines.nil?
#find the latest review deadline
#less than current time
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in @sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if ((flag == 1) && (deadline.due_at <= current_time))
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if (deadline.deadline_type_id == 4 ||deadline.deadline_type_id == 2)
flag = 1
end
end
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response .is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

----

===After changes===
====Method "latest_review_deadline"====
def self.latest_review_deadline(sorted_deadlines)
flag = 0
latest_review_phase_start_time = nil
current_time = Time.new
for deadline in sorted_deadlines
# if flag is set then we saw a review deadline in the
# previous iteration - check if this deadline is a past
# deadline
if flag == 1 && deadline.due_at <= current_time
latest_review_phase_start_time = deadline.due_at
break
else
flag = 0
end
# we found a review or re-review deadline - examine the next deadline
# to check if it is past
if deadline.deadline_type_id == 4 || deadline.deadline_type_id == 2
flag = 1
end
end
return latest_review_phase_start_time
end

====Method "submission_valid?" ====
def self.submission_valid?(response)
if response
map=ResponseMap.find(response.map_id)
#assignment_participant = Participant.where(["id = ?", map.reviewee_id])
@sorted_deadlines = nil
@sorted_deadlines = DueDate.where(["assignment_id = ?", map.reviewed_object_id]).order('due_at DESC')
# to check the validity of the response
if !@sorted_deadlines.nil?
latest_review_phase_start_time = latest_review_deadline(@sorted_deadlines)
resubmission_times = ResubmissionTime.where(participant_id: map.reviewee_id).order('resubmitted_at DESC')
if response.is_valid_for_score_calculation?(resubmission_times, latest_review_phase_start_time)
@invalid = 0
else
@invalid = 1
end
return @invalid
end
end
end

==Changed code to Rails 4 format==
Line 89 SQL query uses 'find_by_sql' which is not in accord with Rails 4 format and we substituted it with 'where'; which can be reflected in Line 93 in our case.

==Rewrite Line 89 long SQL==
Since Line 89 SQL is too long, which violated the rule that code should be readable; thus we take the following measures:
questionnaire_data = ScoreView.where(type: 'Scale', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)
questionnaire_data += ScoreView.where(type: 'Criterion', q1_id: @questions[0].questionnaire_id, s_response_id: @response.id)

==Unit tests using Rspec==
There are six methods in the new version of answer.rb; so we performed six unit tests. The test file for Answer model is answer_spec.rb which can be found in the directory: expertiza/spec/models/ . Below is the unit test code:

require 'rspec'
require_relative '../rails_helper'
#Unit test for 'get_total_score'
describe 'get_total_score' do
before(:each) {
Answer.stub(:submission_valid?)
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
@question=Question.new(
txt: "qusetionaaaaa",
weight: 1,
questionnaire_id: 200,
type: "Criterion",
break_before: true)
}
it 'should return weighted total score when sum_of_weights > 0 && max_question_score' do
score = ScoreView.new(:type => 'Criterion',
:q1_id => @question.questionnaire_id,
:s_response_id => @responses.id,
:question_weight => 1,
:s_score => 5,
:q1_max_question_score => 5)
ScoreView.stub(:where).and_return([score])
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq 100
end
it 'should return -1 when sum_of_weights <= 0 or max_question_score does not exist' do
expect(Answer.get_total_score(:response => [@responses], :questions => [@question])).to eq -1
end
end

#Unit test for 'compute_stat'
describe 'computer_stat' do
before(:each) {
@scores = {max: -999999999, min: 999999999}
Answer.stub(:get_total_score).and_return(100)
}
context "when invalid is 1" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 1)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [0, @scores]
end
end
context "when invalid is 0" do
it 'should return current score and scores' do
Answer.instance_variable_set(:@invalid, 0)
expect(Answer.compute_stat(nil, nil, @scores, 5)).to eq [100, @scores]
end
end
end

# Unit test for 'submission_valid?'
describe 'submission valid' do
before(:each) {
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
@responses=Response.new
@responses.id=1000
@responses.created_at = DateTime.current
@responses.updated_at = DateTime.current
@responses.map_id=1
@responses.additional_comment="additional_comment"
@responses.version_num=1
map=double(:ResponseMap)
ResponseMap.stub(:find).and_return(map)
map.stub(:reviewed_object_id)
map.stub(:reviewee_id)
DueDate.stub(:where).and_return(sorted_deadlines)
sorted_deadlines.stub(:order).and_return(sorted_deadlines)
ResubmissionTime.stub(:where)
nil.stub(:order)
Answer.stub(:latest_review_deadline)
}
it 'invalid should be 1' do
@responses.stub(:is_valid_for_score_calculation?).and_return(false)
expect(Answer.submission_valid?(@responses)).to eq 1
end
it 'invalid should be 0' do
@responses.stub(:is_valid_for_score_calculation?).and_return(true)
expect(Answer.submission_valid?(@responses)).to eq 0
end
end

# Unit test for 'latest review deadline'
describe 'latest review deadline' do
late_due = DueDate.new(due_at: Time.parse("2020-10-30"), deadline_type_id: 2)
early_due = DueDate.new(due_at: Time.parse("2010-10-30"), deadline_type_id: 2)
sorted_deadlines = [late_due, early_due]
it 'should return early due date' do
expect(Answer.latest_review_deadline(sorted_deadlines)).to eq early_due.due_at
end
end

CSC/ECE 517 Fall 2015

2015-10-26T22:21:37Z

Hxia3: /* Writing Assignment 2 */

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]

CSC/ECE 517 Fall 2015

2015-10-26T22:20:58Z

Hxia3: /* Writing Assignment 2 */

==Writing Assignment 2==
*[[CSC/ECE_517_Fall_2015/sample_page]]
*[[CSC/ECE_517_Fall_2015/ossE1558BGJ]]
*[[CSC/ECE_517_Fall_2015/oss]]