Expertiza_Wiki - User contributions [en]

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T03:24:32Z

Hkumbum: /* Test Cases */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Implementation===

Below are the key files to be modified:
====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* '''review_mapping_controller.rb:''' Method's like get_reviewer that consist of user_id will consist of calls to generic method which assigns a team_id or user_id based on the assignment being reviewed.
* '''response_controller:''' Initial check if it's a team based or an individual review to assign the corresponding id.

====Handling Concurrency====

There can exist a concurrency problem with the team review system. If two members from the team start with the review at the same time, the member who started the review first will lose his/her changes as the second members changes will be overwritten.

To solve this problem, we plan to use a boolean field 'lock' for locking mechanism.
If any member from the team starts with the review, we will set the lock field to true. Once the response is locked, no other member is allowed to edit the response. This lock will be released after the response has been saved.

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL). All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

We intend to write unit tests using RSpec for all the methods which we modified/created.

===Factory Girl===
Factory Girl is used for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>
===Test Cases===
1. If the instructor selects "Review by team", check if the review is done by a team member, not by participant.

2. If one teammate is working on a review, another teammate should not be able to edit it at the same time.

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T03:24:23Z

Hkumbum: /* Running RSpec */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Implementation===

Below are the key files to be modified:
====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* '''review_mapping_controller.rb:''' Method's like get_reviewer that consist of user_id will consist of calls to generic method which assigns a team_id or user_id based on the assignment being reviewed.
* '''response_controller:''' Initial check if it's a team based or an individual review to assign the corresponding id.

====Handling Concurrency====

There can exist a concurrency problem with the team review system. If two members from the team start with the review at the same time, the member who started the review first will lose his/her changes as the second members changes will be overwritten.

To solve this problem, we plan to use a boolean field 'lock' for locking mechanism.
If any member from the team starts with the review, we will set the lock field to true. Once the response is locked, no other member is allowed to edit the response. This lock will be released after the response has been saved.

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL). All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

We intend to write unit tests using RSpec for all the methods which we modified/created.

===Factory Girl===
Factory Girl is used for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>
===Test Cases===
1. If the instructor selects "Review by team", check if the review is done by a team member, not by participant.
2. If one teammate is working on a review, another teammate should not be able to edit it at the same time.

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T02:40:06Z

Hkumbum: /* Implementation */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Implementation===

Below are the key files to be modified:
====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL). All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is used for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T02:39:41Z

Hkumbum: /* Key files to be modified */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Implementation===

Below are the key files to be modified
====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL). All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is used for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T02:18:08Z

Hkumbum: /* RSpec */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL). All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is used for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T02:11:54Z

Hkumbum: /* Factory Girl */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

RSpec is used to write test cases using TTD approach. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is used for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T02:10:08Z

Hkumbum: /* RSpec */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''assignments/edit/_review_report.html.erb:''' Add a dropdown for the instructors to select if the reviews are individual or team-based.

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

RSpec is used to write test cases using TTD approach. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
We have used Factory Girl for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.
===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T02:06:13Z

Hkumbum: /* Factory Girl */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Design Pattern ====
'''Model View Controller'''

In an MVC model, a software application is divided into three major components: Model, View and Controller.

'''Model''' - Keeps data, logic and relations between objects and the database. It also handles validations, associations and transactions.

'''View''' - Displays the data received from the controller in the user interface.

'''Controller''' - Accepts the client's input and converts it into action points for the model or view. Other responsibilities include querying models and organizing data in a structure that is displayed by the view.

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''review_mapping/_review_report.html.erb:'''

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
We have used Factory Girl for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.
===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-12T01:49:45Z

Hkumbum: /* Controllers */

== Purpose ==

When a participant of a team reviewed an assignment, his/her review is independent of his teammate’s reviews. To allow teammates to discuss and review together, allowing teams to submit reviews for the team as a whole should be allowed ideally. We intend to do this in our project.

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Objects of ResponseMap record the information of who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review. We added a boolean field "reviewer_is_team" to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table.
# For an Instructor to specify whether the review is a Team/Individual based review, we will be providing a dropdown on the Review Strategy tab of assignment creation.
# Ensure that features such as "view my scores", or the "alternate view/heat map" should continue working.
# Concurrency control: Shouldn't allow multiple teammates to edit the team's review at the same time. The scope of the project doesn't include concurrent editing to allow multiple teammates to edit a review simultaneously.

== Design ==

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* '''review_response_map.rb:''' Add a field reviewer_is_team , which determines if the reviewer is doing an individual review or on behalf of the team.
* '''assignment.rb:''' Add a field review_type , that indicates if the assignment is a team based or an individual assignment decided by the instructor.

====Views====
* '''review_mapping/_review_report.html.erb:'''

====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
We have used Factory Girl for creating Assignment and Team objects to be used for testing. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-03T00:15:48Z

Hkumbum: /* Database Design */

== Purpose ==

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Add fields to the ResponseMap model to record who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review.
# Add a boolean field reviewer_is_team to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table. Else, it will be a reference to the Participants table.
# For an Instructor to specify whether the review is a Team/Individual based review, provide a checkbox on the Review Strategy tab of assignment creation.

== Design ==

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviewer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* review_response_map.rb
* participant.rb
* response_map.rb
* response.rb
* assignment_team.rb
* assignment_participant.rb
* assignment.rb
====Views====
* review_mapping/_review_report.html.erb
====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

CSC/ECE 517 Spring 2016 E1631 Team-based reviewing

2016-04-03T00:02:22Z

Hkumbum: /* Design */

== Purpose ==

*Currently all reviews in Expertiza are done by individuals. This is true regardless of whether the assignment is done by individuals or teams .
*There are occasions when it's advantageous to review projects as a team .
*It helps foster discussion and thereby improves the process of learning.

== Task Description ==
This project comprises of the following steps :

# Add fields to the ResponseMap model to record who reviews whom. The field reviewee_id refers to the team who is being reviewed. The field reviewer_id refers to the individual/team performing the review.
# Add a boolean field reviewer_is_team to identify if the review is performed by a team or an individual.
# If reviewer_is_team is true, the reviewer_id will be a reference to the Teams table. Else, it will be a reference to the Participants table.
# For an Instructor to specify whether the review is a Team/Individual based review, provide a checkbox on the Review Strategy tab of assignment creation.

== Design ==

==== Use Case Diagram ====

'''Name:''' Specify review type on Review Strategy tab.

'''Actor:''' Instructor.

'''Description:''' The instructor specifies whether this review is an individual review or a team based review on the Review Strategy tab.

'''Name:''' Perform Review.

'''Actor:''' Individual Student/Team.

'''Description:''' The individual/team will perform a review for the Assignment.

[[File:OODDUseCase.jpg]]

=== Database Design ===

ResponseMap in essence, records who reviews whom. Schema of ResponseMap:

{| class="wikitable"
|-
! Field
! Data type
|-
| id
| int(11)
|-
| reviewed_object_id
| int(11)
|-
| reviewer_id
| int(11)
|-
| reviewee_id
| int(11)
|-
| type
| varchar(255)
|-
| created_at
| datetime
|-
| updated_at
| datetime
|-
| caliberate_to
| boolean
|-
| reviewer_is_team
| boolean
|}

The description of the fields of the database for ResponseMap:

1. '''id:''' The unique record identifier.

2. '''reviewed_object_id:''' The id of the object that is reviewed. Assignments or ReviewMaps could be reviewed.

3. '''reviewer_id:''' The reviewer can either be an “AssignmentTeam” or “AssignmentParticipant”, which is indicated by the field reviwer_is_team.

4. '''reviewee_id:''' The id “AssignmentTeam” who is getting the “Response” i.e., the one whose work is being reviewed.

5. '''type :''' Indicates the type of the ResponseMap.

6. '''created_at:''' The timestamp when the Response was created.

7. '''updated_at:''' The timestamp when the Response was updated.

8. '''calibrate_to:''' A field of boolean data type.

9. '''reviwer_is_team:''' If this field is ‘true’, the reviewer_id refers to the id of the “AssignmentTeam” to which the participant belongs. Else, it refers to the id of the “Participant” itself.

===Key files to be modified===

====Models====
* review_response_map.rb
* participant.rb
* response_map.rb
* response.rb
* assignment_team.rb
* assignment_participant.rb
* assignment.rb
====Views====
* review_mapping/_review_report.html.erb
====Controllers====
* review_mapping_controller.rb
* participants_controller.rb

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T03:55:56Z

Hkumbum: /* Building Factory */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
We have used Factory Girl for creating test Assignment and Team objects. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factory===
Below is the code to create object of team class.

<code>
FactoryGirl.define do
factory :team do
name "Wikipedia contribution_Team2"
parent_id 999
#parent_id 741
type "AssignmentTeam"
submitted_hyperlinks "---\n- http://water.com\n- http://shed.com"
end
end
</code>

===Example RSpec===
We have written unit tests for each of the methods we have re-factored in this project. Here's a unit test example contained in spec/model/assignment_team_spec.rb:

<code>
describe "#has_submissions?" do
it "checks if a team has submitted hyperlinks" do
# assignment = build(:assignment)
assign_team = build(:assignment_team)
assign_team.submitted_hyperlinks << "\n- https://www.harrypotter.ncsu.edu"
expect(assign_team.has_submissions?).to be true
end
end
</code>

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T03:51:59Z

Hkumbum: /* Building Factory */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
We have used Factory Girl for creating test Assignment and Team objects. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factory===
Below is the code to create object of team class.

<code>
FactoryGirl.define do
factory :team do
name "Wikipedia contribution_Team2"
parent_id 999
#parent_id 741
type "AssignmentTeam"
submitted_hyperlinks "---\n- http://water.com\n- http://shed.com"
end
end
</code>

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T03:51:21Z

Hkumbum: /* Setup */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
RSpec is a testing framework for Rails, and is a Behavioral-Driven Development tool. It is a domain specific language(DSL).

There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
We have used Factory Girl for creating test Assignment and Team objects. Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl. Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factory===
Below is the code to create object of team class.

<code>
FactoryGirl.define do
factory :team do
name "Wikipedia contribution_Team2"
parent_id 999
#parent_id 741
type "AssignmentTeam"
submitted_hyperlinks "---\n- http://water.com\n- http://shed.com"
end
end
</code>q

===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:37:45Z

Hkumbum: /* References */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

== References ==
{{reflist|20em}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:36:48Z

Hkumbum: /* References */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:36:38Z

Hkumbum: /* References */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:34:45Z

Hkumbum: /* Running RSpec */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===
<code>
$ rspec spec/models/assignment_team_spec.rb
</code>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:33:57Z

Hkumbum: /* Running RSpec */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===

$ rspec spec/models/assignment_team_spec.rb

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:30:45Z

Hkumbum: /* Setup */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:29:05Z

Hkumbum: /* Setup */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'

gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:28:56Z

Hkumbum: /* Setup */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile

<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:28:33Z

Hkumbum: /* Factory Girl */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

===Setup===
Below code has to be added to the gemfile
<code>
gem 'rspec-rails'
gem "factory_girl_rails", "~> 4.0"
</code>

===Building Factories===
===Running RSpec===

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:13:37Z

Hkumbum: /* Factory Girl */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://www.npmjs.com/package/gulp-purescript</ref>.

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:13:08Z

Hkumbum: /* Factory Girl */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing. <ref>https://stackoverflow.com/questions/5183975/factory-girl-whats-the-purpose</ref>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:12:14Z

Hkumbum: /* Factory Girl */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:10:10Z

Hkumbum: /* References */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.<ref>http://stackoverflow.com/questions/5183975/factory-girl-whats-the-purpose</ref>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==
{{Reflist}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:07:50Z

Hkumbum: /* References */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.<ref>http://stackoverflow.com/questions/5183975/factory-girl-whats-the-purpose</ref>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

== References ==
{{reflist|20em}}

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:06:49Z

Hkumbum: /* UI Testing */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.<ref>http://stackoverflow.com/questions/5183975/factory-girl-whats-the-purpose</ref>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

==References==

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-02T00:05:55Z

Hkumbum: /* Testing Details */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

===Factory Girl===
Factory Girl is a replacement for fixtures. Fixtures have to be updated whenever we change a data model whereas adding and removing fields is much easier in Factory Girl.
Fixture definitions are global whereas Factories can be local, so isolated cases can be tested. Factories are defined to create objects for testing.<ref>http://stackoverflow.com/questions/5183975/factory-girl-whats-the-purpose</ref>

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.

CSC/ECE 517 Spring 2016/OSS E1601

2016-04-01T23:05:46Z

Hkumbum: /* Testing UI */

=== E1601: Refactor methods related to submitted_hyperlinks. ===

This wiki is for the open source refactoring project E1601: Refactor methods related to submitted_hyperlinks for the course ECE/CSC 517.

== Peer Review Information ==

The reviewers may use the below student and instructor logins for the purpose of reviewing and testing the functionality. These students belong to the same team and work on an assignment created by the below instructor:
* Instructor login: username -> instructor6, password -> password
* Student login: username -> student5884, password -> password
* Student login: username -> student6420, password -> password
'''Please note''': Please do not delete the above users or their team. If you wish to do so, please add them back so as to aid other reviewers. Also note that the option to submit hyperlinks in the UI will be displayed to the enrolled students only if assignment deadline is in future and the assignment is not in "Finish" state.

== Expertiza Introduction==

Expertiza is an open source web application which enhances the student's learning through peer reviews. The students can form teams and work on assignments given by course instructors. The peers can review the submissions and give feedback. The students also get to review the reviewers!

== Problem statement ==

'''Before''': When a student submitted files and hyperlinks for an assignment, that content was submitted on behalf of his team, and not individually (even if there is only one person in the team i.e a student working on an assignment cannot be without a team even if he is working alone). Some of the previous contributors had worked on a project which made this change and associated all the submitted content to teams instead of the individual participants: the submitted_hyperlinks and dirctory_num fields were moved to teams table. All the hyperlinks were now recorded in one submitted_hyperlinks field in the team model instead of being present in all the participants of the team. All the submitted files similarly were uploaded to the common file space and in the “course_folder/assignment_folder/team_folder” path.

'''What was wrong with that''': There are multiple methods in assignment_participant.rb which still give the impression that the author is submitting the hyperlinks on behalf of himself and not the team even though the relevant fields have been moved to teams model. These methods are to be moved to assignment_teams.rb for improving the clarity and the efficiency of code.

'''What refactoring we have done to improve the code''':

''Task1::'' Removed “hyperlinks_array” method and “hyperlinks” method from assignment_participant.rb. Created “hyperlinks” method in assignment_team.rb.

''Task2::'' Removed “submit_hyperlink” and “remove_hyperlink” from assignment_pariticpant.rb and created equivalent methods in assignment_team.rb.

''Task3::'' Removed “has_submissions?” from assginment_participant.rb and created the equivalent method in assignment_team.rb.

''Task4::'' All the calls to the above methods were refactored to call the appropriate method's functions.

''Task5::'' Refactored some of the logic of controller methods.

''Task6::'' Tests for submitting and removing submitted hyperlinks and files.

== List of files changed ==

Model Files:

#assignment_participant.rb
#assignment_team.rb
#student_task.rb

View Files:

#submitted_content/_hyperlink.html.erb
#assignments/edit/_calibration.html.erb
#assignments/list_submissions.html.erb
#submitted_content/_main.html.erb

Controller Files:

#sign_up_sheet_controller.rb
#submitted_content_controller.rb

Files with major modifications:

#The model: assignment_participant.rb
#The model: assignment_team.rb
#The controller: submitted_content_controller.rb

== Key changes ==

Four methods <code>hyperlinks</code>, <code>has_submissions?</code>, <code>submit_hyperlink</code> and <code>remove_hyperlink</code> were moved from the assignment_participant.rb model to assignment_team.rb, and the <code>hyperlinks_array</code> method was removed. 

'''Task1::''' The below methods <code>hyperlinks_array</code> and <code>hyperlinks</code> were removed from the assignment_participant.rb. The <code>hyperlinks</code> method which existed here seemed suspect as there was no <code>hyperlinks</code> method in the AssignmentTeam/Team models so the <code>try</code> would always fail and return an empty array. Also the <code>hyperlinks_array</code> method retrieved the hyperlinks from the <code>submitted_hyperlinks</code> field of the team model so in moving to AssignmentTeam model we just had to remove the .team quantifier.

<code>
def hyperlinks
team.try(:hyperlinks) || []
end

def hyperlinks_array
self.team.submitted_hyperlinks.blank? ? [] : YAML::load(self.team.submitted_hyperlinks)
end

</code>

They are both merged into a new single <code>hyperlinks</code> method in assignment_team.rb. All callers of both methods were refactored to use <code>hyperlinks</code> method of AssignmentTeam.

<code>
def hyperlinks
self.submitted_hyperlinks.blank? ? [] : YAML::load(self.submitted_hyperlinks)
end
</code>

'''Task2::''' Earlier, the following method <code>submit_hyperlink</code> was in assignment_participant.rb:

<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks_array
hyperlinks << hyperlink
team_object = self.team
team_object.submitted_hyperlinks = YAML::dump(hyperlinks)
team_object.save
end
</code>

It has been now moved to assignment_team.rb as below. Again, as the method was moved to AssignmentTeam model, it obviated the need to invoke the <code>team</code> method.
<code>
def submit_hyperlink(hyperlink)
hyperlink.strip!
raise "The hyperlink cannot be empty" if hyperlink.empty?
url = URI.parse(hyperlink)
# If not a valid URL, it will throw an exception
Net::HTTP.start(url.host, url.port)
hyperlinks = self.hyperlinks
hyperlinks << hyperlink
self.submitted_hyperlinks = YAML::dump(hyperlinks)
self.save
end
</code>
A similar refactoring was done for <code>remove_hyperlinks</code> method in assignment_participant.rb.

'''Task3::''' The methods <code>has_submissions?</code> earlier existed both in AssignmentTeam model and AssignmentParticipant model.

'' In assignment_team.rb''

<code>
def has_submissions?
list_of_users = participants;
list_of_users.each { |participant| return true if participant.has_submissions? }
false
end
</code>

''In assignment_participant.rb''

<code>
def has_submissions?
return ((self.team.submitted_files.length > 0) or (hyperlinks_array.length > 0))
end
</code>

What was happening earlier was that <code>has_submissions?</code> (AssignmentTeam method) used to call <code>has_submissions?</code> for each of the AssignmentParticipants in the team. This was redundant as the <code>submitted_files</code> and <code>submitted_hyperlinks</code> fields had been moved from the participant to the team model in earlier projects. So the participant objects again ended up again going to the team for retrieving these fields.

So we removed <code>has_submissions?</code> from the AssignmentParticipant and refactored the one already present in AssignmentTeam to the simple code below:

''In assignment_team.rb''

<code>
def has_submissions?
return ((self.submitted_files.length > 0) or (hyperlinks.length > 0))
end
</code>

'''Task4::''' Most importantly, at all the places in the Expertiza code, where there were calls to the above mentioned methods in assignment_participant.rb, they were refactored appropriately to call the newly created methods in assignment_team.rb.

''Sample example :''

<code>
if (participant.submitted_at.nil? && participant.hyperlinks.empty?)
</code>

''This was refactored as''

<code>
if (participant.submitted_at.nil? && participant.team.hyperlinks.empty?)
</code>

In refactoring the call points, we used the existing <code>team</code> method of AssignmentParticipant to get the AssignmentTeam object associated with the particular participant and then invoked the equivalent methods on the <code>team</code> object.

'''Task5 ::''' Refactoring some of controller code.

In submitted_content_controller, <code>remove_hyperlink</code> method used to cycle through all the participants belonging to the team of current participant, and for each participant call the <code>remove_hyperlink</code> method of the AssignmentParticipant Model to delete the instance of input hyperlink.

Since all the required hyperlink methods and fields are now in AssignmentTeam this would be redundant and waste cycles. So we refactored it to directly call the AssignmentTeam <code>remove_hyperlink</code> method.

''Earlier in submitted_content_controller.rb''

<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)
hyperlink_to_delete = @participant.hyperlinks_array[params['chk_links'].to_i]

team_id = TeamsUser.team_id(@participant.parent_id, @participant.user_id)
team_participants = Array.new
if Team.exists?(team_id)
team_users = TeamsUser.where(team_id: team_id)
team_users.each do |team_user|
team_participants << AssignmentParticipant.where(parent_id: @participant.parent_id, user_id: team_user.user_id).first
end
else
team_participants << @participant
end

team_participants.each do |team_participant|
team_participant.remove_hyperlink(hyperlink_to_delete)
end
</code>

''Refactored:''
<code>
def remove_hyperlink
@participant = AssignmentParticipant.find(params[:hyperlinks][:participant_id])

return unless current_user_id?(@participant.user_id)

team = @participant.team
hyperlink_to_delete = team.hyperlinks[params['chk_links'].to_i]
team.remove_hyperlink(hyperlink_to_delete)
</code>

== Testing Details ==

=== RSpec ===
There were no existing tests for the hyperlinks related methods. We used RSpec to write test cases using TTD approach. The assignment_team_spec.rb in the spec folder will have these tests. All the tests can be executed by rspec spec command, or can also be executed individually using the command "rspec spec/models/assignment_team_spec.rb".

=== UI Testing ===

Following are some of the steps which we performed to test this code from the User interface.

''Before the test::'' Have two students in an assignment team (say student1 and student2, you can also use the student logins listed in this wiki) for an active assignment. Active assignment simply means that the due date is in future and the assignment is not in "Finish" state. You can use an instructor login (example username: instructor6 password: password) to create a new assignment or update the due dates of some previous assignment and assign the team to it.

''Test1:'' Login as student1. Submit a hyperlink (say : linkA) as student1.

''Expected:'' Submit should go through. The hyperlink should be visible when you login as student2.

''Test2:'' Now as student2, submit another hyperlink (say linkB).

''Expected:'' Submit should go through. Now both hyperlinks should be visible from both student1 and student2.

''Test3:'' As student1, try submitting linkB.

''Expected:'' As linkB already exists in team's hyperlinks the submit should not go through.

''Test4:'' Remove a hyperlink (say linkA).

''Expected:'' Remove goes through. Now only linkB should be visible from both student accounts.

''Test5:'' Remove all hyperlinks.

''Expected:'' Hyperlinks list is empty for team and this can be seen from both student accounts.

''Test6:'' Submit some hyperlink. Try dropping topic after submitting.

''Expected:'' You are not allowed to drop if you have submitted some work. Only if you remove the submitted work it is possible for you to drop.

''Test7:'' Submit some hyperlink. Do a review of the team after logging in as a student in another team. The assignment should be in review stage for this to be possible, you can move the due dates via instructor login to achieve this.

''Expected:'' Peer review should show the links submitted by the other team. Review should be submitted successfully.