Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T19:38:17Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

[[File:FIleSelectionforUpload.png]]

[[File:PaperDisplay.png]]

[[File:AddCOntributor.png]]

[[File:EmailSenttoAddedContributor.png]]

[[File:DisplayCOntributors.png]]

Link to Screencast: https://www.youtube.com/watch?v=rg06JjVJqtQ&feature=youtu.be

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:52:32Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

[[File:FIleSelectionforUpload.png]]

[[File:PaperDisplay.png]]

[[File:AddCOntributor.png]]

[[File:EmailSenttoAddedContributor.png]]

[[File:DisplayCOntributors.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:AddCOntributor.png

2017-12-13T04:52:02Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:49:04Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

[[File:FIleSelectionforUpload.png]]

[[File:PaperDisplay.png]]

[[File:EmailSenttoAddedContributor.png]]

[[File:DisplayCOntributors.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:DisplayCOntributors.png

2017-12-13T04:48:36Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:47:20Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

[[File:FIleSelectionforUpload.png]]

[[File:PaperDisplay.png]]

[[File:EmailSenttoAddedContributor.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:EmailSenttoAddedContributor.png

2017-12-13T04:46:49Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:46:06Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

[[File:FIleSelectionforUpload.png]]

[[File:PaperDisplay.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:PaperDisplay.png

2017-12-13T04:45:34Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:44:56Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

[[File:FIleSelectionforUpload.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:FIleSelectionforUpload.png

2017-12-13T04:44:24Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:43:59Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

[[File:NotUploaded.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:NotUploaded.png

2017-12-13T04:43:28Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:42:37Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

[[File:ShowCommandsforBlackHolePaper.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:ShowCommandsforBlackHolePaper.png

2017-12-13T04:42:07Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:41:42Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

[[File:ShowPAper.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:ShowPAper.png

2017-12-13T04:41:09Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:40:33Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

[[File:NewResearchPAper1.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:NewResearchPAper1.png

2017-12-13T04:40:03Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:39:24Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

[[File:Login.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:Login.png

2017-12-13T04:38:45Z

Vnpatel: uploaded a new version of "File:Login.png"

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-12-13T04:37:19Z

Vnpatel:

== '''Introduction''' ==

==Problem Definition==

Expertiza is mainly a peer-assessment system for the students to review submissions made by their peers. For a similar system for journals and conferences, there is one stark difference from the standard peer assessment system. For journals and papers, we need to allow the user to create an account to submit the paper, unlike the standard system where the instructor is supposed to create account for all the students. Also, when a user wants to add a co-author for his/her paper/submission, he should be able to invite them irrespective of the fact that the invited user has an account or not. If the invited user does not have an account, a new account must be created for him/her. For the new system, submitting and reviewing is same as the peer assessment system.

==Scope==

This project aims at extending the application of the expertiza system towards reviewing of journals and conferences by peer authors and relevant users. Hence, it enhances the utility of the expertiza platform for better knowledge sharing beyond the simple assignment submission and reviewing.

=='''Requirements'''==

1. Any non-Expertiza user can sign up, for submitting his/her work

2. Document upload privileges for that user.

3. Adding co-authors to a paper being submitted for reviewing.

4. View for scores/reviews submitted by reviewers.

=='''Use Cases'''==

[[File:UseCaseDiagram1Revision1.jpg]]

[[File:Actor1.PNG]]

'''Name:''' Sign up

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' He/she should not have existing account on Expertiza

'''Primary Sequence:'''

1. Go to Conference Reviewing section

2. Provide information in form for signup

Captcha

3. Activate account by opening link, provided via e-mail

'''Name:''' Add contributors

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' Writer must have uploaded a paper for reviewing

'''Primary Sequence:'''

1. Sign in

2. Select the uploaded document

3. Select option to add contributors

4. Add information of co-authors. Email, Name, etc

'''Name:''' Create a submission

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The user is logged in and wants to submit a paper.

'''Primary Sequence:'''

1. Selects the “Submit your work” button

2. Enter the details of the paper, like track of paper (which can be selected from a dropdown).

3. The writer is redirected to an upload page where the user can upload the submission.

'''Name:''' Upload Paper

'''Actor:''' Writer

'''Other Participants:''' None

'''Precondition:''' The writer has already created a submission window and is at the upload page.

'''Primary Sequence:'''

1. The writer clicks the “Upload paper”button.

2. The writer selects the paper to be submitted from local device.

3. The writer clicks the “Submit” button.

=='''Database Design'''==

Table to handle many to many relationship between contributors and paper writer.

[[File:Capture.PNG]]

The database for storing the papers submitted is not needed as we will be re-using the assignments database already implemented in the expertiza system by simply adding new attributes as mentioned below.

The project uses mainly uses the same database of the actual expertiza system. The tables need to be edited by adding some attributes to provide sufficiemnt relations among the system.

1. The table assignments that stores the submissions need to have a new attribute that can distinguish if the submission is a paper or not.

2. The roles table identifies all different types of users that access expertiza system like instructor, students, etc. We need to add two more roles to this table, the writer and his co-writers.

___
EFG: I wouldn't do it that way; I'd add attributes to the teams table. The teams table currently tells where the submitted work is, and it would continue to do that. But now, the same individual could be on multiple teams for the same assignment. Each team would still be associated with one reviewable submission. In fact, two or more teams for the same "assignment" could have exactly the same set of members, if they have submitted two papers for the conference.
This requires a new step. When someone clicks on the assignment, the system needs to ask which team/paper/submission they want to work on.

I would also say that if someone is participating in only one assignment, you take them directly to the page where they choose their submission, rather than requiring them to choose the assignment.

=='''Class Diagram'''==

[[File:ClassDiagram1Revision1.jpg]]

=='''Files to be created'''==

1. '''new_writer_signup.html.erb''' : /app/views/users/

Needed to allow the author/writer of paper to signup to expertiza. As signup is not part of the current system, this needs to be explicitly created.

2. '''writer_homepage.html.erb''' :

This is the homepage of the writer. He can view his submissions and access the functionalities available to him.

3. '''add_coauthors.html.erb''' :

This file is needed to allow the writer to invite co-authors for his/her paper. The writer enters the details of the co-author to be invited in this page.

4. '''writer_paper_mapping.rb''' :

This is the model needed to map the papers to their authors. As papers and writers have a many to many relation, it needs to be handled by this model.

=='''Files to be edited'''==

1. users_controller.rb

Methods added:
1. create_writer : for implementing the sign-up for a writer
2. new_writer : creates an instance of user class

2. assignments_controller.rb

Methods added:
1. addContributor : for adding co-authors to already submitted papers
2. updateAttributes : for updating the attributes of the submitted paper
3. addReviewDetails : to control the number of reviews, etc. for a given paper

=='''Implementation'''==

Here is a sample code snippet:

View:

<%= form_for @user , :url => url_for(:controller => 'users', :action => 'create_writer') do |f|%>
<%= f.label :name %>
<%= f.text_field :name %>
<%= f.label :email %>
<%= f.text_field :email %>
<%= f.label :password %>
<%= f.text_field :crypted_password %>
<%=submit_tag "Create Writer"%>
<%end%>

Controller:

def new_writer
@user = User.new
render 'new_writer_signup.html.erb'
end

def create_writer
@user = User.new(user_params)
@user.role_id = 8;
@user.is_new_user = 1;
if @user.save
flash[:success] = "Your account has been successfully created"
render 'new_writer_signup.html.erb'
else
render 'new_writer_signup.html.erb'
end
end

=='''Designing Practices'''==

The designing practices used will be determined as the project proceeds and the requirements are handled. But for starting the project we will be following the following standard design practices:

1. Model-View-Controller architecture

2. Using standard naming convention for variables and methods, like name_variable, singular words for class name, etc.

3. Try not to violate DRY principle

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

The automated tests will be implemented based on final implementation of the project as many functions to be used are already defined and tested. But for manual testing, the following test plan can be used.

Test plan for Publishing a paper

1) Click on the link from conference website

2) Enter name, password, and email ID

3) Publish paper

4) Fill in the details for the paper to be published

5) upload paper

6) add collaboraters (enter name and email of contributors)

Test plan for editing paper attributes

1) Login

2) Select paper from displayed paper list

3) update attributes and save.

4) Logout

=='''Screenshot'''==

[[File:Signup.png]]

For further queries, contact:

adupadhy@ncsu.edu

dkamin@ncsu.edu

vnpatel@ncsu.edu

uparikh@ncsu.edu

File:Signup.png

2017-12-13T04:36:25Z

Vnpatel:

CSC/ECE 517 Fall 2017/E17A5 Allow users to create an account and submit work to an "assignment" (e.g., for conference reviewing)

2017-11-10T03:49:22Z

Vnpatel:

File:ClassDiagram1 latest.png

2017-11-10T03:48:25Z

Vnpatel:

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:28:45Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path:
1)describe 'check_directory_path' do:
2) it 'returns false if directory path already in use' do:
3) @assignment = create(:assignment)
4) expect(@assignment.check_directory_path).to eql(false)
5) end
6)end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment:

1)it 'is not valid without directory_path' do
2) assignment.directory_path = nil
3) assignment.should_not be_valid
4)end

3) To check if after assigning course to an assignment is the directory path updated to contain the course path:

1)it 'should contain course in path name' do
2) @assignment = create(:assignment)
3) @assignment.directory_path = Course.first.directory_path.to_s + "/finaltest"
4) expect(@assignment.directory_path).to include(Course.first.directory_path)
5)end
** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:20:28Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path:
1)describe 'check_directory_path' do:
2) it 'returns false if directory path already in use' do:
3) @assignment = create(:assignment)
4) expect(@assignment.check_directory_path).to eql(false)
5) end
6)end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment:

1)it 'is not valid without directory_path' do
2) assignment.directory_path = nil
3) assignment.should_not be_valid
4)end

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:07:05Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path.

1) describe 'check_directory_path' do
2) it 'returns false if directory path already in use' do
3)     @assignment = create(:assignment)
4)     expect(@assignment.check_directory_path).to eql(false)
5)   end
6) end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment.

1) it 'is not valid without directory_path' do
2)   assignment.directory_path = nil
3)   assignment.should_not be_valid
4) end

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:05:51Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path.

1) describe 'check_directory_path' do
2) it 'returns false if directory path already in use' do
3)     @assignment = create(:assignment)
4)     expect(@assignment.check_directory_path).to eql(false)
5)   end
6) end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment.

1) it 'is not valid without directory_path' do
2)   assignment.directory_path = nil
3)   assignment.should_not be_valid
4) end

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:05:05Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path.

1)describe 'check_directory_path' do
2) it 'returns false if directory path already in use' do
3)     @assignment = create(:assignment)
4)     expect(@assignment.check_directory_path).to eql(false)
5)   end
6)end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment.

1)it 'is not valid without directory_path' do
2)   assignment.directory_path = nil
3)   assignment.should_not be_valid
4)end

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:03:56Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path.
1)describe 'check_directory_path' do
2) it 'returns false if directory path already in use' do
3)     @assignment = create(:assignment)
4)     expect(@assignment.check_directory_path).to eql(false)
5)   end
6)end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment.
1)it 'is not valid without directory_path' do
2)   assignment.directory_path = nil
3)   assignment.should_not be_valid
4)end

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-11-03T19:02:18Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

==''' Automated tests for Issue #391 and #404 '''==

Following RSPEC Code is added to assignment_spec.rb:

1) To check if the directory storage path specified by the user is a part of any other submissions directory we check if the assignment.directory_path is a part of any existing directory path.
describe 'check_directory_path' do
    it 'returns false if directory path already in use' do
      @assignment = create(:assignment)
      expect(@assignment.check_directory_path).to eql(false)
    end
end

2) To check that an assignment object cannot be saved until a submission directory path is provided for that assignment.
it 'is not valid without directory_path' do
    assignment.directory_path = nil
    assignment.should_not be_valid
end

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-29T16:03:59Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

** To test the changes clone the following repository https://github.com/daxamin/expertiza .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-29T16:03:14Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://youtu.be/OVVknOBkG6Y

Link to ScreenCast Bug #404 : https://youtu.be/uvnamlY2wzg

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

** To test the changes clone the following repository [https://github.com/daxamin/expertiza] .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-28T04:03:50Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

Link to ScreenCast Bug #391 : https://mymediasite.online.ncsu.edu/online/Play/4f2a294dc38246f996119d309fec30da1d

Link to ScreenCast Bug #404 : https://mymediasite.online.ncsu.edu/online/Play/a1f2b9b7a74b458cb8613c09024f40f01d

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

** To test the changes clone the following repository [https://github.com/daxamin/expertiza] .

CSC/ECE 517 Fall 2017/E1762 Test various kinds of response-map hierarchies

2017-10-28T03:46:05Z

Vnpatel:

==Expertiza Background==
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and edit assignments to Expertiza. Students can be assigned in teams based on their selection of the topics. The Expertiza project is supported by the National Science Foundation. The 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.

==Introduction==
==='''Problem Statement'''===
In Expertiza, there are several types of response maps (model files in app/models). They basically map responses, the one who submitted the response and the one to whom it is directed to. The parent class is ResponseMap, and the subclasses are (from most used to least used) ReviewResponseMap, TeammateReviewResponseMap, FeedbackResponseMap, QuizResponseMap, AssignmentSurveyResponseMap, BookmarkRatingResponseMap, MetareviewResponseMap, SelfReviewResponseMap, CourseSurveyResponseMap, GlobalSurveyResponseMap. You can find the database structure for these response maps here. For each response map record, there is one reviewer_id and reviewee_id. However, you need to check the code to learn what are recorded as reviewer/reviewee ids (see the foreign key constraints at the beginning of each model, they could be participant_id, team_id, etc. as per that model). These models do not have any unit tests.

=='''Work to be done'''==
• Create a factory for each response map models in factories.rb file (review_response_map factory has already existed).

• Then create test files in spec/models (you can refer to answer_spec.rb, due_date_spec.rb for how to write specs); write model specs for methods (if you find any method has no caller, remove the method instead of write tests for it). Good tests means their coverage is maximum, so try to cover as much methods and conditions as possible.
---

=='''Files to be used or created'''==
To write the unit tests for the models, we need to define the spec files for the models. But before that, we need to understand the working of the methods. For this we use the following files (in '''app\models''') –

• Response_map.rb

• Review_response_map.rb

• Teammate_review_response_map.rb

• Feedback_response_map.rb

• Quiz_response_map.rb

• Assignment_survey_response_map.rb

• Bookmark_rating_response_map.rb

• Metareview_response_map.rb

• Self_review_response_map.rb

• Course_survey_response_map.rb

• Global_survey_response_map.rb

While writing our tests we will need a way to set up database records in a way to test against them in different scenarios. This is done by creating factories for each response map model in the '''spec/factories/factories.rb''' file.

Now, we use RSpec to create the test cases for these models. These files are added in the spec/models/ folder. The convention of naming the files is MODELNAME_spec.rb, hence we get following files.

• Response_map_spec.rb

• Review_response_map_spec.rb

• Teammate_review_response_map_spec.rb

• Feedback_response_map_spec.rb

• Quiz_response_map_spec.rb

• Assignment_survey_response_map_spec.rb

• Bookmark_rating_response_map_spec.rb

• Metareview_response_map_spec.rb

• Self_review_response_map_spec.rb

• Course_survey_response_map_spec.rb

• Global_survey_response_map_spec.rb

=='''Creating Factories'''==
Each response map model needs its own factory for testing to create relevant mock objects to test the specs written. Hence here is a sample of a factory we created for the response_map.rb model.

factory :response_map, class: ResponseMap do
reviewed_object_id 1
reviewer_id 1
reviewee_id 1
type 'ResponseMap'
calibrate_to 0
end

CSC/ECE 517 Fall 2017/E1762 Test various kinds of response-map hierarchies

2017-10-28T03:44:15Z

Vnpatel:

'''Badhu Barabar Che Enjoy Khali tuj chutiyo chu'''

==Expertiza Background==
Expertiza is a web application where students can submit and peer-review learning objects (articles, codes, websites, etc). Instructors add and edit assignments to Expertiza. Students can be assigned in teams based on their selection of the topics. The Expertiza project is supported by the National Science Foundation. The 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.

==Introduction==
==='''Problem Statement'''===
In Expertiza, there are several types of response maps (model files in app/models). They basically map responses, the one who submitted the response and the one to whom it is directed to. The parent class is ResponseMap, and the subclasses are (from most used to least used) ReviewResponseMap, TeammateReviewResponseMap, FeedbackResponseMap, QuizResponseMap, AssignmentSurveyResponseMap, BookmarkRatingResponseMap, MetareviewResponseMap, SelfReviewResponseMap, CourseSurveyResponseMap, GlobalSurveyResponseMap. You can find the database structure for these response maps here. For each response map record, there is one reviewer_id and reviewee_id. However, you need to check the code to learn what are recorded as reviewer/reviewee ids (see the foreign key constraints at the beginning of each model, they could be participant_id, team_id, etc. as per that model). These models do not have any unit tests.

=='''Work to be done'''==
• Create a factory for each response map models in factories.rb file (review_response_map factory has already existed).

• Then create test files in spec/models (you can refer to answer_spec.rb, due_date_spec.rb for how to write specs); write model specs for methods (if you find any method has no caller, remove the method instead of write tests for it). Good tests means their coverage is maximum, so try to cover as much methods and conditions as possible.
---

=='''Files to be used or created'''==
To write the unit tests for the models, we need to define the spec files for the models. But before that, we need to understand the working of the methods. For this we use the following files (in '''app\models''') –

• Response_map.rb

• Review_response_map.rb

• Teammate_review_response_map.rb

• Feedback_response_map.rb

• Quiz_response_map.rb

• Assignment_survey_response_map.rb

• Bookmark_rating_response_map.rb

• Metareview_response_map.rb

• Self_review_response_map.rb

• Course_survey_response_map.rb

• Global_survey_response_map.rb

While writing our tests we will need a way to set up database records in a way to test against them in different scenarios. This is done by creating factories for each response map model in the '''spec/factories/factories.rb''' file.

Now, we use RSpec to create the test cases for these models. These files are added in the spec/models/ folder. The convention of naming the files is MODELNAME_spec.rb, hence we get following files.

• Response_map_spec.rb

• Review_response_map_spec.rb

• Teammate_review_response_map_spec.rb

• Feedback_response_map_spec.rb

• Quiz_response_map_spec.rb

• Assignment_survey_response_map_spec.rb

• Bookmark_rating_response_map_spec.rb

• Metareview_response_map_spec.rb

• Self_review_response_map_spec.rb

• Course_survey_response_map_spec.rb

• Global_survey_response_map_spec.rb

=='''Creating Factories'''==
Each response map model needs its own factory for testing to create relevant mock objects to test the specs written. Hence here is a sample of a factory we created for the response_map.rb model.

factory :response_map, class: ResponseMap do
reviewed_object_id 1
reviewer_id 1
reviewee_id 1
type 'ResponseMap'
calibrate_to 0
end

CSC/ECE 517 Fall 2017/E1762 Test various kinds of response-map hierarchies

2017-10-28T02:24:48Z

Vnpatel:

lakh la kaik

CSC/ECE 517 Fall 2017/E1762 Test various kinds of response-map hierarchies

2017-10-28T02:24:35Z

Vnpatel: Blanked the page

CSC/ECE 517 Fall 2017/E1762 Test various kinds of response-map hierarchies

2017-10-28T02:22:56Z

Vnpatel:

hi thereto harami chu

CSC/ECE 517 Fall 2017/E1762 Test various kinds of response-map hierarchies

2017-10-28T02:22:34Z

Vnpatel: Created page with "hi there"

hi there

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T22:24:33Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

** To test the changes clone the following repository [https://github.com/daxamin/expertiza] .

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T22:22:30Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

** Transfer of files from one directory to another will only be visible if you clone and run the updated expertiza project on local machine or it will be available on server.

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T22:20:19Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor

2) Click on Manage , select assignments.

3) New public assignment/ New private assignment

4) Fill in the details and remember the directory path

5) Save

6) Create New assignment

7) Fill in the details and keep the directory path same as the one before.

8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor

2) Click on Manage , select assignments.

3) Find out an assignment which isn't assigned to a course.

4) Select assign to course badge

5) Select course from available radio button

6) Click Save

7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T22:19:25Z

Vnpatel:

==Introduction==
==='''Problem Statement'''===
In Expertiza, students may submit links (which go into the Expertiza db) or files (which go into a directory in the Expertiza filespace). A persistent problem in Expertiza has been that instructors have created multiple assignments that had the same submission directory. In this case, the students’ submissions for one assignment went into the same directory as the submissions for another assignment, and reviewers who thought they were reviewing for one assignment were also presented with work submitted by a different student on another assignment. The basic problem has been fixed, but there are some special cases that need to be addressed, and tests need to be written.
----
=='''Issues to be fixed'''==

Issue #391: When an assignment is created, there needs to be a check that the submission directory is not the same as the submission directory for any other assignment. In Expertiza, the pathname for an assignment always has the instructor’s user-id (e.g., /efg) in the path, so it’s only necessary to check all assignments created by the current instructor to make sure that the specified directory path is not in use by another assignment. Make sure that the check is made correctly even if it is a TA who creates the assignment. There is a method for setting path of the submission in assignment.rb.

Issue #404: When a previously created assignment is assigned to a course, any existing submissions need to be moved to a subdirectory of the course in the Expertiza filespace. (In Expertiza, an assignment can be created without being assigned to any course, and can later be assigned to a course.) Even the assigning the assignment to a course is implemented in assignment.rb

----

=='''Modified Files'''==

1) assignment_controller.rb

2) assignment.rb

3) assignment/new.html.erb

----

=='''Approach taken to resolve the issues'''==

==='''Issue #391 '''===

-> When an instructor tries to create a new assignment with the storage directory similar to one of the other assignments or a sub-part of other pre-existing assignment the system would warn the instructor about this change and wouldn't save the assignment.
-> The system once gets a create request compares the directory path to paths of all existing directories for similarity and sub-part check (sub part check is required because if not done a directory will have submission files of one assignment as well as a directory for some other assignment) and logs an error if similarity is found.
-> If there errors they will be displayed in /assignment/new.html.erb

Pseudo Code:
Added following logic in assignment.rb
1) assignment_path (path user is trying to assign to new assignment)
2) for each assignment in assignment_database
3) if assignment.directory_path includes assignment_path
4) add to errors "Directory is already assigned to some assignment"

In assignment/new.html.erb
1) Display error if any

==='''Issue #404 '''===
When an instructor creates a new assignment, (s)he can do it without specifying the course to which assignment belongs. In this case, the directory path for the course is assigned as "<instructor_username>/path/mentioned/while/creating/" Eg. "instructor6/assignment4/Java/"

However when later s(he) assigns a course to the assignment, the assignment directory path should change to "<course_path>/>/path/mentioned/while/creating/" Eg. "CSC517/f17/assignment4/ruby"

Psuedo Code: Added the following logic in assignments_controller.rb update method
1) assignment_path (old path where files are stored)
2) assignment_new_path = course_path + assignment_path (As course assigned to an assignment it must be stored within the directory structure of that course)
3) create directory assignment_new_path
4) for each assignment_file in assignment_path
5) FileUtils.mv(assignment_file, assignment_new_path)
6) assignment.save

==''' How to Test '''==

==''' Issue #391 '''==

Steps to test Issue #391:

1) Login as Instructor
2) Click on Manage , select assignments.
3) New public assignment/ New private assignment
4) Fill in the details and remember the directory path
5) Save
6) Create New assignment
7) Fill in the details and keep the directory path same as the one before.
8) You will see an error displayed on top of the page.

==''' Issue #404 '''==

Steps to Test Issue #404:

1) Login as Instructor
2) Click on Manage , select assignments.
3) Find out an assignment which isn't assigned to a course.
4) Select assign to course badge
5) Select course from available radio button
6) Click Save
7) Now you will the updated path on assignment display list and instead of assign to course remove from course badge will be visible.

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T21:33:07Z

Vnpatel:

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T21:20:34Z

Vnpatel:

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T21:11:37Z

Vnpatel:

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T21:04:33Z

Vnpatel:

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

CSC/ECE 517 Fall 2017/E1782 OSS Project Red Assignment Directories

2017-10-27T21:01:56Z

Vnpatel: Created page with "Hi"