Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-11T06:27:50Z

Apendya: /* Tests Added */

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
=''' Implementation details''' =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop-up a chat box where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Observer Pattern'''=
Using Faye and Sync gems, we prevent the client from polling the server. Instead, we publish the messages to the corresponding chat box and using sync config , we make the users, i.e the authors and reviewers subscribe to this particular chat box. This way, the coupling between various different objects is loosened and messages can be sent back and forth between authors and reviewers without modifying any of those objects. These observers are subscribed and unsubscribed at any point in time without causing further ramifications. This way, the chat functionality does not depend upon the implementation of the User class.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains the method is_reviewer(message) which take the message object as input and return whether the message was sent by author or reviewer. Using the output of these methods, various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JavaScript and CSS==
===Added===
1. Chats.js file has been added for managing the pop up chat logic. 
2. Chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View:''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review.

Flow of events: 
1. Login to reviewer's account. 
2. Click on the assignment. 
3. Click on "Other's Work". 
4. Click on the chat button next to the assignment topic. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: The message has been sent to the author. 

'''Author View''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review. 

Flow of events: 
1. Login to author's account 
2. Click on the assignment. 
3. Click on "Messages" 
4. Assert the presence of the message in the window. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: Author has received the message and can send messages. 

==Unit Tests==

Testing the newly added Models - Chat,Message

=====Tests Added=====

1. Model validations for the chat model: validating the chat so that it has a unique assignment_team_id.

2. Model validations for the message model: validating each message has a user_id, chat_id and a body. Also, checking that it belongs to both user and chat classes.

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoticons library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-11T06:27:00Z

Apendya:

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
=''' Implementation details''' =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop-up a chat box where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Observer Pattern'''=
Using Faye and Sync gems, we prevent the client from polling the server. Instead, we publish the messages to the corresponding chat box and using sync config , we make the users, i.e the authors and reviewers subscribe to this particular chat box. This way, the coupling between various different objects is loosened and messages can be sent back and forth between authors and reviewers without modifying any of those objects. These observers are subscribed and unsubscribed at any point in time without causing further ramifications. This way, the chat functionality does not depend upon the implementation of the User class.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains the method is_reviewer(message) which take the message object as input and return whether the message was sent by author or reviewer. Using the output of these methods, various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JavaScript and CSS==
===Added===
1. Chats.js file has been added for managing the pop up chat logic. 
2. Chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View:''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review.

Flow of events: 
1. Login to reviewer's account. 
2. Click on the assignment. 
3. Click on "Other's Work". 
4. Click on the chat button next to the assignment topic. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: The message has been sent to the author. 

'''Author View''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review. 

Flow of events: 
1. Login to author's account 
2. Click on the assignment. 
3. Click on "Messages" 
4. Assert the presence of the message in the window. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: Author has received the message and can send messages. 

==Unit Tests==

Testing the newly added Models - Chat,Message

=====Tests Added=====

1. Model validations for the chat model: validating the chat so that it has a unique assignment_id.

2. Model validations for the message model: validating each message has a user_id, chat_id and a body. Also, checking that it belongs to both user and chat classes.

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoticons library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-11T06:25:06Z

Apendya: /* Observer Pattern */

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop-up a chat box where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Observer Pattern'''=
Using Faye and Sync gems, we prevent the client from polling the server. Instead, we publish the messages to the corresponding chat box and using sync config , we make the users, i.e the authors and reviewers subscribe to this particular chat box. This way, the coupling between various different objects is loosened and messages can be sent back and forth between authors and reviewers without modifying any of those objects. These observers are subscribed and unsubscribed at any point in time without causing further ramifications. This way, the chat functionality does not depend upon the implementation of the User class.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains the method is_reviewer(message) which take the message object as input and return whether the message was sent by author or reviewer. Using the output of these methods, various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JavaScript and CSS==
===Added===
1. Chats.js file has been added for managing the pop up chat logic. 
2. Chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View:''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review.

Flow of events: 
1. Login to reviewer's account. 
2. Click on the assignment. 
3. Click on "Other's Work". 
4. Click on the chat button next to the assignment topic. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: The message has been sent to the author. 

'''Author View''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review. 

Flow of events: 
1. Login to author's account 
2. Click on the assignment. 
3. Click on "Messages" 
4. Assert the presence of the message in the window. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: Author has received the message and can send messages. 

==Unit Tests==

Testing the newly added Models - Chat,Message

=====Tests Added=====

1. Model validations for the chat model: validating the chat so that it has a unique assignment_id.

2. Model validations for the message model: validating each message has a user_id, chat_id and a body. Also, checking that it belongs to both user and chat classes.

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoticons library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-11T06:23:50Z

Apendya: /* Unit Tests */

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop-up a chat box where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Observer Pattern'''=
Using Faye and Sync gems, we prevent the client from polling the server. Instead , we publish the messages to the corresponding chat box and using sync config , we make the users ,ie the authors and reviewers subscribe to this particular chat box. This way , the coupling between various different objects is loosened and messages can be sent back and forth between authors and reviewers without modifying any of those objects. These observers are subscribed and unsubscribed at any point in time without causing further ramifications. This way , the chat functionality does not depend upon the implementation of the User class.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains the method is_reviewer(message) which take the message object as input and return whether the message was sent by author or reviewer. Using the output of these methods, various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JavaScript and CSS==
===Added===
1. Chats.js file has been added for managing the pop up chat logic. 
2. Chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View:''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review.

Flow of events: 
1. Login to reviewer's account. 
2. Click on the assignment. 
3. Click on "Other's Work". 
4. Click on the chat button next to the assignment topic. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: The message has been sent to the author. 

'''Author View''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review. 

Flow of events: 
1. Login to author's account 
2. Click on the assignment. 
3. Click on "Messages" 
4. Assert the presence of the message in the window. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: Author has received the message and can send messages. 

==Unit Tests==

Testing the newly added Models - Chat,Message

=====Tests Added=====

1. Model validations for the chat model: validating the chat so that it has a unique assignment_id.

2. Model validations for the message model: validating each message has a user_id, chat_id and a body. Also, checking that it belongs to both user and chat classes.

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoticons library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-11T06:04:29Z

Apendya:

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop-up a chat box where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Observer Pattern'''=
Using Faye and Sync gems, we prevent the client from polling the server. Instead , we publish the messages to the corresponding chat box and using sync config , we make the users ,ie the authors and reviewers subscribe to this particular chat box. This way , the coupling between various different objects is loosened and messages can be sent back and forth between authors and reviewers without modifying any of those objects. These observers are subscribed and unsubscribed at any point in time without causing further ramifications. This way , the chat functionality does not depend upon the implementation of the User class.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains the method is_reviewer(message) which take the message object as input and return whether the message was sent by author or reviewer. Using the output of these methods, various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JavaScript and CSS==
===Added===
1. Chats.js file has been added for managing the pop up chat logic. 
2. Chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View:''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review.

Flow of events: 
1. Login to reviewer's account. 
2. Click on the assignment. 
3. Click on "Other's Work". 
4. Click on the chat button next to the assignment topic. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: The message has been sent to the author. 

'''Author View''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review. 

Flow of events: 
1. Login to author's account 
2. Click on the assignment. 
3. Click on "Messages" 
4. Assert the presence of the message in the window. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: Author has received the message and can send messages. 

==Unit Tests==

Testing the newly added Models - Chat,Message

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoticons library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-08T00:17:56Z

Apendya: /* Feature Tests */ added tests

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop-up a chat box where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains 2 methods self_or_other(message) and reviewee_or_reviewer(message) which take the message object as input and return whether the current_user sent the message and whether message was sent by reviewee_or_reviewer. Using the output of these methods,
various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JS==
===Added===
Chats.js file has been added for managing the pop up chat logic.

==CSS==
===Added===
chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View:''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review.

Flow of events: 
1. Login to reviewer's account. 
2. Click on the assignment. 
3. Click on "Other's Work". 
4. Click on the chat button next to the assignment topic. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: The message has been sent to the author. 

'''Author View''' 
Preconditions: There is an assignment team created and a topic assigned to them. Also, a reviewer has selected their topic to review. 

Flow of events: 
1. Login to author's account 
2. Click on the assignment. 
3. Click on "Messages" 
4. Assert the presence of the message in the window. 
5. Type the message. 
6. Assert the presence of the message in the window. 

Post conditions: Author has received the message and can send messages. 

==Unit Tests==

Testing the newly added Models - Chat,Message

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoticons library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-07T18:21:26Z

Apendya:

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop a chat up where the reviewee can see/send messages.

[[File:Chat3.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains 2 methods self_or_other(message) and reviewee_or_reviewer(message) which take the message object as input and return whether the current_user sent the message and whether message was sent by reviewee_or_reviewer. Using the output of these methods,
various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JS==
===Added===
Chats.js file has been added for managing the pop up chat logic.

==CSS==
===Added===
chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View''' reviewer should be able to open a chat and send messages 

'''Reviewee View''' reviewee should be able to open a chat and send messages

==Unit Tests==

Testing the newly added Models - Chat,Message

= Future Improvements =
Currently, a member of the reviewee team can view messages from all of the reviewers in a single pop-up box . Now , each of the reviewees need to keep opening the pop-up box to check if they have any new messages from one of their reviewers.Same is the case for reviewers. In future, a unread messages feature can be developed which shows if the user has any new messages since the last time they have opened the pop-up box.
Also, one of the most used features in chats are emoticons. If a proper emoji library is added, it can enrich the conversations between the reviewees and their reviewers.

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

File:Chat3.png

2016-12-07T18:21:03Z

Apendya:

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-07T05:19:35Z

Apendya:

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop a chat up where the reviewee can see/send messages.

[[File:Chat2.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We added the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignmentTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains 2 methods self_or_other(message) and reviewee_or_reviewer(message) which take the message object as input and return whether the current_user sent the message and whether message was sent by reviewee_or_reviewer. Using the output of these methods,
various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JS==
===Added===
Chats.js file has been added for managing the pop up chat logic.

==CSS==
===Added===
chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View''' reviewer should be able to open a chat and send messages 

'''Reviewee View''' reviewee should be able to open a chat and send messages

==Unit Tests==

Testing the newly added Models - Chat,Message

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-12-07T04:30:27Z

Apendya:

='''Introduction to Expertiza'''=
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

='''Problem Statement'''=
During reviews, many a time, reviewers may have questions about the submitted material or the authors may want to give some instructions to the reviewers. It may sometimes block the reviewers from progressing with the review. Reviewers can end up submitting empty review forms with all 0s if they cannot figure something out. The aim of this project is to provide a mini-discussion platform for each submission so that reviewers and authors can ask/answer questions in the form of a real-time chat window. For example, if the server on which the application is deployed is down, then the reviewer can send a message that the server is down to the authors and then the authors can get the server up and running and send a message to the reviewer informing the same rather than receiving low grade on that review.
= Implementation details =
=='''Database Design'''==
To implement the chat feature , we are creating 2 new models i.e Chat and Message. The associations for these models are Chat belongs to AssignmentTeam and has many messages while Message belongs to Chat. Now, the Chat model will contain the assignment_team_id element. Using AssignmentTeam, we can find whether the chat user is a reviewee or the reviewer.

=== Tables and Schema ===

*Chat (belongs to AssignmentTeam)
::*id - primary key - int
::*assignment_team_id - id of the team - int

*Message (belongs to Chat)
::*id - primary key - int
::*body - contains the message body - text
::*user_id - id of the sender. hidden from the UI. - int
::*chat_id - id of the chat to which this message belongs to. - int

=== Use case diagram ===
[[File:Usecase_chat.png]]

=='''Modifications in UI'''==
===Changes in existing views===
1)Scenario 1: When the reviewer has a doubt and wants to send a message to the reviewee group. 
A new link for chat will be provided along with the begin/edit options of a review. Clicking on this link will pop a chat up.

[[File:Chat1.png]]

2)Scenario 2: When the reviewee group wants to view their messages or send messages to his reviewers. 
A new link for messages will be provided along with "Your work". Clicking on this link will pop a chat up where the reviewee can see/send messages.

[[File:Chat2.png]]

==Technologies used==

Most of the web uses Http which uses TCP/IP transports. This means that the connection is initialed by client, server responds to the request and becomes idle.
For implementing a chat feature using the above technique requires the client to keep on poling so that it receives the latest messages from the server.
Apart from this, there are ways that server initiates the communication with the client when there is data which is called push or comet. Both these techniques involve overhead of http and isn't a very good way for low latency applications.

For a better way, we will use web sockets into place which provides persistent connections between a server and a client, which enables both to send data at any time.

To implement this we used a ruby gem Faye which is a messaging system with publish-subscribe. It works on Bayeux protocol.

We will have the messages of the chat displayed in a partial which is updated using Sync - Realtime Rails Partials.

For the live chat, we need to start the rack server using the command

'''rackup sync.ru -E production'''

===Sync - Realtime Rails Partials===
Sync helps in updating the partials in the real time.
<%= sync partial: "message_row", collection: Message.by_chat(@team.chat) %>
<%= sync_new partial: "message_row", resource: Message.new, scope: Message.by_chat(@team.chat) %>

The first tag fetches all the messages that are related to this chat that were previously sent and the second tag fetches new messages in the real time.
Message.bychat function helps us in scoping so that only the messages related to this chat are fetched.

='''Files Added/Modified'''=
==Models==

===Added===
Two new models chat.rb and message.rb have been added. The dependency between them is a one-to-many relationship , i.e a Chat has many messages and Message belongs to Chat. The message model also has a many-to-one relation with User while Chat has a one-to-one relationship with AssignmentTeam.

===Modified===
We add the relationship corresponding to chats and messages in existing models User and AssignmentTeam. We also added a oncreate method in Assignmentteam for creating a new chat whenever a AssignemntTeam is created.

==Controllers==

===Added===
A new controller messages_controller.rb was added. The major functionality this controller provides is that via sync gem, it syncs a new message to the corresponding chat as soon as the new message has been saved which facilitates the real time chat.
===Modified===
The student_task_controller.rb has been modified to add a chat_mappings instance variable in the view method which makes the chat objects associated with the reviee team available for the view.

==Helper==

===Added===
A new helper module messages_helper.rb has been added. It contains 2 methods self_or_other(message) and reviewee_or_reviewer(message) which take the message object as input and return whether the current_user sent the message and whether message was sent by reviewee_or_reviewer. Using the output of these methods,
various css classes are added to the message div to provide UI enhancements.

==Views==

===Added===
The _message_row.html.erb has been added. It is the partial in which messages are rendered row wise in a chat box.
===Modified===
The _responses.html.erb partial in student_review view has been modified to provide the Chat option for the reviewer. The reviewer has to click on the Chat link to send or view messages to or from the reviewee team. The view.html.erb in student_task view has been modified to provide a Your messages link for the reviewee team. When the reviewee clicks on this link , a side bar pops up and the reviewee will be able to see all the available chats and respond to the queries of the reviewers.

==JS==
===Added===
Chats.js file has been added for managing the pop up chat logic.

==CSS==
===Added===
chats.css file has been added for managing the styles related to the chat popup.

=Test=
== Feature Tests ==
'''Reviewer View''' reviewer should be able to open a chat and send messages 

'''Reviewee View''' reviewee should be able to open a chat and send messages

==Unit Tests==

Testing the newly added Models - Chat,Message

= Reference links =
*[https://www.youtube.com/watch?v=TVdb2aV-Rvo/ Project Demo]
*[http://www.chrismccord.com/blog/2013/04/21/sync-realtime-rails-partials/ Sync - Realtime Rails Partials]
*[http://bamboolab.eu/blog/implement-a-chat-app-in-rails-4 Sample chat implementation]
*[https://faye.jcoglan.com/ Faye]
*[https://github.com/abhinand-lingareddy/pocmultichat Group chat POC]

File:Chat2.png

2016-12-07T04:29:34Z

Apendya:

File:Chat1.png

2016-12-07T04:28:26Z

Apendya: uploaded a new version of "File:Chat1.png"

File:Chat1.png

2016-12-07T04:26:01Z

Apendya:

File:Usecase chat.png

2016-11-14T07:12:29Z

Apendya: uploaded a new version of "File:Usecase chat.png"

File:Usecase chat.png

2016-11-14T07:08:23Z

Apendya: uploaded a new version of "File:Usecase chat.png": Reverted to version as of 06:50, 14 November 2016

File:Usecase chat.png

2016-11-14T07:06:55Z

Apendya: uploaded a new version of "File:Usecase chat.png"

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-14T06:51:19Z

Apendya:

File:Usecase chat.png

2016-11-14T06:50:52Z

Apendya:

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-14T06:48:04Z

Apendya: /* Use case diagram */

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-14T06:45:53Z

Apendya: added usecase diagram

User:Apendya

2016-11-10T04:32:00Z

Apendya: Created page with "Ajay Chandra Pendyala unity ID: apendya"

Ajay Chandra Pendyala
unity ID: apendya

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-10T04:24:36Z

Apendya:

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-10T04:23:15Z

Apendya:

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-10T04:21:49Z

Apendya:

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-10T04:20:36Z

Apendya:

CSC/ECE 517 Fall 2016 E1689: Anonymous Chat Between Author and Reviewer

2016-11-10T04:15:59Z

Apendya: semantic and grammatical fixes

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-11-04T03:50:02Z

Apendya:

'''E1644: Refactor and Test 'Teams_Controller' Controller'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
[https://en.wikipedia.org/wiki/Code_refactoring '''Refactoring'''] is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, to improve readability of code.

== Changes to View ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

=== Instructions for testing Rspecs ===

1. git clone https://github.com/bhaskarsinha1311/expertiza.git

2. Change to the expertiza directory and then perform "bundle install" and rake db:migrate.

3. Start the rails server

4. In a new terminal and in the expertiza directory, perform the following commands:
i. rspec spec/controllers/teams_controller_spec.rb
ii. rspec spec/features/inherit_teams_display_spec.rb
iii. rspec spec/features/list_teams_spec.rb

The results to the above commands can be found [https://www.youtube.com/watch?v=CcSruLHQoeU/ here].

===Testing Inherit Method===

To test that while creating an assignment team, the inherit teams section should be displayed, we log in as instructor got to list page and click on Create Team Link. On this page, we test that it should contain the string 'Inherit Teams From Course'.
To do this test manually, user need lo log in as an Instructor and navigate to assignments page for any course. There the user can click on 'Create Teams' icon and will be redirected to the Create teams page for an assignment, there the user can check for the 'inherit teams' button in the view, ideally, it should be there.

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

To test that while creating a course team, the inherit teams section should not be displayed, we do same steps in the previous case but finally, we test that the page does NOT contain 'Inherit Teams from Course'.
To do this test manually, user need lo log in as an Instructor and navigate to courses page. There the user can click on 'Create Teams' icon and will be redirected to 'create team' page, ideally, the 'Inherit Teams' button should not be displayed.

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

Similarly, for creating a team for an assignment without a course, we test that the page does not contain 'Inherit Teams From Course'. For this particular test case, we added a new factory object defined as an assignment with the course set to nil.
This can not be tested manually because assignment cannot be created without a course parent.

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

This test checks that after creating an assignment team the count in the teams table increase by 1.
This test cannot be performed manually as it is testing the count of a database table.
But, the user can check this functionality online by logging in as an instructor, going to the assignment page of any course and clicking on 'create teams' icon. Following up with entering the required details and clicking on 'create team'.

describe "POST #create" do
context "with an assignment team" do
it "increases count by 1" do
expect{create :assignment_team, assignment: @assignment}.to change(Team,:count).by(1)
end
it "redirects to the list page" do
end
end
end

The same test an be applied to create a course team as well.

context "with a course team" do
it "increases the count by 1" do
expect{create :course_team, course: @course}.to change(Team,:count).by(1)
end
end

===Testing Delete Method===

The delete method should work for deleting both assignment and course teams. We check this functionality by deleting the respective team and then check if the count of Teams goes down by 1.
The user can check this test manually by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with an assignment team " do
it "deletes an assignment team" do
@assignment = create(:assignment)
@a_team = create(:assignment_team)
expect{ @a_team.delete }.to change(Team, :count).by(-1)
end
end

Same Delete test has been applied to the course team
The manual check can also be performed in a similar way by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with a course team " do
it "deletes a course team" do
@course = create(:course)
@c_team = create(:course_team)
expect{ @c_team.delete }.to change(Team, :count).by(-1)
end
end

===Testing List Method===

The list method lists all the team nodes. This test that we have written, checks whether the instructor is able to view the team nodes in the list view.
To do this test manually user can log into the system as an instructor and click on any course, the course teams will be displayed. Also, the user can click on any team node to view information about that team.

describe 'List Team' do

it 'should list all team nodes' do
create(:assignment)
create(:assignment_node)
assignment_team = create(:assignment_team)
team_user = create(:team_user)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
page.all('#theTable tr').each do |tr|
expect(tr).to have_content?(assignment_team.name)
end
end
end

==References==

* [https://github.com/bhaskarsinha1311/expertiza/ Github] link to the project.
* [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit Link] to the project description.
* [https://www.youtube.com/watch?v=CcSruLHQoeU/ Youtube video of tests]

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-11-04T03:48:42Z

Apendya: /* Instructions for testing Rspecs */

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-11-04T03:48:23Z

Apendya: /* Manual Instructions for testing Rspecs */

'''E1644: Refactor and Test 'Teams_Controller' Controller'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
[https://en.wikipedia.org/wiki/Code_refactoring '''Refactoring'''] is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, to improve readability of code.

== Changes to View ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

=== Instructions for testing Rspecs ===

1. git clone https://github.com/bhaskarsinha1311/expertiza.git
2. Change to the expertiza directory and then perform "bundle install" and rake db:migrate.
3. Start the rails server
4. In a new terminal and in the expertiza directory, perform the following commands:
i. rspec spec/controllers/teams_controller_spec.rb
ii. rspec spec/features/inherit_teams_display_spec.rb
iii. rspec spec/features/list_teams_spec.rb

The results to the above commands can be found [https://www.youtube.com/watch?v=CcSruLHQoeU/ here].

===Testing Inherit Method===

To test that while creating an assignment team, the inherit teams section should be displayed, we log in as instructor got to list page and click on Create Team Link. On this page, we test that it should contain the string 'Inherit Teams From Course'.
To do this test manually, user need lo log in as an Instructor and navigate to assignments page for any course. There the user can click on 'Create Teams' icon and will be redirected to the Create teams page for an assignment, there the user can check for the 'inherit teams' button in the view, ideally, it should be there.

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

To test that while creating a course team, the inherit teams section should not be displayed, we do same steps in the previous case but finally, we test that the page does NOT contain 'Inherit Teams from Course'.
To do this test manually, user need lo log in as an Instructor and navigate to courses page. There the user can click on 'Create Teams' icon and will be redirected to 'create team' page, ideally, the 'Inherit Teams' button should not be displayed.

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

Similarly, for creating a team for an assignment without a course, we test that the page does not contain 'Inherit Teams From Course'. For this particular test case, we added a new factory object defined as an assignment with the course set to nil.
This can not be tested manually because assignment cannot be created without a course parent.

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

This test checks that after creating an assignment team the count in the teams table increase by 1.
This test cannot be performed manually as it is testing the count of a database table.
But, the user can check this functionality online by logging in as an instructor, going to the assignment page of any course and clicking on 'create teams' icon. Following up with entering the required details and clicking on 'create team'.

describe "POST #create" do
context "with an assignment team" do
it "increases count by 1" do
expect{create :assignment_team, assignment: @assignment}.to change(Team,:count).by(1)
end
it "redirects to the list page" do
end
end
end

The same test an be applied to create a course team as well.

context "with a course team" do
it "increases the count by 1" do
expect{create :course_team, course: @course}.to change(Team,:count).by(1)
end
end

===Testing Delete Method===

The delete method should work for deleting both assignment and course teams. We check this functionality by deleting the respective team and then check if the count of Teams goes down by 1.
The user can check this test manually by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with an assignment team " do
it "deletes an assignment team" do
@assignment = create(:assignment)
@a_team = create(:assignment_team)
expect{ @a_team.delete }.to change(Team, :count).by(-1)
end
end

Same Delete test has been applied to the course team
The manual check can also be performed in a similar way by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with a course team " do
it "deletes a course team" do
@course = create(:course)
@c_team = create(:course_team)
expect{ @c_team.delete }.to change(Team, :count).by(-1)
end
end

===Testing List Method===

The list method lists all the team nodes. This test that we have written, checks whether the instructor is able to view the team nodes in the list view.
To do this test manually user can log into the system as an instructor and click on any course, the course teams will be displayed. Also, the user can click on any team node to view information about that team.

describe 'List Team' do

it 'should list all team nodes' do
create(:assignment)
create(:assignment_node)
assignment_team = create(:assignment_team)
team_user = create(:team_user)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
page.all('#theTable tr').each do |tr|
expect(tr).to have_content?(assignment_team.name)
end
end
end

==References==

* [https://github.com/bhaskarsinha1311/expertiza/ Github] link to the project.
* [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit Link] to the project description.

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-11-04T03:47:58Z

Apendya: /* Instructions for manually testing Rspecs */

'''E1644: Refactor and Test 'Teams_Controller' Controller'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
[https://en.wikipedia.org/wiki/Code_refactoring '''Refactoring'''] is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, to improve readability of code.

== Changes to View ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

=== Manual Instructions for testing Rspecs ===

1. git clone https://github.com/bhaskarsinha1311/expertiza.git
2. Change to the expertiza directory and then perform "bundle install" and rake db:migrate.
3. Start the rails server
4. In a new terminal and in the expertiza directory, perform the following commands:
i. rspec spec/controllers/teams_controller_spec.rb
ii. rspec spec/features/inherit_teams_display_spec.rb
iii. rspec spec/features/list_teams_spec.rb

The results to the above commands can be found [https://www.youtube.com/watch?v=CcSruLHQoeU/ here].

===Testing Inherit Method===

To test that while creating an assignment team, the inherit teams section should be displayed, we log in as instructor got to list page and click on Create Team Link. On this page, we test that it should contain the string 'Inherit Teams From Course'.
To do this test manually, user need lo log in as an Instructor and navigate to assignments page for any course. There the user can click on 'Create Teams' icon and will be redirected to the Create teams page for an assignment, there the user can check for the 'inherit teams' button in the view, ideally, it should be there.

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

To test that while creating a course team, the inherit teams section should not be displayed, we do same steps in the previous case but finally, we test that the page does NOT contain 'Inherit Teams from Course'.
To do this test manually, user need lo log in as an Instructor and navigate to courses page. There the user can click on 'Create Teams' icon and will be redirected to 'create team' page, ideally, the 'Inherit Teams' button should not be displayed.

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

Similarly, for creating a team for an assignment without a course, we test that the page does not contain 'Inherit Teams From Course'. For this particular test case, we added a new factory object defined as an assignment with the course set to nil.
This can not be tested manually because assignment cannot be created without a course parent.

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

This test checks that after creating an assignment team the count in the teams table increase by 1.
This test cannot be performed manually as it is testing the count of a database table.
But, the user can check this functionality online by logging in as an instructor, going to the assignment page of any course and clicking on 'create teams' icon. Following up with entering the required details and clicking on 'create team'.

describe "POST #create" do
context "with an assignment team" do
it "increases count by 1" do
expect{create :assignment_team, assignment: @assignment}.to change(Team,:count).by(1)
end
it "redirects to the list page" do
end
end
end

The same test an be applied to create a course team as well.

context "with a course team" do
it "increases the count by 1" do
expect{create :course_team, course: @course}.to change(Team,:count).by(1)
end
end

===Testing Delete Method===

The delete method should work for deleting both assignment and course teams. We check this functionality by deleting the respective team and then check if the count of Teams goes down by 1.
The user can check this test manually by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with an assignment team " do
it "deletes an assignment team" do
@assignment = create(:assignment)
@a_team = create(:assignment_team)
expect{ @a_team.delete }.to change(Team, :count).by(-1)
end
end

Same Delete test has been applied to the course team
The manual check can also be performed in a similar way by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with a course team " do
it "deletes a course team" do
@course = create(:course)
@c_team = create(:course_team)
expect{ @c_team.delete }.to change(Team, :count).by(-1)
end
end

===Testing List Method===

The list method lists all the team nodes. This test that we have written, checks whether the instructor is able to view the team nodes in the list view.
To do this test manually user can log into the system as an instructor and click on any course, the course teams will be displayed. Also, the user can click on any team node to view information about that team.

describe 'List Team' do

it 'should list all team nodes' do
create(:assignment)
create(:assignment_node)
assignment_team = create(:assignment_team)
team_user = create(:team_user)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
page.all('#theTable tr').each do |tr|
expect(tr).to have_content?(assignment_team.name)
end
end
end

==References==

* [https://github.com/bhaskarsinha1311/expertiza/ Github] link to the project.
* [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit Link] to the project description.

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-11-04T03:47:01Z

Apendya: rspec testing

'''E1644: Refactor and Test 'Teams_Controller' Controller'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
[https://en.wikipedia.org/wiki/Code_refactoring '''Refactoring'''] is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, to improve readability of code.

== Changes to View ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

=== Manual Instructions for testing Rspecs ===

1. git clone https://github.com/bhaskarsinha1311/expertiza.git
2. Change to the expertiza directory and then perform "bundle install" and rake db:migrate.
3. Start the rails server
4. In a new terminal and in the expertiza directory, perform the following commands:
i. rspec spec/controllers/teams_controller_spec.rb
ii. rspec spec/features/inherit_teams_display_spec.rb
iii. rspec spec/features/list_teams_spec.rb

The results to the above commands can be found [https://www.youtube.com/watch?v=CcSruLHQoeU /here].

===Testing Inherit Method===

To test that while creating an assignment team, the inherit teams section should be displayed, we log in as instructor got to list page and click on Create Team Link. On this page, we test that it should contain the string 'Inherit Teams From Course'.
To do this test manually, user need lo log in as an Instructor and navigate to assignments page for any course. There the user can click on 'Create Teams' icon and will be redirected to the Create teams page for an assignment, there the user can check for the 'inherit teams' button in the view, ideally, it should be there.

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

To test that while creating a course team, the inherit teams section should not be displayed, we do same steps in the previous case but finally, we test that the page does NOT contain 'Inherit Teams from Course'.
To do this test manually, user need lo log in as an Instructor and navigate to courses page. There the user can click on 'Create Teams' icon and will be redirected to 'create team' page, ideally, the 'Inherit Teams' button should not be displayed.

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

Similarly, for creating a team for an assignment without a course, we test that the page does not contain 'Inherit Teams From Course'. For this particular test case, we added a new factory object defined as an assignment with the course set to nil.
This can not be tested manually because assignment cannot be created without a course parent.

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

This test checks that after creating an assignment team the count in the teams table increase by 1.
This test cannot be performed manually as it is testing the count of a database table.
But, the user can check this functionality online by logging in as an instructor, going to the assignment page of any course and clicking on 'create teams' icon. Following up with entering the required details and clicking on 'create team'.

describe "POST #create" do
context "with an assignment team" do
it "increases count by 1" do
expect{create :assignment_team, assignment: @assignment}.to change(Team,:count).by(1)
end
it "redirects to the list page" do
end
end
end

The same test an be applied to create a course team as well.

context "with a course team" do
it "increases the count by 1" do
expect{create :course_team, course: @course}.to change(Team,:count).by(1)
end
end

===Testing Delete Method===

The delete method should work for deleting both assignment and course teams. We check this functionality by deleting the respective team and then check if the count of Teams goes down by 1.
The user can check this test manually by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with an assignment team " do
it "deletes an assignment team" do
@assignment = create(:assignment)
@a_team = create(:assignment_team)
expect{ @a_team.delete }.to change(Team, :count).by(-1)
end
end

Same Delete test has been applied to the course team
The manual check can also be performed in a similar way by logging in as an instructor navigating to the page of any team for an assignment and clicking on 'Delete Team' icon.

context "with a course team " do
it "deletes a course team" do
@course = create(:course)
@c_team = create(:course_team)
expect{ @c_team.delete }.to change(Team, :count).by(-1)
end
end

===Testing List Method===

The list method lists all the team nodes. This test that we have written, checks whether the instructor is able to view the team nodes in the list view.
To do this test manually user can log into the system as an instructor and click on any course, the course teams will be displayed. Also, the user can click on any team node to view information about that team.

describe 'List Team' do

it 'should list all team nodes' do
create(:assignment)
create(:assignment_node)
assignment_team = create(:assignment_team)
team_user = create(:team_user)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
page.all('#theTable tr').each do |tr|
expect(tr).to have_content?(assignment_team.name)
end
end
end

==References==

* [https://github.com/bhaskarsinha1311/expertiza/ Github] link to the project.
* [https://docs.google.com/document/d/1TFC0G3zW-xkJYuloh_BmvWnj3dGZB23GOIYuikNRf_I/edit Link] to the project description.

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-10-29T04:09:03Z

Apendya: /* References */

'''E1644: Refactor and Test 'Teams_Controller' Controller'''

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
'''Refactoring'''[[https://en.wikipedia.org/wiki/Code_refactoring]] is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, to improve readability of code.

== Changes to View ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

===Testing Inherit Method===

To test that while creating an assignment team, the inherit teams section should be displayed, we login as instructor got to list page and click on Create Team Link. On this page we test that it should contain the string 'Inherit Teams From Course'.

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

To test that while creating a course team, the inherit teams section should not be displayed, we do same steps as previous case but finally we test that the page does NOT contain 'Inherit Teams from Course'

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

Similarly, for creating a team for an assignment without a course, we test that the page does not contain 'Inherit Teams From Course'. For this particular test case, we added a new factory object for that defined an assignment with course set to nil.

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

This test checks that after creating an assignment team the count in the teams table increase by 1.

describe "POST #create" do
context "with an assignment team" do
it "increases count by 1" do
expect{create :assignment_team, assignment: @assignment}.to change(Team,:count).by(1)
end
it "redirects to the list page" do
end
end
end

The same test for a course team as well

context "with a course team" do
it "increases the count by 1" do
expect{create :course_team, course: @course}.to change(Team,:count).by(1)
end
end

===Testing Delete Method===

The delete method should work for deleting both assignment and course teams. We check this functionality by deleting the respective team and then check if the count of Teams goes down by 1.

context "with an assignment team " do
it "deletes an assignment team" do
@assignment = create(:assignment)
@a_team = create(:assignment_team)
expect{ @a_team.delete }.to change(Team, :count).by(-1)
end
end

context "with a course team " do
it "deletes a course team" do
@course = create(:course)
@c_team = create(:course_team)
expect{ @c_team.delete }.to change(Team, :count).by(-1)
end
end

===Testing List Method===

The list method lists all the team nodes. This test that we have written, checks whether the instructor is able to view the team nodes in the list view.

describe 'List Team' do

it 'should list all team nodes' do
create(:assignment)
create(:assignment_node)
assignment_team = create(:assignment_team)
team_user = create(:team_user)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
page.all('#theTable tr').each do |tr|
expect(tr).to have_content?(assignment_team.name)
end
end
end

==References==

1. [[https://github.com/bhaskarsinha1311/expertiza/ Github link to project ]]

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-10-29T04:03:01Z

Apendya: added descriptions for delete and list tests

'''E1644: Refactor and Test 'Teams_Controller' Controller'''<ref>Project Description document https://google.com</ref>

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
'''Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, tp improve readability of code.

== Changes to View ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

===Testing Inherit Method===

To test that while creating an assignment team, the inherit teams section should be displayed, we login as instructor got to list page and click on Create Team Link. On this page we test that it should contain the string 'Inherit Teams From Course'.

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

To test that while creating a course team, the inherit teams section should not be displayed, we do same steps as previous case but finally we test that the page does NOT contain 'Inherit Teams from Course'

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

Similarly, for creating a team for an assignment without a course, we test that the page does not contain 'Inherit Teams From Course'. For this particular test case, we added a new factory object for that defined an assignment with course set to nil.

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

This test checks that after creating an assignment team the count in the teams table increase by 1.

describe "POST #create" do
context "with an assignment team" do
it "increases count by 1" do
expect{create :assignment_team, assignment: @assignment}.to change(Team,:count).by(1)
end
it "redirects to the list page" do
end
end
end

The same test for a course team as well

context "with a course team" do
it "increases the count by 1" do
expect{create :course_team, course: @course}.to change(Team,:count).by(1)
end
end

===Testing Delete Method===

The delete method should work for deleting both assignment and course teams. We check this functionality by deleting the respective team and then check if the count of Teams goes down by 1.

context "with an assignment team " do
it "deletes an assignment team" do
@assignment = create(:assignment)
@a_team = create(:assignment_team)
expect{ @a_team.delete }.to change(Team, :count).by(-1)
end
end

context "with a course team " do
it "deletes a course team" do
@course = create(:course)
@c_team = create(:course_team)
expect{ @c_team.delete }.to change(Team, :count).by(-1)
end
end

===Testing List Method===

The list method lists all the team nodes. This test that we have written, checks whether the instructor is able to view the team nodes in the list view.

describe 'List Team' do

it 'should list all team nodes' do
create(:assignment)
create(:assignment_node)
assignment_team = create(:assignment_team)
team_user = create(:team_user)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
page.all('#theTable tr').each do |tr|
expect(tr).to have_content?(assignment_team.name)
end
end
end

==References==

1. <ref> Github link to project https://github.com/bhaskarsinha1311/expertiza</ref>

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-10-29T02:56:56Z

Apendya:

'''E1644. Refactor and Test 'Teams_Controller' Controller'''<ref>Project Description document https://google.com</ref>

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
'''Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, tp improve readability of code.

== Changes to GUI ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>
<%= submit_tag "Inherit" %>

Which was changed to:

<% if not @parent.instance_of?(Course) and not @parent.course.nil? %>
Inherit Teams From Course
Use the teams that are currently defined for the course.
<%= form_tag :action => 'inherit' do %>
<%= hidden_field_tag 'id', @parent.id %>

<%= submit_tag "Inherit" %>
<% end %>

To fix the view, in the ''new.html.erb'' file of teams, we enclose the inherit teams section in an ''if condition'' that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

===Testing Inherit Method===

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

===Testing Delete Method===

===Testing List Method===

==References==

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-10-29T02:55:49Z

Apendya: /* Changes to GUI */

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-10-29T02:47:13Z

Apendya: /* Changes to GUI */

'''E1644. Refactor and Test 'Teams_Controller' Controller'''<ref>Project Description document https://google.com</ref>

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
'''Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, tp improve readability of code.

== Changes to GUI ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

{{<H2> Inherit Teams From Course </H2>
- Use the teams that are currently defined for the course.
-<%= form_tag :action => 'inherit' do %>
- <%= hidden_field_tag 'id', @parent.id %>
-
- <%= submit_tag "Inherit" %>}}

Changes in UI, to fix view for inherit team
In the new.html.erb file of teams, we enclose the inherit teams section in an if condition that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

===Testing Inherit Method===

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

===Testing Delete Method===

===Testing Inherit Method===

===Testing List Method===

CSC/ECE 517 Fall 2016/E1644. Refactor and test Teams Controller

2016-10-29T02:45:56Z

Apendya: /* Refactoring */

'''E1644. Refactor and Test 'Teams_Controller' Controller'''<ref>Project Description document https://google.com</ref>

This page provides a brief description of the '''Expertiza''' project. The project is aimed at refactoring and testing the 'Teams_Controller' Controller, which contains the methods to create new teams, list the existing teams, create new teams by inheriting existing teams, deleting existing teams and creating multiple teams at once by assigning them random topics. The project entailed, refactoring some part of the controller to improve the readability of code and then creating test cases in [https://en.wikipedia.org/wiki/RSpec RSpec] to verify the methods it possesses.

==Introduction to Expertiza==
[http://expertiza.ncsu.edu/ Expertiza] is a peer review based system which provides incremental learning from the class. This project has been developed together by faculty and students using [http://rubyonrails.org/ Ruby on Rails] framework. Expertiza allows the instructor to create, edit and delete assignments, create new assignment topics, assign them to a particular class or selected students, have students work on teams and then review each other's assignments at the end. For the students, they can signup for topics, form teams, and submit their projects and assignments.
Students then review the work done by other students and give suggestions to improve. Teams after reviews are allotted scores and they can refer to the peer comments to further improve their work. It also supports submission of different file types for assignments, including the URLs and wiki pages.

== Project Description ==
'''Teams_Controller''' primarily handles the team creation, deletion and other behaviours. Most of those are called from the instructor’s view. When manual testing is done, most of the methods can be called by clicking the “Create teams” icon from both assignments and courses.
The following tasks have been performed as per the requirements.

As a part of the project, some GUI's changes had to be made because they did not work the way they should have, some minor issues in the code were fixed and tests were written in '''RSpec''' for the methods delete, create, create teams, list and inherit.

===Create Method===
The method '''Create''' is called when an instructor tries to create a team manually. This works for both, creating ''assignment teams'' and ''course teams''. Assignment teams are teams made to do a particular assignment together and ''Course Teams'' are teams which are made for the whole course.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to create course teams.

* To verify that the Instructor is able to create assignment teams.

===Delete Method===
The method '''Delete''' is called when an instructor tries to delete a team manually. This works for both, deleting ''assignment teams'' and ''course teams''.

Following Test Cases were written and executed in RSpec to test this method:

* To verify that the Instructor is able to delete course teams.

* To verify that the Instructor is able to delete assignment teams.

===List Method===
The method '''List''' lists all the team nodes and the instructor is able to expand each team node to see the user nodes as well.

Following Test Cases were written and executed in RSpec to test this method:

* To check that all teams are being listed in the view.

===Inherit Method===
The method '''Inherit''' inherits teams from course to assignments, but the “Inherit Teams From Course” option should not display when either 1) we are editing a course object or 2) the current assignment object does not have a course associated with it.

Following Test Cases were written and executed in RSpec to test this method:

* To check that ''inherit teams'' is displayed while creating an assignment team.

* To check that ''inherit teams'' is not displayed while creating a course team.

* To check that ''inherit teams'' is not displayed while creating teams for an assignment without a course.

== Refactoring ==
'''Refactoring'''<ref>Refactoring https://en.wikipedia.org/wiki/Code_refactoring</ref> is restructuring of code without the need of changing any external behavior. It reduces complexity and improves readability. It also becomes easy to extend the application with respect to different modules and their functionalities.
Some common techniques to refactor are:

* Moving methods to appropriate modules
* Breaking methods into more meaningful functionality
* Creating more generalized code.
* Renaming methods and variable.
* Inheritance

As the part of the project, the variable ''@signUps'' in the delete method in the teams_controller was changed to snake case, tp improve readability of code.

== Changes to GUI ==
To fix the view for ''inherit teams'' functionality, changes to the view were made.

Initially, the code was:

-<H2> Inherit Teams From Course </H2>
- Use the teams that are currently defined for the course.
-<%= form_tag :action => 'inherit' do %>
- <%= hidden_field_tag 'id', @parent.id %>
-
- <%= submit_tag "Inherit" %>

Changes in UI, to fix view for inherit team
In the new.html.erb file of teams, we enclose the inherit teams section in an if condition that checks that the parent of the team is not a Course and it is not an Assignment whose course is nil.

== Testing the Teams_Controller ==

===Testing Inherit Method===

it 'should display inherit teams while creating an assignment team' do
create(:assignment)
create(:assignment_node)
create(:assignment_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_content('Inherit Teams From Course')
end

it 'should not display inherit teams while creating a course team' do
create(:course)
create(:course_node)
create(:course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Course'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

it 'should not display inherit teams while creating team for an assignment without a course' do
create(:assignment_without_course)
create(:assignment_without_course_node)
create(:assignment_without_course_team)
login_as("instructor6")
visit '/teams/list?id=1&type=Assignment'
click_link 'Create Team'
expect(page).to have_no_content('Inherit Teams From Course')
end

===Testing Create Method===

===Testing Delete Method===

===Testing Inherit Method===

===Testing List Method===