Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T22:20:31Z

Zli36:

== '''Eexpertiza''' ==
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.
== '''Rspec''' ==
rspec is a meta-gem, which depends on the rspec-core, rspec-expectations and rspec-mocks gems. Each of these can be installed separately and loaded in isolation using require. Among other benefits, this allows you to use rspec-expectations, for example, in Test::Unit::TestCase if you happen to prefer that style.
Conversely, if you like RSpec's approach to declaring example groups and examples (describe and it) but prefer Test::Unit assertions and mocha, rr or flexmock for mocking, you'll be able to do that without having to install or load the components of RSpec that you're not using.
== '''Problem Statement''' ==
Unfortunately, Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.

One reason is that we use fixture to create records in test DB each time running tests.

For example, the codes in quiz_spec.rb contain too much create so that prolong testing time.
<pre>
# Create an assignment due date
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create :assignment_due_date, due_at: (DateTime.now + 1)
</pre>

One solution is building an complete database to one time to support all RSpec test without create new records.
== '''Related Work''' ==
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

== '''Task''' ==
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type)).
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to Expertiza.

== '''Design''' ==
=== Database design ===
We design a expertiza_test database to save the test date used for Rspec. The test database owns the same structure as the real expertiza database, including the relations between tables and some restriction of attribute like it cannot be null or some other requirements for different attributes. Besides, the data in test database is the same as the data in factories part in spec, which includes FeedbackResponseMap.rb, Respone.rb, factories.rb, quiz_factory.rb. In this situation we do not need to create some data before testing, and we can use the data in test DB directly. Because of it, the overhead of testing cases will experience obvious decreasing.
like the Rspec statements in creating some User objects.:
factory :admin, class: User do
sequence(:name) {|n| "admin#{n}" }
role { Role.where(name: 'Administrator').first || association(:role_of_administrator) }
password "password"
password_confirmation "password"
sequence(:fullname) {|n| "#{n}, administrator" }
email "expertiza@mailinator.com"
parent_id 1
private_by_default false
mru_directory_path nil
email_on_review true
email_on_submission true
email_on_review_of_review true
is_new_user false
master_permission_granted 0
handle "handle"
leaderboard_privacy false
digital_certificate nil
timezonepref nil
public_key nil
copy_of_emails false
end

then transfer this into SQL query and then add the information the same as designed for Rspec test into expertiza_test database.
INSERT INTO User VALUES (xxxxx, xxxxxx, xxxxx, xxxxxxxx, xxxxxxx, xxxxxxx, xxxx );

=== feature test design ===
To accelerate the feature test, we have to eliminate pseudo data creation. Now all the feature tests have to create their own data before each test. After building a test database, all the pseudo data creation statement can be removed from the test files. Instead, the tests reference data stored in the test database.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T22:11:57Z

Zli36:

== '''Eexpertiza''' ==
== '''Rspec''' ==
rspec is a meta-gem, which depends on the rspec-core, rspec-expectations and rspec-mocks gems. Each of these can be installed separately and loaded in isolation using require. Among other benefits, this allows you to use rspec-expectations, for example, in Test::Unit::TestCase if you happen to prefer that style.
Conversely, if you like RSpec's approach to declaring example groups and examples (describe and it) but prefer Test::Unit assertions and mocha, rr or flexmock for mocking, you'll be able to do that without having to install or load the components of RSpec that you're not using.
== '''Problem Statement''' ==
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.Unfortunately, Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.

One reason is that we use fixture to create records in test DB each time running tests.

For example, the codes in quiz_spec.rb contain too much create so that prolong testing time.
<pre>
# Create an assignment due date
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create :assignment_due_date, due_at: (DateTime.now + 1)
</pre>

One solution is building an complete database to one time to support all RSpec test without create new records.
== '''Related Work''' ==
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

== '''Task''' ==
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type)).
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to Expertiza.

== '''Design''' ==
=== Database design ===
We design a expertiza_test database to save the test date used for Rspec. The test database owns the same structure as the real expertiza database, including the relations between tables and some restriction of attribute like it cannot be null or some other requirements for different attributes. Besides, the data in test database is the same as the data in factories part in spec, which includes FeedbackResponseMap.rb, Respone.rb, factories.rb, quiz_factory.rb. In this situation we do not need to create some data before testing, and we can use the data in test DB directly. Because of it, the overhead of testing cases will experience obvious decreasing.
like the Rspec statements in creating some User objects.:
factory :admin, class: User do
sequence(:name) {|n| "admin#{n}" }
role { Role.where(name: 'Administrator').first || association(:role_of_administrator) }
password "password"
password_confirmation "password"
sequence(:fullname) {|n| "#{n}, administrator" }
email "expertiza@mailinator.com"
parent_id 1
private_by_default false
mru_directory_path nil
email_on_review true
email_on_submission true
email_on_review_of_review true
is_new_user false
master_permission_granted 0
handle "handle"
leaderboard_privacy false
digital_certificate nil
timezonepref nil
public_key nil
copy_of_emails false
end

then transfer this into SQL query and then add the information the same as designed for Rspec test into expertiza_test database.
=== feature test design ===
To accelerate the feature test, we have to eliminate pseudo data creation. Now all the feature tests have to create their own data before each test. After building a test database, all the pseudo data creation statement can be removed from the test files. Instead, the tests reference data stored in the test database.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T22:11:42Z

Zli36:

== '''Eexpertiza''' ==
== '''Rspec''' ==
== '''Problem Statement''' ==
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.Unfortunately, Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.
For example, the codes in quiz_spec.rb contain too much create so that prolong testing time.
<pre>
# Create an assignment due date
create(:deadline_type, name: "submission")
create(:deadline_type, name: "review")
create(:deadline_type, name: "metareview")
create(:deadline_type, name: "drop_topic")
create(:deadline_type, name: "signup")
create(:deadline_type, name: "team_formation")
create(:deadline_right)
create(:deadline_right, name: 'Late')
create(:deadline_right, name: 'OK')
create :assignment_due_date, due_at: (DateTime.now + 1)
</pre>

One solution is building an complete database to one time to support all RSpec test without create new records.
== '''Related Work''' ==
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

== '''Task''' ==
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type)).
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to Expertiza.

== '''Design''' ==
=== Database design ===
We design a expertiza_test database to save the test date used for Rspec. The test database owns the same structure as the real expertiza database, including the relations between tables and some restriction of attribute like it cannot be null or some other requirements for different attributes. Besides, the data in test database is the same as the data in factories part in spec, which includes FeedbackResponseMap.rb, Respone.rb, factories.rb, quiz_factory.rb. In this situation we do not need to create some data before testing, and we can use the data in test DB directly. Because of it, the overhead of testing cases will experience obvious decreasing.
=== feature test design ===
To accelerate the feature test, we have to eliminate pseudo data creation. Now all the feature tests have to create their own data before each test. After building a test database, all the pseudo data creation statement can be removed from the test files. Instead, the tests reference data stored in the test database.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T22:05:58Z

Zli36:

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T22:03:37Z

Zli36:

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:47:49Z

Zli36:

= Accelerate RSPec testing =
== Problem Statement ==
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.
Unfortunately, Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.

== Related Work ==
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

== Task ==
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:45:40Z

Zli36:

= Accelerate RSPec testing =
== Problem Statement ==
Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.

== Related Work ==
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

== Task ==
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:43:40Z

Zli36:

=== Problem Statement ===
Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.

=== Related Work ===
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

=== Task ===
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:43:16Z

Zli36:

== E1701. Accelerate RSpec testing==
=== Problem Statement ===
Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.

=== Related Work ===
* Classes involved: All RSpec test files in Expertiza.
* Database involved: Expertiza_test

=== Task ===
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:42:06Z

Zli36:

== E1701. Accelerate RSpec testing==
=== Problem Statement ===
Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.

=== Related Work ===
Classes involved: All RSpec test files in Expertiza.
Database involved: Expertiza_test

=== Task ===
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:41:01Z

Zli36:

== E1701. Accelerate RSpec testing==
=== Problem Statement ===
Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.

=== Related Work ===
Classes involved: All RSpec test files in Expertiza.
What needs to be done:

=== Task ===
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:39:43Z

Zli36:

##E1701. Accelerate RSpec testing##
Classes involved: All RSpec test files in Expertiza.
What needs to be done: Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:39:30Z

Zli36:

## E1701. Accelerate RSpec testing ##
Classes involved: All RSpec test files in Expertiza.
What needs to be done: Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests.
One reason is that we use fixture to create records in test DB each time running tests.
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing

2016-11-08T21:38:50Z

Zli36: Created page with "Classes involved: All RSpec test files in Expertiza. What needs to be done: Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all test..."

Classes involved: All RSpec test files in Expertiza.
What needs to be done: Expertiza tests are really slow. If you check the TravisCI, it needs more than 9 min to run all tests. One reason is that we use fixture to create records in test DB each time running tests.
Formally, you need to:
* Create the records in test DB according to the content in fixtures.
* Check each test file and delete certain DB records creation code that insert default records (eg. create(:deadline_type))
* And keep all the test cases passing when using test DB and make sure the time running test cases is shorter than before.
* You should submit the sql file of test DB to expertiza.

CSC/ECE 517 Fall 2016

2016-11-08T21:36:49Z

Zli36: /* Final Project Design Document */

[http://www.example.com link title]==Calibration Assignment Submissions==
*[[Calibration Assignment Submission (Firebrick JS)]]
*[[Calibration Assignment Submission (Active Job)]]
==Writing Assignments 2==
*[[CSC/ECE 517 Fall 2016/E1666. Test team functionality]]
*[[CSC/ECE 517 Fall 2016/E1643. Refactor Suggestion controller]]
*[[CSC/ECE 517 Fall 2016/E1631. Refactoring Bidding Interface]]
*[[CSC/ECE 517 Fall 2016/E1674.Refactor leaderboard.rb and write unit tests]]
*[[CSC/ECE 517 Fall 2016/E1671. Unit Tests for participants.rb Hierarchy]]
*[[CSC/ECE 517 Fall 2016/E1668.Test e-mailing functionality]]
*[[CSC/ECE 517 Fall 2016/E1658. Refractor lottery_controller.rb and write integration tests]]
*[[CSC/ECE 517 Fall 2016/E1660. Review requirements and thresholds]]
*[[CSC/ECE 517 Fall 2016/E1650. Sort instructor views alphabetically by default]]
*[[CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller]]
*[[CSC/ECE 517 Fall 2016/E1645. Refactoring Tree Display Controller]]
*[[CSC/ECE 517 Fall 2016/E1659. Refactor on_the_fly_calc.rb]]
*[[CSC/ECE 517 Fall 2016/E1657. Introduce a Student View for instructors]]
*[[CSC/ECE 517 Fall 2016/E1653. Fix and improve rubric criteria]]
*[[CSC/ECE 517 Fall 2016/E1642. Refactor review_response_map.rb]]
*[[CSC/ECE 517 Fall 2016/E1633. Refactor different question types from quiz feature]]
*[[CSC/ECE_517_Fall_2016/E1664:_Feature_Test_Assignment_Creation]]
*[[CSC/ECE 517 Fall 2016/E1666. Test team functionality]]
*[[CSC/ECE_517_Fall_2016/E1654. Improve_date-picker_and_deadlines]]
*[[CSC/ECE_517_Fall_2016/E1652 Fix teammate advertisements and requests to join a team ]]
*[[CSC/ECE_517_Fall_2016/E1662. UI issues/fixes]]
*[[CSC/ECE_517_Fall_2016/E1673. Refactor question_type.rb]]
*[[CSC/ECE_517_Fall_2016/E1675. Timestamp for student file & hyperlink submissions]]
*[[CSC/ECE_517_Fall_2016/E1640. Refactor response.rb and response_helper.rb]]
*[[CSC/ECE 517 Fall 2016/E1634. Refactor and write unit test of due_date.rb and deadline_helper.rb]]
*[[CSC/ECE_517_Fall_2016/M1654._Improve_network_security_features]]
*[[CSC/ECE_517_Fall_2016/E1670._Unit_tests_for_answers.rb]]
*[[CSC/ECE_517_Fall_2016/E1641. Refactor review_mapping_controller.rb]]
*[[CSC/ECE_517_Fall_2016/M1652_Implement_ImageMap_Support_Servo]]
*[[CSC/ECE_517_Fall_2016/E1648/Add_past_due_assignment]]
*[[CSC/ECE 517 Fall 2016/E1656. Improve imports]]
*[[CSC/ECE_517_Fall_2016/M1653_Implement_HTML_form_validation]]
==Final Project Design Document==
*[[CSC/ECE 517 Fall 2016 E1696 Improve Self-Review]]
*[[CSC/ECE 517 Fall 2016 E1676 Role-based reviewing]]
*[[CSC/ECE 517 Fall 2016/E1680. Improve survey functionality]]
*[[CSC/ECE 517 Fall 2016/E1693. Drag-and-drop interface for creating rubrics]]
*[[CSC/ECE 517 Fall 2016/E1701. Accelerate RSpec testing]]

CSC/ECE 517 Fall 2016/E1675. Timestamp for student file & hyperlink submissions

2016-10-28T21:02:55Z

Zli36: /* Testing from UI */

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passing===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===

===Testing from UI===

#[https://youtu.be/cGXu1YPG0Ec Demo link]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/rsndates/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2016/E1675. Timestamp for student file & hyperlink submissions

2016-10-28T20:52:19Z

Zli36: /* Parameter Passed */

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passing===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===

===Testing from UI===

#[http://bit.ly/myexpertiza Demo link]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/rsndates/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2016/E1675. Timestamp for student file & hyperlink submissions

2016-10-28T20:51:00Z

Zli36: Created page with "==E1675.Timestamp for student file & hyperlink submissions == This page provides a description of the Expertiza based OSS project. __TOC__ ===About Expertiza=== [http://ex..."

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passed===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===

===Testing from UI===

#[http://bit.ly/myexpertiza Demo link]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/rsndates/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

CSC/ECE 517 Fall 2016

2016-10-28T20:50:47Z

Zli36: /* Writing Assignments 2 */

User talk:Zli36

2016-10-28T20:42:15Z

Zli36: /* E1675.Timestamp for student file & hyperlink submissions */

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passed===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===

===Testing from UI===

#[http://bit.ly/myexpertiza Demo link]

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/rsndates/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T20:41:33Z

Zli36: /* References */

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passed===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===

===Testing from UI===

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/rsndates/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wiki.expertiza.ncsu.edu/index.php/Expertiza_documentation Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T20:40:17Z

Zli36: /* E1675.Timestamp for student file & hyperlink submissions */

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passed===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===

===Testing from UI===

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/rsndates/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T20:38:31Z

Zli36:

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team.
* Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passed===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===
The current version of expertiza did not have any test for VersionsController. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for VersionsController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
<pre>
user-expertiza $rspec spec
.
.
.
Finished in 5.39 seconds (files took 25.33 seconds to load)
66 examples, 0 failures

Randomized with seed 19254
.
.
</pre>

===Testing from UI===
Following are a few testcases with respectto our code changes that can be tried from UI:
1. To go to versions index page, type in the following url after logging in:
http://152.46.16.81:3000/versions

2. After logging in as student/instructor or admin : Try accessing the new, create, edit, update actions. These actions are not allowed to any of the users.
http://152.46.16.81:3000/versions/new
This calls the new action. In the current production version of expertiza, it is unhandled and application gives a default 404 page.

3. Another feature that can be tested from UI is Pagination. Try searching for a user's versions and see if the results are paginated or not. Search here:
http://152.46.16.81:3000/versions/search

4. Visit the same URL as step 3, you should see only the students under that instructor in the users dropdown.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T20:37:03Z

Zli36:

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza project is software to create reusable learning objects through peer review. It also supports team projects, and the submission of almost any document type, including URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team * Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
* In order to make the exist hyperlinks clickable, we will choose whose operation is Submit Hyperlink in database.
<pre>
<% if record.operation == "Submit Hyperlink" %>
<td><a href="<%= record.content %>" target="_blank"><%= record.content %></a> </td>

<% else %>
<td><%= record.content %></td>
<% end %>
<td><%= record.created_at %></td>
</pre>

===Parameter Passed===
We utilize the params hash from the previous view called List_submissions. We then use a where query that matches the team_id from the submissions record table.
<pre>

<%= link_to "Show Submission Records", submission_records_path(team_id: team.id) %>(View:list_submission)
@submission_records = SubmissionRecord.where(team_id: params[:team_id])(submission_record_controller)

</pre>

===Automated Testing using RSPEC===
The current version of expertiza did not have any test for VersionsController. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for VersionsController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
<pre>
user-expertiza $rspec spec
.
.
.
Finished in 5.39 seconds (files took 25.33 seconds to load)
66 examples, 0 failures

Randomized with seed 19254
.
.
</pre>

===Testing from UI===
Following are a few testcases with respectto our code changes that can be tried from UI:
1. To go to versions index page, type in the following url after logging in:
http://152.46.16.81:3000/versions

2. After logging in as student/instructor or admin : Try accessing the new, create, edit, update actions. These actions are not allowed to any of the users.
http://152.46.16.81:3000/versions/new
This calls the new action. In the current production version of expertiza, it is unhandled and application gives a default 404 page.

3. Another feature that can be tested from UI is Pagination. Try searching for a user's versions and see if the results are paginated or not. Search here:
http://152.46.16.81:3000/versions/search

4. Visit the same URL as step 3, you should see only the students under that instructor in the users dropdown.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T18:33:21Z

Zli36:

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team * Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

Relationships:
* belongs_to : teams
* has_many : list_submissions

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
<pre>
</pre>

===Automated Testing using RSPEC===
The current version of expertiza did not have any test for VersionsController. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for VersionsController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
<pre>
user-expertiza $rspec spec
.
.
.
Finished in 5.39 seconds (files took 25.33 seconds to load)
66 examples, 0 failures

Randomized with seed 19254
.
.
</pre>

===Testing from UI===
Following are a few testcases with respectto our code changes that can be tried from UI:
1. To go to versions index page, type in the following url after logging in:
http://152.46.16.81:3000/versions

2. After logging in as student/instructor or admin : Try accessing the new, create, edit, update actions. These actions are not allowed to any of the users.
http://152.46.16.81:3000/versions/new
This calls the new action. In the current production version of expertiza, it is unhandled and application gives a default 404 page.

3. Another feature that can be tested from UI is Pagination. Try searching for a user's versions and see if the results are paginated or not. Search here:
http://152.46.16.81:3000/versions/search

4. Visit the same URL as step 3, you should see only the students under that instructor in the users dropdown.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T18:30:20Z

Zli36:

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team * Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured, create, update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right control to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

=====View Submission Record =====
<pre>
</pre>

===Automated Testing using RSPEC===
The current version of expertiza did not have any test for VersionsController. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for VersionsController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
<pre>
user-expertiza $rspec spec
.
.
.
Finished in 5.39 seconds (files took 25.33 seconds to load)
66 examples, 0 failures

Randomized with seed 19254
.
.
</pre>

===Testing from UI===
Following are a few testcases with respectto our code changes that can be tried from UI:
1. To go to versions index page, type in the following url after logging in:
http://152.46.16.81:3000/versions

2. After logging in as student/instructor or admin : Try accessing the new, create, edit, update actions. These actions are not allowed to any of the users.
http://152.46.16.81:3000/versions/new
This calls the new action. In the current production version of expertiza, it is unhandled and application gives a default 404 page.

3. Another feature that can be tested from UI is Pagination. Try searching for a user's versions and see if the results are paginated or not. Search here:
http://152.46.16.81:3000/versions/search

4. Visit the same URL as step 3, you should see only the students under that instructor in the users dropdown.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin

User talk:Zli36

2016-10-28T18:25:21Z

==E1675.Timestamp for student file & hyperlink submissions ==

This page provides a description of the Expertiza based OSS project.

__TOC__

===About Expertiza===

[http://expertiza.ncsu.edu/ Expertiza] is an open source project based on [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create new assignments and customize new or existing assignments. It also allows the instructor to create a list of topics the students can sign up for. Students can form teams in Expertiza to work on various projects and assignments. Students can also peer review other students' submissions. Expertiza supports submission across various document types, including the URLs and wiki pages.

===Problem Statement===
In Expertiza we accept hyperlinks as well as files submitted by students, which makes it harder to track the updates for students' submission. In this project you are required to keep track of timestamp records for students' submissions and updates of artifacts (submitted files or hyperlinks). Authors can delete or re-submit files and hyperlinks too, you should also have those activities recorded.

===Task Goals ===
What needs to be done:

* Record the timestamps for file/hyperlink submissions.
* Add code to keep all those time stamps tracked and updated.
* Change the view of 0.0.0.0:3000/assignments/list_submissions view (by clicking the “View submissions icon”) to display the submition histories of each team * Make the available submissions clickable (some submitted items maight be deleted, so they are displayed but not clickable).
* After this project, the ResubmissionTime model (and related code) will not be used anymore. Please remove related code and db table.
* Create tests to make sure the test coverage increase.

===Program Design ===

We created a set of new controller, model and views to finish the function for timestamps.
We added a model named SubmissionRecord that contains the following attributes.

* Hyperlink - hyperlink that could be uploaded - String.
* Upload File - file that could be uploaded - File.
* Team id - id that links the model to the team that created it. - Integer.
* Created at - timestamp for time of creation.
* Operation - Description of what occured,create,update and delete.
* User - User who change the status of current table Get this from current user id.
* Content - String, the file name or the hyperlink.

===Implementation===

=====Action_allowed=====
* In present code, the application has right controll to decide which kind of user could have access to the specific page. In order to let instructor see the submission_record, we need to add action_allowed method in submission_record_controller. Codes are here.
<pre>
def action_allowed?
if params[:action] == 'edit' || params[:action] == 'update'
assignment = Assignment.find(params[:id])
return true if ['Super-Administrator', 'Administrator'].include? current_role_name
return true if assignment.instructor_id == current_user.id
return true if TaMapping.exists?(ta_id: current_user.id, course_id: assignment.course_id) &&
(TaMapping.where(course_id: assignment.course_id).include?TaMapping.where(ta_id: current_user.id, course_id: assignment.course_id).first)
return true if assignment.course_id && Course.find(assignment.course_id).instructor_id == current_user.id
return false
else
['Super-Administrator',
'Administrator',
'Instructor',
'Teaching Assistant'].include? current_role_name
end
end
</pre>

=====Submit Hyperlink & File =====
* After we created the table, there isn't a specific page for us to fill in the submission_record database table. So we find the previous page for students to submitted their hyperlinks and files which are in submitted_content. And we add codes to fill in submission_record table once a hyperlink or file is submitted.

<pre>
def submit_hyperlink

@participant = AssignmentParticipant.find(params[:id])
return unless current_user_id?(@participant.user_id)

team = @participant.team
team_hyperlinks = team.hyperlinks
if team_hyperlinks.include?(params['submission'])
flash[:error] = "You or your teammate(s) have already submitted the same hyperlink."
else
begin
team.submit_hyperlink(params['submission'])
@participant.update_resubmit_times

#create a submission record
@submission_record = SubmissionRecord.new(team_id: team, user: @participant.name, assignment_id: params[:id], operation: "Submit Hyperlink")
@submission_record.save
rescue
flash[:error] = "The URL or URI is not valid. Reason: #{$ERROR_INFO}"
end
undo_link("The link has been successfully submitted.")
end
redirect_to action: 'edit', id: @participant.id
end
</pre>

<pre>
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Submit File")
@submission_record.save
</pre>

===== Remove Hyperlink or File=====
* When students want to delete their hyperlinks or files submitted before, the data in submission_record table should not disappear. What we want are all operations made by the team. As a result, we add specific code in the original delete function to reserve the data in submission_record table.
<pre>
#create a submission record
@submission_record = SubmissionRecord.new(team_id: team.id, user:@participant.name , assignment_id: assignment.id, operation: "Remove Hyperlink")
@submission_record.save
</pre>

<pre>
def delete_selected_files
#create a submission record
assignment = Assignment.find(participant.parent_id)
team = participant.team
@submission_record = SubmissionRecord.new(team_id: team.id, user: participant.name , assignment_id: assignment.id, operation: "Remove File")
@submission_record.save
filename = params[:directories][params[:chk_files]] + "/" + params[:filenames][params[:chk_files]]
FileUtils.rm_r(filename)
end
</pre>

===Automated Testing using RSPEC===
The current version of expertiza did not have any test for VersionsController. Using the test driven development(TDD) approach, we have added an exhaustive set of RSPEC tests for VersionsController, to test all the modifications we have done to the code of the controller class. The tests use double and stub features of rspec-rails gem, to fake the log in by different users - Administrator, Instructor, Student etc. The tests can be executed "rpec spec" command as shown below.
<pre>
user-expertiza $rspec spec
.
.
.
Finished in 5.39 seconds (files took 25.33 seconds to load)
66 examples, 0 failures

Randomized with seed 19254
.
.
</pre>

===Testing from UI===
Following are a few testcases with respectto our code changes that can be tried from UI:
1. To go to versions index page, type in the following url after logging in:
http://152.46.16.81:3000/versions

2. After logging in as student/instructor or admin : Try accessing the new, create, edit, update actions. These actions are not allowed to any of the users.
http://152.46.16.81:3000/versions/new
This calls the new action. In the current production version of expertiza, it is unhandled and application gives a default 404 page.

3. Another feature that can be tested from UI is Pagination. Try searching for a user's versions and see if the results are paginated or not. Search here:
http://152.46.16.81:3000/versions/search

4. Visit the same URL as step 3, you should see only the students under that instructor in the users dropdown.

===References===

#[https://github.com/expertiza/expertiza Expertiza on GitHub]
#[https://github.com/WintersLt/expertiza GitHub Project Repository Fork]
#[http://expertiza.ncsu.edu/ The live Expertiza website]
#[http://bit.ly/myexpertiza Demo link]
#[http://wikis.lib.ncsu.edu/index.php/Expertiza Expertiza project documentation wiki]
#[https://relishapp.com/rspec Rspec Documentation]
#Clean Code: A handbook of agile software craftsmanship. Author: Robert C Martin